在 Python 中,实例方法(instance method),类方法(class method)与静态方法(static method)经常容易混淆。
三者区别:是否与类或者实例进行绑定
实例方法是和实例对象进行了绑定
类方法是和类对象进行了绑定
静态方法并不会与类或者实例绑定
实例方法
Python 的实例方法用得最多,也最常见。我们先来看 Python 的实例方法。
需要注意的是实例方法中
class T(object):
def f(self):
return 1
t = T()
t.f()
T.f(t) #等价的
直接通过类调用实例方法和先实例化再通过实例化对象调用方法是等价的
使用t.f的时候不需要再指定第一个参数self的值,这就是因为使用了descriptor机制,T.f(在Python2中是unboundmethod,在Python3中是标准的函数)有__get__方法,会将T.f从原来的类型转换成boundmethod,这是一个绑定了第一个参数的函数对象,于是调用时不再需要指定第一个参数。
下面的例子
class Kls(object):
def __init__(self, data):
self.data = data
def printd(self):
print(self.data)
ik1 = Kls('leo')
ik2 = Kls('lee')
ik1.printd()
ik2.printd()
输出:
leo
lee
上述例子中,printd为一个实例方法。实例方法第一个参数为self,当使用ik1.printd()调用实例方法时,实例ik1会传递给self参数,这样self参数就可以引用当前正在调用实例方法的实例。利用实例方法的这个特性,上述代码正确输出了两个实例的成员数据。
类方法
Python 的类方法采用装饰器@classmethod来定义,我们直接看例子。
class Kls(object):
num_inst = 0
def __init__(self):
print("come")
Kls.num_inst = Kls.num_inst + 1
print(Kls.num_inst)
@classmethod
def get_no_of_instance(cls):
return cls.num_inst
ik1 = Kls()
ik2 = Kls()
#类方法可以通过实例来调用也可通过类来调用
print (ik1.get_no_of_instance())
print (Kls.get_no_of_instance())
输出:
come
1
come
2
2
2
在上述例子中,我们需要统计类Kls实例的个数,因此定义了一个类变量num_inst来存放实例个数。通过装饰器@classmethod的使用,方法get_no_of_instance被定义成一个类方法。在调用类方法时,Python 会将类(class Kls)传递给cls,这样在get_no_of_instance内部就可以引用类变量num_inst。
由于在调用类方法时,只需要将类型本身传递给类方法,因此,既可以通过类也可以通过实例来调用类方法。
静态方法
在开发中,我们常常需要定义一些方法,这些方法跟类有关,但在实现时并不需要引用类或者实例,例如,设置环境变量,修改另一个类的变量,等。这个时候,我们可以使用静态方法。
Python 使用装饰器@staticmethod来定义一个静态方法。
IND = 'ON'
class Kls(object):
def __init__(self, data):
self.data = data
@staticmethod
def checkind():
return IND == 'ON'
def do_reset(self):
if self.checkind():
print('Reset done for: %s' % self.data)
def set_db(self):
if self.checkind():
print('DB connection made for: %s' % self.data)
ik1 = Kls(24)
ik1.do_reset()
ik1.set_db()
输出:
Reset done for: 24
DB connection made for: 24
在代码中,我们定义了一个全局变量IND,由于IND跟类Kls相关,所以我们将方法checkind放置在类Kls中定义。方法checkind只需检查IND的值,而不需要引用类或者实例,因此,我们将方法checkind定义为静态方法。
对于静态方法,Python 并不需要传递类或者实例,因此,既可以使用类也可以使用实例来调用静态方法。
实例方法,类方法与静态方法的区别
我们用代码说明实例方法,类方法,静态方法的区别。注意下述代码中方法foo,class_foo,static_foo的定义以及使用。
class Kls(object):
def foo(self, x):
print('executing foo(%s,%s)' % (self, x))
@classmethod
def class_foo(cls,x):
print('executing class_foo(%s,%s)' % (cls,x))
@staticmethod
def static_foo(x):
print('executing static_foo(%s)' % x)
ik = Kls()
# 实例方法
print("------实例方法----")
#在调用实例方法的时候,会默认把实例对象ik作为第一个参数self传递进去,第二个参数才是1
#所以在调用实例方法的时候输出的是实例的地址
ik.foo(1)
#打印ik.foo的时候foo已经和ik实例进行了绑定
print(ik.foo)
print('==========================================')
print("------类方法----")
# 类方法
#类方法可以通过实例调用也可以通过类直接调用
#在调用的时候直接将类Kls作为第一个参数传递给cls参数,所以调用ik.class_foo(1)会打出Kls的类型信息
ik.class_foo(1)
Kls.class_foo(1)
#打印ik.class_foo的时候calss_foo是和Kls进行了绑定而不是和ik进行了绑定
print(ik.class_foo)
print('==========================================')
print("------静态方法----")
# 静态方法
#静态方法调用的时候并不需要传递类或者实例
# 静态方法很像我们在类外定义的函数,只不过静态方法可以通过类或者实例来调用而已。
ik.static_foo(1)
Kls.static_foo('hi')
#当调用ik.static_foo时,静态方法并不会与类或者实例绑定
print(ik.static_foo)
输出:
------实例方法----
executing foo(<__main__.Kls object at 0x106907a20>,1)
<bound method Kls.foo of <__main__.Kls object at 0x106907a20>>
==========================================
------类方法----
executing class_foo(<class '__main__.Kls'>,1)
executing class_foo(<class '__main__.Kls'>,1)
<bound method Kls.class_foo of <class '__main__.Kls'>>
==========================================
------静态方法----
executing static_foo(1)
executing static_foo(hi)
<function Kls.static_foo at 0x1069050d0>
Process finished with exit code 0
对于实例方法,调用时会把实例ik作为第一个参数传递给self参数。因此,调用ik.foo(1)时输出了实例ik的地址。
对于类方法,调用时会把类Kls作为第一个参数传递给cls参数。因此,调用ik.class_foo(1)时输出了Kls类型信息。
前面提到,可以通过类也可以通过实例来调用类方法,在上述代码中,我们再一次进行了验证。
对于静态方法,调用时并不需要传递类或者实例。其实,静态方法很像我们在类外定义的函数,只不过静态方法可以通过类或者实例来调用而已。
值得注意的是,在上述例子中,foo只是个函数,但当调用ik.foo的时候我们得到的是一个已经跟实例ik绑定的函数。调用foo时需要两个参数,但调用ik.foo时只需要一个参数。foo跟ik进行了绑定,因此,当我们打印ik.foo时,会看到以下输出:
<bound method Kls.foo of <__main__.Kls object at 0x106907a20>>
当调用ik.class_foo时,由于class_foo是类方法,因此,class_foo跟Kls进行了绑定(而不是跟ik绑定)。当我们打印ik.class_foo时,输出:
<bound method Kls.class_foo of <class '__main__.Kls'>>
当调用ik.static_foo时,静态方法并不会与类或者实例绑定,因此,打印ik.static_foo(或者Kls.static_foo)时输出:
<function Kls.static_foo at 0x1069050d0>