要理解什麼是裝飾器，您首先須要熟悉Python處理函數的方式。從它的觀點來看，函數和對象沒有什麼不一樣。它們有屬性，能夠從新分配:python
def func(): print('hello from func') func() > hello from func new_func = func new_func() > hello from func print(new_func.__name__) > func
此外，你還能夠將它們做爲參數傳遞給其餘函數:編程
def func(): print('hello from func') def call_func_twice(callback): callback() callback() call_func_twice(func) > hello from func > hello from func
如今,咱們介紹裝飾器。裝飾器(decorator)用於修改函數或類的行爲。實現這一點的方法是定義一個返回另外一個函數的函數(裝飾器)。這聽起來很複雜，可是經過這個例子你會理解全部的東西:swift
def logging_decorator(func): def logging_wrapper(*args, **kwargs): print(f'Before {func.__name__}') func(*args, **kwargs) print(f'After {func.__name__}') return logging_wrapper def sum(x, y): print(x + y) sum(2, 5)> Before sum> 7> After sum
讓咱們一步一步來:緩存
首先，咱們在第1行定義logging_decorator函數。它只接受一個參數，也就是咱們要修飾的函數。微信
在內部，咱們定義了另外一個函數:logging_wrapper。而後返回logging_wrapper，並使用它來代替原來的修飾函數。app
在第7行，您能夠看到如何將裝飾器應用到sum函數。機器學習
在第11行，當咱們調用sum時，它不單單調用sum。它將調用logging_wrapper，它將在調用sum以前和以後記錄日誌。編輯器
這很簡單:可讀性。Python因其清晰簡潔的語法而備受讚譽，裝飾器也不例外。若是有任何行爲是多個函數共有的，那麼您可能須要製做一個裝飾器。下面是一些可能會派上用場的例子:函數
在運行時檢查實參類型學習
基準函數調用
緩存功能的結果
計數函數調用
檢查元數據(權限、角色等)
元編程
和更多…
如今咱們將列出一些代碼示例。
帶有返回值的裝飾器
假設咱們想知道每一個函數調用須要多長時間。並且，函數大多數時候都會返回一些東西，因此裝飾器也必須處理它:
def timer_decorator(func): def timer_wrapper(*args, **kwargs): import datetime before = datetime.datetime.now() result = func(*args,**kwargs) after = datetime.datetime.now() print "Elapsed Time = {0}".format(after-before) return result def sum(x, y): print(x + y) return x + y sum(2, 5)> 7> Elapsed Time = some time
能夠看到，咱們將返回值存儲在第5行的result中。但在返回以前，咱們必須完成對函數的計時。這是一個沒有裝飾者就不可能實現的行爲例子。
帶有參數的裝飾器
有時候，咱們想要一個接受值的裝飾器(好比Flask中的@app.route('/login'):
def permission_decorator(permission): def _permission_decorator(func): def permission_wrapper(*args, **kwargs): if someUserApi.hasPermission(permission): result = func(*args, **kwargs) return result return None return permission wrapper return _permission_decorator
def delete_user(user): someUserApi.deleteUser(user)
爲了實現這一點，咱們定義了一個額外的函數，它接受一個參數並返回一個裝飾器。
帶有類的裝飾器
使用類代替函數來修飾是可能的。惟一的區別是語法，因此請使用您更熟悉的語法。下面是使用類重寫的日誌裝飾器:
class Logging: def __init__(self, function): self.function = function def __call__(self, *args, **kwargs): print(f'Before {self.function.__name__}') self.function(*args, **kwargs) print(f'After {self.function.__name__}') def sum(x, y): print(x + y)
sum(5, 2)> Before sum> 7> After sum
這樣作的好處是，您沒必要處理嵌套函數。你所須要作的就是定義一個類並覆蓋__call__方法。
裝飾類
有時，您可能想要修飾類中的每一個方法。你能夠這樣寫
class MyClass: def func1(self): pass def func2(self): pass
但若是你有不少方法，這可能會失控。值得慶幸的是，有一種方法能夠一次性裝飾整個班級:
def logging_decorator(func): def logging_wrapper(*args, **kwargs): print(f'Before {func.__name__}') result = func(*args, **kwargs) print(f'After {func.__name__}') return result return logging_wrapper
def log_all_class_methods(cls): class NewCls(object): def __init__(self, *args, **kwargs): self.original = cls(*args, **kwargs) def __getattribute__(self, s): try: x = super(NewCls,self).__getattribute__(s) except AttributeError: pass else: return x x = self.original.__getattribute__(s) if type(x) == type(self.__init__): return logging_decorator(x) else: return x return NewCls class SomeMethods: def func1(self): print('func1') def func2(self): print('func2') methods = SomeMethods()methods.func1()> Before func1> func1> After func1
如今，不要驚慌。這看起來很複雜，但邏輯是同樣的:
首先，咱們讓logging_decorator保持原樣。它將應用於類的全部方法。
而後咱們定義一個新的裝飾器:log_all_class_methods。它相似於普通的裝飾器，但卻返回一個類。
NewCls有一個自定義的__getattribute__。對於對原始類的全部調用，它將使用logging_decorator裝飾函數。
內置的修飾符
您不只能夠定義本身的decorator，並且在標準庫中也提供了一些decorator。我將列出與我一塊兒工做最多的三我的:
@property -一個內置插件的裝飾器，它容許你爲類屬性定義getter和setter。
@lru_cache - functools模塊的裝飾器。它記憶函數參數和返回值，這對於純函數(如階乘)很方便。
@abstractmethod——abc模塊的裝飾器。指示該方法是抽象的，且缺乏實現細節。
·END·
機器學習·數據分析
本文分享自微信公衆號 - Python學會（gh_39aead19f756）。
若有侵權，請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」，歡迎正在閱讀的你也加入，一塊兒分享。