淺析裝飾器的那些事兒
一、裝飾器的簡單定義
外層函數返回里層函數的引用,里層函數引用外層函數的變量。
二、裝飾器的作用
通俗來講裝飾器的作用就是在不改變已有函數代碼前提下,為該函數增加新的功能。
- def run():
- print('我會跑')
- fun()
現在我想在原有函數的基礎上新增一個功能:我會唱歌。這個時候利用裝飾器則輕松可以幫我們實現這個功能。
三、實例理解
(1)不傳參的裝飾器
- def outer(fun):
- def inner():
- fun() //fun是外層函數的變量,在inner里面用
- return inner //inner就是里層函數的引用
(2)傳遞參數的裝飾器:
- def func(fun):
- def add(*args,**kwarge):
- return fun(*args,**kwargs)
- return add
現在對于裝飾器的基本格式有一定的了解,就可以直接寫函數了。下面實現文章開頭的 我會唱歌 的功能
- def outer(fun):
- def inner(*args, **kwarge):
- print("我會唱歌")
- return fun(*args, **kwarge)
- return inner
四、如何使用裝飾器
- 方法一:使用@符號+裝飾器的名字 把它放在想要裝飾函數的上一行即可
- @outer
- def run():
- print('我會跑')
- run()
- 方法二:
- def run():
- print('我會跑')
- run=outer(run) #就等價于@outer
- run()
- 最終打印結果是:
- 我會唱歌
- 我會跑
如果我想知道fun 傳遞的參數是什么,在裝飾器內部可以使用如下方式:
- def outer(fun):
- a = 1
- def inner(*args, **kwarge): # args是一個數組,kwargs一個字典
- print(fun.__name__) #打印fun接收的函數的名字
- print("我會唱歌")
- return fun(*args, **kwarge)
- return inner
但是如果我們 print(run.__name__,6666666) 輸出的結果是inner,并不是我們想要的run,這里的函數被warpTheFunction替代了。它重寫了我們函數的名字和注釋文檔(docstring)。解決方法如下:
- from functools import wraps
- def outer(fun):
- @wraps(fun)
- def inner(*args, **kwargs):
- print(fun.__name__,11111111111)
- print("我會唱歌")
- return fun(*args, **kwargs)
- return inner
- @outer
- def run():
- print('我會跑')
- print(run.__name__,6666666) //輸出結果為 run 666666
五、自己實現裝飾器
- def subuser_keymanage(view_func):
- '''功能是實現用戶管理權限的判定'''
- def _wrapper_view(request, *args, **kwargs):
- user = request.user #一個Customer對象,包含了用戶名/密碼等信息
- customer = user.customer.customer_id #用戶的id
- select_status = get_curuser_permission(user=user, customer=customer)#調用函數返回的值有兩種0和1
- if not select_status:#如果返回0表示沒有權限,返回錯誤碼
- return render_response(request, ErrorCode.FAILED)
- return view_func(request, *args, **kwargs)
- return _wrapper_view
- @subuser_keymanage
- def generate_subuser_ak_sk(request):
- params = json.loads(request.body) #獲取卡前端傳遞的參數
- user_id_only = params.get("user_id") #獲取用戶表示id值
- 中間代碼就忽略了......
- return render_response(request, ErrorCode.FAILED)
六、裝飾器小結
通過裝飾器很大程度上可以減少代碼的復用,在代碼規范中這一點是很重要的。
以上就是裝飾器的基本知識,即便沒有任何基礎,按照作者的思路,套用固定的格式,不需要完全理解,只要按照流程一步一步就能寫出高端大氣上檔次的裝飾器了,恭喜你!
前方高能請注意:裝飾器傳參,三層嵌套函數一般用的比較少,其實也不難,一層一層看,跟上文講的一樣,僅作為知識的拓寬。
- import logging
- def use_logging(level):
- def decorator(func):
- def wrapper(*args, **kwargs):
- if level == "warn":
- logging.warn("%s is running" % func.__name__)
- elif level == "info":
- logging.info("%s is running" % func.__name__)
- return func(*args)
- return wrapper
- return decorator
- @use_logging(level="warn")
- def foo(name='foo'):
- print("i am %s" % name)
- foo()
- i am foo
- WARNING:root:foo is running