Python @staticmethod和@classmethod

Last Updated on 2019年9月27日

Python其实有3个方法,即静态方法(staticmethod),类方法(classmethod)和实例方法,如下:

def foo(x):
    print "executing foo(%s)"%(x)

class A(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    

a = A()

这里先理解下函数参数里面的self和cls，这个self和cls是对类或者实例的绑定。

对于一般的函数来说我们可以这么调用foo(x),这个函数就是最常用的,它的工作跟任何东西(类,实例)无关.

对于实例方法,我们知道在类里每次定义方法的时候都需要绑定这个实例,就是foo(self, x),为什么要这么做呢?因为实例方法的调用离不开实例,我们需要把实例自己传给函数,调用的时候是这样的a.foo(x)(其实是foo(a, x))，对象实例a隐式地作为第一个参数传递：

a.foo(1)
# executing foo(<__main__.A object at 0xb7dbef0c>,1)

使用classmethod类方法一样,只不过它传递的是类而不是实例,A.class_foo(x)，如果您将某些东西定义为类方法，则可能是因为您打算从类而不是从类实例调用它，注意这里的self和cls可以替换别的参数,但是python的约定是这俩,还是不要改的好。

a.class_foo(1)
# executing class_foo(<class '__main__.A'>,1)

A.class_foo(1)
# executing class_foo(<class '__main__.A'>,1)

使用staticmethods时，self（对象实例）和 cls（类）都不会隐式传递为第一个参数。它们的行为类似于普通函数，不同之处在于您可以从实例或类中调用它们：

a.static_foo(1)
# executing static_foo(1)

A.static_foo('hi')
# executing static_foo(hi)

静态方法常用于对与类之间具有某种逻辑联系的函数进行分组。

好好使设计类的方法的，可以使代码更清晰可观。