Python 3.x从基础到实战 - typing类型提示

Python Typing模块是Python 3.5版本之后才引入的模块，它提供了一些类型注解的功能，可以帮助开发者更好地进行类型检查和类型提示。在Python中，类型注解并不是强制要求的，但是使用类型注解能够提高代码的可读性和可维护性，特别是在大型项目中。

本教程将介绍Python Typing模块的基础用法和进阶用法，并提供一些用法示例。

基础用法

基本类型注解

Python Typing模块中包含了许多基本类型，包括：

• int
• float
• str
• bool
• list
• tuple
• set
• dict

可以通过在函数参数或返回值前添加类型注解来指定参数或返回值的类型。示例代码如下：

def add(x: int, y: int) -> int:
    return x + y

def concat(s1: str, s2: str) -> str:
    return s1 + s2

在上面的示例中，add函数接受两个整数类型的参数，并返回一个整数类型的值；concat函数接受两个字符串类型的参数，并返回一个字符串类型的值。

Union类型注解

有时候一个参数或返回值可能有多种类型，可以使用Union类型注解来指定。示例代码如下：

from typing import Union

def add(x: Union[int, float], y: Union[int, float]) -> Union[int, float]:
    return x + y

在上面的示例中，add函数接受两个参数，这两个参数可以是整数类型或浮点数类型，返回值也可以是整数类型或浮点数类型。

List、Tuple和Set类型注解

可以使用List、Tuple和Set类型注解来指定一个列表、元组或集合的元素类型。示例代码如下：

from typing import List, Tuple, Set

def process_list(lst: List[int]) -> List[int]:
    return [x * 2 for x in lst]

def process_tuple(tup: Tuple[str, int, float]) -> Tuple[float, str, int]:
    return (tup[2], tup[0], tup[1])

def process_set(s: Set[str]) -> Set[str]:
    return {x.upper() for x in s}

在上面的示例中，process_list函数接受一个整数类型的列表，返回一个整数类型的列表，其中每个元素都乘以2；process_tuple函数接受一个包含字符串、整数和浮点数类型的元组，返回一个包含浮点数、字符串和整数类型的元组，顺序也发生了变化；process_set函数接受一个字符串类型的集合，返回一个字符串类型的集合，其中每个元素都变成了大写字母。

Dict类型注解

可以使用Dict类型注解来指定一个字典的键和值的类型。示例代码如下：

from typing import Dict

def process_dict(d: Dict[str, int]) -> Dict[int, str]:
    return {v: k for k, v in d.items()}

在上面的示例中，process_dict函数接受一个键为字符串类型、值为整数类型的字典，返回一个键为整数类型、值为字符串类型的字典，其中键和值的顺序发生了变化。

可选类型

有时我们需要指定一个类型可以为空值，这可以通过在类型注释中使用Optional来实现：

from typing import Optional

def get_first_item(items: Optional[List[str]]) -> Optional[str]:
    if not items:
        return None
    return items[0]

items = ["apple", "banana", "cherry"]
print(get_first_item(items))  # Output: "apple"

print(get_first_item(None))  # Output: None

在这个例子中，我们使用Optional[List[str]]类型注释来指定函数参数items的类型为一个字符串列表或None。然后，在函数中我们使用Optional[str]来指定返回值类型为一个字符串或None。

Callable类型注解

可以使用Callable类型注解来指定一个函数的参数和返回值类型。示例代码如下：

from typing import Callable

def process_func(f: Callable[[int, int], int], x: int, y: int) -> int:
    return f(x, y)

在上面的示例中，process_func函数接受一个函数类型的参数f，这个函数接受两个整数类型的参数并返回一个整数类型的值，同时还接受两个整数类型的参数x和y，返回值也是一个整数类型的值。函数体内调用了参数f，将x和y作为参数传递给它，并返回它的返回值。

Any类型注解

可以使用Any类型注解来指定一个参数或返回值可以是任意类型。示例代码如下：

from typing import Any

def process_any(x: Any) -> Any:
    return x

在上面的示例中，process_any函数接受一个任意类型的参数x，并返回它本身。

类型别名

类型别名是指将一个类型定义为一个新的名称。这可以使代码更易于理解和维护。例如，我们可以使用类型别名来定义一个名为Person的元组类型：

from typing import Tuple

Person = Tuple[str, int]

def get_person() -> Person:
    return ("Alice", 25)

name, age = get_person()
print(name)  # Output: "Alice"
print(age)  # Output: 25

在这个例子中，我们使用Tuple[str, int]类型注释来定义一个名为Person的元组类型。然后，在函数中我们使用Person来表示元组类型。

TypeVar类型注解

TypeVar类型注解可以用来定义一个泛型类型，表示一个类型参数。示例代码如下：

from typing import TypeVar, List

T = TypeVar('T')

def process_list(lst: List[T], f: Callable[[T], T]) -> List[T]:
    return [f(x) for x in lst]

在上面的示例中，TypeVar('T')定义了一个类型参数T，process_list函数接受一个泛型类型的列表，和一个接受一个泛型类型参数并返回一个泛型类型的函数，返回一个泛型类型的列表，其中每个元素都被传入函数进行处理。

Generic类型注解

Generic类型注解可以用来定义一个泛型类型，表示一个类或函数是泛型的。示例代码如下：

from typing import TypeVar, Generic, List

T = TypeVar('T')

class Stack(Generic[T]):
    def __init__(self):
        self.items: List[T] = []

    def push(self, item: T) -> None:
        self.items.append(item)

    def pop(self) -> T:
        return self.items.pop()

    def is_empty(self) -> bool:
        return len(self.items) == 0

在上面的示例中，TypeVar('T')定义了一个类型参数T，Stack(Generic[T])定义了一个泛型类型Stack，这个类型接受一个类型参数T，表示一个栈，这个栈可以存储任意类型的元素。Stack类有三个方法：push方法接受一个泛型类型参数item，将它压入栈中；pop方法弹出栈中的元素，并返回它；is_empty方法检查栈是否为空。

总结

Python Typing模块提供了一些类型注解的功能，可以帮助开发者更好地进行类型检查和类型提示。在本教程中，我们介绍了Python Typing模块的基础用法和进阶用法，并提供一些用法示例。使用Python Typing模块可以提高代码的可读性和可维护性，特别是在大型项目中。