Python 函数注解随性笔记)

本文主要是介绍Python 函数注解随性笔记)，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Python 函数注解随性笔记

1、Python 函数定义的弊端
2、函数定义的弊端的解决方法
- 2.1 增加文档 Documentation String
- 2.1 增加函数注解 Function Annotations
3、业务应用

1、Python 函数定义的弊端

Python 是动态语言，变量随时可以被赋值，且能赋值为不同的类型
Python 不是静态编译语言，变量类型实在运行期决定的
动态语言很灵活，但是这种特性也是弊端
- 难发现：由于不做任何类型检查，知道运行期问题才显现出来，或者线上运行时才能暴露出问题
- 难使用：函数的使用者看到函数的时候，并不知道你的函数设计，并不知道应该传入什么类型的数据

请看以下例子：

def add(x, y):return x + yprint(add(3, 5))
print(add('hello', 'world'))
print(add('hello', 5))

8
helloworld
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-238-6e69a92ee60e> in <module>4 print(add(3, 5))5 print(add('hello', 'world'))
----> 6 print(add('hello', 5))<ipython-input-238-6e69a92ee60e> in add(x, y)1 def add(x, y):
----> 2     return x + y3 4 print(add(3, 5))5 print(add('hello', 'world'))TypeError: can only concatenate str (not "int") to str

2、函数定义的弊端的解决方法

如何解决这种动态语言定义的弊端呢？有以下两种方法。

2.1 增加文档 Documentation String

这只是一个惯例，不是强制标准，不能要求程序员一定要为函数提供说明文档

函数定义更新了，文档未必同步更新

def add(x, y):""":param x:int:param y: int:return: int"""return x + yprint(help(add))

Help on function add in module __main__:add(x, y):param x:int:param y: int:return: intNone

2.1 增加函数注解 Function Annotations

Python 3.5 引入
对函数的参数进行类型注解
对函数的返回值进行类型注解
只对函数参数做一个辅助的说明，并不对函数参数进行类型检查
提供给第三方工具做代码分析，发现隐藏bug
函数注解的信息，保存在 __annotations__ 属性中
Python 3.6 引入变量注解。注意它也只是对变量的说明，非强制 i:int = 5
类型不一样时，解释器会着色，但是不影响执行

在这里插入图片描述

def add(x:int, y:int) -> int:""":param x:int:param y: int:return: int"""return x + yprint(help(add))
print(add.__annotations__)

Help on function add in module __main__:add(x: int, y: int) -> int:param x:int:param y: int:return: intNone
{'x': <class 'int'>, 'y': <class 'int'>, 'return': <class 'int'>}Process finished with exit code 0