萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

Python 裝飾器 完整入門教學:從閉包到實用 logger

裝飾器是 Python 進階開發的核心技能,廣泛用於日誌、計時、權限驗證、快取等切面邏輯。本文從閉包概念出發,層層深入到實用裝飾器寫法。

1. 閉包:裝飾器的基石

def outer(x):
    y = [1, 2, 3]
    
    def inner():
        print("x:", x)      # 引用外層變數 x
        print("y:", y)      # 引用外層變數 y (環境變數)
    
    return inner  # 回傳內層函式

x = 5  # 這個 x 不會被 inner 使用
f = outer(2)
f()  
# 輸出:
# x: 2
# y: [1, 2, 3]

# 檢視閉包環境變數
print(f.__closure__)  
# (, )

關鍵點:inner 即使在 outer 結束後仍保有對 x、y 的存取權,這就是閉包。

2. 裝飾器本質:函式接受函式、回傳函式

def entrance(func):
    def inner():
        print(f"呼叫函式: {func.__name__}")
        func()  # 執行原函式
    return inner

# 手動裝飾
def fun1():
    print("fun1 執行中")

fun1 = entrance(fun1)
fun1()
# 輸出:
# 呼叫函式: fun1
# fun1 執行中

3. @ 語法糖

@entrance
def fun2():
    print("fun2 執行中")

# 等價於 fun2 = entrance(fun2)
fun2()

4. 關鍵問題:參數傳遞

基本裝飾器不支援帶參數的函式:

@entrance
def fun3(x):
    print(f"參數: {x}")

fun3(1)  # TypeError: inner() takes 0 positional arguments but 1 was given

5. 解決方案:*args, **kwargs

def entrance(func):
    def inner(*args, **kwargs):
        print(f"呼叫: {func.__name__}, 參數: {args}, {kwargs}")
        return func(*args, **kwargs)  # 透傳參數與回傳值
    return inner

@entrance
def fun3(x, y=10):
    return x + y

print(fun3(5))        # 15
print(fun3(5, y=20))  # 25

6. 實用裝飾器:logger

import functools
import logging
import time

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

def logger(func):
    @functools.wraps(func)  # 保留原函式中繼資料
    def wrapper(*args, **kwargs):
        start = time.perf_counter()
        logger.info(f"呼叫 {func.__name__} args={args} kwargs={kwargs}")
        try:
            result = func(*args, **kwargs)
            logger.info(f"{func.__name__} 回傳: {result}")
            return result
        except Exception as e:
            logger.exception(f"{func.__name__} 拋出異常: {e}")
            raise
        finally:
            elapsed = time.perf_counter() - start
            logger.info(f"{func.__name__} 耗時: {elapsed:.4f} 秒")
    return wrapper

# 使用
@logger
def add(a, b):
    time.sleep(0.1)
    return a + b

@logger
def divide(a, b):
    return a / b

add(3, 5)
divide(10, 0)  # 會記錄異常並重新拋出

7. 進階:帶參數的裝飾器

def retry(max_attempts=3, delay=1):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            for attempt in range(1, max_attempts + 1):
                try:
                    return func(*args, **kwargs)
                except Exception as e:
                    if attempt == max_attempts:
                        raise
                    logger.warning(f"{func.__name__} 第 {attempt} 次失敗: {e}, {delay}秒後重試")
                    time.sleep(delay)
        return wrapper
    return decorator

@retry(max_attempts=3, delay=0.5)
def unstable_api_call():
    # 模擬不穩定 API
    if random.random() < 0.7:
        raise ConnectionError("網路不穩")
    return "成功"

8. 類別裝飾器

class CountCalls:
    def __init__(self, func):
        self.func = func
        self.count = 0
        functools.update_wrapper(self, func)

    def __call__(self, *args, **kwargs):
        self.count += 1
        print(f"{self.func.__name__} 被呼叫第 {self.count} 次")
        return self.func(*args, **kwargs)

@CountCalls
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("Alice")
say_hello("Bob")
# say_hello.count 可取得呼叫次數

核心觀念總結

概念說明
閉包內層函式記住外層作用域變數
裝飾器可呼叫物件,接收函式回傳函式
@ 符號語法糖,等同 func = decorator(func)
*args/**kwargs支援任意參數傳遞的關鍵
functools.wraps保留 __name__, __doc__, __annotations__ 等
類別裝飾器實作 __call__ 可保有狀態 (如計數)
copyright © 萬盛學電腦網 all rights reserved