萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

九步掌握 Python 裝飾器:從入門到進階實戰

裝飾器 是 Python 最具特色的語法糖,本質是「接受函數、回傳函數」的高階函數。本文遵循「九步學習法」,從最簡單的函數包裝層層深入,掌握參數化、類裝飾器、保留元資料等進階技巧。

步驟 1:最簡單的目標函數

def myfunc():
    print("myfunc() called.")

myfunc()
myfunc()

步驟 2:手動包裝函數 (裝飾器雛形)

def deco(func):
    print("before myfunc() called.")
    func()
    print("after myfunc() called.")
    return func

myfunc = deco(myfunc)  # 手動裝飾
myfunc()
myfunc()

步驟 3:語法糖 @deco

@deco
def myfunc():
    print("myfunc() called.")

myfunc()
myfunc()

等同於 myfunc = deco(myfunc)。注意:裝飾器在 模組載入時 立即執行,故「before/after」只會印一次。

步驟 4:內層包裝函數 (確保每次呼叫都執行包裝邏輯)

def deco(func):
    def _deco():
        print("before myfunc() called.")
        func()
        print("after myfunc() called.")
    return _deco

@deco
def myfunc():
    print("myfunc() called.")
    return 'ok'

myfunc()
myfunc()

現在每次呼叫 myfunc() 都會印 before/after。

步驟 5:支援參數的裝飾器

def deco(func):
    def _deco(a, b):
        print("before myfunc() called.")
        ret = func(a, b)
        print(f"after myfunc() called. result: {ret}")
        return ret
    return _deco

@deco
def myfunc(a, b):
    print(f"myfunc({a},{b}) called.")
    return a + b

myfunc(1, 2)
myfunc(3, 4)

步驟 6:支援可變參數 *args, **kwargs

def deco(func):
    def _deco(*args, **kwargs):
        print(f"before {func.__name__} called.")
        ret = func(*args, **kwargs)
        print(f"after {func.__name__} called. result: {ret}")
        return ret
    return _deco

@deco
def myfunc(a, b):
    return a + b

@deco
def myfunc2(a, b, c):
    return a + b + c

步驟 7:參數化裝飾器 (帶參數的裝飾器)

def deco(arg):
    def _deco(func):
        def __deco():
            print(f"before {func.__name__} called [{arg}].")
            func()
            print(f"after {func.__name__} called [{arg}].")
        return __deco
    return _deco

@deco("mymodule")
def myfunc():
    print("myfunc() called.")

@deco("module2")
def myfunc2():
    print("myfunc2() called.")

結構:deco(arg) 回傳真正的裝飾器 _deco,再裝飾函數。

步驟 8:類別裝飾器 (狀態化裝飾器)

class Deco:
    def __init__(self, arg):
        self.arg = arg
    def __call__(self, func):
        def wrapper(*args, **kwargs):
            print(f"before {func.__name__} [{self.arg}]")
            ret = func(*args, **kwargs)
            print(f"after {func.__name__} [{self.arg}]")
            return ret
        return wrapper

@Deco("class-based")
def myfunc():
    print("myfunc() called.")

步驟 9:functools.wraps 保留原函數元資料

from functools import wraps

def deco(func):
    @wraps(func)  # 複製 __name__, __doc__, __module__, __annotations__ 等
    def wrapper(*args, **kwargs):
        print("before")
        return func(*args, **kwargs)
    return wrapper

@deco
def myfunc():
    """這是文件字串"""
    pass

print(myfunc.__name__)  # 'myfunc' (而非 'wrapper')
print(myfunc.__doc__)   # '這是文件字串'

實戰應用場景

  • 日誌/計時:@timer, @log_calls
  • 權限/認證:@login_required, @permission('admin')
  • 快取:@lru_cache, @cache(ttl=60)
  • 重試/熔斷:@retry(times=3), @circuit_breaker
  • 資料驗證:@validate(schema)

避坑指南

  • ❌ 忘記 return wrapper → 裝飾後函數變 None。
  • ❌ 忘記 @wraps → 除錯、文檔生成、序列化失效。
  • ❌ 參數化裝飾器層數錯誤 → TypeError。
  • ✅ 使用 functools.wraps 或 functools.update_wrapper。
  • ✅ 類別裝飾器實作 __call__ 保持可呼叫性。

九步走完,裝飾器不再是黑魔法,而是你工具箱裡最鋒利的瑞士刀。

copyright © 萬盛學電腦網 all rights reserved