Python函式引數和註解是什麼

dongfanger發表於2021-04-09

四種引數

Python函式func定義如下:

def func(first, *args, second="Hello World", **kwargs):
    print(first)
    print(args)
    print(second)
    print(kwargs)


func("dongfanger", "san", py="good")

執行後會輸出:

dongfanger
('san',)
Hello World
{'py': 'good'}

它有四種引數:

  • first是定位引數,positional parameter,不可省略。
  • *args是可變引數,arguments,存入元組。
  • second是預設值引數,default argument values,可以省略。
  • **args是關鍵字引數,keyword arguments,存入字典。

func函式的呼叫方式有以下這些:

①傳入單個定位引數。

func("dongfanger")  
dongfanger
()
Hello World
{}

②第一個引數後的任意個引數會被*args捕獲,存入一個元組。

func("dongfanger", "a", "b", "c")
dongfanger
('a', 'b', 'c')
Hello World
{}

③沒有明確指定名稱的關鍵字引數會被**kwargs捕獲,存入一個字典。

func("dongfanger", j="1", k="2")
dongfanger
()
Hello World
{'j': '1', 'k': '2'}

④second只能作為關鍵字引數傳入。

func("dongfanger", second="cool")
dongfanger
()
cool
{}

⑤定位函式也能作為關鍵字引數傳入。

func(first="san")
san
()
Hello World
{}

⑥字典前加上**,其所有元素作為單個引數傳入,同名鍵會繫結到對應具名引數上,餘下的被**args捕獲。

my_dict = {"first": "dongfanger", "location": "cd", "second": "cool", "age": "secret"}
func(**my_dict)
dongfanger
()
cool
{'location': 'cd', 'age': 'secret'}

除了這四種引數,還有一種Python3新增加的僅限關鍵字引數。

僅限關鍵字引數

僅限關鍵字引數(keyword-only argument)是Python3的新特性,func函式的second引數就是僅限關鍵字引數,“僅限”的意思是說,只能通過關鍵字引數指定,它一定不會捕獲未命名的定位引數。

假如把引數位置調整一下定義another_func函式:

def another_func(first, another_second="Hello World", *args,  **kwargs):
    print(first)
    print(another_second)
    print(args)
    print(kwargs)


another_func("dongfanger", "a", "b", "c")

輸出會變成:

dongfanger
a  # 注意這裡
('b', 'c')
{}

another_second不是僅限關鍵字引數,而只是預設值引數,因為它捕獲到了定位引數。

由此得知,定義僅限關鍵字引數,必須把它放到*args引數後面,就像func函式一樣,反例是another_func函式。

還有第二個方法定義僅限關鍵字引數,在簽名中放一個*

>>> def f(a, *, b):  # b是僅限關鍵字引數
...    return a, b
...
>>> f(1, b=2)  # 只能傳關鍵字引數
(1, 2)
>>> f(1, 2)  # 不能傳定位引數
Traceback (most recent call last):
  File "<input>", line 1, in <module>
TypeError: f() takes 1 positional argument but 2 were given
>>> f(1, 2, 3)  # 不能傳定位引數
Traceback (most recent call last):
  File "<input>", line 1, in <module>
TypeError: f() takes 1 positional argument but 3 were given

僅限關鍵字引數不一定要有預設值,就像b一樣,強制必須傳入實參。

內省中的函式引數

函式內省的意思是說,當你拿到一個“函式物件”的時候,你可以繼續知道,它的名字,引數定義等資訊。這些資訊可以通過函式物件的屬性(一些雙下劃線的魔法方法)得到。

對於func函式:

def func(first, *args, second="Hello World", **kwargs):
    print(first)
    print(second)
    print(args)
    print(kwargs)

和another_func函式:

def another_func(first, another_second="Hello World", *args,  **kwargs):
    print(first)
    print(another_second)
    print(args)
    print(kwargs)

__defaults__屬性】

元組,儲存著定位引數和關鍵字引數的預設值。

print(func.__defaults__)  # None

print(another_func.__defaults__)  # ('Hello World',)

__kwdefaults__屬性】

字典,儲存僅限關鍵字引數。

print(func.__kwdefaults__)  # {'second': 'Hello World'}

print(another_func.__kwdefaults__)  # None

__code__屬性】

code物件引用,code物件自身有很多屬性,其中包括引數名稱。

print(func.__code__.co_varnames)  # ('first', 'second', 'args', 'kwargs')

print(another_func.__code__.co_varnames)  # ('first', 'another_second', 'args', 'kwargs')

另外還可以使用inspect庫的signature方法來檢視內省中的函式引數:

from inspect import signature

print(signature(func))  
# (first, *args, second='Hello World', **kwargs)

框架和IDE等工具可以使用這些資訊驗證程式碼。

函式註解

如果刷過力扣演算法題,那麼對函式註解就不會陌生。比如:

def clip(text:str, max_len:'int > 0'=80) -> str:
    pass

引數:後面是註解表示式,可以用來註解引數型別和約束。如果引數有預設值,註解放在引數名和=號之間。

可以在函式末尾的):之間新增->和註解表示式,來對返回值新增註解。

註解表示式可以是任何型別,最常用的型別是類(如str或int)和字串(如'int > 0')。

函式註解只是個註解,Python對註解所做的唯一的事情是,把它們存入函式的__annotations__屬性中:

print(clip.__annotations__)
#{'text': <class 'str'>, 'max_len': 'int > 0', 'return': <class 'str'>}

Python不做檢查,不做強制,不做驗證,什麼操作都不做!註解只是後設資料,可以供框架和IDE等工具使用。

小結

本文介紹了Python函式的四種引數:定位引數、可變引數、預設值引數、關鍵字引數,和第五種Python3新特性引數:僅限關鍵字引數。拿到一個函式物件後,可以通過函式屬性(一些雙下劃線的魔法方法)檢視內省中的引數資訊。函式註解是一種後設資料,存在__annotations__屬性中,備註函式的引數和返回值的型別,它只是個註解,Python不會做任何強制檢查

參考資料:

《流暢的Python》

https://blog.csdn.net/cadi2011/article/details/86641811

https://segmentfault.com/q/1010000012595419

更文進度

由於個人原因,寫文章時間變少了,雖然我仍然會努力碼字,但是更文頻率不得不降低。

從本週起公眾號改周更了!固定週五早上七點半推送!細水流長不負讀者期望!

時間跨度加長可能會導致內容連續性變弱,影視劇做法是設定上集回顧和下集預告,我借鑑了這個做法,在公眾號文章最後附加了“更文進度“,告知以前更新了什麼,以後會更新什麼。

【上文回顧】

歸檔電子書:

https://dongfanger.gitee.io/blog/

【下文預告】

順序不分先後,只列舉我想到的可能會更新的內容:

  • Python進階系列,二刷流暢的Python函式相關章節
  • teprunner測試平臺,測試計劃增刪改查
  • teprunner測試平臺,前端適配小屏電腦優化改造
  • teprunner測試平臺,定時任務
  • teprunner測試平臺,Dashboard
  • teprunner測試平臺,小工具共享指令碼

相關文章