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实现的HTTP并发测试完整示例
Apr 23 Python
Windows系统下使用flup搭建Nginx和Python环境的方法
Dec 25 Python
Python基本语法经典教程
Mar 11 Python
Python中表达式x += y和x = x+y 的区别详解
Jun 20 Python
Python安装lz4-0.10.1遇到的坑
May 20 Python
Python使用sorted对字典的key或value排序
Nov 15 Python
对Python中list的倒序索引和切片实例讲解
Nov 15 Python
python图形工具turtle绘制国际象棋棋盘
May 23 Python
详解使用python绘制混淆矩阵(confusion_matrix)
Jul 14 Python
python+openCV调用摄像头拍摄和处理图片的实现
Aug 06 Python
Python响应对象text属性乱码解决方案
Mar 31 Python
Python操作MySQL数据库的示例代码
Jul 13 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
使用sockets:从新闻组中获取文章(二)
2006/10/09 PHP
微信支付PHP SDK之微信公众号支付代码详解
2015/12/09 PHP
js 页面执行时间计算代码
2009/03/04 Javascript
优化 JavaScript 代码的方法小结
2009/07/16 Javascript
javascript学习笔记(十五) js间歇调用和超时调用
2012/06/20 Javascript
js导航栏单击事件背景变换示例代码
2014/01/13 Javascript
javascript控制图片播放的实现代码
2020/07/29 Javascript
jQuery选择器用法实例详解
2015/12/17 Javascript
jQuery Form 表单提交插件之formSerialize,fieldSerialize,fieldValue,resetForm,clearForm,clearFields的应用
2016/01/23 Javascript
JavaScript的ExtJS框架中表格的编写教程
2016/05/21 Javascript
fullpage.js全屏滚动插件使用实例
2016/09/06 Javascript
原生js实现无限循环轮播图效果
2017/01/20 Javascript
js canvas实现简单的图像扩散效果
2020/06/28 Javascript
Vue项目引进ElementUI组件的方法
2018/11/11 Javascript
JavaScript实现邮箱后缀提示功能的示例代码
2018/12/13 Javascript
微信小程序常用的3种提示弹窗实现详解
2019/09/19 Javascript
vux-scroller实现移动端上拉加载功能过程解析
2019/10/08 Javascript
搭建Vue从Vue-cli到router路由护卫的实现
2019/11/14 Javascript
vue element-ui中table合计指定列求和实例
2020/11/02 Javascript
Python的Tornado框架的异步任务与AsyncHTTPClient
2016/06/27 Python
浅谈Python中带_的变量或函数命名
2017/12/04 Python
对python中的for循环和range内置函数详解
2018/04/17 Python
python print 按逗号或空格分隔的方法
2018/05/02 Python
Python实现拷贝/删除文件夹的方法详解
2018/08/29 Python
Python绘制股票移动均线的实例
2019/08/24 Python
Python3之字节串bytes与字节数组bytearray的使用详解
2019/08/27 Python
python3中关于excel追加写入格式被覆盖问题(实例代码)
2020/01/10 Python
python中前缀运算符 *和 **的用法示例详解
2020/05/28 Python
生产厂厂长岗位职责
2013/12/25 职场文书
学习心得体会
2014/01/01 职场文书
乡镇庆八一活动方案
2014/02/02 职场文书
法律专业自荐信
2014/06/03 职场文书
网络营销策划方案
2014/06/04 职场文书
2014个人四风对照检查材料思想汇报
2014/09/18 职场文书
2015年推广普通话演讲稿
2015/03/20 职场文书
《蓝鲸的眼睛》读后感5篇
2020/01/15 职场文书