بتل کد Battle Codeدارد باز می‌شود…

جلسه‌ی 38: دکوریتورها Decorators

توابع را مثل داده جابه‌جا می‌کنیم و با دکوریتور (decorator) رفتاری مثل ثبت لاگ، شمارش و کش را بدون تغییر بدنه‌ی تابع اضافه می‌کنیم.

در این جلسه یاد می‌گیری

درس

در پایتون تابع یک شیء معمولی است: می‌توان آن را در متغیر گذاشت، به تابع دیگر داد یا از تابع برگرداند. تابعی که تابع دیگری را بگیرد یا برگرداند higher-order function نام دارد.

def apply(func, value):
    return func(value)

print(apply(len, "python"))   # 6
print(apply(str.upper, "ok"))  # OK

تابعی که داخل تابع دیگر تعریف شود به متغیرهای تابع بیرونی دسترسی دارد، حتی بعد از پایان آن. این ترکیب را closure می‌گویند و پایه‌ی همه‌ی دکوریتورهاست.

def make_multiplier(factor):
    def multiply(x):
        return x * factor
    return multiply

double = make_multiplier(2)
print(double(21))  # 42

دکوریتور تابعی است که تابعی می‌گیرد و تابع جدیدی (wrapper) برمی‌گرداند. نوشتن @decorator بالای تعریف دقیقاً معادل func = decorator(func) است. با *args و **kwargs wrapper هر امضایی را می‌پذیرد.

def announce(func):
    def wrapper(*args, **kwargs):
        print(f"calling {func.__name__}")
        return func(*args, **kwargs)
    return wrapper

@announce
def add(a, b):
    return a + b

بدون مراقبت، تابع تزئین‌شده نام و docstring خود را از دست می‌دهد و add.__name__ می‌شود wrapper. دکوریتور functools.wraps این اطلاعات را کپی می‌کند؛ در کد حرفه‌ای همیشه از آن استفاده کنید.

from functools import wraps

def announce(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        return func(*args, **kwargs)
    return wrapper

دکوریتور پارامتردار یک لایه‌ی بیشتر دارد: @repeat(3) اول repeat(3) را اجرا می‌کند که خودش دکوریتور برمی‌گرداند. وقتی چند دکوریتور روی هم باشند، نزدیک‌ترین به def اول اعمال می‌شود.

def repeat(times):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for _ in range(times):
                func(*args, **kwargs)
        return wrapper
    return decorator

کاربردهای رایج: ثبت لاگ، اندازه‌گیری، شمارش فراخوانی، کنترل دسترسی، اعتبارسنجی آرگومان‌ها و کش (memoization). برای ذخیره‌ی وضعیت می‌توان روی خود wrapper ویژگی گذاشت، مثل wrapper.calls = 0.

def count_calls(func):
    def wrapper(*args, **kwargs):
        wrapper.calls += 1
        return func(*args, **kwargs)
    wrapper.calls = 0
    return wrapper

مثال‌های این جلسه

چالش‌ها

  1. Functions as Values (آسان)
  2. Closure Factory (آسان)
  3. First Decorator (آسان)
  4. Uppercase Results (متوسط)
  5. Preserve Metadata (متوسط)
  6. Call Counter (متوسط)
  7. Repeat N Times (متوسط)
  8. Hand-made Memoize (سخت)
  9. Argument Validator (سخت)
  10. Stacking Order (سخت)
  11. Call Tracer (متوسط)
  12. Retry Decorator (سخت)

بیشتر بخوان

← جلسه‌ی 37: ایتریتورها و ژنراتورها جلسه‌ی 39: مدیران زمینه →