使用Python Typing模塊提升代碼可讀性和健壯性實(shí)例探索

更新時(shí)間：2024年01月22日 11:32:51 作者：半個(gè)碼農(nóng)

這篇文章主要為大家介紹了使用Python Typing模塊提升代碼可讀性和健壯性實(shí)例探索,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪

前言

Python的typing模塊提供了用于類型注解的功能。通過使用typing模塊，你可以在代碼中添加類型注釋，以提高代碼的可讀性和可維護(hù)性，并且可以使用類型檢查來驗(yàn)證代碼中的類型是否符合預(yù)期。

一.基本用法

1.基本類型提示

from typing import List, Tuple, Dict, Set
def add(a: int, b: int) -> int: # 定義輸入的變量為int 類型，返回值也是int
    return a + b
def get_name_age() -> Tuple[str, int]:# 定義返回類型為元組并且，第一個(gè)元素str,第二個(gè)是int
    return "王五", 18
def get_students() -> List[str]:# 定義返回類型為list，所有元素為str
    return ["小黑", "小華", "小米"]
def get_scores() -> Dict[str, int]:# 定義返回為字典，key是str，value是int
    return {"python": 100, "java": 80, "go": 80}
def get_unique_numbers() -> Set[int]:# 定義返回是集合，并且里面的元素為int
    return {1, 2, 3, 4, 5,6}

2.泛型類型提示

from typing import TypeVar, Generic
T = TypeVar("T")
class Stack(Generic[T]):
    def push(self, item: T) -> None:
        pass
    def pop(self) -> T:
        pass
    def is_empty(self) -> bool:
        pass

3.類方法、靜態(tài)方法和實(shí)例方法的類型提示

from typing import ClassVar, Optional
class MyClass:
    my_var: ClassVar[int] = 0
    def __init__(self, value: int) -> None:
        self.value = value
    def instance_method(self, x: int) -> int:
        return self.value * x
    @classmethod
    def class_method(cls, y: int) -> int:
        return cls.my_var + y
    @staticmethod
    def static_method(z: int) -> int:
        return z * 2

4.Union類型提示

from typing import Union

def func(x: Union[int, float]) -> None:
    pass

5.Any類型提示

from typing import Any
def func(x: Any) -> None:
    pass

6.Callable類型提示

from typing import Callable
def func(x: Callable[[int], int]) -> None:
    pass

7.定義變量類型

from typing import Optional  
name: str = "張三"  
age: int = 18  
address: Optional[str] = None # 字符類型，或者None

二.使用場(chǎng)景

類型檢查：typing模塊可以用于進(jìn)行類型檢查，防止運(yùn)行時(shí)出現(xiàn)參數(shù)和返回值類型不符合的情況。這對(duì)于提高代碼的健壯性和可維護(hù)性非常有幫助。
文檔附加說明：通過使用typing模塊中的類型注解，可以在代碼中為變量、函數(shù)參數(shù)和返回值添加類型信息，方便使用者了解函數(shù)的期望輸入和輸出。這可以提高代碼的可讀性和可維護(hù)性。
IDE提示：一些集成開發(fā)環(huán)境（IDE）可以利用typing模塊中的類型注解提供更精準(zhǔn)的代碼提示，從而提高開發(fā)效率。
類型轉(zhuǎn)換：雖然typing模塊主要用于類型注解和檢查，但也可以用于類型轉(zhuǎn)換。例如，可以使用cast()函數(shù)將一個(gè)對(duì)象強(qiáng)制轉(zhuǎn)換為指定的類型。
自定義類型注解：typing模塊還支持自定義類型注解，可以用來定義自己的數(shù)據(jù)類型或泛型。這對(duì)于創(chuàng)建可重用的組件和庫非常有用。
與其他類型的比較：在比較兩個(gè)不同類型的數(shù)據(jù)時(shí)，可以使用issubclass()和isinstance()函數(shù)來判斷一個(gè)類是否是另一個(gè)類的子類或一個(gè)對(duì)象是否是某個(gè)類的實(shí)例。

三.注意事項(xiàng)

向后兼容性：雖然typing模塊已經(jīng)正式加入到了標(biāo)準(zhǔn)庫中，但是如果核心開發(fā)者認(rèn)為有必要的話，API也可能會(huì)發(fā)生改變，即不保證向后兼容性。
類型別名：可以通過給類型賦予別名來簡(jiǎn)化類型注釋，例如使用Vector = List[float]來創(chuàng)建一個(gè)類型別名。需要注意的是，簡(jiǎn)單的類型注解如默認(rèn)的int、str等除外。
泛型：可以使用泛型類來定義可以接受不同類型參數(shù)的類。需要注意的是，泛型類不能直接實(shí)例化，需要使用繼承泛型類的方式創(chuàng)建具體類。
類型變量：可以使用TypeVar來定義類型變量，用于約束泛型類型參數(shù)的類型。需要注意的是，TypeVar不是一個(gè)類，使用isinstance(x, T)會(huì)在運(yùn)行時(shí)拋出TypeError異常。
使用場(chǎng)景：雖然typing模塊提供了一些強(qiáng)大的類型注解和檢查功能，但這些功能并不會(huì)在運(yùn)行時(shí)強(qiáng)制執(zhí)行類型檢查。因此，在某些情況下，即使代碼中添加了類型注解，也可能仍然會(huì)出現(xiàn)類型錯(cuò)誤。
IDE支持：雖然許多IDE支持typing模塊中的類型注解和檢查功能，但不同IDE的支持程度可能會(huì)有所不同。因此，在使用IDE進(jìn)行代碼開發(fā)和調(diào)試時(shí)，需要注意IDE對(duì)typing模塊的支持情況