Python入门篇-类型注解

　　　　　　　　　　　　　　Python入门篇-类型注解

　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　作者：尹正杰

版权声明：原创作品，谢绝转载！否则将追究法律责任。

一.函数定义的弊端

1>.动态语言很灵活，但是这种特性也是弊端

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

2>.如何解决这种动态语言定义的弊端

增加文档Documentation String
　　这只是一个惯例，不是强制标准，不能要求程序员一定为函数提供说明文档
　　函数定义更新了，文档未必同步更新
　　　　def add(x, y):
　　　　　　'''
　　　　　　:param x: int
　　　　　　:param y: int
　　　　　　:return: int
　　　　'''
　　　　return x + y
　　　　print(help(add))

3>.函数注解

#！/usr/bin/env python
#_*_coding:utf-8_*_
#@author :yinzhengjie
#blog:http://www.cnblogs.com/yinzhengjie/tag/python%E8%87%AA%E5%8A%A8%E5%8C%96%E8%BF%90%E7%BB%B4%E4%B9%8B%E8%B7%AF/
#EMAIL:y1053419035@qq.com


def add(x:int , y:int) -> int :
    '''
    :param x: int
    :param y: int
    :return: int
    '''
    return x + y

print(help(add))
print(add(4, 5))
print(add('Yin', 'zhengjie'))




#以上代码执行结果如下:
Help on function add in module __main__:

add(x:int, y:int) -> int
    :param x: int
    :param y: int
    :return: int

None
9
Yinzhengjie

二.函数注解Function Annotations

1>.函数注解

　　Python 3.5引入
　　对函数的参数进行类型注解
　　对函数的返回值进行类型注解
　　只对函数参数做一个辅助的说明，并不对函数参数进行类型检查
　　提供给第三方工具，做代码分析，发现隐藏的bug
　　函数注解的信息，保存在__annotations__属性中

2>.变量注解

Python 3.6引入变量注解
　　i : int = 3

三.业务应用-函数参数类型检查

1>.思路

　　函数参数的检查，一定是在函数外
　　函数应该作为参数，传入到检查函数中
　　检查函数拿到函数传入的实际参数，与形参声明对比
　　__annotations__属性是一个字典，其中包括返回值类型的声明。假设要做位置参数的判断，无法和字典中的声明对应。使用inspect模块

2>.inspet模块

#！/usr/bin/env python
#_*_coding:utf-8_*_
#@author :yinzhengjie
#blog:http://www.cnblogs.com/yinzhengjie/tag/python%E8%87%AA%E5%8A%A8%E5%8C%96%E8%BF%90%E7%BB%B4%E4%B9%8B%E8%B7%AF/
#EMAIL:y1053419035@qq.com

import inspect
"""
signature(callable):
    获取签名（函数签名包含了一个函数的信息，包括函数名、它的参数类型、它所在的类和名称空间及其他信息）
"""

def add(x:int, y:int, *args,**kwargs) -> int:
    return x + y

print(add.__annotations__)                 #不推荐使用它，返回的结果是无序的

sig = inspect.signature(add)
print(sig, type(sig))                        # 函数签名
print('params : ', sig.parameters)          # OrderedDict,即返回的结果是一个有序字典
print('return : ', sig.return_annotation)
print(sig.parameters['y'], type(sig.parameters['y']))
print(sig.parameters['x'].annotation)
print(sig.parameters['args'])
print(sig.parameters['args'].annotation)
print(sig.parameters['kwargs'])
print(sig.parameters['kwargs'].annotation)
print("是否是函数：{}".format(inspect.isfunction(add)))
print("是否是类的方法：{}".format(inspect.ismethod(add)))
print("是否是生成器对象：{}".format(inspect.isgenerator(add)))
print("是否是生成器函数：{}".format(inspect.isgeneratorfunction(add)))
print("是否是类：{}".format(inspect.isclass(add)))
print("是否是模块：{}".format(inspect.ismodule(inspect)))
print("是否是内建对象：{}".format(inspect.isbuiltin(print)))            #还有很多is函数，需要的时候查阅inspect模块帮助




#以上代码执行结果如下:
{'x': <class 'int'>, 'y': <class 'int'>, 'return': <class 'int'>}
(x:int, y:int, *args, **kwargs) -> int <class 'inspect.Signature'>
params :  OrderedDict([('x', <Parameter "x:int">), ('y', <Parameter "y:int">), ('args', <Parameter "*args">), ('kwargs', <Parameter "**kwargs">)])
return :  <class 'int'>
y:int <class 'inspect.Parameter'>
<class 'int'>
*args
<class 'inspect._empty'>
**kwargs
<class 'inspect._empty'>
是否是函数：True
是否是类的方法：False
是否是生成器对象：False
是否是生成器函数：False
是否是类：False
是否是模块：True
是否是内建对象：True

#！/usr/bin/env python
#_*_coding:utf-8_*_
#@author :yinzhengjie
#blog:http://www.cnblogs.com/yinzhengjie/tag/python%E8%87%AA%E5%8A%A8%E5%8C%96%E8%BF%90%E7%BB%B4%E4%B9%8B%E8%B7%AF/
#EMAIL:y1053419035@qq.com

import inspect
"""
Parameter对象
    保存在元组中，是只读的
    name，参数的名字
    annotation，参数的注解，可能没有定义
    default，参数的缺省值，可能没有定义
    empty，特殊的类，用来标记default属性或者注释annotation属性的空值
    kind，实参如何绑定到形参，就是形参的类型
        POSITIONAL_ONLY，值必须是位置参数提供
        POSITIONAL_OR_KEYWORD，值可以作为关键字或者位置参数提供
        VAR_POSITIONAL，可变位置参数，对应*args
        KEYWORD_ONLY，keyword-only参数，对应*或者*args之后的出现的非可变关键字参数
        VAR_KEYWORD，可变关键字参数，对应**kwargs
"""

def add(x, y:int=7, *args, z, t=10,**kwargs) -> int:
    return x + y

sig = inspect.signature(add)
print(sig)
print('params : ', sig.parameters) # 有序字典
print('return : ', sig.return_annotation)
print("*" * 20 + "我是分割线" + "*" * 20)

for i, item in enumerate(sig.parameters.items()):
    name, param = item
    print(i+1, name, param.annotation, param.kind, param.default)
    print(param.default is param.empty, end='

')



#以上代码执行结果如下:
(x, y:int=7, *args, z, t=10, **kwargs) -> int
params :  OrderedDict([('x', <Parameter "x">), ('y', <Parameter "y:int=7">), ('args', <Parameter "*args">), ('z', <Parameter "z">), ('t', <Parameter "t=10">), ('kwargs', <Parameter "**kwargs">)])
return :  <class 'int'>
********************我是分割线********************
1 x <class 'inspect._empty'> POSITIONAL_OR_KEYWORD <class 'inspect._empty'>
True

2 y <class 'int'> POSITIONAL_OR_KEYWORD 7
False

3 args <class 'inspect._empty'> VAR_POSITIONAL <class 'inspect._empty'>
True

4 z <class 'inspect._empty'> KEYWORD_ONLY <class 'inspect._empty'>
True

5 t <class 'inspect._empty'> KEYWORD_ONLY 10
False

6 kwargs <class 'inspect._empty'> VAR_KEYWORD <class 'inspect._empty'>
True

3>.小试牛刀

有函数如下
　　def add(x, y:int=7) -> int:
　　　　return x + y
　　
请检查用户输入是否符合参数注解的要求？

思路
　　调用时，判断用户输入的实参是否符合要求
　　调用时，用户感觉上还是在调用add函数
　　对用户输入的数据和声明的类型进行对比，如果不符合，提示用户

#！/usr/bin/env python
#_*_coding:utf-8_*_
#@author :yinzhengjie
#blog:http://www.cnblogs.com/yinzhengjie/tag/python%E8%87%AA%E5%8A%A8%E5%8C%96%E8%BF%90%E7%BB%B4%E4%B9%8B%E8%B7%AF/
#EMAIL:y1053419035@qq.com

import inspect

def check(fn):
    def wrapper(*args, **kwargs):
        sig = inspect.signature(fn)
        params = sig.parameters
        values = list(params.values())
        for i,p in enumerate(args):
            param = values[i]
            if param.annotation is not param.empty and not isinstance(p, param.annotation):
                print(p,'!==',values[i].annotation)
        for k,v in kwargs.items():
            if params[k].annotation is not inspect._empty and not isinstance(v, params[k].annotation):
                print(k,v,'!===',params[k].annotation)
        return fn(*args, **kwargs)
    return wrapper

@check
def add(x, y:int=7) -> int:         #我们要求第二个参数必须是int类型,并且返回值类型也为int
    return x + y

print(add(2,1))
print(add(20,y=10))
print(add(y=100,x=200))
print(add("Yin","zhengjie"))        #我们在实际传参时故意不按照要求传参，发现会有相应的提示信息



#以上代码执行结果如下:
3
30
300
zhengjie !== <class 'int'>
Yinzhengjie