python 中的self和cls

python 中的self和cls

一句话描述：self是类（Class）实例化对象，cls就是类（或子类）本身，取决于调用的是那个类。
@staticmethod 属于静态方法装饰器，@classmethod属于类方法装饰器。我们需要从声明和使用两个方面来理解。

详细介绍

一般来说，要使用某个类的方法，需要先⚠️实例化一个对象再调用方法。而使用@staticmethod或@classmethod，就可以不需要实例化，直接类名.方法名()来调用。这有利于组织代码，把某些应该属于某个类的函数给放到那个类里去，同时有利于命名空间的整洁。🤔

首先定义一个类A，类A中有三个函数，foo1为静态函数，用@staticmethod装饰器装饰，这种方法与类有某种关系但不需要使用到实例或者类来参与。

class A(object):
    a = 'a'
    @staticmethod
    def foo1(name):
        print('hello', name, A.a)
    def foo2(self, name):
        print('hello', name, self.a)
    @classmethod
    def foo3(cls, name):
        print('hello', name, cls.a)
class B(A):
    a = 'b'
    @staticmethod
    def foo1(name):
        print('hello', name, B.a)
    def foo2(self, name):
        print('subclass B')
        print('hello', name, self.a)
    @classmethod
    def foo3(cls, name):
        print('hello', name, cls.a)

如下两种方法都可以正常输出，也就是说

既可以作为类的方法使用，也可以作为类的实例的方法使用。

a = A()
b = B()
a.foo1("小熊猫") # hello 小熊猫 a
A.foo1("小熊猫") # hello 小熊猫 a
b.foo1("大熊猫") # subclass B， hello 大熊猫 b
B.foo1("大熊猫") # subclass B， hello 大熊猫 b

foo2为正常的函数，是类的实例的函数，调用方式如下。

将实参实例化对象或者类名称传入self对象，取到不同的属性和方法。

a.foo2("小熊猫") # hello 小熊猫 a
A.foo2(a, "小熊猫") # hello 小熊猫 a
A.foo2(b, "小熊猫") # hello 小熊猫 b
A.foo2(A, "小熊猫") # hello 小熊猫 a 
A.foo2(B, "小熊猫") # hello 小熊猫 b
B.foo2(a, "小熊猫") # subclass B， hello 小熊猫 a
b.foo2("小熊猫") # subclass B， hello 小熊猫 b

foo3为类函数，cls作为第一个参数用来表示类本身. 在类方法中用到，类方法是只与类本身有关而与实例无关的方法。如下两种方法都可以正常输出。

可以看出，传入形参cls的值为前面的调用函数，如果再传入对象或者类名称，会报类型错误，多传了一个参数。

a.foo3("小熊猫")
A.foo3("小熊猫")
# a.foo3(a, "小熊猫") # TypeError: foo3() takes 2 positional arguments but 3 were given
# A.foo3(A, "小熊猫") # TypeError: foo3() takes 2 positional arguments but 3 were given
b.foo3("大熊猫")
B.foo3("大熊猫")

@staticmethod和@classmethod的用法

相同：

• @staticmethod和@classmethod都可以直接类名.方法名()来调用

区别：

• 从它们的使用上来看,@staticmethod不需要表示自身对象的self和自身类的cls参数，就跟使用函数一样。@classmethod也不需要self参数，但第一个参数是调用类方法的类。
• 如果在@staticmethod中要调用到这个类的一些属性方法，只能直接类名.属性名或类名.方法名。
• 而@classmethod因为持有cls参数，可以来调用类的属性，类的方法，实例化对象等，避免硬编码。

class A(object):
    a = 'a'
    @staticmethod
    def foo1(name):
        print('hello foo1', name, A.a)
        print("hello foo4 ", B.foo2(B, "小熊猫"))
    def foo2(self, name):
        print('hello foo2', name, self.a)
    @classmethod
    def foo3(cls, name):
        print('hello foo3', name, cls.a)
        print("hello foo5", cls().foo2(name))
        print("hello foo6", cls().foo1(name))
class B(A):
    a = 'b'
    @staticmethod
    def foo1(name):
        print('subclass B， hello', name, B.a)
    def foo2(self, name):
        print('subclass B， hello', name, self.a)
    @classmethod
    def foo3(cls, name):
        print('subclass B， hello', name, cls.a)

重点应关注@staticmethod和@classmethod调用本类或其他类的函数和属性的区别

例子1：

关键看第二句 subclass B， hello 小熊猫 b，在调用 B.foo2(B, “小熊猫”) 时，执行了B类型下的foo2()方法，该方法无返回值，因此 下句输出为 hello foo4 None

a = A()
a.foo1("小熊猫")
# 输出
hello foo1 小熊猫 a
subclass B， hello 小熊猫 b
hello foo4  None

例子2：

a.foo3("小熊猫")
# 输出
hello foo3 小熊猫 a
hello foo2 小熊猫 a
hello foo5 None
hello foo1 小熊猫 a
subclass B， hello 小熊猫 b
hello foo4  None
hello foo6 None

最后一个小例子

class A(object):
    @classmethod
    def acquire(cls, param):
        if cls is A:
            raise Exception("只有子类才能调用！！！")
        return "类 a %r 的参数为 %r" % (cls, param)

class B(A):
    pass

class C(A):
    pass

print(B.acquire("小熊猫"))
print(C.acquire("大熊猫"))
print(A.acquire("爱吃竹子"))
# 结果
类 a <class '__main__.B'> 的参数为 '小熊猫'
类 a <class '__main__.C'> 的参数为 '大熊猫'
Exception: 只有子类才能调用！！！