Python中return self的用法详解

Z时代
2024-01-10
分类：综合

在Python中，有些开源项目中的方法返回结果为self. 对于不熟悉这种用法的读者来说，这无疑使人困扰，本文的目的就是给出这种语法的一个解释，并且给出几个例子。

在Python中，return self的作用为：（英语原文，笔者水平有限，暂不翻译）

Returning self from a method simply means that your method returns a reference to the instance object on which it was called. This can sometimes be seen in use with object oriented APIs that are designed as a fluent interface that encourages method cascading.

通俗的说法是， allow chaining(这个是笔者自己的翻译：链式调用).

例子：


class Foo(object):
 def __init__(self):
  self.myattr = 0
 def bar(self):
  self.myattr += 1
  return self
f = Foo()
f.bar().bar().bar()
print(f.myattr)

输出结果为4.

把bar()方法改为返回return None，则上述代码会出错。


class Foo(object):
 def __init__(self):
  self.myattr = 0
 def bar(self):
  self.myattr += 1
  return None
f = Foo()
f.bar().bar().bar()
print(f.myattr)

输出结果如下：

AttributeError: 'NoneType' object has no attribute 'bar'

那么return self返回的结果是什么呢？


class Foo(object):
 def __init__(self):
  self.myattr = 0
 def bar(self):
  self.myattr += 1
  #return None
  return self
f = Foo()
print(type(f.bar()))

输出结果为：

<class '__main__.Foo'>

可以发现，return self返回的是类的实例。

一个真实的例子：

sklearn模块中很多方法的返回结果为self, 比如大多数模型的fit()方法，例子如下：


from sklearn.linear_model import LogisticRegression
X = [[0,0], [0,1], [1,0], [1,1]]
y = [0, 1, 1, 0]
clf = LogisticRegression()
# fit函数返回的结果就是self, 允许链式调用
t = clf.fit(X,y).predict([[0,2]])
print(t)

输出：