名词解释
本文主要介绍静态方法@staticmethod和类方法@classmethod在类中的应用,在介绍这两个函数装饰器之前,先介绍类中的几个名词,便于后面的理解:
类对象:定义的类就是类对象
类属性:定义在__init__ 外部的变量
类方法:定义在类中,且被@classmethod 装饰的方法
实例对象:类对象实例化后就是实例对象
实例属性:定义在__init__内部带有self.的变量
实例方法:定义在类对象中,且未被@classmethod装饰的方法就是实例方法
静态方法:定义在类中,且被@staticmethod 装饰的方法
直观的解释见下图:
@staticmethod用法
@staticmethod用于标记一个方法为静态方法。静态方法不接收类的实例(self)或类(cls)作为第一个参数,不需要对类实例化,可以直接被调用,但不能访问类或实例属性。
在pytorch的Function类中,虽然申明forward和backward为静态方法,但是这里均接受ctx上下文对象,用于保存和访问两者之间传递的信息。
静态方法:
python
class Func:
@staticmethod
def add(x, y):
return x + y
# 使用静态方法
result = Func.add(3, 4)
实例化方法:
python
class Func:
def add(self, x, y):
return x + y
result = Func() # 实例化
result.add(3, 4)
既然两种方法效果一样,且实例方法的功能比静态方法更丰富,为何还需要在类下面搞一个多此一举的静态方法?
原因如下:
将独立的函数打包装在类下面,使代码更加组织化和模块化。
可以在类下面创建独立于类实例的函数。
@classmethod用法
在函数前面加@classmethod,表明该方法是类方法,无需实例化可以被直接调用,但是需要接受cls作为第一个参数传入。
需要注意的是,一旦实例方法前面被加了@classmethod,该实例方法的级别就从二级跃升到一级,与类是一个级别。(假设类是一级,类下面的实例方法是二级。)
因此,类方法不能调用实例属性和实例方法,只能调用类属性和类方法。但是,实例方法可以调用类属性和类方法。
案例1:类方法的简单应用
python
class ExampleClass:
class_variable = 10
print('类属性:', class_variable)
@classmethod
def class_method(cls, x):
y = cls.class_variable + x
return y
print('----- 调用类方法 --------')
y = ExampleClass.class_method(100)
print('类方法输出:',y)
print('----- 类方法调用结束 -----')
输出:
python
类属性: 10
----- 调用类方法 --------
类方法输出: 110
----- 类方法调用结束 -----
与实例化方法对比:
python
class ExampleClass:
class_variable = 10
print('类属性:', class_variable)
@classmethod
def class_method(cls, x):
y = cls.class_variable + x
return y
exampleclass = ExampleClass()
y = exampleclass.class_method(100)
print(y)
输出:
python
类属性: 10
110
案例2:类方法作为工厂方法
python
class Vehicle:
def __init__(self, vehicle_type):
self.vehicle_type = vehicle_type
print('初始化实例属性:',self.vehicle_type)
@classmethod
def car(cls):
print('类方法')
return cls(10).test(100)
def test(self, x):
print('实例化方法:', self.vehicle_type + x)
print(Vehicle.car())
输出:
python
类方法
初始化实例属性: 10
实例化方法: 110
代码的执行流程如下:
- Vehicle.car():类对象调用类方法。
- cls(10):其中cls代指类对象Vehicle,因此cls(10)代表Vehicle(10),相当于对Vehicle类进行了实例化。
- init:执行类实例化cls(10)时,程序会对实例化属性进行初始化self.vehicle_type = vehicle_type,此时self.vehicle_type=10。
- .test(100):实例化对象cls(10)调用实例化方法test(100),此时会执行实例化方法test()中的内容。
案例3:类方法与类方法和类属性之间的调用
python
class Vehicle:
x0 = 20
@classmethod
def car(cls, x):
y = cls.test(10) + x
cls.x0 = cls.x0 + x
return y, cls.x0
@classmethod
def test(cls, x):
return x
x, y = Vehicle.car(100)
print('调用类方法:',x,y)
print('调用类属性:',Vehicle.x0)
输出:
python
调用类方法: 110 120
调用类属性: 120
可以发现,类方法与类方法之间能够相互调用,且类方法可以修改类的属性。
总结
静态方法和类方法都不需实例化,可以直接被调用;
静态方法不接受self作为第一个参数;
类方法接受cls作为第一个参数;
实例化方法接受self作为第一个参数;
静态方法和类方法均不能访问实例属性和调用实例方法;
实例对象可以访问类属性、类方法、实例属性、实例方法。