آموزش دکوراتور(decorator) در پایتون

دکوراتور‌ها(decorator) در پایتون، به ما امکان می‌دهند تا یک رفتار اضافی را به یک تابع اضافه کنیم، بدون اینکه کدهای آن تابع را تغییر دهیم. دکوراتور یک تابع است که یک تابع دیگر را بعنوان ورودی(input)، دریافت می‌کند و یک تابع جدید را برمی‌گردانَد(return می‌کند).

ایجاد یک دکوراتور ساده

ابتدا دکوراتور را تعریف کنید، سپس دستور @decorator_name را در بالای تابع اعطا شده قرار دهید. دقت کنید که در دستور مذکور، باید به جای عبارت decorator_name پس از @، نام تابع دکوراتور را قرار دهید. 

def changecase(func):
  def myinner():
    return func().upper()
  return myinner

@changecase
def myfunction():
  return "Hello Sally"

print(myfunction())

HELLO SALLY

با قرار دادن دستور @changecase در بالای تابع myfunction()، این تابع به صورت پارامتر، به تابع changecase اعطا می‌شود. به تابع changecase تابع دکوراتور گفته می‌شود؛ زیرا دیگر تابع ها، به آن اعطا می‌شوند. و به تابع myfunction تابع اعطا شده(decorated) گفته می‌شود. 

فراخوانی چندباره‌ی دکوراتور

ما می‌توانیم یک تابع دکوراتور را چندین بار فراخوانی کنیم. تنها کافیست نام دکوراتور را به همراه @ در بالای تابعی که می‌خواهیم اعطا شود، قرار دهیم. 

def changecase(func):
  def myinner():
    return func().upper()
  return myinner

@changecase
def myfunction():
  return "Hello Sally"

@changecase
def otherfunction():
  return "I am speed!"

print(myfunction())
print(otherfunction())

HELLO SALLY
I AM SPEED!

استفاده از آرگومان‌ها در تابع اعطاشده(Decorated)

ما می‌توانیم تابع‌هایی که نیاز به آرگومان دارند را نیز بعنوان تابع ‌های اعطا شده مورد استفاده قرار دهیم؛ فقط مطمئن شوید که این آرگومان‌ها را در تابع wrapper پاس دهید:

def changecase(func):
  def myinner(x):
    return func(x).upper()
  return myinner

@changecase
def myfunction(nam):
  return "Hello " + nam

print(myfunction("John"))

HELLO JOHN

دستورات *args و **kwargs

گاهی اوقات، تابع دکوراتور، کنترلی روی آرگومان‌هایی که از تابع اعطا شده(decorated) پاس داده شده‌اند ندارد، برای حل این مشکل، دستورِ (*args, **kwargs) را در تابع wrapper (یعنی تابعی که در درون تابع دکوراتور قرار دارد) اضافه کنید؛ به این طریق، تابع wrapper می‌تواند هر تعداد و هر نوع آرگومانی را بپذیرد؛ و آنها را به تابع اعطا شده پاس دهد. برای اطلاعات بیشتر در مورد این دو آرگومان، اینجا کلیک کنید. 

def changecase(func):
  def myinner(*args, **kwargs):
    return func(*args, **kwargs).upper()
  return myinner

@changecase
def myfunction(nam):
  return "Hello " + nam

print(myfunction("John"))

HELLO JOHN

استفاده از آرگومان برای دکوراتور(Decorator)

ما می‌توانیم با اضافه کردن یک سطحِ wrapper دیگر، برای خودِ دکوراتورها، آرگومان اختصاص دهیم:

def changecase(n):
  def changecase(func):
    def myinner():
      if n == 1:
        a = func().lower()
      else:
        a = func().upper()
      return a
    return myinner
  return changecase

@changecase(1)
def myfunction():
  return "Hello Linus"

print(myfunction())

hello linus

استفاده از چندین دکوراتور(Multiple Decorators)

ما می‌توانیم از چندین دکوراتور روی یک تابع ( اعطا شده) استفاده کنیم. برای انجام این کار، فراخوانی‌های دکوراتور را روی یکدیگر در بالای تابع اعطا شده قرار دهید. دکوراتورها به ترتیب معکوس فراخوانی می‌شوند؛ و این کار از نزدیک‌ترین مورد به تابع اعطا شده، شروع می‌شود. 

def changecase(func):
  def myinner():
    return func().upper()
  return myinner

def addgreeting(func):
  def myinner():
    return "Hello " + func() + " Have a good day!"
  return myinner

@changecase
@addgreeting
def myfunction():
  return "Tobias"

print(myfunction())

HELLO TOBIAS HAVE A GOOD DAY!

حفاظت از داده‌های متای تابع

تابع‌ها در پایتون یک سری داده‌های متا(metadata) دارند که می‌توانیم با استفاده از خصوصیت های __name__  و  __doc__ به آنها دسترسی پیدا کنیم. 

def myfunction():
  return "Have a great day!"

print(myfunction.__name__)

myfunction

def changecase(func):
  def myinner():
    return func().upper()
  return myinner

@changecase
def myfunction():
  return "Have a great day!"

print(myfunction.__name__)

myinner

برای حل این مشکل، پایتون یک تابع داخلی(built-in) به نام functools.wraps دارد که می‌توانیم از آن برای حفاظت کردن از نام و داک‌استرینگ(docstring) تابع اصلی استفاده کنیم. 

import functools

def changecase(func):
  @functools.wraps(func)
  def myinner():
    return func().upper()
  return myinner

@changecase
def myfunction():
  return "Have a great day!"

print(myfunction.__name__)

myfunction

منبع: www.w3schools.com/python