جلسهی 38: دکوریتورها Decorators
توابع را مثل داده جابهجا میکنیم و با دکوریتور (decorator) رفتاری مثل ثبت لاگ، شمارش و کش را بدون تغییر بدنهی تابع اضافه میکنیم.
در این جلسه یاد میگیری
- توابع درجهیک (
first-class) وclosureرا بشناسم و از آنها استفاده کنم. - دکوریتور بنویسم که با
*argsو**kwargsروی هر تابعی کار کند و باfunctools.wrapsنام تابع را حفظ کند. - دکوریتور پارامتردار و ترتیب چند دکوریتور روی هم را درک کنم.
- دکوریتورهای کاربردی شمارش فراخوانی، اعتبارسنجی، تلاش دوباره و کش بسازم.
درس
در پایتون تابع یک شیء معمولی است: میتوان آن را در متغیر گذاشت، به تابع دیگر داد یا از تابع برگرداند. تابعی که تابع دیگری را بگیرد یا برگرداند 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مثالهای این جلسه
- مثال تابع در پایتون: def apply(func, value):
- مثال تابع در پایتون: def make_multiplier(factor):
- مثال تابع در پایتون: def announce(func):
- مثال تابع در پایتون: def announce(func): — دکوریتورها
- مثال تابع در پایتون: def repeat(times):
- مثال تابع در پایتون: def count_calls(func):
چالشها
- Functions as Values (آسان)
- Closure Factory (آسان)
- First Decorator (آسان)
- Uppercase Results (متوسط)
- Preserve Metadata (متوسط)
- Call Counter (متوسط)
- Repeat N Times (متوسط)
- Hand-made Memoize (سخت)
- Argument Validator (سخت)
- Stacking Order (سخت)
- Call Tracer (متوسط)
- Retry Decorator (سخت)
بیشتر بخوان
← جلسهی 37: ایتریتورها و ژنراتورها جلسهی 39: مدیران زمینه →