一篇文章带你了解python中的typing模块和类型注解
作者:KbMan 发布时间:2023-08-05 21:37:02
function annotation 写法:
使用冒号
:
加类型代表参数类型默认值参数示例:
b: int = 2
使用
->
加类型代表返回值类型
python解释器运行时并不会检查类型,类型不对也不会抛异常,仅仅是注解而已。示例:
def plus(a: int, b: int = 2) -> int:
return a + b
python 解析器并不会在意类型注解,严格来说这是不对的,Python 会把类型信息放在 __annotations__
属性中:
>>> def foo(a: str):
... print('hello', a)
...
>>> foo.__annotations__
{'a': str}
>>> class Bar:
... a: str
... b: int
>>> Bar.__annotations__
{'a': str, 'b': int}
typing模块
内置提供的类型:int
、str
、float
,typing模块提供的类型:Dict
、List
、Tuble
...
typing使用方括号 Dict[str, int]
而不是圆括号 Dict(str, int)
Dict
Dict[str, int]: 表示一个 keys 的类型为 str,values 的类型为 int 的字典,比如 {"a": 1, "b": 2}
from typing import Dict
Dict[str, Dict[str, List[str]]]如下:
{
'原木镇': {
'第一小学': ['张伟', '王伟', '王芳'],
'第二小学': ['李伟', '李娜'],
},
'鸽子镇': {
'高山中学': ['张敏', '李静'],
'亿百中学': ['王静']
'蟒蛇小学': ['刘伟', '王秀英']
}
}
List
List[int] 表示由整型组成的列表,比如[0, 1, 1, 2, 3]
List[List[int]] = [[1, 2], [2, 3]]
Tuple
Tuple[int, float, str] is a tuple of an int, a float and a string.
person: Tuple[str, int, float] = ('Mike', 22, 1.75)
set/AbstractSet
根据官方文档,Set 推荐用于注解返回类型,AbstractSet 用于注解参数
def describe(s: AbstractSet[int]) -> Set[int]:
return set(s)
Sequence
Sequence,是 collections.abc.Sequence 的泛型,在某些情况下,我们可能并不需要严格区分一个变量或参数到底是列表 list 类型还是元组 tuple 类型,我们可以使用一个更为泛化的类型,叫做 Sequence,其用法类似于 List
def square(elements: Sequence[float]) -> List[float]:
return [x ** 2 for x in elements]
NoReturn
NoReturn,当一个方法没有返回结果时,为了注解它的返回类型,我们可以将其注解为NoReturn
def hello() -> NoReturn:
print('hello')
Any
Any,可以代表所有类型,所有的无参数类型注解和返回类型注解的都会默认使用 Any 类型,以下两个函数等价:
def add(a):
return a + 1
def add(a: Any) -> Any:
return a + 1
TypeVar
TypeVar,自定义兼容特定类型的变量,比如有的变量声明为 int、float、None 都是符合要求的,实际就是代表任意的数字或者空内容都可以,其他的类型则不可以,比如列表 list、字典 dict 等等,像这样的情况,我们可以使用 TypeVar 来表示。
height = 1.75
Height = TypeVar('Height', int, float, None)
def get_height() -> Height:
return height
NewType
newType,声明一些具有特殊含义的类型,像 Tuple 的例子一样,我们需要将它表示为 Person,即一个人的含义,但但从表面上声明为 Tuple 并不直观,所以我们可以使用 NewType 为其声明一个类型,如:
Person = NewType('Person', Tuple[str, int, float])
person = Person(('Mike', 22, 1.75))
实际上 person 就是一个 tuple 类型,我们可以对其像 tuple 一样正常操作。
Callable
Callable,可调用类型,通常用来注解一个方法, 在声明的时候需要使用 Callable[[Arg1Type, Arg2Type, ...], ReturnType]
这样的类型注解,将参数类型和返回值类型都要注解出来,例如:
def date(year: int, month: int, day: int) -> str:
return f'{year}-{month}-{day}'
def get_date_fn() -> Callable[[int, int, int], str]:
return date
-> Callable[[int, int, int], str]: 中括号内分别标记了返回的方法的参数类型和返回值类型。
Union
Union,联合类型,Union[X, Y]
代表要么是 X 类型,要么是 Y 类型。
Union[Union[int, str], float] == Union[int, str, float]
Union[int] == int
Union[int, str, int] == Union[int, str]
# 无参数顺序
Union[int, str] == Union[str, int]
在一些方法参数声明的时候比较有用,比如一个方法,要么传一个字符串表示的方法名,要么直接把方法传过来:
def process(fn: Union[str, Callable]):
if isinstance(fn, str):
# str2fn and process
pass
elif isinstance(fn, Callable):
fn()
这样的声明在一些类库方法定义的时候十分常见。
Optional
Optional,意思是说这个参数可以为空或已经声明的类型,即 Optional[X]
等价于 Union[X, None]
。
Optional 并不等价于可选参数,当它作为参数类型注解的时候,不代表这个参数可以不传递,而是说这个参数可以传None,不传也会报错。
当一个方法执行结果,如果执行完毕就不返回错误信息, 如果发生问题就返回错误信息,则可以这么声明:
def judge(result: bool) -> Optional[str]:
if result: return 'Error Occurred'
Generator
Generator,想代表一个生成器类型,可以使用 Generator,它的声明比较特殊,其后的中括号紧跟着三个参数,分别代表 YieldType、SendType、ReturnType,如:
def echo_round() -> Generator[int, float, str]:
sent = yield 0
while sent >= 0:
sent = yield round(sent)
return 'Done'
在这里 yield 关键字后面紧跟的变量的类型就是 YieldType,yield 返回的结果的类型就是 SendType,最后生成器 return 的内容就是 ReturnType。
当然很多情况下,生成器往往只需要 yield 内容就够了,我们是不需要 SendType 和 ReturnType 的,可以将其设置为空,如:
def infinite_stream(start: int) -> Generator[int, None, None]:
while True:
yield start
start += 1
来源:https://www.cnblogs.com/KbMan/p/12095857.html
![](https://www.aspxhome.com/images/zang.png)
![](https://www.aspxhome.com/images/jiucuo.png)
猜你喜欢
- 一:安装pip install web.py二:URL 处理任何网站最重要的部分就是它的URL结构。urls=('/',
- 1. 字符编码简介1.1. ASCIIASCII(American Standard Code for Information Interc
- 我就废话不多说了,直接上代码吧!import datetimeimport timedef get_float_time_stamp():
- 有的时候需要用python处理二进制数据,比如,存取文件,socket操作时.这时候,可以使用python的struct模块来完成.可以用
- 首先给大家介绍ThinkPHP函数详解:M方法M方法用于实例化一个基础模型类,和D方法的区别在于:1、不需要自定义模型类,减少IO加载,性能
- 引言本文将深入探讨Python语言中的核心概念:类(Class)和对象(Object)。我们将介绍这些基本概念,然后通过示例代码详细展示Py
- 使用Python绘制正态分布曲线,借助matplotlib绘图工具;#-*-coding:utf-8-*-"""
- ASP开发中有用的function集合,挺有用处的!希望大家保留!<% '**
- 【原文地址】New C# "Orcas" Language Features: Automatic Properties
- 有件东西我观察了很多年,那就是很少有开发者会去使用SQL Server中的一个非常有用的东西——EX
- 静态数据类型静态数据类型是指不可以对该数据类型进行修改,即只读的数据类型。迄今为止学过的静态数据类型有字符串,元组。在使用[]操作符对字符串
- 一、装饰器decorator decorator设计模式允许动态地对现有的对象或函数包装以至于修改现有的职责和行为,简单地讲用来动态地扩展现
- 我们将研究一种判别式分类方法,其中直接学习评估 g(x)所需的 w 参数。我们将使用感知器学习算法。感知器学习算法很容易实现,但为了节省时间
- 相信很多与页面打过交道的同学都对 Yahoo 的 Best Practices for Speeding Up Your Web Site
- 没人愿意等待。所以,没有访问者真的能够忍受一个打开速度极慢的网站。但是,网页打开速度到底对用户行为有什么影响,恐怕没几个人能够说清楚吧。前几
- 今天发现一个使用python写的管理cisco设备的小框架tratto,可以用来批量执行命令。下载后主要有3个文件:Systems.py 定
- 数据结构树简介一、树简介树(Tree)是一种抽象的数据结构,是一个数据的集合,集合中的数据组成了一个树状结构。例如上图,看起来像一棵倒挂的树
- 随着互联网产业的飞速发展和电子产业的飞速发展,人们的社交似乎离不开网络,这就应运了SNS的飞速发展。从打开QQ空间关注朋友们的动态,最近心情
- 这篇文章我们来讲讲如何在python使用bs4模块返回值中正确使用find和find_all来取值。我们先来看看find函数在两种场景使用:
- 很早就在这里看到过解决方案,与嗷嗷讨论后发现这个方案还是很可靠的。当然,唯一的缺点就是每一个属性都要去Hack,但我在很多实践中,只用‘修正