Python 中从类方法“返回 self”的目的

Python 2月前 57

来自类方法的 return self 语句的目的是：

将多个调用链接到一个方法的能力，因为 return self 返回实例对象。
使用迭代器协议，这要求我们从 __iter__() 方法返回 self。

class Calc():
    def __init__(self, number=0):
        self.number = number

    def add(self, value):
        self.number = self.number + value
        return self

    def subtract(self, value):
        self.number = self.number - value
        return self


calc = Calc()

calc.add(5).subtract(2).add(5)
print(calc.number)  # 👉️ 8

calc.subtract(5).add(3)
print(calc.number)  # 👉️ 6

Calc() 类中的加法和减法使用 return self 语句。

当我们调用实例方法时，Python 会自动将 self 作为第一个参数传递给该方法。

self 表示类的实例 – 调用方法的实例。

当我们从类方法返回 self 时，我们基本上返回实例对象。

这允许我们在单个语句中链接对该方法的多次调用。

add() 和 subtract() 方法返回实例，因此我们可以在一行中链接对这些方法的多次调用，而无需将结果存储在中间变量中。

class Calc():
    def __init__(self, number=0):
        self.number = number

    def add(self, value):
        self.number = self.number + value
        return self

    def subtract(self, value):
        self.number = self.number - value
        return self


calc = Calc()

calc.add(5).subtract(2).add(5)
print(calc.number)  # 👉️ 8

我们不会经常看到方法链模式，但一些库会使用它。

这个想法是每个方法都返回一个对象，它允许调用在一个语句中链接在一起，而不会将结果存储在中间变量中。

当我们看到诸如 obj.a().a().b() 之类的语法时，底层代码使用了方法链接模式。

但是，在实现迭代器协议时，从类方法返回 self 更为常见。

__iter__() 方法必须返回迭代器对象本身。

下面是一个如何通过实现 __iter__() 方法使类可迭代的示例。

class Counter:
    def __init__(self, start, stop):
        self.current = start - 1
        self.stop = stop

    def __iter__(self):
        # 👇️ return `self` here
        return self

    def __next__(self):
        self.current += 1
        if self.current < self.stop:
            return self.current
        raise StopIteration


for c in Counter(0, 4):
    print(c)  # 👉️ 0, 1, 2, 3