一日一技:什么情況使用靜態方法和類方法?
最近有同學在知識星球上問,什么情況下使用靜態方法,什么情況下使用類方法。今天我們就來捋一下這兩個方法的應用場景。
首先,我們來定義一個普通的類,里面都是普通的方法,普通方法又叫實例方法。
- class People:
- def __init__(self, name, age):
- self.name = name
- self.age = age
- def introduce_myself(self):
- print(f'大家好,我叫: {self.name}')
- def add_two_string_num(self, a, b):
- a_int = int(a)
- b_int = int(b)
- return a_int + b_int
- def calc_age_after_n_year(self, n):
- age = self.add_two_string_num(self.age, n)
- print(f'{n}年以后,我{age}歲')
這個類運行起來的效果如下圖所示:
大家注意在這個類里面的方法add_two_string_num,它接受兩個參數,并將他們轉換為int類型,然后相加并返回結果。這個過程非常簡單,但是,它跟People這個類有什么直接關系嗎?
其實這個方法跟這個類沒有什么直接關系,我們甚至把它改成函數都可以:
- def add_two_string_num(a, b):
- a_int = int(a)
- b_int = int(b)
- return a_int + b_int
- class People:
- def __init__(self, name, age):
- self.name = name
- self.age = age
- def introduce_myself(self):
- print(f'大家好,我叫: {self.name}')
- def calc_age_after_n_year(self, n):
- age = add_two_string_num(self.age, n)
- print(f'{n}年以后,我{age}歲')
- kingname = People('kingname', 20)
- kingname.introduce_myself()
- kingname.calc_age_after_n_year(10)
運行結果跟之前完全一樣:
我們可以說,add_two_string_num函數就是一個工具函數。工具函數接收參數,輸出結果,完全不關心誰在調用他,也不關心在哪里調用他。
但現在有一個比較尷尬的事情,這個函數,只有 People在調用,其它地方都沒有調用。單獨把它放到其它地方又顯得多余,弄成實例方法又浪費了self參數,這個時候,我們就可以用靜態方法:
- class People:
- def __init__(self, name, age):
- self.name = name
- self.age = age
- def introduce_myself(self):
- print(f'大家好,我叫: {self.name}')
- @staticmethod
- def add_two_string_num(a, b):
- a_int = int(a)
- b_int = int(b)
- return a_int + b_int
- def calc_age_after_n_year(self, n):
- age = People.add_two_string_num(self.age, n)
- print(f'{n}年以后,我{age}歲')
- kingname = People('kingname', 20)
- kingname.introduce_myself()
- kingname.calc_age_after_n_year(10)
一句話總結:靜態方法就是某個類專用的工具函數。
說完了靜態方法,我們再說說類方法。什么情況下應該使用類方法呢?回答這個問題前,我先反問你一個問題,怎么把People類初始化成一個實例?
你說這還不簡單嗎,一行代碼就行了啊:
- xxx = People('xxx', 10)
注意,這里你在初始化這個類的時候,你是一個一個參數傳入進去的。如果你用過順豐寄送快遞,你就會發現,填寫收件人的時候,有兩種方式,一種方式就像上面這樣,一個一個參數填進去。另一種方式,它給你一個輸入框,你把一段包含姓名,地址,手機號的文字粘貼進去,它自動解析。
那么,如果我現在給你一個字符串:我的名字:青南,我的年齡:20,把它提取出來。你怎么基于這個字符串生成People類的實例?
這個時候,你可能會這樣寫:
- import re
- content = '我的名字:青南,我的年齡:20,把它提取出來'
- name = re.search('名字:(.*?),', content).group(1)
- age = re.search('年齡:(\d+)', content).group(1)
- kingname = People(name, age)
這樣做確實可以,但我能不能讓People這個類自動識別呢?其實是可以的,有兩種方法,一種方法是在__init__里面多加幾個參數,然后在初始化的時候,從這幾個參數里面解析,這個方法大家都知道,我就不多講了。我們來講講第二個方法,就是使用類方法。
我們只需要再定義一個類方法:
- import re
- class People:
- def __init__(self, name, age):
- self.name = name
- self.age = age
- def introduce_myself(self):
- print(f'大家好,我叫: {self.name}')
- @staticmethod
- def add_two_string_num(a, b):
- a_int = int(a)
- b_int = int(b)
- return a_int + b_int
- @classmethod
- def from_chinese_string(cls, sentence):
- name = re.search('名字:(.*?),', content).group(1)
- age = re.search('年齡:(\d+)', content).group(1)
- return cls(name, age)
- def calc_age_after_n_year(self, n):
- age = People.add_two_string_num(self.age, n)
- print(f'{n}年以后,我{age}歲')
- content = '我的名字:青南,我的年齡:20,把它提取出來'
- kingname = People.from_chinese_string(content)
- kingname.introduce_myself()
- kingname.calc_age_after_n_year(10)
運行效果如下圖所示:
類方法使用裝飾器@classmethod來裝飾,并且它的第一個參數是隱式參數cls。這個參數其實就是People這個類本身。這個隱式參數在我們調用類方法的時候,是不需要傳入的。在這個類方法里面,相當于使用People初始化了一個實例,然后把這個實例返回了出去。
這樣做有什么好處呢?好處就在于我們完全不需要修改__init__,那么,也就不需要修改代碼里面其它調用了People類的地方。例如現在我又想增加從英文句子里面提取名字和年齡的功能,那么只需要再添加一個類方法就可以了:
- import re
- class People:
- def __init__(self, name, age):
- self.name = name
- self.age = age
- def introduce_myself(self):
- print(f'大家好,我叫: {self.name}')
- @staticmethod
- def add_two_string_num(a, b):
- a_int = int(a)
- b_int = int(b)
- return a_int + b_int
- @classmethod
- def from_chinese_string(cls, sentence):
- name = re.search('名字:(.*?),', content).group(1)
- age = re.search('年齡:(\d+)', content).group(1)
- return cls(name, age)
- @classmethod
- def from_english_string(cls, sentence):
- name = re.search('name: (.*?),', content).group(1)
- age = re.search('age: (\d+)', content).group(1)
- return cls(name, age)
- def calc_age_after_n_year(self, n):
- age = People.add_two_string_num(self.age, n)
- print(f'{n}年以后,我{age}歲')
- content = 'my name: kinganme, my age: 15 please extract them'
- kingname = People.from_english_string(content)
- kingname.introduce_myself()
- kingname.calc_age_after_n_year(10)
運行效果如下圖所示:
一句話總結:當你想使用工廠模式,根據不同的參數生成同一個類的不同對象的時候,就可以使用類方法。
其實如果大家使用過Python自帶的datetime模塊,你就會發現類方法無處不在:
- import datetime
- now = datetime.datetime.now()
- dt = datetime.datetime.fromtimestamp(1633691412)
- dt2 = datetime.datetime.fromisoformat('2021-10-08 19:10:05')
這段代碼里面的.now()、.fromtimestamp()和 .fromisoformat(),都是類方法。他們最終返回的都是datetime.datetime對象,區別在于他們是根據不同類型的輸入參數生成的。
本文轉載自微信公眾號「未聞Code」,可以通過以下二維碼關注。轉載本文請聯系未聞Code公眾號。