python 编码中为什么要写类型注解?
作者:ShadwoYD
1、背景
我们先谈谈为什么在Python编码过程中强烈推荐使用类型注解 ?
Python对于初学者来说是非常好上手,原因是在于对计算机底层原理的高度封装和动态语言的特性使得Python用起来非常的舒适。但这种“舒适”是有代价的,我们可能听说过一句形容动态语言的话,动态一时爽,一直动态一直爽。为什么会这么说?动态的确会赋予我们在编码时更多的灵活性与能力,但是动态带来的是更多的不确定性及混乱,导致了后来的维护者甚至作者自己都会产生很大的维护压力(可以想象一个经过几年迭代的复杂系统,如果大部分都使用动态的方式来编写代码的样子),正所谓能力越大责任越大,需要进行克制;
而类型注解能很好的帮我们在维护与开发时,理清变量类型降低不确定性和混乱度,并且从容的使用变量。在这里废话了这么多,主要是为了能让读者能深刻意识到动态带来的正反方向带来的“爽”。后面进入正题;
2、使用方式
2.1、 Python3内置的类型注解
内置注解肯能大家都接触过,但总感觉很麻烦,导致后面很容易就放弃写注解,这是因为得到不正反馈,看如下示例:
a: str = "aa" b: int = 1 # 参数和返回标注了类型,那么接下来调用时就能进行提示 def example(a: str) -> str: return f"Hello {a}" pirnt(example("world")) # # 一些简单的标注,看起来起不到效果,但如果换个有含义的名字呢 User = str Age = int Answer = str def say_hello(u: User) -> Answer: return f"Hello {u}" print(say_hello("Shadow"))
上面简单演示了内置的类型注解是如何使用的,但是其实这么简单的类型注解并不能帮助我们很好的标注变量;下面介绍一个typing模块
2.2、typing 模块的快速入门
typing 模块是类型注解的主角,Python运行时不强制执行函数和变量类型注解,但这些注解可用于类型检查器、IDE、静态检查器等第三方工具。这些第三方工具会在我们编码时进行提示与纠错;
下面提供一些日常使用到的方法与用例给大家参考:
import typing # 自定义类型注解 User = str Age = 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,第二个为value def 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, float def 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 = str up: Action = "up" down: Action = "down" # 在python3.9 中对枚举参数类型有更好的支持 MODE = type.Literal['r', 'rb', 'w', 'wb'] def open_file(file: str, mode: MODE) -> str: pass open_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()
以上十几个用例场景基本能覆盖大部分日常编码,如果还有一些别的需求可参考官方的文档,上面有明确的说明;
Docs: docs.python.org/zh-cn/3/lib…
3、写在最后
希望文章能对大家对类型注解的了解与使用有所帮助,早日脱离被动态绕得心里“骂娘”与找不到"娘"的日子。
以上就是python 编码中为什么要写类型注解?的详细内容,更多关于python 类型注解的资料请关注脚本之家其它相关文章!