一、概述1、描述变量类型注解是用来对变量和函数的参数返回值类型做注解,让调用方减少类型方面的错误,也可以提高代码的可读性和易用性。
但是,变量类型注解语法传入的类型表述能力有限,不能说明复杂的类型组成情况,因此引用了typing模块,来实现复杂的类型表达。
2、常用的数据类型typedescription
int 整型 integer
float 浮点数字
bool 布尔(int 的子类)
str 字符 (unicode)
bytes 8 位字符
object 任意对象(公共基类)
list[str] 字符组成的列表
tuple[int, int] 两个int对象的元组
tuple[int, ...] 任意数量的 int 对象的元组
dict[str, int] 键是 str 值是 int 的字典
iterable[int] 包含 int 的可迭代对象
sequence[bool] 布尔值序列(只读)
mapping[str, int] 从 str 键到 int 值的映射(只读)
any 具有任意类型的动态类型值
union 联合类型
optional 参数可以为空或已经声明的类型
mapping 映射,是 collections.abc.mapping 的泛型
mutablemapping mapping 对象的子类,可变
generator 生成器类型, generator[yieldtype、sendtype、returntype]
noreturn 函数没有返回结果
set 集合 set 的泛型, 推荐用于注解返回类型
abstractset collections.abc.set 的泛型,推荐用于注解参数
sequence collections.abc.sequence 的泛型,list、tuple 等的泛化类型
typevar 自定义兼容特定类型的变量
generic 自定义泛型类型
newtype 声明一些具有特殊含义的类型
callable 可调用类型, callable[[参数类型], 返回类型]
noreturn 没法返回值
3、mypy模块mypy是python的可选静态类型检查器
安装mypy模块 pip3 install mypy
使用mypy进行静态类型检查 mypy 执行 python 文件
二、使用1、基本使用from typing import list, set, dict, tuple#对于简单的 python 内置类型,只需使用类型的名称x1: int = 1x2: float = 1.0x3: bool = truex4: str = "test"x5: bytes = b"test" # 对于 collections ,类型名称用大写字母表示,并且# collections 内类型的名称在方括号中x6: list[int] = [1]x7: set[int] = {6, 7}#对于映射,需要键和值的类型x8: dict[str, float] = {'field': 2.0}#对于固定大小的元祖,指定所有元素的类型x9: tuple[int, str, float] = (3, "yes", 7.5)#对于可变大小的元祖,使用一种类型和省略号x10: tuple[int, ...] = (1, 2, 3) '''在终端执行检查(venv) d:\python>mypy .\01.pysuccess: no issues found in 1 source file'''
2、函数参数返回值添加类型标注1. 指定多个参数的方式
'''定义一个函数 参数 num int类型返回值 字符串类型使用mypy检测'''def num_fun(num: int) -> str: return str(num) num_fun(100)print(num_fun(100)) # 指定多个参数的方式def plus(num1: int, num2: int) -> int: return num1 + num2 # 在类型注释后为参数添加默认值,默认值需要添加在末尾'''声明函数参数时,所有带有默认值的参数必须放在非默认参数的后面。这是因为 python 解释器需要确定参数传递的顺序,如果默认参数放在非默认参数前面,解释器就无法确定哪个参数是哪个'''def func1(num1: int, my_float: float = 3.5)-> float: return num1 + my_floatprint(func1(10,20))f = func1print(f(10))
2. callable
callable 是一个抽象类,用于描述可调用对象的基本行为,例如函数、方法和类。当你声明一个函数变量并将其分配给一个变量时,这个变量只是一个普通的 python 对象,并不是一个可调用对象,因此它没有默认值
带有默认值的参数可以放在任何位置,但是在声明函数参数时,所有带有默认值的参数必须放在非默认参数的后面。这是因为 python 解释器需要确定参数传递的顺序,如果默认参数放在非默认参数前面,解释器就无法确定哪个参数是哪个。
from typing import callable#定义变量 指向一个函数def func2(num1:int, my_float=3.5) -> str: return f'返回结果{num1 + my_float}'print(func2(10))#callable指向可调用(函数)值的方式x: callable[[int, float], str] = func2print(x(10, 3.5)) '''执行结果返回结果13.5返回结果13.5'''
3. iterator
#定义函数,产生整数的生成器,每次返回一个from typing import iterator# 产生整数的生成器函数安全地返回只是一个 整数迭代器的函数#,因此这就是我们对其进行注释的方式def g(n: int) -> iterator[int]: i = 0 while i < n: yield i #下次迭代时,代码从 yield 的下一条语句(不是下一行)开始执行 i += 1 print(g(10))for i in g(10): print(i) '''执行结果<generator object g at 0x00000000014e88e0>0123456789'''
3、混合类型检查改进1.联合运算符
联合运算符使用 " | " 线来替代了旧版本中union[] 方法,使得程序更简洁
#新版本def get_name(user: str | dict) -> str: if isinstance(user, str): return user elif isinstance(user, dict): return user.get('name', '')print(get_name({'name':'bob'}))print(get_name("alice"))
在这个例子中,函数get_name接受一个参数user,它可以是一个字符串或一个字典。如果user是一个字符串,函数会直接返回这个字符串;如果user是一个字典,函数会尝试从字典中获取name字段的值,并返回它。
在这个例子中,我们使用联合运算符将str和dict类型组合起来,表示user可以是这两种类型之一。
#旧版本,union方法来实现相同的功能from typing import uniondef get_name2(user: union[str, dict]) -> str: if isinstance(user, str): return user elif isinstance(user, dict): return user.get('name', '') print(get_name2({'name':'bob'}))print(get_name2("alice"))'''执行结果bobalice'''
4、类型别名更改#旧版本oldname = strdef oldfunc(param:oldname) -> oldname: return param + paramoldfunc('oldfunc:花非人陌') #新版本,从3.10后开始支持from typing import typealias newstr :typealias = str #定义类型别名newint :typealias = intdef func_test(num:newint, msg:newstr)->newstr: return str(num) + msgprint(func_test(100,"类型名称更改"))
以上就是python中的变量类型标注怎么用的详细内容。
