详解python3类型注释annotations实用案例


Posted in Python onJanuary 20, 2021

1、类型注解简介

Python是一种动态类型化的语言,不会强制使用类型提示,但为了更明确形参类型,自python3.5开始,PEP484为python引入了类型注解(type hints)

示例如下:

详解python3类型注释annotations实用案例 

2、常见的数据类型

  • int,long,float: 整型,长整形,浮点型
  • bool,str: 布尔型,字符串类型
  • List, Tuple, Dict, Set: 列表,元组,字典, 集合
  • Iterable,Iterator: 可迭代类型,迭代器类型
  • Generator:生成器类型
  • Sequence: 序列

3、基本的类型指定

def test(a: int, b: str) -> str:
  print(a, b)
  return 200


if __name__ == '__main__':
  test('test', 'abc')

函数test,a:int 指定了输入参数a为int类型,b:str b为str类型,-> str 返回值为srt类型。可以看到,在方法中,我们最终返回了一个int,此时pycharm就会有警告;

调用这个方法时,参数a 输入的是字符串,此时也会有警告;

but…,pycharm这玩意儿 只是提出了警告,但实际上运行是不会报错,毕竟python的本质还是动态语言

详解python3类型注释annotations实用案例

4、复杂的类型指定

指定列表

from typing import List
Vector = List[float]


def scale(scalar: float, vector: Vector) -> Vector:
  return [scalar * num for num in vector]


# type checks; a list of floats qualifies as a Vector.
new_vector = scale(2.0, [1.0, -4.2, 5.4])
print(new_vector)

指定 字典、元组 类型

from typing import Dict, Tuple, Sequence

ConnectionOptions = Dict[str, str]
Address = Tuple[str, int]
Server = Tuple[Address, ConnectionOptions]


def broadcast_message(message: str, servers: Sequence[Server]) -> None:
  print(message)
  print(servers)

# The static type checker will treat the previous type signature as
# being exactly equivalent to this one.


if __name__ == '__main__':
  broadcast_message('OK', [(('127.0.0.1', 8080), {"method": "GET"})])

详解python3类型注释annotations实用案例

这里需要注意,元组这个类型是比较特殊的,因为它是不可变的。
所以,当我们指定Tuple[str, str]时,就只能传入长度为2,并且元组中的所有元素都是str类型

5、创建变量时的类型指定

对于常量或者变量添加注释

from typing import NamedTuple


class Employee(NamedTuple):
  name: str
  id: int = 3


employee = Employee('Guido')
# assert employee.id == 3  # 当类型一致时,不会输出内容,反之报错
assert employee.id == '3'  # 当类型一致时,不会输出内容,反之报错
# AssertionError

指定一个变量odd,显式的声明了它应该是整数列表。如果使用mypy来执行这个脚本,将不会收到任何提示输出,因为已经正确地传递了期望的参数去执行所有操作。

from typing import List

def odd_numbers(numbers: List) -> List:
  odd: List[int] = []
  for number in numbers:
    if number % 2:
      odd.append(number)

  return odd

if __name__ == '__main__':
  numbers = list(range(10))
  print(odd_numbers(numbers))

mypy 安装

pip install mypy

执行 mypy file,正常情况下不会报错

C:\Users\Sunny_Future\AppData\Roaming\Python\Python36\Scripts\mypy.exe tests.py

# 指定 环境变量或者 linux 下可以直接执行 mypy
# mypy tests.py

Success: no issues found in 1 source file

详解python3类型注释annotations实用案例

接下来,尝试更改一下代码,试图去添加整形之外的其他类型内容!那么执行则会检查报错

from typing import List


def odd_numbers(numbers: List) -> List:
  odd: List[int] = []
  for number in numbers:
    if number % 2:
      odd.append(number)

  odd.append('foo')

  return odd


if __name__ == '__main__':
  numbers = list(range(10))
  print(odd_numbers(numbers))

代码中添加一个行新代码,将一个字符串foo附加到整数列表中。现在,如果我们针对这个版本的代码来运行mypy

C:\Users\Sunny_Future\AppData\Roaming\Python\Python36\Scripts\mypy.exe tests.py

详解python3类型注释annotations实用案例

tests.py:114: error: Argument 1 to “append” of “list” has incompatible type “str”; expected “int”
Found 1 error in 1 file (checked 1 source file)

6、 泛型指定

from typing import Sequence, TypeVar, Union

T = TypeVar('T')   # Declare type variable


def first(l: Sequence[T]) -> T:  # Generic function
  return l[0]


T = TypeVar('T')       # Can be anything
A = TypeVar('A', str, bytes) # Must be str or bytes
A = Union[str, None]     # Must be str or None

7、再次重申

在Python 3.5中,你需要做变量声明,但是必须将声明放在注释中:

# Python 3.6
odd: List[int] = []

# Python 3.5
odd = [] # type: List[int]

如果使用Python 3.5的变量注释语法,mypy仍将正确标记该错误。你必须在 #井号之后指定type:。如果你删除它,那么它就不再是变量注释了。基本上PEP 526增加的所有内容都为了使语言更加统一。

8、不足之处

虽然指定了 List[int] 即由 int 组成的列表,但是,实际中,只要这个列表中存在 int(其他的可以为任何类型)pycharm就不会出现警告,使用 mypy 才能检测出警告!

from typing import List


def test(b: List[int]) -> str:
  print(b)
  return 'test'


if __name__ == '__main__':
  test([1, 'a'])

pycharm 并没有检测出类型错误,没有告警

详解python3类型注释annotations实用案例mypy

工具 检测到 类型异常,并进行了报错

详解python3类型注释annotations实用案例 

9、demo

# py2 引用
from__future__import annotations
class Starship:
  captain: str = 'Picard'
  damage: int
  stats: ClassVar[Dict[str, int]] = {}

  def __init__(self, damage: int, captain: str = None):
    self.damage = damage
    if captain:
      self.captain = captain # Else keep the default

  def hit(self):
    Starship.stats['hits'] = Starship.stats.get('hits', 0) + 1

enterprise_d = Starship(3000)
enterprise_d.stats = {} # Flagged as error by a type checker
Starship.stats = {} # This is OK
from typing import Dict
class Player:
  ...
players: Dict[str, Player]
__points: int

print(__annotations__)
# prints: {'players': typing.Dict[str, __main__.Player],
#     '_Player__points': <class 'int'>}
class C:
  __annotations__ = 42
  x: int = 5 # raises TypeError

到此这篇关于详解python3类型注释annotations实用案例的文章就介绍到这了,更多相关python3类型注释annotations内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
Python类属性的延迟计算
Oct 22 Python
Python 调用Java实例详解
Jun 02 Python
Python实现树的先序、中序、后序排序算法示例
Jun 23 Python
PyQt5每天必学之单行文本框
Apr 19 Python
使用11行Python代码盗取了室友的U盘内容
Oct 23 Python
用python脚本24小时刷浏览器的访问量方法
Dec 07 Python
python使用zip将list转为json的方法
Dec 31 Python
解决使用export_graphviz可视化树报错的问题
Aug 09 Python
Python3监控疫情的完整代码
Feb 20 Python
python print 格式化输出,动态指定长度的实现
Apr 12 Python
django 解决自定义序列化返回处理数据为null的问题
May 20 Python
Python实现老照片修复之上色小技巧
Oct 16 Python
python-jwt用户认证食用教学的实现方法
Jan 19 #Python
使用Python爬虫爬取小红书完完整整的全过程
Jan 19 #Python
python 自动识别并连接串口的实现
Jan 19 #Python
python爬取抖音视频的实例分析
Jan 19 #Python
python中的插入排序的简单用法
Jan 19 #Python
Python实现淘宝秒杀功能的示例代码
Jan 19 #Python
Python爬虫后获取重定向url的两种方法
Jan 19 #Python
You might like
php防止恶意刷新与刷票的方法
2014/11/21 PHP
PHP连接Nginx服务器并解析Nginx日志的方法
2015/08/16 PHP
用JQuery 实现AJAX加载XML并解析的脚本
2009/07/25 Javascript
javascript定时保存表单数据的代码
2011/03/17 Javascript
你必须知道的Javascript知识点之&quot;字面量和对应类型&quot;说明介绍
2013/04/23 Javascript
js跳转页面方法总结
2014/01/29 Javascript
如何用js 实现依赖注入的思想,后端框架思想搬到前端来
2015/08/03 Javascript
jQuery实现一个简单的轮播图
2017/02/19 Javascript
jQuery实现动态生成表格并为行绑定单击变色动作的方法
2017/04/17 jQuery
vue引入jq插件的实例讲解
2017/09/12 Javascript
jQuery实现的模仿雨滴下落动画效果
2018/12/11 jQuery
layui多图上传实现删除功能的例子
2019/09/23 Javascript
JavaScript判断数组类型的方法
2019/10/23 Javascript
eslint+prettier统一代码风格的实现方法
2020/07/22 Javascript
JavaScript 闭包的使用场景
2020/09/17 Javascript
[01:35:53]完美世界DOTA2联赛PWL S3 Magma vs GXR 第二场 12.13
2020/12/17 DOTA
一个基于flask的web应用诞生(1)
2017/04/11 Python
Python2.7 实现引入自己写的类方法
2018/04/29 Python
python 批量修改/替换数据的实例
2018/07/25 Python
tensorflow实现加载mnist数据集
2018/09/08 Python
使用Python做定时任务及时了解互联网动态
2019/05/15 Python
Python2.7实现多进程下开发多线程示例
2019/05/31 Python
Python 50行爬虫抓取并处理图灵书目过程详解
2019/09/20 Python
python分布式计算dispy的使用详解
2019/12/22 Python
Vs Code中8个好用的python 扩展插件
2020/10/12 Python
Jeep牧马人、切诺基和自由人零配件:4 Wheel Drive Hardware
2017/07/02 全球购物
MVC的各个部分都有那些技术来实现?如何实现?
2016/04/21 面试题
出纳的岗位职责
2013/11/09 职场文书
安全协议书范本
2014/04/21 职场文书
爬山的活动方案
2014/08/16 职场文书
2014年青年教师工作总结
2014/12/17 职场文书
民事起诉书范本
2015/05/19 职场文书
六五普法先进个人主要事迹材料
2015/11/03 职场文书
党员干部学习十八届五中全会精神心得体会
2016/01/05 职场文书
话题作文之自信作文
2019/11/15 职场文书
Django开发RESTful API实现增删改查(入门级)
2021/05/10 Python