python函数注释翻译_对同事好一些 - Python 函数参数注解（Type Annotations）

函数参数注释不会影响程序运行时间，它们不会被类型检查，这些注释会在运行的时候被忽略掉。

它存在的主要目的是用于增加程序的可读性，让你或者其他程序员更好地使用它。

第三方工具和IDE框架可能会对这些注解添加语义。同时它们也会出现在文档中。

如何来使用函数参数注释：

def mysteryCobine(a: str, b: str, times: int) -> str:

return (a+b)*times

print(mysteryCobine('Hello ', 'World!', 4))

如上面程序所示，

: str,: str, and: int 是用于告知正确的函数的参数类型应该是什么形式

-> str 用于告诉程序员，这个function会返回一个str的值

这样就可以避免其它程序设计者对这个函数的错误理解。

并且在IDE中引用时，会出现类型提示。

复杂类型的函数参数注解

Python 內建的型別(例如： int, float, dict, list, …)可以直接使用型別註釋，但如果是較複雜的資料型別就需要 typing 模組的輔助。

typing是 Python 3.5 以上內建的模組。

該模組並非用來規定 Python 程式必須使用什麼型別，而是透過型別註釋(type annotations)讓開發者或協作者可以更加了解某個變數的型別，也讓第三方的工具能夠實作型別檢查器(type checker)。

例如當我們想表達都是 int 的列表(list)，並無法直接這樣表達：

def test(x: list[int]):

pass

上述會導致以下錯誤：

TypeError: 'type' object is not subscriptable

正确的方式是使用typing 模組的 List 進行表達：

from typing import List

def test(x: List[int]):

pass

如此一來就能夠正確執行囉！

利用typing.Union讓一個函式或方法能夠接受多種型別

from typing import Union

def print_grade(grade: Union[int, str]):

if isinstance(grade, str):

print(grade + ' percent')

else:

print(str(grade) + '%')

from typing import Union

def print_something(x: Union[int, str]):

if isinstance(x, (int,str)):

print(f'Got {x}')

else:

raise TypeError('Only int & str are accepted')

print_something(1)

参考：

官方文件：