python 編碼中為什麼要寫類型註解？

Posted on by

1、背景

我們先談談為什麼在Python編碼過程中強烈推薦使用類型註解 ？

Python對於初學者來說是非常好上手，原因是在於對計算機底層原理的高度封裝和動態語言的特性使得Python用起來非常的舒適。但這種“舒適”是有代價的，我們可能聽說過一句形容動態語言的話，動態一時爽，一直動態一直爽。為什麼會這麼說？動態的確會賦予我們在編碼時更多的靈活性與能力，但是動態帶來的是更多的不確定性及混亂，導致瞭後來的維護者甚至作者自己都會產生很大的維護壓力（可以想象一個經過幾年迭代的復雜系統，如果大部分都使用動態的方式來編寫代碼的樣子），正所謂能力越大責任越大，需要進行克制；

而類型註解能很好的幫我們在維護與開發時，理清變量類型降低不確定性和混亂度，並且從容的使用變量。在這裡廢話瞭這麼多，主要是為瞭能讓讀者能深刻意識到動態帶來的正反方向帶來的“爽”。後面進入正題；

2、使用方式

2.1、 Python3內置的類型註解

內置註解肯能大傢都接觸過，但總感覺很麻煩，導致後面很容易就放棄寫註解，這是因為得到不正反饋，看如下示例：

a: str = "aa"
b: int = 1

# 參數和返回標註瞭類型，那麼接下來調用時就能進行提示
def example(a: str) -> str:
 return f"Hello {a}"

pirnt(example("world"))

# # 一些簡單的標註，看起來起不到效果，但如果換個有含義的名字呢
User = str
Age = int
Answer = str

def say_hello(u: User) -> Answer:
 return f"Hello {u}"

print(say_hello("Shadow"))

上面簡單演示瞭內置的類型註解是如何使用的，但是其實這麼簡單的類型註解並不能幫助我們很好的標註變量；下面介紹一個typing模塊

2.2、typing 模塊的快速入門

typing 模塊是類型註解的主角，Python運行時不強制執行函數和變量類型註解，但這些註解可用於類型檢查器、IDE、靜態檢查器等第三方工具。這些第三方工具會在我們編碼時進行提示與糾錯；

下面提供一些日常使用到的方法與用例給大傢參考：

import typing

# 自定義類型註解
User = str
Age = int

# 定義有多種類型註解的類型
AnyStr = typing.TypeVar('AnyStr', str, bytes)
a_str: AnyStr = "a"
a_bytes: AnyStr = b"a"



# 通用類型, 接收通用的類型，盡量少的去使用
def example_1(a: typing.Any):
  print(a)


"""
typing 模塊是允許使用下標來輔助標記類型
"""

# 列表, 下標為列表的屬性
def example_2(a_list: typing.List[User]) -> typing.List[str]:
  pass


# 字典，下標第一個為key，第二個為value
def example_3(a_dict: typing.Dict[User, Age]) -> typing.Dict[str, int]:
  pass


# 元祖，下標為元祖的屬性
def example_4(a_tuple: typing.Tuple[User] = None) -> typing.Tuple[User]:
  pass


# Union, 在一些場景下我們某些參數或返回值是不確定，至少給定一個參數類型
def example_5(a_b: typing.Union[str, int]) -> typing.Union[str, int]:
  pass


# Optional, 與Union 有點類似，但默認多帶一個None，至少給定一個參數類型
# 如：Optional[str] 等價於 Union[str, None]
def example_6(a: str) -> typing.Optional[str]:
  pass


# Tuple, 返回值有多個的時候, 如需要返回str, int, bool, float
def example_7() -> typing.Tuple[str, int, bool, float]:
  pass


# class, 類本身也是一種類型
class Action:

  up: str = "up"
  down: str = "down"

# 指定需求一個action對象的參數
def example_8(action_obj: Action) -> Action:
  pass


# 這樣在一些枚舉參數的場景下，我們也可以使用類作為我們枚舉參數的歸類
def example_9(action_cls: Action) -> Action:
  pass

# 如果上面的枚舉參數你覺得並不能很好的實現，那麼還是可以使用自定義類型註解的方式去實現
Action = str
up: Action = "up"
down: Action = "down"

# 在python3.9 中對枚舉參數類型有更好的支持
MODE = type.Literal['r', 'rb', 'w', 'wb']
def open_file(file: str, mode: MODE) -> str:
  pass

open_file('/some/path', 'r') # 正常
open_file('/other/path', 'typo') # 會提示該類型不合法


# Type, 在一些多態類的場景下標註同一個類型的不同的形態
class User: ...

class BasicUser(User): ...

class ProUser(User): ...

class TeamUser(User): ...

# 相當於 typing.Union[User, BasicUser, ProUser, TeamUser]
def make_new_user(user_class: typing.Type[User]) -> User:
  return user_class()

以上十幾個用例場景基本能覆蓋大部分日常編碼，如果還有一些別的需求可參考官方的文檔，上面有明確的說明;

Docs: docs.python.org/zh-cn/3/lib…

3、寫在最後

希望文章能對大傢對類型註解的瞭解與使用有所幫助，早日脫離被動態繞得心裡“罵娘”與找不到”娘”的日子。

以上就是python 編碼中為什麼要寫類型註解？的詳細內容，更多關於python 類型註解的資料請關註WalkonNet其它相關文章！

推薦閱讀：