这篇文章将为大家详细讲解有关python 编码中需要写类型注解的原因是什么,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。
使用方式
2.1、 Python3内置的类型注解
内置注解肯能大家都接触过,但总感觉很麻烦,导致后面很容易就放弃写注解,这是因为得到不正反馈,看如下示例:
a: str = "aa"b: int = 1# 参数和返回标注了类型,那么接下来调用时就能进行提示def example(a: str) -> str: return f"Hello {a}"pirnt(example("world"))# # 一些简单的标注,看起来起不到效果,但如果换个有含义的名字呢User = strAge = intAnswer = strdef say_hello(u: User) -> Answer: return f"Hello {u}"print(say_hello("Shadow"))
上面简单演示了内置的类型注解是如何使用的,但是其实这么简单的类型注解并不能帮助我们很好的标注变量;下面介绍一个typing模块
2.2、typing 模块的快速入门
typing 模块是类型注解的主角,Python运行时不强制执行函数和变量类型注解,但这些注解可用于类型检查器、IDE、静态检查器等第三方工具。这些第三方工具会在我们编码时进行提示与纠错;
下面提供一些日常使用到的方法与用例给大家参考:
import typing# 自定义类型注解User = strAge = int# 定义有多种类型注解的类型AnyStr = typing.TypeVar('AnyStr', str, bytes)a_str: AnyStr = "a"a_bytes: AnyStr = b"a"# 通用类型, 接收通用的类型,尽量少的去使用def example_1(a: typing.Any): print(a)"""typing 模块是允许使用下标来辅助标记类型"""# 列表, 下标为列表的属性def example_2(a_list: typing.List[User]) -> typing.List[str]: pass# 字典,下标第一个为key,第二个为valuedef example_3(a_dict: typing.Dict[User, Age]) -> typing.Dict[str, int]: pass# 元祖,下标为元祖的属性def example_4(a_tuple: typing.Tuple[User] = None) -> typing.Tuple[User]: pass# Union, 在一些场景下我们某些参数或返回值是不确定,至少给定一个参数类型def example_5(a_b: typing.Union[str, int]) -> typing.Union[str, int]: pass# Optional, 与Union 有点类似,但默认多带一个None,至少给定一个参数类型# 如:Optional[str] 等价于 Union[str, None]def example_6(a: str) -> typing.Optional[str]: pass# Tuple, 返回值有多个的时候, 如需要返回str, int, bool, floatdef example_7() -> typing.Tuple[str, int, bool, float]: pass# class, 类本身也是一种类型class Action: up: str = "up" down: str = "down"# 指定需求一个action对象的参数def example_8(action_obj: Action) -> Action: pass# 这样在一些枚举参数的场景下,我们也可以使用类作为我们枚举参数的归类def example_9(action_cls: Action) -> Action: pass# 如果上面的枚举参数你觉得并不能很好的实现,那么还是可以使用自定义类型注解的方式去实现Action = strup: Action = "up"down: Action = "down"# 在python3.9 中对枚举参数类型有更好的支持MODE = type.Literal['r', 'rb', 'w', 'wb']def open_file(file: str, mode: MODE) -> str: passopen_file('/some/path', 'r') # 正常open_file('/other/path', 'typo') # 会提示该类型不合法# Type, 在一些多态类的场景下标注同一个类型的不同的形态class User: ...class BasicUser(User): ...class ProUser(User): ...class TeamUser(User): ...# 相当于 typing.Union[User, BasicUser, ProUser, TeamUser]def make_new_user(user_class: typing.Type[User]) -> User: return user_class()
关于python 编码中需要写类型注解的原因是什么就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。