类的方法不需访问实例时,根据具体场景选择使用@staticmethod或者@classmethod进行装饰
说明: 一般的类方法要接收一个self参数表示此类的实例,但有些方法不需要访问实例,这时分为两种情况:
1、方法不需要访问任何成员,或者只需要显式访问这个类自己的成员。这样的方法不需要额外参数,应当用@staticmethod装饰。 在Python 3.X版本中,允许直接定义不含self参数的方法,并且允许不通过实例调用。但是一旦通过实例调用这个方法,就会因为参数不匹配而出错。 加上@staticmethod进行修饰,可以让Python解释器明确此方法不需要self参数,提前拦截问题,可读性也更好。
错误示例:
class MyClass:
def my_func(): # 没有用@staticmethod修饰,通过实例调用会出错
pass
MyClass.my_func() # Python 3.X中允许,2.X中出错
my_instance = MyClass()
my_instance.my_func() # Python 3.X和2.X中都会出错
正确示例:
class MyClass:
@staticmethod
def my_func(): # 用@staticmethod修饰后,解释器会将其解析为静态方法
pass
MyClass.my_func() # OK
my_instance = MyClass()
my_instance.my_func() # OK,但是不推荐,容易和普通方法混淆。最好写成MyClass.my_func()
2、方法不需要访问实例的成员,但需要访问基类或派生类的成员。这时应当用@classmethod装饰。装饰后的方法,其第一个参数不再传入实例,而是传入调用者的最底层类。 比如,下面这个例子,通过基类Spam的count方法,来统计继承树上每个类的实例个数:
class Spam:
num_instances = 0
@classmethod
def count(cls): # 对每个类做独立计数
cls.num_instances += 1 # cls是实例所属于的最底层类
def __init__(self):
self.count() # 将self.__class__传给count方法
class Sub(Spam):
num_instances = 0
class Other(Spam):
num_instances = 0
x = Spam()
y1, y2 = Sub(), Sub()
z1, z2, z3 = Other(), Other(), Other()
x.num_instances, y1.num_instances, z1.num_instances # 输出:(1, 2, 3)
Spam.num_instances, Sub.num_instances, Other.num_instances # 输出:(1, 2, 3)
但是使用@classmethod时需要注意,由于在继承场景下传入的第一个参数并不一定是这个类本身,因
此并非所有访问类成员的场景都应该用@classmethod。比如下面这个例子中,Base显式的想要修改自
己的成员inited(而不是派生类的成员),这时应当用@staticmethod。
错误示例:
class Base:
inited = False
@classmethod
def set_inited(cls): # 实际可能传入Derived类
cls.inited = True # 并没有修改Base.inited,而是给Derived添加了成员
class Derived(Base):
pass
x = Derived()
x.set_inited()
if Base.inited:
print("Base is inited") # 不会被执行