Python静态方法@staticmethod和类方法@classmethod

Python静态方法@staticmethod和类方法@classmethod经常出现在类的定义中,二者和常规实例方法之间有什么区别呢?先看例子:

class A:   
      cnt = 0   
      val = 1   
      def __init__(self, cnt=0, val=1):   
          self.val = val   
          A.cnt += 1   
         
      def normal_fun(self, x):   
          print(x + self.val)   
         
      @classmethod   
      def get_cnt(cls, x):   
          print('cnt:', A.cnt)   
          print(str(x) + '+val:', x+A.val)   
          cls().normal_fun(x)
  
      @staticmethod   
      def _add(x, y):   
          print(x + y)   

其中,第一个方法normal_fun(self, x)是常规实例方法,前面有@classmethod修饰符声明的方法get_cnt(cls, x)是类方法,前面有@staticmethod修饰符声明的方法_add(x, y)是静态方法。

三者的不同:

(1)从定义上来说

常规实例方法定义时前面不需要任何修饰符声明,其括号内的第一个参数必须是self;
类方法定义时前面必须用中@classmethod修饰符声明,括号中的第一个参数必须是cls;
静态方法定义时前面必须用中@staticmethod修饰符声明,括号中的参数和普通函数一样,不需要添加self或cls。

(2)从用法上来说

常规实例方法绑定类的实例,必须用类的实例引用,直接用类名引用将报错,如:

In [2]: a = A()      # 最常引用方法,用实例引用                                                           

In [3]: a.normal_fun(1)                                                         
2

In [4]: A.normal_fun(1)           # 用类名引用将报错                                              
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-4-d6fe7e9b4001> in <module>
----> 1 A.normal_fun(1)

TypeError: normal_fun() missing 1 required positional argument: 'x'

In [5]: A.normal_fun(a,1)              # 也可以这样引用,不常用                                         
2

类方法静态方法绑定类,既可以用类名引用,也可以用实例引用,如下:

In [3]: A.get_cnt(1)               # 类名引用                                             
cnt: 1
1+val: 2
2

In [4]: a.get_cnt(1)                 # 实例引用                                           
cnt: 2
1+val: 2
2

In [11]: A._add(1,1)                                                            
2

In [12]: a._add(1,1)                                                            
2
(3)从应用场景上讲

常规实例方法最为常见,其定义的方法一般都要使用init方法中的类属性,从而完成某项类要实现的功能。

类方法在执行时,调用它的类将自动约束到方法的cls参数,可通过这个参数访问类的其它参数。这句话怎么理解呢?例子中的类方法get_cnt的最后一句cls().normal_fun(x),即此时cls()将代表类A来访问A中的normal_fun方法,相当于A.normal_fun(x)。

     @classmethod  
     def get_cnt(cls, x):  
         print('cnt:', A.cnt)  
         print(str(x) + '+cnt:', x+A.cnt)  
         cls().normal_fun(x)  # 引用其它方法,相当于A.normal_fun(x)
In [2]: A.get_cnt(1)                                                            
cnt: 1
1+val: 2
2      # 引用normal_fun(1)的输出

人们通常用类方法实现与本类的所有对象有关的操作,如本例中,类方法get_cnt的作用是记录程序运行中创建的类A的实例对象的个数,每创建一个A类实例,cnt的值便会加1,用第一个print语句输出计数值。第二个print语句是为了说明类方法如何引用init中的属性。

# 此示例为删除cls().normal_fun(x)语句后的运行结果
In [7]: a = A()           # 第一次创建类实例                                                      

In [8]: A.get_cnt(1)                                                            
cnt: 1
1+val: 2

In [9]: b = A()           # 第二次创建类实例                                                      

In [10]: A.get_cnt(1)                                                           
cnt: 2
1+val: 2

In [11]: c = A()          # 第三次创建类实例                                                      

In [12]: A.get_cnt(1)                                                           
cnt: 3
1+val: 2

静态方法的实质是与类无关的普通函数,原本可将其定义在类外面作为全局函数使用,但出于某种原因,比如为了更好的组织代码,使编程模块更清晰,命名空间更整洁,将其置于类内作为局部函数使用。比如Python中有add()函数,numpy中也有add()函数,使用类名.方法名的引用方法将很好的避免np.add()和Python中的add()冲突。

其中,类方法的使用场景比较模糊,所以静态方法比类方法更为常见,且二者的定义中几乎都不会使用init中的类属性,我看了很多使用类方法的示例,用静态方法完全可以代替之,所以不用纠结到底用哪个,一般要用到init中的类属性时就用常规方法,不需要init中的类属性时就用静待方法。

(4)使用init中的类属性和其它类方法时:

常规实例方法:

self.属性名
self.方法名

比如本文例子中的normal_fun方法,使用类属性val时直接用self.val的形式。
类方法静态方法

类名.属性名
类名.方法名

如本例中get_cnt方法在使用val时采用A.val来引用,而不是self.val。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,470评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,393评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,577评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,176评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,189评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,155评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,041评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,903评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,319评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,539评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,703评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,417评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,013评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,664评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,818评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,711评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,601评论 2 353

推荐阅读更多精彩内容