最近在读Detectron2中的源码,看到很多类中都有@classmethod来修饰函数,这里就简记一下@classmethod在类中修饰函数的作用。
例子来源自
python @classmethod 的使用场合
官方的说法
classmethod(function)
中文说明:
classmethod
是用来指定一个类的方法为类方法,没有此参数指定的类的方法为实例方法,使用方法如下:
class C:
@classmethod
def f(cls, arg1, arg2, ...): ...
看了之后,一脸懵逼,什么叫指定一个类的方法?
看完python @classmethod 的使用场合
这篇文章后,豁然开朗。
定义一个时间类
class Data_test(object):
day = 0
month = 0
year = 0
def __init__(self, year=0, month=0, day=0):
self.day = day
self.month = month
self.year = year
def out_date(self):
print("year : %s" % self.year)
print("month : %s" % self.month)
print("day : %s" % self.day)
t = Data_test(2016, 8, 1)
t.out_date()
输出如下:
year : 2016
month : 8
day : 1
用户开始挑毛病了
用户想输入的是 “2016-8-1” 这样的字符格式,那么该如何处理呢?
如果是我,就会在调用Date_test 类前做一下处理:
先把‘2016-8-1’ 分解成 year,month,day 三个变量,然后转成int,再调用Date_test(year,month,day)函数。 也很符合要求,如下:
string_date = '2016-8-1'
year, month, day = map(int, string_date.split('-'))
s = Data_test(year, month, day)
s.out_date()
输出如下:
year : 2016
month : 8
day : 1
自己人不愿意了
如果调用你这个类的其他人表示,我就不愿意自己分解,就需要你类中能自动分解出这三个变量。
这时候有没有想起C++中定义类时,可以重载构造函数?
是不是想起,如果我构造类时,能有多种初始化方法那该有多好?
Python当然也可以,再回顾中文说明:
classmethod
是用来指定一个类的方法为类方法,没有此参数指定的类的方法为实例方法。
那我们可不可以把这个字符串处理的函数放到 Date_test
类当中呢?
那么@classmethod
就开始出场了
这就有点类似有多种不同的构造函数,而这些不同的构造函数就通过 @classmethod
来修饰
所以说,classmethod
叫做指定一个类的方法,也就是构造类的方法
看下一个例子:
class Data_test2(object):
day = 0
month = 0
year = 0
def __init__(self, year=0, month=0, day=0):
self.day = day
self.month = month
self.year = year
@classmethod
def get_date(cls, data_as_string):
# 这里第一个参数是cls, 表示调用当前的类名
year, month, day = map(int, string_date.split('-'))
date1 = cls(year, month, day) # 再调用初始化__init__函数
# 返回的是一个初始化后的类
return date1
def out_date(self):
print("year : %s" % self.year)
print("month : %s" % self.month)
print("day : %s" % self.day)
r = Data_test2.get_date("2016-8-6")
r.out_date()
输出
year : 2016
month : 8
day : 1
好处当然就是就是你以后重构类的时候不必要修改构造函数,只需要额外添加你要处理的函数,然后使用装饰符 @classmethod 就可以了