快捷導(dǎo)航

python中的裝飾器該如何使用

更新時(shí)間：2021年06月17日 17:11:17 作者：zhangkun

裝飾器經(jīng)常被用于有切面需求的場景，較為經(jīng)典的有插入日志、性能測試、事務(wù)處理等。裝飾器是解決這類問題的絕佳設(shè)計(jì)，有了裝飾器，我們就可以抽離出大量函數(shù)中與函數(shù)功能本身無關(guān)的雷同代碼并繼續(xù)重用。裝飾器的作用就是為已經(jīng)存在的對(duì)象添加額外的功能。

1. 需求是怎么來的
2. 以不變應(yīng)萬變，是變也
3. 最大限度地少改動(dòng)
4.對(duì)帶參數(shù)的函數(shù)使用裝飾器
5. 給裝飾器參數(shù)
6.帶類參數(shù)的裝飾器
7. 對(duì)一個(gè)函數(shù)應(yīng)用多個(gè)裝飾器
8. 作為一個(gè)類

1. 需求是怎么來的

裝飾器的定義很是抽象，我們來看一個(gè)小例子。

def foo():
    print('in foo()')
foo()

這是一個(gè)很無聊的函數(shù)沒錯(cuò)。但是突然有一個(gè)更無聊的人，我們稱呼他為B君，說我想看看執(zhí)行這個(gè)函數(shù)用了多長時(shí)間，好吧，那么我們可以這樣做：

import time

def foo():
    start = time.time()
    print('in foo()')
    time.sleep(2)
    end = time.time()
    print(f'used:{end - start}')

foo()

很好，功能看起來無懈可擊?？墒堑疤鄣腂君此刻突然不想看這個(gè)函數(shù)了，他對(duì)另一個(gè)叫foo2的函數(shù)產(chǎn)生了更濃厚的興趣。

怎么辦呢？如果把以上新增加的代碼復(fù)制到foo2里，這就犯了大忌了~復(fù)制什么的難道不是最討厭了么！而且，如果B君繼續(xù)看了其他的函數(shù)呢？

2. 以不變應(yīng)萬變，是變也

還記得嗎，函數(shù)在Python中是一等公民，那么我們可以考慮重新定義一個(gè)函數(shù)timeit，將foo的引用傳遞給他，然后在timeit中調(diào)用foo并進(jìn)行計(jì)時(shí)，這樣，我們就達(dá)到了不改動(dòng)foo定義的目的，而且，不論B君看了多少個(gè)函數(shù)，我們都不用去修改函數(shù)定義了！

import time

def foo():
    print('in foo()')

def timeit(func):
    start = time.time()
    func()
    time.sleep(2)
    end = time.time()
    print('used:', end - start)

timeit(foo)

看起來邏輯上并沒有問題，一切都很美好并且運(yùn)作正常！……等等，我們似乎修改了調(diào)用部分的代碼。原本我們是這樣調(diào)用的：foo()，修改以后變成了：timeit(foo)。這樣的話，如果foo在N處都被調(diào)用了，你就不得不去修改這N處的代碼?；蛘吒鼧O端的，考慮其中某處調(diào)用的代碼無法修改這個(gè)情況，比如：這個(gè)函數(shù)是你交給別人使用的。

3. 最大限度地少改動(dòng)

既然如此，我們就來想想辦法不修改調(diào)用的代碼；如果不修改調(diào)用代碼，也就意味著調(diào)用foo()需要產(chǎn)生調(diào)用timeit(foo)的效果。我們可以想到將timeit賦值給foo，但是timeit似乎帶有一個(gè)參數(shù)……想辦法把參數(shù)統(tǒng)一吧！如果timeit(foo)不是直接產(chǎn)生調(diào)用效果，而是返回一個(gè)與foo參數(shù)列表一致的函數(shù)的話……就很好辦了，將timeit(foo)的返回值賦值給foo，然后，調(diào)用foo()的代碼完全不用修改！

# -*- coding: UTF-8 -*-
import time

def foo():
    print('in foo()')

# 定義一個(gè)計(jì)時(shí)器，傳入一個(gè)，并返回另一個(gè)附加了計(jì)時(shí)功能的方法
def timeit(func):
    # 定義一個(gè)內(nèi)嵌的包裝函數(shù)，給傳入的函數(shù)加上計(jì)時(shí)功能的包裝
    def wrapper():
        start = time.time()
        func()
        time.sleep(2)
        end = time.time()
        print('used:', end - start)

    # 將包裝后的函數(shù)返回
    return wrapper

foo = timeit(foo)
foo()

這樣，一個(gè)簡易的計(jì)時(shí)器就做好了！我們只需要在定義foo以后調(diào)用foo之前，加上foo = timeit(foo)，就可以達(dá)到計(jì)時(shí)的目的，這也就是裝飾器的概念，看起來像是foo被timeit裝飾了。在在這個(gè)例子中，函數(shù)進(jìn)入和退出時(shí)需要計(jì)時(shí)，這被稱為一個(gè)橫切面(Aspect)，這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。與傳統(tǒng)編程習(xí)慣的從上往下執(zhí)行方式相比較而言，像是在函數(shù)執(zhí)行的流程中橫向地插入了一段邏輯。在特定的業(yè)務(wù)領(lǐng)域里，能減少大量重復(fù)代碼。面向切面編程還有相當(dāng)多的術(shù)語，這里就不多做介紹，感興趣的話可以去找找相關(guān)的資料。

這個(gè)例子僅用于演示，并沒有考慮foo帶有參數(shù)和有返回值的情況，完善它的重任就交給你了：）

上面這段代碼看起來似乎已經(jīng)不能再精簡了，Python于是提供了一個(gè)語法糖來降低字符輸入量。

import time


def timeit(func):
    def wrapper():
        start = time.time()
        func()
        time.sleep(2)
        end = time.time()
        print('used:', end - start)

    return wrapper


@timeit
def foo():
    print('in foo()')


foo()

重點(diǎn)關(guān)注第11行的@timeit，在定義上加上這一行與另外寫foo = timeit(foo)完全等價(jià)，千萬不要以為@有另外的魔力。除了字符輸入少了一些，還有一個(gè)額外的好處：這樣看上去更有裝飾器的感覺。

看到這里其實(shí)你也明白了,python 中的裝飾器本質(zhì)上就是一個(gè)函數(shù),這個(gè)函數(shù)接收其他的函數(shù)作為參數(shù),并將其以一個(gè)全新的修改后的函數(shù)替換它。

4.對(duì)帶參數(shù)的函數(shù)使用裝飾器

如果要包裝的函數(shù)有參數(shù)，也不麻煩，只要內(nèi)嵌包裝函數(shù)的形參和返回值與原函數(shù)相同，裝飾函數(shù)返回內(nèi)嵌包裝函數(shù)對(duì)象就可以啦

import datetime,time

def out(func):
    def inner(*args):
        start = datetime.datetime.now()
        func(*args)
        end = datetime.datetime.now()
        print(end-start)
        print("out and inner")
    return inner

@out
def myfunc(*args):
    time.sleep(1)
    print("args is{}".format(args))

myfunc("lalalal")

5. 給裝飾器參數(shù)

給裝飾器傳參也不難，和上一示例相比在外層多了一層包裝而已

#coding:utf-8
def outermost(*args):
	def out(func):
		print ("裝飾器參數(shù){}".format(args))
		def inner(*args):
			print("innet start")
			func(*args)
			print ("inner end")
		return inner
	return out

@outermost(666)
def myfun(*args):
	print ("試試裝飾器和函數(shù)都帶參數(shù)的情況,被裝飾的函數(shù)參數(shù){}".format(args))

myfun("zhangkun")

6.帶類參數(shù)的裝飾器

參數(shù)是什么類型其實(shí)都不影響的，你看，參數(shù)是個(gè)類也一樣的

class locker:
    def __init__(self):
        print("locker.__init__() should be not called")

    @staticmethod
    def acquire():
        print("locker.acquire() static method be called")

    @staticmethod
    def release():
        print("locker.release() static method be called")

def outermost(cls):
    def out(func):
        def inner():
            cls.acquire()
            func()
            cls.release()
        return inner
    return out

@outermost(locker)
def myfunc():
    print("myfunc called")

myfunc()

7. 對(duì)一個(gè)函數(shù)應(yīng)用多個(gè)裝飾器

一個(gè)函數(shù)可以擁有多個(gè)裝飾器，但是要注意順序

class mylocker:
    def __init__(self):
        print("mylocker.__init__() called.")

    @staticmethod
    def acquire():
        print("mylocker.acquire() called.")

    @staticmethod
    def unlock():
        print("  mylocker.unlock() called.")

class lockerex(mylocker):
    @staticmethod
    def acquire():
        print("lockerex.acquire() called.")

    @staticmethod
    def unlock():
        print("  lockerex.unlock() called.")

def lockhelper(cls):
    def _deco(func):
        def __deco2(*args, **kwargs):
            print("before %s called." % func.__name__)
            cls.acquire()
            try:
                return func(*args, **kwargs)
            finally:
                cls.unlock()
        return __deco2
    return _deco

class example:
    @lockhelper(mylocker)
    @lockhelper(lockerex)
    def myfunc2(self, a, b):
        print(" myfunc2() called.")
        print(a+b)

a = example()
a.myfunc2(1,2)

8. 作為一個(gè)類

雖然裝飾器幾乎總是可以用函數(shù)實(shí)現(xiàn),但是在某些情況下,使用用戶自定義的類可能會(huì)更好

import time


class DerocatorAsClass:
    def __init__(self,funcation):
        self.funcation = funcation

    def __call__(self, *args, **kwargs):
        # 調(diào)用函數(shù)之前,做點(diǎn)什么
        result = self.funcation(*args,**kwargs)
        print('3333333333')
        # 在調(diào)用之后做點(diǎn)什么并且返回結(jié)果
        return result

@DerocatorAsClass
def foo():
    print('in foo()')


foo()

如上例，用類作為裝飾器也是很方便的

以上就是python中的裝飾器該如何使用的詳細(xì)內(nèi)容，更多關(guān)于python 裝飾器的使用的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: