Python -類型提示 Type Hints

為什么會有類型提示

• Python是一種動態類型語言，這意味着我們在編寫代碼的時候更為自由，運行時不需要指定變量類型
• 但是與此同時 IDE 無法像靜態類型語言那樣分析代碼，及時給我們相應的提示，比如字符串的 split 方法

def split_str(s):
    strs = s.split(",")

由於不知道參數 s 是什么類型，所以當你敲  s.  的時候不會出現 split 的語法提示

 

解決上述問題，類型提示

Python 3.5、3.6 新增了兩個特性 PEP 484 和 PEP 526

• PEP 484：https://www.python.org/dev/peps/pep-0484/
• PEP 526：https://www.python.org/dev/peps/pep-0526/

幫助 IDE 為我們提供更智能的提示

這些新特性不會影響語言本身，只是增加一點提示

 

類型提示分類

主要分兩個

• 變量提示：PEP 526 特性加的
• 函數參數提示：PEP 484 特性加的

 

變量類型提示

沒有使用類型提示

想說明變量的數據類型只能通過注釋

# 'primes' is a list of integers
primes = []  # type: List[int]

# 'captain' is a string (Note: initial value is a problem)
captain = ...  # type: str


class Starship:
    # 'stats' is a class variable
    stats = {}  # type: Dict[str, int]

 

使用了類型提示

from typing import List, ClassVar, Dict

# int 變量，默認值為 0
num: int = 0

# bool 變量，默認值為 True
bool_var: bool = True

# 字典變量，默認為空
dict_var: Dict = {}

# 列表變量，且列表元素為 int
primes: List[int] = []


class Starship:
    # 類變量,字典類型,鍵-字符串,值-整型
    stats: ClassVar[Dict[str, int]] = {}

    # 實例變量，標注了是一個整型
    num: int

這里會用到 typing 模塊，后面會再展開詳解

 

假設變量標注了類型，傳錯了會報錯嗎？

from typing import List

# int 變量，默認值為 0
num: int = 0

# bool 變量，默認值為 True
bool_var: bool = True

# 字典變量，默認為空
dict_var: Dict = {}

# 列表變量，且列表元素為 int
primes: List[int] = []


num = "123"
bool_var = 123
dict_var = []
primes = ["1", "2"]

print(num, bool_var, dict_var, primes)


# 輸出結果
123 123 [] ['1', '2']

它並不會報錯，但是會有 warning，是 IDE 的智能語法提示

所以，這個類型提示更像是一個規范約束，並不是一個語法限制

 

變量類型提示-元組打包

# 正常的元組打包
a = 1, 2, 3

# 加上類型提示的元組打包
t: Tuple[int, ...] = (1, 2, 3)
print(t)

t = 1, 2, 3
print(t)

# py3.8+ 才有的寫法
t: Tuple[int, ...] = 1, 2, 3
print(t)

t = 1, 2, 3
print(t)


# 輸出結果
(1, 2, 3)
(1, 2, 3)
(1, 2, 3)
(1, 2, 3)

 

為什么要加 ...

不加的話，元組打包的時候，會有一個 warning 提示

 

變量類型提示-元組解包

# 正常元組解包
message = (1, 2, 3)
a, b, c = message
print(a, b, c)  # 輸出 1 2 3

# 加上類型提示的元組解包
header: str
kind: int
body: Optional[List[str]]

# 不會 warning 的栗子
header, kind, body = ("str", 123, ["1", "2", "3"])

# 會提示 warning 的栗子
header, kind, body = (123, 123, ["1", "2", "3"])

Optional 會在后面講 typing 的時候詳解

 

在類里面使用

class BasicStarship:
    captain: str = 'Picard'               # 實例變量，有默認值
    damage: int                           # 實例變量，沒有默認值
    stats: ClassVar[Dict[str, int]] = {}  # 類變量，有默認值

 

ClassVar

• 是 typing 模塊的一個特殊類
• 它向靜態類型檢查器指示不應在類實例上設置此變量

 

函數參數類型提示

不僅提供了函數參數列表的類型提示，也提供了函數返回的類型提示

栗子一

# 參數 name 類型提示 str，而函數返回值類型提示也是 str
def greeting(name: str) -> str:
    return 'Hello ' + name

 

栗子二

 def greeting(name: str, obj: Dict[str, List[int]]) -> None:
    print(name, obj)