Python3 类型标注支持操作


Posted in Python onJune 02, 2021

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 解释器并不会因为这些注解而提供额外的校验,没有任何的类型检查工作。也就是说,这些类型注解加不加,对你的代码来说没有任何影响:

Python3 类型标注支持操作

输出:

Python3 类型标注支持操作

但这么做的好处是:

让别的程序员看得更明白

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

Python3 类型标注支持操作

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

Python3 类型标注支持操作

输出:

Python3 类型标注支持操作

在 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

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

Python3 类型标注支持操作

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

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

以上为个人经验,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python中使用语句导入模块或包的机制研究
Mar 30 Python
Python数组遍历的简单实现方法小结
Apr 27 Python
python编码总结(编码类型、格式、转码)
Jul 01 Python
基于Python_脚本CGI、特点、应用、开发环境(详解)
May 23 Python
解决pycharm的Python console不能调试当前程序的问题
Jan 20 Python
一篇文章弄懂Python中所有数组数据类型
Jun 23 Python
python 处理微信对账单数据的实例代码
Jul 19 Python
Python读取csv文件实例解析
Dec 30 Python
如何解决tensorflow恢复模型的特定值时出错
Feb 06 Python
pytorch实现CNN卷积神经网络
Feb 19 Python
利用Python pandas对Excel进行合并的方法示例
Nov 04 Python
Python paramiko使用方法代码汇总
Nov 20 Python
python 实现两个变量值进行交换的n种操作
聊聊Python中关于a=[[]]*3的反思
python内置进制转换函数的操作
Jun 02 #Python
Python 内置函数速查表一览
Jun 02 #Python
利用Python判断你的密码难度等级
Jun 02 #Python
Python标准库之typing的用法(类型标注)
只用50行Python代码爬取网络美女高清图片
You might like
用PHP调用数据库的存贮过程!
2006/10/09 PHP
PHP图片裁剪函数(保持图像不变形)
2014/05/04 PHP
thinkPHP+phpexcel实现excel报表输出功能示例
2017/06/06 PHP
新浪的图片新闻效果
2007/01/13 Javascript
js资料prototype 属性
2007/03/13 Javascript
location.search在客户端获取Url参数的方法
2010/06/08 Javascript
jQuery timers计时器简单应用说明
2010/10/28 Javascript
基于jQuery的倒计时实现代码
2012/05/30 Javascript
Ajax执行顺序流程及回调问题分析
2012/12/10 Javascript
JS中令人发指的valueOf方法介绍
2013/02/22 Javascript
js或者jquery判断图片是否加载完成实现代码
2013/03/20 Javascript
选择器中含有空格在使用示例及注意事项
2013/07/31 Javascript
JavaScript生成的动态下雨背景效果实现方法
2015/02/25 Javascript
jquery判断复选框是否选中进行答题提示特效
2015/12/10 Javascript
Vue-Router实现组件间跳转的三种方法
2017/11/07 Javascript
解决vue.js 数据渲染成功仍报错的问题
2018/08/25 Javascript
微信小程序textarea层级过高的解决方法
2019/03/04 Javascript
Js视频播放器插件Video.js使用方法详解
2020/02/04 Javascript
element中的$confirm的使用
2020/04/26 Javascript
[01:00:53]OG vs IG 2018国际邀请赛小组赛BO2 第一场 8.18
2018/08/19 DOTA
python监控linux内存并写入mongodb(推荐)
2017/09/11 Python
python微信跳一跳系列之色块轮廓定位棋盘
2018/02/26 Python
pyqt5中QThread在使用时出现重复emit的实例
2019/06/21 Python
如何将 awk 脚本移植到 Python
2019/12/09 Python
解决Python命令行下退格,删除,方向键乱码(亲测有效)
2020/01/16 Python
python爬虫要用到的库总结
2020/07/28 Python
python获得命令行输入的参数的两种方式
2020/11/02 Python
印度尼西亚手表和包包商店:Urban Icon
2019/12/12 全球购物
2014基层党员干部学习全国两会心得体会
2014/03/17 职场文书
个人租房协议书(范本)
2014/10/14 职场文书
2015年入党积极分子评语
2015/03/26 职场文书
2015年领班工作总结
2015/04/29 职场文书
房地产项目合作意向书
2015/05/08 职场文书
关爱留守儿童主题班会
2015/08/13 职场文书
《多彩的民间艺术》教学反思
2016/02/16 职场文书
《七律·长征》教学反思
2016/02/16 职场文书