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:[e-mail]


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:[e-mail]

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:[e-mail]

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='\n\n')



#以上代碼執行結果如下:
(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:[e-mail]

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