Python中typing模块的具体使用

目录

• typing库
• 一、 简介
• 二、 别名
• 1、 类型别名
• 2、 NewType
• 3、 可调用对象
• 三、 泛型支持
• 1、集合类型
• 2、 抽象基类
• 3、 泛型
• 4、 Any
• 5、 特殊形式
• 5.1 Type
• 5.2 Union
• 5.3 Optional
• 5.4 Tuple
• 5.5 Callable

typing库

一、 简介

Python是一门弱类型的语言，很多时候我们可能不清楚函数参数类型或者返回值类型，很有可能导致一些类型没有指定方法，在写完代码一段时间后回过头看代码，很可能忘记了自己写的函数需要传什么参数，返回什么类型的结果，就不得不去阅读代码的具体内容，降低了阅读的速度，typing模块可以很好的解决这个问题

Python 运行时并不强制标注函数和变量类型。类型标注可被用于第三方工具，比如类型检查器、集成开发环境、静态检查器等

typing的主要作用有：

• 类型检查，防止运行时出现参数、返回值类型不符
• 作为开发文档附加说明，方便使用者调用时传入和返回参数类型
• 模块加入不会影响程序的运行不会报正式的错误，pycharm支持typing检查错误时会出现黄色警告

官方文档：【https://docs.python.org/zh-cn/3/library/typing.html】

语法：

def 函数名(参数: 数据类型) -> 返回值类型:
    pass

变量名: 数据类型 = 值

二、 别名

1、 类型别名

要定义一个类型别名，可以将一个类型赋给别名。类型别名可用于简化复杂类型签名，同时类型别名适用于简化复杂的类型签名

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import Sequence

ConnectionOptions = dict[str, int]  # 表示字典中的键为字符串类型，值为整型
Address = tuple[str, int, ...]  # 表示元组的第一个数据为字符串，第二个数据为整型，里面只能存储两个数据，有省略号表示里面可以添加n个整型数据
Server = tuple[Address, ConnectionOptions]

def broadcast_message(message: str,
                      servers: Sequence[Server]  # 表示一个序列对象里面存储了[tuple[tuple[str, int], dict[str, int]]]
                      ) -> None:  # 返回值为空
    ...

broadcast_message("a", [(("a", 1, 2), {"a": 1})])

2、 NewType

使用NewType辅助函数创建不同的类型，静态类型检查器会将新类型视为它是原始数据的子类，相当于C++里面的`typedef

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import NewType

UserId = NewType('UserId', int)  # 其不会创建一个新的类或引入其他内存，只是做一个约束作用

def name_by_id(user_id: UserId) -> str:
    ...

name_by_id(42)  # Fails type check
name_by_id(UserId(42))  # OK

num = UserId(5) + 1  # type: int，可以进行对应数据类型的操作

同时，可以嵌套创建，即可以基于NewType创建NewType

3、 可调用对象

Callable[[Arg1Type, Arg2Type], ReturnType]

如，实现一个互斥锁的装饰器

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from collections.abc import Callable  # 注意要使用Concatenate和ParamSpec就必须使用这个模块里面的Callable
from threading import Lock
from typing import TypeVar
from pip._vendor.typing_extensions import Concatenate, ParamSpec  # 导入typing的扩展

P = ParamSpec('P')  # 里面有args和kwargs参数
R = TypeVar('R')  # 自定义数据类型

my_lock = Lock()  # 创建一个互斥锁

def with_lock(f: Callable[Concatenate[Lock, P], R]) -> Callable[P, R]:
    '''一个提供互斥锁，使得线程安全的装饰器'''
    def inner(*args: P.args, **kwargs: P.kwargs) -> R:
        return f(my_lock, *args, **kwargs)
    return inner

@with_lock
def sum_threadsafe(lock: Lock, numbers: list[float]) -> float:
    '''Add a list of numbers together in a thread-safe manner.'''
    with lock:
        return sum(numbers)

# We don't need to pass in the lock ourselves thanks to the decorator.
print(sum_threadsafe([1.1, 2.2, 3.3]))

无需指定调用签名，用省略号字面量替换类型提示里的参数列表： Callable[..., ReturnType]，就可以声明可调对象的返回类型

与 Callable 和 ParamSpec 一起使用，对一个高阶可调用对象进行类型注释，该对象可以增加、删除或转换另一个可调用对象的参数。 使用形式为Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable]。 Concatenate 目前只在作为 Callable 的第一个参数时有效。Concatenate 的最后一个参数必须是一个 ParamSpec

三、 泛型支持

typing模快最基本的支持有Any ，Tuple，Callable，TypeVar 和 Generic类型组成

1、集合类型

from typing import (
    List,  # list的泛型版本。用于注释返回类型。要注释参数，最好使用抽象集合类型，如Sequence或Iterable
    Set,  # set的泛型版本
    Dict  # dict 的泛型版本。对标注返回类型比较有用。如果要标注参数的话，使用如 Mapping 的抽象容器类型是更好的选择
    )

2、 抽象基类

from typing import (
    Mapping,  # 要注释函数参数中的Key-Value类型时，推荐使用的抽象集合类型
    Sequence,  # 要注释函数参数中的序列例如列表类型时，推荐使用的抽象集合类型
    Iterable  # 要注释函数参数中的迭代类型时，推荐使用的抽象集合类型
    )

3、 泛型

TypeVar：其就像C++里面的template一样

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import (
    Sequence,
    TypeVar  # 限制多个变量为同一个数据类型
)

T = TypeVar('T')  # Can be anything 
A = TypeVar('A', str, bytes)  # Must be str or bytes 

def repeat(x: T, n: int) -> Sequence[T]:
    """Return a list containing n references to x."""
    return [x] * n

def longest(x: A, y: A) -> A:
    """Return the longest of two strings."""
    return x if len(x) >= len(y) else y

AnyStr

AnyStr是一个字符串和字节类型的特殊类型变量AnyStr = TypeVar('AnyStr', str, bytes)，它用于可以接受任何类型的字符串而不允许不同类型的字符串混合的函数

4、 Any

特殊类型，表明类型没有任何限制

• 每一个类型都对 Any 兼容
• Any 对每一个类型都兼容

Any 是一种特殊的类型。静态类型检查器将所有类型视为与Any兼容，反之亦然， Any也与所有类型相兼容。

这意味着可对类型为 Any 的值执行任何操作或者方法调用并将其赋值给任意变量

如下所示，将 Any 类型的值赋值给另一个更具体的类型时，Python不会执行类型检查。例如，当把 a 赋值给 s 时，即使 s 被声明为 str类型，在运行时接收到的是 int 值，静态类型检查器也不会报错

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import (
    Any,
    NoReturn,  # 表示函数没有返回值
)

def test(s: Any) -> NoReturn:
    s.item()  # 不会检测s里面是否有item()属性

def test_(s: object) -> NoReturn:
    s.item()  # 会检测s里面是否有item属性

当参数无类型是，默认为Any类型

5、 特殊形式

5.1 Type

一个注解为 C 的变量可以接受一个类型为 C 的值。相对地，一个注解为 Type[C] 的变量可以接受本身为类的值 。 更精确地说它接受 C的 类对象

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# @author: A.L.Kun
# @file : test.py
# @time : 2022/5/13 16:54
from typing import (
    Type,
)

class User:
    ...

class BasicUser(User):
    ...

# Accepts User, BasicUser, ...

def make_new_user(user_class: Type[User]) -> User:
    return user_class()

print(make_new_user(User))

5.2 Union

联合类型；Union[X, Y]意味着：要么是 X，要么就是 Y。定义一个联合类型，需要注意的有：

• 参数必须是类型，而且必须至少有一个参数。
• 能继承或者实例化一个联合类型。
• Union[X, Y]不能写成 Union[X][Y] 。
• 可以使用 Optional[X] 作为Union[X, None]的缩写- 联合类型的联合类型会被展开打平
• 仅有一个参数的联合类型会坍缩成参数自身，比如:

Union[int] == int  # The constructor actually returns int

多余的参数会被跳过，比如:

Union[int, str, int] == Union[int, str]

在比较联合类型的时候，参数顺序会被忽略，比如:

Union[int, str] == Union[str, int]

5.3 Optional

可选类型，Optional[X] 等价于Union[X, None]

5.4 Tuple

元组类型,Tuple[X, Y] 标注了一个二元组类型，其第一个元素的类型为 X 且第二个元素的类型为Y。空元组的类型可写作 Tuple[()]

为表达一个同类型元素的变长元组，使用省略号字面量，如Tuple[int, ...]。单独的一个 Tuple 等价于 Tuple[Any, ...]，进而等价于tuple

示例: Tuple[int, float, str]表示一个由整数、浮点数和字符串组成的三元组

5.5 Callable

可调用类型；Callable[[int], str]是一个函数，接受一个 int 参数，返回一个str。下标值的语法必须恰为两个值：参数列表和返回类型。参数列表必须是一个类型和省略号组成的列表；返回值必须是单一一个类型

不存在语法来表示可选的或关键词参数，这类函数类型罕见用于回调函数。Callable[..., ReturnType]（使用字面省略号）能被用于提示一个可调用对象，接受任意数量的参数并且返回 ReturnType。单独的 Callable 等价于Callable[..., Any]，并且进而等价于 collections.abc.Callable

更多语法，请到官方查看！！！

到此这篇关于Python中typing模块的具体使用的文章就介绍到这了,更多相关Python typing模块内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！