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中使用PDB库调试程序
Apr 05 Python
Python实现的简单算术游戏实例
May 26 Python
利用Python爬虫给孩子起个好名字
Feb 14 Python
Python中文件的读取和写入操作
Apr 27 Python
Python 类的特殊成员解析
Jun 20 Python
python批量下载抖音视频
Jun 17 Python
Python装饰器实现方法及应用场景详解
Mar 26 Python
在Matplotlib图中插入LaTex公式实例
Apr 17 Python
python中sympy库求常微分方程的用法
Apr 28 Python
基于Python实现简单学生管理系统
Jul 24 Python
Python中递归以及递归遍历目录详解
Oct 24 Python
Python可视化神器pyecharts之绘制箱形图
Jul 07 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通过header实现文本文件下载的代码
2010/08/08 PHP
php检查是否是ajax请求的方法
2015/04/16 PHP
10个值得深思的PHP面试题
2016/11/14 PHP
[原创]php集成安装包wampserver修改密码后phpmyadmin无法登陆的解决方法
2016/11/23 PHP
JQuyer $.post 与 $.ajax 访问WCF ajax service 时的问题需要注意的地方
2011/09/20 Javascript
Jquery异步请求数据实例代码
2011/12/28 Javascript
javascript一元操作符(递增、递减)使用示例
2013/08/07 Javascript
jQuery设置和移除文本框默认值的方法
2015/03/09 Javascript
jQuery实现个性翻牌效果导航菜单的方法
2015/03/09 Javascript
jQuery实现MSN中文网滑动Tab菜单效果代码
2015/09/09 Javascript
基于jQuery实现网页打印功能
2015/12/01 Javascript
jQuery checkbox选中问题之prop与attr注意点分析
2016/11/15 Javascript
Node.js的Mongodb使用实例
2016/12/30 Javascript
canvas 绘制圆形时钟
2017/02/22 Javascript
JS完成画圆圈的小球
2017/03/07 Javascript
jquery.uploadifive插件怎么解决上传限制图片或文件大小问题
2017/05/08 jQuery
JavaScript 基础表单验证示例(纯Js实现)
2017/07/20 Javascript
JS实现获取word文档内容并输出显示到html页面示例
2018/06/23 Javascript
vue2.x集成百度UEditor富文本编辑器的方法
2018/09/21 Javascript
Nuxt.js 数据双向绑定的实现
2019/02/17 Javascript
Node.js 实现抢票小工具 &amp; 短信通知提醒功能
2019/10/22 Javascript
原生js+canvas实现下雪效果
2020/08/02 Javascript
Angular+Ionic使用queryParams实现跳转页传值的方法
2020/09/05 Javascript
Django内容增加富文本功能的实例
2017/10/17 Python
python爬取网页内容转换为PDF文件
2020/07/28 Python
Python自定义装饰器原理与用法实例分析
2018/07/16 Python
python的sorted用法详解
2019/06/25 Python
Python 如何实现访问者模式
2020/07/28 Python
Python 如何展开嵌套的序列
2020/08/01 Python
为中国消费者甄选天下优品:网易严选
2016/08/11 全球购物
Dower & Hall官网:英国小众轻奢珠宝品牌
2019/01/31 全球购物
党章培训心得体会
2014/09/04 职场文书
婚育证明格式
2015/06/17 职场文书
2015重阳节座谈会主持词
2015/07/30 职场文书
排查并解决Oracle sysaux表空间异常增长
2022/04/20 Oracle
Java死锁的排查
2022/05/11 Java/Android