Python中裝飾器語法是怎么樣的

這篇文章主要介紹了Python中裝飾器語法是怎么樣的，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

Python中裝飾器語法詳解

裝飾器是python里的一個非常有意思的部分，他用于封裝函數代碼，顯式的將封裝器應用到被封裝的函數上，從而使得他們選擇加入到裝飾器指定的功能中。對于在函數運行前處理常見前置條件（例如確認授權），或在函數運行后確保清理（輸出清除或異常處理），裝飾器都非常有用。

簡單來說，裝飾器就是實現了一個通用的功能，然后將這個通用的功能應用到不同的、需要使用這個功能的函數上，從而避免每次都在不同函數上反復寫相同的功能代碼。

裝飾器的本質是一個函數，他接受被裝飾的函數作為位置參數，裝飾器通過使用該參數來執行某些操作，然后返回一個函數引用，這個函數可以是原始函數，或者是另外一個函數。

我們舉例子說明，裝飾器是這樣的函數，他們接受被裝飾的可調用函數作為唯一的參數，并且返回一個可調用函數，

registry = [] 

def register(decorated): 

    registry.append(decorated) 

    return decorated 

def foo(): 

    return 3 

foo = register(foo) 

print(registry[0])

<function foo at 0x00000000025D51E0>

register方法是一個簡單的裝飾器，它把被裝飾的函數添加到一個列表中，然后這里是將未改變的被裝飾函數返回，可以看出，裝飾器一般是傳入被裝飾函數的引用，然后經過一些指定的處理，最后返回值也是一個函數引用。

還有一種更簡單的語法形式：

裝飾器的語法糖：我們這里看到的對foo進行裝飾的方法是運用

foo = register(foo)語句，還有一種簡單的用法是在聲明函數的位置應用裝飾器，從而使得代碼更容易閱讀，并且讓人立刻意識到使用了裝飾器。

registry = []

def register(decorated):

    registry.append(decorated) 

    return decorated

@register 

def foo(x=3): 

    return x 

@register

def bar(x=5): 

    return 5

for func in registry: 

    print(func())

3

5

再看一個更復雜、更一般化的裝飾器函數。裝飾器的本質是在執行原有函數（被裝飾的函數）的同時，再加上一些額外的功能。

def requires_ints(decorated): 

    def inner(*args, **kwargs): 

        kwarg_values = [i for i in kwargs.values()] 

        for arg in list(args) + kwarg_values: 

            if not isinstance(arg, int): 

                raise TypeError('{} only accepts integers as arguments'.format(decorated.__name__)) 

        return decorated(*args, **kwargs) 

    return inner

在這個裝飾器函數requires_ints我們可以看到，他定義了一個內嵌函數inner，這個內嵌函數的參數首先收集被裝飾函數的所有參數，然后對其進行判斷，判斷其是否為整數類型（這就是裝飾器添加的額外功能），然后再調用被裝飾的函數本身，最后將這個內嵌函數返回。因此當我們再用原函數名進行調用的時候，原來的被裝飾函數的引用就能指向這個新的內嵌函數，就能在實現原函數功能的基礎上，加上附加的功能了。

同時，我們再提煉一下這里面的幾個重難點：

第一，requires_ints中，decorated這個變量是內嵌作用域的變量，在他調用退出后，返回的inner函數是可以記住這個變量的。

第二，python不支持函數的參數列表的多態，即一個函數名只能對應唯一的參數列表形式。

第三，在內嵌函數內部調用被裝飾函數的時候，使用了解包參數，關于這args, *kwargs，的參數形式，前面章節中細講過。

那我們也用這個裝飾器來裝飾一個函數。

@requires_ints 

def foo(x,y):

    print(x+y) 

foo(3,5) 

8

這里將名稱foo賦給inner函數，而不是賦給原來被定義的函數，如果運行foo（3,5），將利用傳入的這兩個參數運行inner函數，inner函數執行類型檢查，然后運行被裝飾方法，如果傳入的不是整形數，例如下面這個例子，那么裝飾器的附加功能就會進行類型檢查：

@requires_ints 

def foo(x,y): 

    print(x+y)

foo('a',5) 

Traceback (most recent call last): 

  File "E:/12homework/12homework.py", line 15, in <module>

    foo('a',5) 

  File "E:/12homework/12homework.py", line 7, in inner 

raise TypeError('{} only accepts integers as arguments'.format(decorated.__name__)) 

TypeError: foo only accepts integers as arguments

其次內嵌的函數和被裝飾的函數的參數形式必須完全一樣，這里用的args, *kwargs概況函數參數的一般形式，因此也是完全對應的。

最后說說裝飾器參數

最后來介紹這個復雜一些的話題，裝飾器參數。之前我們列舉的常規例子里，裝飾器只有一個參數，就是被裝飾的方法。但是，有時讓裝飾器自身帶有一些需要的信息，從而使裝飾器可以用恰當的方式裝飾方法十分有用。

這些參數并不是和被裝飾的函數并列作為參數簽名，而是在原有裝飾器的基礎上額外再增加一層封裝，那么，實質是這個接受其他參數的裝飾器并不是一個實際的裝飾器，而是一個返回裝飾器的函數。

最終返回的內嵌函數inner是最終使用indent和sort_keys參數的函數，這沒有問題

import json

def json_output(indent=None, sort_keys=False): 

    def actual_decorator(decorated): 

        def inner(*args, **kwargs): 

            result = decorated(*args, **kwargs)

            return json.dumps(result, indent=indent, sort_keys=sort_keys) 

        return inner 

    return actual_decorator 

@json_output(indent=8)

def do_nothing(): 

    return {'status':'done','func':'yes'} 

print(do_nothing())

{

        "status": "done",

        "func": "yes"

}

我們在這里詳細解釋說明的是操作順序，看上去我們使用的是@jsonoutput(indent=8)，作這和之前的裝飾器語法糖看上去有些不同，實際上這個不是最終的裝飾器函數，通過調用jsonoutput(indent=8)，返回函數指針actual_decorator，這個函數才是真正放在@后的裝飾器函數，原始的被裝飾函數最終獲得了內涵更豐富的inner函數對象，完成了裝飾過程，值得一提的是，所謂的裝飾器參數最終傳給了最內層的inner函數。

記住，在定義裝飾器函數后，真正的裝飾器函數只有一個參數，那就是被裝飾的函數指針，而有其他參數的函數實質上只是裝飾器的外圍函數，他可以依據參數對裝飾器進行進一步的定制。一句話：一個函數不可能接受被裝飾的方法，又接受其他參數

在語法糖中@func這種不帶括號的，就是直接使用裝飾器函數進行裝飾，如果是@func()帶括號的，實質上是先調用func()函數返回真正的裝飾器，然后再用@進行調用。

感謝你能夠認真閱讀完這篇文章，希望小編分享的“Python中裝飾器語法是怎么樣的”這篇文章對大家有幫助，同時也希望大家多多支持億速云，關注億速云行業資訊頻道，更多相關知識等著你來學習!