快捷導(dǎo)航

Python 裝飾器原理、定義與用法詳解

更新時(shí)間：2019年12月07日 10:18:31 作者：code_designer

這篇文章主要介紹了Python 裝飾器原理、定義與用法,結(jié)合實(shí)例形式分析了Python裝飾器的概念、定義、實(shí)現(xiàn)方法、應(yīng)用場(chǎng)景及相關(guān)操作注意事項(xiàng),需要的朋友可以參考下

本文實(shí)例講述了Python 裝飾器原理、定義與用法。分享給大家供大家參考，具體如下：

Python 裝飾器

一、何為裝飾器

1、在函數(shù)中定義函數(shù)

在函數(shù)中定義另外的函數(shù)，就是說(shuō)可以創(chuàng)建嵌套的函數(shù)，例子如下

def sayHi(name="hjj2"):
 print 'inside sayHi() func'
 def greet():
  return 'inside greet() func'
 print(greet())
sayHi()
#output
#  inside sayHi() func
#  inside greet() func

2、將函數(shù)作為參數(shù)傳給另外一個(gè)函數(shù)，裝飾器原型

def sayHi():
 return 'hi hjj2'
def doSthBeforeSayHi(func):
 print 'before sayHi func'
 print(func())
doSthBeforeSayHi(sayHi)
#output
#  before sayHi func
#  hi hjj2

3、實(shí)現(xiàn)一個(gè)裝飾器

在第二步中，我們已經(jīng)基本探究到裝飾器的原理了，python裝飾器做的事就是通過(guò)封裝一個(gè)函數(shù)并且用這樣或那樣的方式來(lái)修改它的行為。不帶@的初步示例如下：

def new_decorator(func):
  def wrapDecorator():
   print 'before func'
   func()
   print 'after func'
  return wrapDecorator
def func_require_decorator():
  print 'a func need decorator'
func_require_decorator()
#ouput: a func need decorator
func_require_decorator = new_decorator(func_require_decorator)
func_require_decorator()
#ouput:
#  before func
#  a func need decorator
#  after func

使用@來(lái)運(yùn)行裝飾器

@new_decorator
func_require_decorator()
#ouput:
#  before func
#  a func need decorator
#  after func

這里我們可以看到，這兩個(gè)例子的運(yùn)行結(jié)果是一樣的。所以我們能想象得到@new_decorator的作用就是

func_require_decorator = new_decorator(func_require_decorator)

我們繼續(xù)優(yōu)化這個(gè)裝飾器，現(xiàn)在我們有一個(gè)問(wèn)題就是，如果我們想要通過(guò)print(func_require_decorator.__name__)就會(huì)報(bào)錯(cuò)# Output: wrapTheFunction。這樣就需要借助python提供的functools.wraps來(lái)解決了

@wraps接受一個(gè)函數(shù)來(lái)進(jìn)行裝飾，并加入了復(fù)制函數(shù)名稱、注釋文檔、參數(shù)列表等等的功能。這可以讓我們?cè)谘b飾器里面訪問(wèn)在裝飾之前的函數(shù)的屬性。

from functools import wraps
def new_decorator(func):
  @wraps(func)
  def wrapDecorator():
   print 'before func'
   func()
   print 'after func'
  return wrapDecorator
def func_require_decorator():
  print 'a func need decorator'
@new_decorator
func_require_decorator()
print(func_require_decorator.__name__)
#ouput: func_require_decorator

二、使用場(chǎng)景

1、授權(quán)，大體例子

from functools import wraps
def requires_auth(f):
  @wraps(f)
  def decorated(*args, **kwargs):
    auth = request.authorization
    if not auth or not check_auth(auth.username, auth.password):
      authenticate()
    return f(*args, **kwargs)
  return decorated

2、日志：

from functools import wraps
def logit(logfile='out.log'):
  def logging_decorator(func):
    @wraps(func)
    def wrapped_function(*args,**kwargs):
      log_string = func.__name__+"was called"
      print(log_string)
      with open(logfile,'a') as opened_file:
        opened_file.write(log_string+'\n')
      return func(*args,**kwargs)
    return wrapped_function
  return logging_decorator
@logit()
def func1():
  pass
func1()

3、其他如flask中的@app.route()

三、裝飾器類(lèi)

1、將上面的日志裝飾器變?yōu)轭?lèi)的初步模型如下

from functools import wraps
class logit(object):
  def __init__(self, logfile='out.log'):
    self.logfile = logfile
  def __call__(self, func):
    @wraps(func)
    def wrapped_function(*args, **kwargs):
      log_string = func.__name__ + "was called"
      print(log_string)
      # 打開(kāi)logfile并寫(xiě)入
      with open(self.logfile, 'a') as open_file:
        # 將日志寫(xiě)到指定文件
        open_file.write(log_string + '\n')
      # 發(fā)送一個(gè)通知
      self.notify()
      return func(*args, **kwargs)
    return wrapped_function
  def notify(self):
    pass
@logit()
def myfunc1():
  pass
class email_logit(logit):
  '''
  實(shí)現(xiàn)在函數(shù)調(diào)用時(shí)發(fā)送email
  '''
  def __init__(self, email='admin@xxx.com', *args, **kwargs):
    self.email = email
    super(email_logit, self).__init__(*args, **kwargs)
  def notify(self):
    '''
    發(fā)送郵件通知
    '''
    pass

通過(guò)這種方式，我們可以定義我們?cè)谧约旱男枨?，減少代碼的冗余，提高復(fù)用率。

至此，關(guān)于裝飾器的探索就結(jié)束啦。

更多關(guān)于Python相關(guān)內(nèi)容感興趣的讀者可查看本站專(zhuān)題：《Python面向?qū)ο蟪绦蛟O(shè)計(jì)入門(mén)與進(jìn)階教程》、《Python數(shù)據(jù)結(jié)構(gòu)與算法教程》、《Python函數(shù)使用技巧總結(jié)》、《Python字符串操作技巧匯總》、《Python編碼操作技巧總結(jié)》及《Python入門(mén)與進(jìn)階經(jīng)典教程》

希望本文所述對(duì)大家Python程序設(shè)計(jì)有所幫助。

您可能感興趣的文章: