首页 > 编程语言 > Python3 类型标注支持操作
2021
08-06

Python3 类型标注支持操作

typing为Python的一个标注库，此默认支持PEP 484和PEP 526指定的类型提示。最基本的支持由Any、Union、Tuple、Callable、TypeVar和Generic类型组成。

有关完整的规范，请参阅PEP 484，有关任何类型提示的简单介绍，请参阅PEP 483。

举个栗子，函数接收并返回一个字符串，如下所示：

def func(name: str) -> str:
    return "Hello" + name

在函数func中，参数预期是str类型，并且返回str类型

typing模块的作用：

类型检查，防止运行时出现参数和返回值类型不符合

作为开发文档附加说明，方便使用者调用传入和返回类型

该模块加入之后并不会影响程序的运行，不会报正式的错误，只有提醒

类型别名

类型别名通过将类型分配别名来进行定义，在这个例子中，Vector和List[str]可以视为可互换的同义词：

from typing import List
Vector = List[str]
def func(name: str) -> Vector:
    return [name]
print(Vector, type(Vector))         # typing.List[str] <class 'typing.GenericMeta'>
value = func("laozhang")
print(value, type(value))           # ['laozhang'] <class 'list'>

NewType

使用NewType()辅助函数来创建不同的类型

from typing import NewType
UserId = NewType("UserId", int)
UserName = NewType("UserName", str)

静态类型检查器会将新类型视为它最原始类型的子类，这对于捕捉逻辑错误非常有用：

def from_int_to_str(user_id: UserId) -> str:
    return str(user_id)
    
print(from_int_to_str(UserId(123)))     # 123
print(from_int_to_str(123))             # 123

你仍然可以对UserId类型的变量执行所有的int支持的操作，但结果将始终为int类型，如下：

value = UserId(123) + UserId(456)
print(value)            # 579
print(type(value))      # <class 'int'>

值得注意的是，UserId = NewType("UserId", int)，UserId是一个函数，该函数将会立即返回你传递给它的任何参数。这也意味着，无法创建UserId的子类型，因为它是运行时的标识函数，而不是实际类型，下面这种写法是错误的：

class MyUser(UserId):
    pass

但是，可以基于UserId创建NewType，如下：

ChildUserId = NewType("ChildUserId", UserId)

Callable

期望特定签名的回调函数可以将类型标注为Callable[[Arg1Type, Arg2Type], ReturnType]。例如：

from typing import Callable
def finder(on_success: Callable[[str, int], None]) -> None:
    pass  
def on_success(s: str, i: int) -> None:
    pass
finder(on_success=on_success)

如果传递过去的回调函数中的参数或返回类型不匹配，PyCharm将会有警告提示

泛型(Generics)

泛型可以使用typing模块中名为TypeVar的新工厂进行参数化，如下：

from typing import TypeVar
T = TypeVar("T")
def finder(s: T) -> T:
    return s

泛型类型可以有任意数量的类型变量，这样的话类型变量可能会收到限制：

from typing import TypeVar
T = TypeVar("T", int, str)
def finder(s: T) -> T:
    return s

这样的话，finder函数将只能接收int/str类型的参数，否则将会有警告提示

typing模块常用类型

int,、float: 整形、浮点型

bool、str: 布尔型、字符串类型

List、Dict、Tuple、Set: 列表、字典、元组、集合

Iterable、Iterator: 可迭代类型、迭代器类型

Generator: 生成器类型

更多关于typing模块的使用：https://docs.python.org/zh-cn/3.7/library/typing.html

Python 3 新特性:类型注解

前几天有同学问到，这个写法是什么意思：

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

我们知道 Python 是一种动态语言，变量以及函数的参数是不区分类型。因此我们定义函数只需要这样写就可以了：

def add(x, y):
    return x + y

这样的好处是有极大的灵活性，但坏处就是对于别人代码，无法一眼判断出参数的类型，IDE 也无法给出正确的提示。

于是 Python 3 提供了一个新的特性：

函数注解

也就是文章开头的这个例子：

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

用 : 类型 的形式指定函数的参数类型，用 -> 类型 的形式指定函数的返回值类型。

然后特别要强调的是，Python 解释器并不会因为这些注解而提供额外的校验，没有任何的类型检查工作。也就是说，这些类型注解加不加，对你的代码来说没有任何影响：

输出：

但这么做的好处是：

让别的程序员看得更明白

让 IDE 了解类型，从而提供更准确的代码提示、补全和语法检查（包括类型检查，可以看到 str 和 float 类型的参数被高亮提示）

在函数的 __annotations__ 属性中会有你设定的注解：

输出：

在 Python 3.6 中，又引入了对变量类型进行注解的方法：

a: int = 123
b: str = 'hello'

更进一步，如果你需要指明一个全部由整数组成的列表：

from typing import List
l: List[int] = [1, 2, 3]

但同样，这些仅仅是“注解”，不会对代码产生任何影响。

不过，你可以通过 mypy 库来检验最终代码是否符合注解。

安装 mypy：

pip install mypy

执行代码：

mypy test.py

如果类型都符合，则不会有任何输出，否则就会给出类似输出：

这些新特性也许你并不会在代码中使用，不过当你在别人的代码中看到时，请按照对方的约定进行赋值或调用。

当然，也不排除 Python 以后的版本把类型检查做到解释器里，谁知道呢。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持自学编程网。

编程技巧