Python中typing模块的基础知识

typing是Python的一个模块，用于在静态类型检查时对代码进行类型提示。它提供了一套注释约定，以帮助开发者在编写代码时清楚地指定变量、函数和方法的类型。这个模块最初是由Guido van Rossum在PEP 484中引入的，并在Python 3.5中成为了标准库的一部分。

typing模块是一个强大且灵活的工具，可以提高代码可读性和可维护性。它允许开发者在代码中明确指定函数的参数和返回值的类型，并允许使用者通过类型提示来检查自己的代码是否符合预期。

下面是一些typing模块的基础知识和使用示例。

1. 基本类型注释

typing模块提供了用于注释各种基本类型的类和函数。例如：

- int：表示整数类型

- float：表示浮点数类型

- str：表示字符串类型

- bool：表示布尔类型

- list：表示列表类型

- tuple：表示元组类型

- dict：表示字典类型

- set：表示集合类型

以下示例演示了如何使用typing模块中的这些类型注释：

from typing import List, Tuple

def add(a: int, b: int) -> int:
    return a + b

def multiply(a: float, b: float) -> float:
    return a * b

def concatenate(a: str, b: str) -> str:
    return a + b

def square_root(numbers: List[float]) -> List[float]:
    return [n ** 0.5 for n in numbers]

def get_name_and_age() -> Tuple[str, int]:
    name = input("What is your name? ")
    age = input("How old are you? ")
    return name, int(age)

在上述示例中，我们定义了几个函数，并使用typing模块对这些函数的参数和返回值进行了注释。这些注释可以提供开发者和使用者更加清晰的代码接口和预期结果。

2. 自定义类型注释

除了基本类型，我们还可以使用typing模块创建自己的自定义类型注释。这在需要表达复杂数据结构或重用类型注释时非常有用。我们可以使用typing模块中的类和函数来创建自定义类型注释。

from typing import List, Tuple

Coordinates = Tuple[float, float]
City = Tuple[str, Coordinates]
Population = List[City]

def get_population() -> Population:
    # 获取人口数据
    # 返回的数据格式为List[Tuple[str, Tuple[float, float]]]
    pass

def print_city_names(population: Population) -> None:
    for city in population:
        print(city[0])

在上述示例中，我们创建了三个自定义类型注释：Coordinates、City和Population。Coordinates是一个包含两个浮点数的元组，City是一个包含城市名称和坐标的元组，Population是一个包含多个City的列表。

3. 泛型类型注释

当我们需要处理泛型数据类型时，可以使用typing模块中的泛型类型来注释这些数据。泛型类型是一种可以在类型注释中指定参数类型的类型。在Python中的泛型类型通常用方括号表示。

以下示例演示如何使用泛型类型注释：

from typing import List, Tuple, TypeVar

T = TypeVar('T')

def reverse(items: List[T]) -> List[T]:
    return items[::-1]

def merge_lists(items1: List[T], items2: List[T]) -> List[T]:
    return items1 + items2

在上述示例中，T是一个泛型类型变量。我们可以在函数参数和返回值的注释中使用这个变量，表示这些参数和返回值是一个泛型列表类型。这样，在调用这些函数时，我们可以传递不同类型的列表，而不需要在函数定义时指定具体的列表类型。

4. Union和Optional类型注释

有时，一个变量可以有多个不同的类型，或者可能是None。对于这种情况，我们可以使用typing模块中的Union和Optional类型来指定变量的可能类型。

以下示例演示了如何使用Union和Optional类型注释：

from typing import Union, Optional

def square_root(num: Union[int, float]) -> float:
    return num ** 0.5

def get_name(replace_none: Optional[str] = None) -> str:
    name = input("What is your name? ")
    if replace_none is not None:
        return replace_none
    return name

在上述示例中，square_root函数的num参数可以是int或float类型，get_name函数的replace_none参数可以是一个可选的字符串类型，允许传递字符串或None。

总结：

typing模块为Python的静态类型检查提供了一套注释约定。它提供了一系列的类和函数，用于注释各种基本类型、自定义类型、泛型类型、联合类型和可选类型。通过使用这些注释，可以提高代码的可读性和可维护性，并帮助开发者更好地理解代码的接口和预期行为。