哈嘍大家好，我是咸魚

我們知道 Python 是一門具有動(dòng)態(tài)特性的語(yǔ)言，在編寫 Python 代碼的時(shí)候不需要顯式地指定變量的類型

這樣做雖然方便，但是降低了代碼的可閱讀性，在后期 review 代碼的時(shí)候容易對(duì)變量的類型產(chǎn)生混淆，需要查閱大量上下文，導(dǎo)致后期維護(hù)困難

為了提高代碼的可讀性、可維護(hù)性，Python 在 PEP 484 中引入了類型提示（ type hinting）。類型提示是 Python 中一個(gè)可選但非常有用的功能，可以使代碼更易于閱讀和調(diào)試

關(guān)于類型提示的介紹可以看：

https://realpython.com/python-type-hints-multiple-types/#use-pythons-type-hints-for-one-piece-of-data-of-alternative-types

在編寫函數(shù)的時(shí)候，我們通常指定其返回值是一種數(shù)據(jù)類型，但是在下面這些情況下可以指定返回不同類型的數(shù)據(jù)：

• 當(dāng)函數(shù)使用條件語(yǔ)句返回不同類型結(jié)果時(shí)
• 函數(shù)有時(shí)返回值，有時(shí)不返回值
• 當(dāng)函數(shù)遇到錯(cuò)誤時(shí)，可能需要返回與正常結(jié)果的返回類型不同的特定錯(cuò)誤對(duì)象
• 想要設(shè)計(jì)更靈活更通用的代碼

那么這時(shí)候該如何編寫類型提示呢？

為常規(guī)函數(shù)編寫類型提示

def parse_email(email_address: str) -> str | None:
    if "@" in email_address:
        username, domain = email_address.split("@")
        return username
    return None

上面的函數(shù)中有一個(gè)條件判斷語(yǔ)句，用于檢查參數(shù) email_address 電子郵箱地址里面是否包含 @ 符號(hào)。如果有，則返回用戶名 username ，沒(méi)有則返回 None，表示電子郵箱地址不完整

所以該函數(shù)的返回值要么是包含用戶名的字符串，要么是 None。那么我們可以用管道符（|） 來(lái)表示函數(shù)返回單個(gè)值的可選類型

# 要么返回 str ，要么返回 None
str | None:

在 Python 3.10 之前，我們還可以使用 typing 模塊中的 Union 來(lái)表示函數(shù)返回的是str 還是 None

from typing import Union

def parse_email(email_address: str) -> Union[str, None]:
    if "@" in email_address:
        username, domain = email_address.split("@")
        return username
    return None

那如果單個(gè)返回值里面包含多個(gè)對(duì)象的話，該如何編寫類型提示呢？

比如說(shuō)上面的函數(shù)，我希望它：

• 如果是有效的郵箱，則返回用戶名和域名
• 如果不是有效的郵箱，返回 None

PS： 當(dāng)返回值里有多個(gè)對(duì)象時(shí)，默認(rèn)是以元組的形式返回

所以我們可以這么寫類型提示

def parse_email(email_address: str) -> tuple[str, str] | None:
    if "@" in email_address:
        username, domain = email_address.split("@")
        return username, domain
    return None

tuple[str, str]| None ，表示返回值可以是兩個(gè)字符串的元組或None

如果使用 typing 模塊中的 Union來(lái)編寫類型提示的話，如下

from typing import Tuple, Union

def parse_email(email_address: str) -> Union[Tuple[str, str], None]:
    if "@" in email_address:
        username, domain = email_address.split("@")
        return username, domain
    return None

舉三反一一下，如果單個(gè)返回值包含三個(gè)對(duì)象，可以這么寫

# 函數(shù)返回值里面包含了字符串、整數(shù)、布爾值
def get_user_info(user: User) -> tuple[str, int, bool]:
    ...

為回調(diào)函數(shù)編寫類型提示

在 Python 中，函數(shù)可以作為另一個(gè)函數(shù)的參數(shù)或者返回其他函數(shù)。這種函數(shù)被稱為高階函數(shù)

比如說(shuō) Python內(nèi)置函數(shù)（例如sorted()、map()和filter()）可以接受一個(gè)函數(shù)作為參數(shù)

這個(gè)作為參數(shù)傳遞的函數(shù)通常被稱為回調(diào)函數(shù)（callback function），因?yàn)樗诹硪粋€(gè)函數(shù)中被調(diào)用（"回調(diào)"），回調(diào)函數(shù)是一種可調(diào)用對(duì)象（callable objects）

可調(diào)用對(duì)象指的是可以像函數(shù)一樣調(diào)用的對(duì)象。Python 中可調(diào)用對(duì)象包括常規(guī)函數(shù)、lambda 表達(dá)式或?qū)崿F(xiàn)了__call__()方法的類）

那么我們?cè)谡{(diào)用回調(diào)函數(shù)的時(shí)候，該如何編寫類型注釋呢？

比如說(shuō)下面的例子

>>> from collections.abc import Callable

>>> def apply_func(
...     func: Callable[[str], tuple[str, str]], value: str
... ) -> tuple[str, str]:
...     return func(value)
...
>>> def parse_email(email_address: str) -> tuple[str, str]:
...     if "@" in email_address:
...         username, domain = email_address.split("@")
...         return username, domain
...     return "", ""
...
>>> apply_func(parse_email, "claudia@realpython.com")
('claudia', 'realpython.com')

在函數(shù) apply_func 的類型提示中，將回調(diào)函數(shù) func作為第一個(gè)參數(shù)，將字符串 value 作為第二個(gè)參數(shù)，返回值是一個(gè)包含兩個(gè) str 的 tuple

而 Callable[[str], tuple[str, str]]：表示回調(diào)函數(shù) func 接收參數(shù)是一個(gè) str，返回值是一個(gè)包含兩個(gè) str 的 tuple

在函數(shù) parse_email 的類型提示中，接受一個(gè) str 類型的參數(shù) email_address ，返回值類型是一個(gè)包含兩個(gè) str 的 tuple

那如果我希望函數(shù) apply_func 能夠接收具有多種輸入類型的不同函數(shù)作為參數(shù)（比如說(shuō)回調(diào)函數(shù)有多個(gè)輸入?yún)?shù)）并有多種返回類型，該怎么辦?

我們可以用省略號(hào)... 來(lái)表示可調(diào)用對(duì)象（例如回調(diào)函數(shù)）可以接受多個(gè)參數(shù)，這樣就不需要依次列出接受參數(shù)的類型

def apply_func( 
	func: Callable[...,tuple[str, str]], value: str) -> tuple[str, str]：
	return func(value)

或者使用 typing 模塊中的類型來(lái)指定任何返回 Any 類型

from collections.abc import Callable
from typing import Any

def apply_func( 
	func: Callable[...,Any], *args: Any, **kwargs: Any) -> tuple[str, str]：
	 return func(*args, **kwargs)

我們還可以在類型提示中把回調(diào)函數(shù)的返回值類型寫成 T ，這是一個(gè)類型變量type variable,可以代表任何類型

from collections.abc import Callable
from typing import Any, TypeVar

T = TypeVar("T")

def apply_func(func: Callable[..., T], *args: Any, **kwargs: Any) -> T:
    return func(*args, **kwargs)

而 apply_func 的返回值類型也是 T，*args: Any, **kwargs: Any 表示 apply_func 可以接受任意數(shù)量的參數(shù)（包括 0）

為生成器編寫類型提示

在 Python 中，生成器（Generators）是一種特殊的迭代器，它們?cè)试S按需生成值，而無(wú)需提前生成所有值并將其存儲(chǔ)在內(nèi)存中

生成器逐個(gè)產(chǎn)生并返回值，這對(duì)于處理大量數(shù)據(jù)或無(wú)限序列非常有用

生成器可以通過(guò)函數(shù)與 yield 語(yǔ)句創(chuàng)建。yield 語(yǔ)句在生成器函數(shù)內(nèi)部被用來(lái)產(chǎn)生一個(gè)值，并在暫停生成器的同時(shí)返回該值給調(diào)用者

每次調(diào)用生成器的 next()方法或使用 for循環(huán)時(shí)，生成器函數(shù)會(huì)從上一次yield語(yǔ)句的位置恢復(fù)執(zhí)行，并繼續(xù)執(zhí)行到下一個(gè)yield語(yǔ)句或函數(shù)結(jié)束

繼續(xù)上面的例子，我現(xiàn)在有大量的郵箱需要判斷是否有效，與其將每個(gè)解析的結(jié)果存儲(chǔ)在內(nèi)存中并讓函數(shù)一次返回所有內(nèi)容，不如使用生成器一次生成一個(gè)解析結(jié)果

>>> from collections.abc import Generator

>>> def parse_email() -> Generator[tuple[str, str], str, str]:
		# 定義初始的 sent 值為元組 ("", "")
...     sent = yield ("", "")
...     while sent != "":
...         if "@" in sent:
...             username, domain = sent.split("@")
...             sent = yield username, domain
...         else:
...             sent = yield "invalid email"
...     return "Done"

Generator[tuple[str, str], str, str]類型提示里面有三個(gè)參數(shù)（后面兩個(gè)是可選的），其中：

• yield 類型：第一個(gè)參數(shù)是生成器生成的結(jié)果。例子中它是一個(gè)元組，包含兩個(gè)字符串，一個(gè)表示用戶名，另一個(gè)表示域名
• send 類型：第二個(gè)參數(shù)表示使用 send 方法發(fā)送給生成器的內(nèi)容。例子中是一個(gè)字符串，表示發(fā)送的郵箱地址
• return 類型：第三個(gè)參數(shù)表示生成器生成值后返回的內(nèi)容。例子中函數(shù)返回字符串“Done”

然后調(diào)用該生成器

>>> generator = parse_email()
>>> next(generator)
('', '')
#使用 send 方法向生成器發(fā)送參數(shù)
>>> generator.send("claudia@realpython.com")
('claudia', 'realpython.com')
>>> generator.send("realpython")
'invalid email'
>>> try:
...     generator.send("")
... except StopIteration as ex:
...     print(ex.value)
...
Done

首先調(diào)用生成器函數(shù)，該函數(shù)將返回一個(gè)新的 parse_email() 生成器對(duì)象。然后，通過(guò)調(diào)用內(nèi)置 next() 函數(shù)將生成器推進(jìn)到第一個(gè) yield 語(yǔ)句

之后開始向生成器發(fā)送電子郵件地址進(jìn)行解析。當(dāng)發(fā)送空字符串或不帶 @ 符號(hào)的字符串時(shí)，生成器將終止

又因?yàn)樯善饕彩堑鳎虼艘部梢允褂?collections.abc.Iterator 而不是 Generator 來(lái)進(jìn)行類型提示

但是如果使用了 collections.abc.Iterator 類型提示，就不能指定 send 類型和 rerurn 類型，因此只有當(dāng)生成器只生成值時(shí) collections.abc.Iterator 才起作用

from collections.abc import Iterator

def parse_emails(emails: list[str]) -> Iterator[tuple[str, str]]:
    for email in emails:
        if "@" in email:
            username, domain = email.split("@")
            yield username, domain

我們還可以在接收參數(shù)里面使用 Iterable 類型提示，這樣表示函數(shù) parse_emails 可以接受任何可迭代對(duì)象，而不僅僅是像以前那樣的列表

from collections.abc import Iterable

def parse_emails(emails: Iterable[str]) -> Iterable[tuple[str, str]]:
    for email in emails:
        if "@" in email:
            username, domain = email.split("@")
            yield username, domain

總結(jié)

以上是生活随笔為你收集整理的Python 中如何编写类型提示的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。