Python中typing模塊的具體使用

Posted on by

typing庫

一、 簡介

Python是一門弱類型的語言，很多時候我們可能不清楚函數參數類型或者返回值類型，很有可能導致一些類型沒有指定方法，在寫完代碼一段時間後回過頭看代碼，很可能忘記瞭自己寫的函數需要傳什麼參數，返回什麼類型的結果，就不得不去閱讀代碼的具體內容，降低瞭閱讀的速度，typing模塊可以很好的解決這個問題

Python 運行時並不強制標註函數和變量類型。類型標註可被用於第三方工具，比如類型檢查器、集成開發環境、靜態檢查器等

typing的主要作用有：

  • 類型檢查，防止運行時出現參數、返回值類型不符
  • 作為開發文檔附加說明，方便使用者調用時傳入和返回參數類型
  • 模塊加入不會影響程序的運行不會報正式的錯誤，pycharm支持typing檢查錯誤時會出現黃色警告

官方文檔：【https://docs.python.org/zh-cn/3/library/typing.html】

語法：

def 函數名(參數: 數據類型) -> 返回值類型:
    pass

變量名: 數據類型 = 值

二、 別名

1、 類型別名

要定義一個類型別名，可以將一個類型賦給別名。類型別名可用於簡化復雜類型簽名，同時類型別名適用於簡化復雜的類型簽名

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import Sequence

ConnectionOptions = dict[str, int]  # 表示字典中的鍵為字符串類型，值為整型
Address = tuple[str, int, ...]  # 表示元組的第一個數據為字符串，第二個數據為整型，裡面隻能存儲兩個數據，有省略號表示裡面可以添加n個整型數據
Server = tuple[Address, ConnectionOptions]


def broadcast_message(message: str,
                      servers: Sequence[Server]  # 表示一個序列對象裡面存儲瞭[tuple[tuple[str, int], dict[str, int]]]
                      ) -> None:  # 返回值為空
    ...

broadcast_message("a", [(("a", 1, 2), {"a": 1})])

2、 NewType

使用NewType輔助函數創建不同的類型，靜態類型檢查器會將新類型視為它是原始數據的子類，相當於C++裡面的`typedef

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import NewType

UserId = NewType('UserId', int)  # 其不會創建一個新的類或引入其他內存，隻是做一個約束作用


def name_by_id(user_id: UserId) -> str:
    ...


name_by_id(42)  # Fails type check
name_by_id(UserId(42))  # OK

num = UserId(5) + 1  # type: int，可以進行對應數據類型的操作

同時，可以嵌套創建，即可以基於NewType創建NewType

3、 可調用對象

Callable[[Arg1Type, Arg2Type], ReturnType]

如，實現一個互斥鎖的裝飾器

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from collections.abc import Callable  # 註意要使用Concatenate和ParamSpec就必須使用這個模塊裡面的Callable
from threading import Lock
from typing import TypeVar
from pip._vendor.typing_extensions import Concatenate, ParamSpec  # 導入typing的擴展

P = ParamSpec('P')  # 裡面有args和kwargs參數
R = TypeVar('R')  # 自定義數據類型

my_lock = Lock()  # 創建一個互斥鎖


def with_lock(f: Callable[Concatenate[Lock, P], R]) -> Callable[P, R]:
    '''一個提供互斥鎖，使得線程安全的裝飾器'''
    def inner(*args: P.args, **kwargs: P.kwargs) -> R:
        return f(my_lock, *args, **kwargs)
    return inner


@with_lock
def sum_threadsafe(lock: Lock, numbers: list[float]) -> float:
    '''Add a list of numbers together in a thread-safe manner.'''
    with lock:
        return sum(numbers)


# We don't need to pass in the lock ourselves thanks to the decorator.
print(sum_threadsafe([1.1, 2.2, 3.3]))

無需指定調用簽名，用省略號字面量替換類型提示裡的參數列表： Callable[…, ReturnType]，就可以聲明可調對象的返回類型

與 Callable 和 ParamSpec 一起使用，對一個高階可調用對象進行類型註釋，該對象可以增加、刪除或轉換另一個可調用對象的參數。 使用形式為Concatenate[Arg1Type, Arg2Type, …, ParamSpecVariable]。 Concatenate 目前隻在作為 Callable 的第一個參數時有效。Concatenate 的最後一個參數必須是一個 ParamSpec

三、 泛型支持

typing模快最基本的支持有Any ，Tuple，Callable，TypeVar 和 Generic類型組成

1、集合類型

from typing import (
    List,  # list的泛型版本。用於註釋返回類型。要註釋參數，最好使用抽象集合類型，如Sequence或Iterable
    Set,  # set的泛型版本
    Dict  # dict 的泛型版本。對標註返回類型比較有用。如果要標註參數的話，使用如 Mapping 的抽象容器類型是更好的選擇
    )

2、 抽象基類

from typing import (
    Mapping,  # 要註釋函數參數中的Key-Value類型時，推薦使用的抽象集合類型
    Sequence,  # 要註釋函數參數中的序列例如列表類型時，推薦使用的抽象集合類型
    Iterable  # 要註釋函數參數中的迭代類型時，推薦使用的抽象集合類型
    )

3、 泛型

TypeVar：其就像C++裡面的template一樣

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import (
    Sequence,
    TypeVar  # 限制多個變量為同一個數據類型
)

T = TypeVar('T')  # Can be anything 
A = TypeVar('A', str, bytes)  # Must be str or bytes 

def repeat(x: T, n: int) -> Sequence[T]:
    """Return a list containing n references to x."""
    return [x] * n

def longest(x: A, y: A) -> A:
    """Return the longest of two strings."""
    return x if len(x) >= len(y) else y

AnyStr

AnyStr是一個字符串和字節類型的特殊類型變量AnyStr = TypeVar('AnyStr', str, bytes)，它用於可以接受任何類型的字符串而不允許不同類型的字符串混合的函數

4、 Any

特殊類型，表明類型沒有任何限制

  • 每一個類型都對 Any 兼容
  • Any 對每一個類型都兼容

Any 是一種特殊的類型。靜態類型檢查器將所有類型視為與Any兼容，反之亦然， Any也與所有類型相兼容。

這意味著可對類型為 Any 的值執行任何操作或者方法調用並將其賦值給任意變量

如下所示，將 Any 類型的值賦值給另一個更具體的類型時，Python不會執行類型檢查。例如，當把 a 賦值給 s 時，即使 s 被聲明為 str類型，在運行時接收到的是 int 值，靜態類型檢查器也不會報錯

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import (
    Any,
    NoReturn,  # 表示函數沒有返回值
)

def test(s: Any) -> NoReturn:
    s.item()  # 不會檢測s裡面是否有item()屬性

def test_(s: object) -> NoReturn:
    s.item()  # 會檢測s裡面是否有item屬性

當參數無類型是，默認為Any類型

5、 特殊形式

5.1 Type

一個註解為 C 的變量可以接受一個類型為 C 的值。相對地，一個註解為 Type[C] 的變量可以接受本身為類的值 。 更精確地說它接受 C的 類對象

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import (
    Type,
)


class User:
    ...


class BasicUser(User):
    ...

# Accepts User, BasicUser, ...

def make_new_user(user_class: Type[User]) -> User:
    return user_class()


print(make_new_user(User))

5.2 Union

聯合類型；Union[X, Y]意味著：要麼是 X，要麼就是 Y。定義一個聯合類型，需要註意的有：

  • 參數必須是類型，而且必須至少有一個參數。
  • 能繼承或者實例化一個聯合類型。
  • Union[X, Y]不能寫成 Union[X][Y] 。
  • 可以使用 Optional[X] 作為Union[X, None]的縮寫- 聯合類型的聯合類型會被展開打平
  • 僅有一個參數的聯合類型會坍縮成參數自身，比如:
Union[int] == int  # The constructor actually returns int

多餘的參數會被跳過，比如:

Union[int, str, int] == Union[int, str]

在比較聯合類型的時候，參數順序會被忽略，比如:

Union[int, str] == Union[str, int]

5.3 Optional

可選類型，Optional[X] 等價於Union[X, None]

5.4 Tuple

元組類型,Tuple[X, Y] 標註瞭一個二元組類型，其第一個元素的類型為 X 且第二個元素的類型為Y。空元組的類型可寫作 Tuple[()]

為表達一個同類型元素的變長元組，使用省略號字面量，如Tuple[int, …]。單獨的一個 Tuple 等價於 Tuple[Any, …]，進而等價於tuple

示例: Tuple[int, float, str]表示一個由整數、浮點數和字符串組成的三元組

5.5 Callable

可調用類型；Callable[[int], str]是一個函數，接受一個 int 參數，返回一個str。下標值的語法必須恰為兩個值：參數列表和返回類型。參數列表必須是一個類型和省略號組成的列表；返回值必須是單一一個類型

不存在語法來表示可選的或關鍵詞參數，這類函數類型罕見用於回調函數。Callable[…, ReturnType]（使用字面省略號）能被用於提示一個可調用對象，接受任意數量的參數並且返回 ReturnType。單獨的 Callable 等價於Callable[…, Any]，並且進而等價於 collections.abc.Callable

更多語法，請到官方查看！！！

到此這篇關於Python中typing模塊的具體使用的文章就介紹到這瞭,更多相關Python typing模塊內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：