python اكواد - كيفية جعل سلسلة من وظيفة الديكور؟




بايثون جاهزة (14)

كيف يمكنني صنع اثنين من الديكور في بيثون من شأنه أن يفعل ما يلي؟

@makebold
@makeitalic
def say():
   return "Hello"

... والتي يجب أن تعود:

"<b><i>Hello</i></b>"

أنا لا أحاول إنشاء HTML بهذه الطريقة في تطبيق حقيقي - مجرد محاولة لفهم كيفية عمل سلاسل الديكور والديكور.


Answers

هنا مثال بسيط من تسلسل الديكور. لاحظ السطر الأخير - يظهر ما يحدث تحت الأغطية.

############################################################
#
#    decorators
#
############################################################

def bold(fn):
    def decorate():
        # surround with bold tags before calling original function
        return "<b>" + fn() + "</b>"
    return decorate


def uk(fn):
    def decorate():
        # swap month and day
        fields = fn().split('/')
        date = fields[1] + "/" + fields[0] + "/" + fields[2]
        return date
    return decorate

import datetime
def getDate():
    now = datetime.datetime.now()
    return "%d/%d/%d" % (now.day, now.month, now.year)

@bold
def getBoldDate(): 
    return getDate()

@uk
def getUkDate():
    return getDate()

@bold
@uk
def getBoldUkDate():
    return getDate()


print getDate()
print getBoldDate()
print getUkDate()
print getBoldUkDate()
# what is happening under the covers
print bold(uk(getDate))()

يبدو الإخراج مثل:

17/6/2013
<b>17/6/2013</b>
6/17/2013
<b>6/17/2013</b>
<b>6/17/2013</b>

بدلاً من ذلك ، يمكنك كتابة دالة مصنع تقوم بإرجاع الديكور الذي يلف قيمة الإرجاع للوظيفة المزينة في علامة تم تمريرها إلى وظيفة المصنع. فمثلا:

from functools import wraps

def wrap_in_tag(tag):
    def factory(func):
        @wraps(func)
        def decorator():
            return '<%(tag)s>%(rv)s</%(tag)s>' % (
                {'tag': tag, 'rv': func()})
        return decorator
    return factory

يمكّنك هذا من الكتابة:

@wrap_in_tag('b')
@wrap_in_tag('i')
def say():
    return 'hello'

أو

makebold = wrap_in_tag('b')
makeitalic = wrap_in_tag('i')

@makebold
@makeitalic
def say():
    return 'hello'

أنا شخصياً كنت سأكتب الديكور بطريقة مختلفة نوعًا ما:

from functools import wraps

def wrap_in_tag(tag):
    def factory(func):
        @wraps(func)
        def decorator(val):
            return func('<%(tag)s>%(val)s</%(tag)s>' %
                        {'tag': tag, 'val': val})
        return decorator
    return factory

التي من شأنها أن تعطي:

@wrap_in_tag('b')
@wrap_in_tag('i')
def say(val):
    return val
say('hello')

لا تنس البناء الذي يكون بناء الجملة الخاص بالديكور هو اختصار:

say = wrap_in_tag('b')(wrap_in_tag('i')(say)))

تحقق من الوثائق لمعرفة كيفية عمل الديكور. إليك ما طلبت:

def makebold(fn):
    def wrapped():
        return "<b>" + fn() + "</b>"
    return wrapped

def makeitalic(fn):
    def wrapped():
        return "<i>" + fn() + "</i>"
    return wrapped

@makebold
@makeitalic
def hello():
    return "hello world"

print hello() ## returns "<b><i>hello world</i></b>"

عند التحدث عن مثال العداد - كما هو موضح أعلاه ، سيتم مشاركة العداد بين جميع الوظائف التي تستخدم الديكور:

def counter(func):
    def wrapped(*args, **kws):
        print 'Called #%i' % wrapped.count
        wrapped.count += 1
        return func(*args, **kws)
    wrapped.count = 0
    return wrapped

بهذه الطريقة ، يمكن إعادة استخدام الديكور الخاص بك لوظائف مختلفة (أو استخدامها لتزيين نفس الوظيفة عدة مرات:) func_counter1 = counter(func); func_counter2 = counter(func)، وسيظل المتغير المضاد خاص لكل منها.


تزيين الدوال مع عدد مختلف من الحجج:

def frame_tests(fn):
    def wrapper(*args):
        print "\nStart: %s" %(fn.__name__)
        fn(*args)
        print "End: %s\n" %(fn.__name__)
    return wrapper

@frame_tests
def test_fn1():
    print "This is only a test!"

@frame_tests
def test_fn2(s1):
    print "This is only a test! %s" %(s1)

@frame_tests
def test_fn3(s1, s2):
    print "This is only a test! %s %s" %(s1, s2)

if __name__ == "__main__":
    test_fn1()
    test_fn2('OK!')
    test_fn3('OK!', 'Just a test!')

نتيجة:

Start: test_fn1  
This is only a test!  
End: test_fn1  


Start: test_fn2  
This is only a test! OK!  
End: test_fn2  


Start: test_fn3  
This is only a test! OK! Just a test!  
End: test_fn3  

يأخذ الديكور طابع الوظيفة ويخلق وظيفة جديدة تقوم بتنفيذ هذه الوظيفة وتحول النتيجة.

@deco
def do():
    ...

هو eqivarent إلى:

do = deco(do)

مثال:

def deco(func):
    def inner(letter):
        return func(letter).upper()  #upper
    return inner

هذه

@deco
def do(number):
    return chr(number)  # number to letter

هو eqivalent إلى do2 def هذا (رقم): chr (رقم)

do2 = deco(do2)

65 <=> "أ"

print(do(65))
print(do2(65))
>>> B
>>> B

لفهم الديكور ، من المهم أن نلاحظ ، أن الديكور خلق وظيفة جديدة تفعل الداخلية التي تنفذ func وتحويل النتيجة.


لشرح الديكور بطريقة أبسط:

مع:

@decor1
@decor2
def func(*args, **kwargs):
    pass

عندما تفعل:

func(*args, **kwargs)

انت فعلا فعلتها:

decor1(decor2(func))(*args, **kwargs)

#decorator.py
def makeHtmlTag(tag, *args, **kwds):
    def real_decorator(fn):
        css_class = " class='{0}'".format(kwds["css_class"]) \
                                 if "css_class" in kwds else ""
        def wrapped(*args, **kwds):
            return "<"+tag+css_class+">" + fn(*args, **kwds) + "</"+tag+">"
        return wrapped
    # return decorator dont call it
    return real_decorator

@makeHtmlTag(tag="b", css_class="bold_css")
@makeHtmlTag(tag="i", css_class="italic_css")
def hello():
    return "hello world"

print hello()

يمكنك أيضا كتابة الديكور في الفصل

#class.py
class makeHtmlTagClass(object):
    def __init__(self, tag, css_class=""):
        self._tag = tag
        self._css_class = " class='{0}'".format(css_class) \
                                       if css_class != "" else ""

    def __call__(self, fn):
        def wrapped(*args, **kwargs):
            return "<" + self._tag + self._css_class+">"  \
                       + fn(*args, **kwargs) + "</" + self._tag + ">"
        return wrapped

@makeHtmlTagClass(tag="b", css_class="bold_css")
@makeHtmlTagClass(tag="i", css_class="italic_css")
def hello(name):
    return "Hello, {}".format(name)

print hello("Your name")

إذا لم تكن تفسيرات طويلة ، راجع جواب باولو بيرجانتينو .

أساسيات الديكور

وظائف بايثون هي كائنات

لفهم الزخارف ، يجب عليك أولاً أن تدرك أن الوظائف هي كائنات في بايثون. هذا له عواقب مهمة. دعونا نرى لماذا مع مثال بسيط:

def shout(word="yes"):
    return word.capitalize()+"!"

print(shout())
# outputs : 'Yes!'

# As an object, you can assign the function to a variable like any other object 
scream = shout

# Notice we don't use parentheses: we are not calling the function,
# we are putting the function "shout" into the variable "scream".
# It means you can then call "shout" from "scream":

print(scream())
# outputs : 'Yes!'

# More than that, it means you can remove the old name 'shout',
# and the function will still be accessible from 'scream'

del shout
try:
    print(shout())
except NameError, e:
    print(e)
    #outputs: "name 'shout' is not defined"

print(scream())
# outputs: 'Yes!'

ضعه بمخيلتك. سنعود إليه قريبًا.

خاصية أخرى مثيرة للاهتمام لوظائف بايثون هي أنها يمكن تعريفها داخل وظيفة أخرى!

def talk():

    # You can define a function on the fly in "talk" ...
    def whisper(word="yes"):
        return word.lower()+"..."

    # ... and use it right away!
    print(whisper())

# You call "talk", that defines "whisper" EVERY TIME you call it, then
# "whisper" is called in "talk". 
talk()
# outputs: 
# "yes..."

# But "whisper" DOES NOT EXIST outside "talk":

try:
    print(whisper())
except NameError, e:
    print(e)
    #outputs : "name 'whisper' is not defined"*
    #Python's functions are objects

مراجع الوظائف

حسنا ، ما زلت هنا؟ الآن الجزء الممتع ...

كنت قد رأيت أن وظائف هي كائنات. لذلك ، وظائف:

  • يمكن تخصيصها لمتغير
  • يمكن تعريفها في وظيفة أخرى

وهذا يعني أن الوظيفة يمكنها return وظيفة أخرى .

def getTalk(kind="shout"):

    # We define functions on the fly
    def shout(word="yes"):
        return word.capitalize()+"!"

    def whisper(word="yes") :
        return word.lower()+"...";

    # Then we return one of them
    if kind == "shout":
        # We don't use "()", we are not calling the function,
        # we are returning the function object
        return shout  
    else:
        return whisper

# How do you use this strange beast?

# Get the function and assign it to a variable
talk = getTalk()      

# You can see that "talk" is here a function object:
print(talk)
#outputs : <function shout at 0xb7ea817c>

# The object is the one returned by the function:
print(talk())
#outputs : Yes!

# And you can even use it directly if you feel wild:
print(getTalk("whisper")())
#outputs : yes...

هناك المزيد!

إذا كان بإمكانك return إحدى الوظائف ، فيمكنك تمرير إحدى المعلمات:

def doSomethingBefore(func): 
    print("I do something before then I call the function you gave me")
    print(func())

doSomethingBefore(scream)
#outputs: 
#I do something before then I call the function you gave me
#Yes!

حسنا ، لديك فقط كل ما تحتاجه لفهم الديكور. كما ترى ، فإن الديكورات هي "مغلفة" ، مما يعني أنها تسمح لك بتنفيذ التعليمات البرمجية قبل وبعد الوظيفة التي تزينها دون تعديل الوظيفة نفسها.

ديكورات يدوية

كيف تفعل ذلك يدويًا:

# A decorator is a function that expects ANOTHER function as parameter
def my_shiny_new_decorator(a_function_to_decorate):

    # Inside, the decorator defines a function on the fly: the wrapper.
    # This function is going to be wrapped around the original function
    # so it can execute code before and after it.
    def the_wrapper_around_the_original_function():

        # Put here the code you want to be executed BEFORE the original function is called
        print("Before the function runs")

        # Call the function here (using parentheses)
        a_function_to_decorate()

        # Put here the code you want to be executed AFTER the original function is called
        print("After the function runs")

    # At this point, "a_function_to_decorate" HAS NEVER BEEN EXECUTED.
    # We return the wrapper function we have just created.
    # The wrapper contains the function and the code to execute before and after. It’s ready to use!
    return the_wrapper_around_the_original_function

# Now imagine you create a function you don't want to ever touch again.
def a_stand_alone_function():
    print("I am a stand alone function, don't you dare modify me")

a_stand_alone_function() 
#outputs: I am a stand alone function, don't you dare modify me

# Well, you can decorate it to extend its behavior.
# Just pass it to the decorator, it will wrap it dynamically in 
# any code you want and return you a new function ready to be used:

a_stand_alone_function_decorated = my_shiny_new_decorator(a_stand_alone_function)
a_stand_alone_function_decorated()
#outputs:
#Before the function runs
#I am a stand alone function, don't you dare modify me
#After the function runs

الآن ، ربما تريد أن يتم استدعاء a_stand_alone_function بدلاً من ذلك في كل مرة تتصل فيها a_stand_alone_function a_stand_alone_function_decorated . هذا أمر سهل ، فقط قم بالكتابة فوق a_stand_alone_function بالوظيفة التي أرجعها my_shiny_new_decorator :

a_stand_alone_function = my_shiny_new_decorator(a_stand_alone_function)
a_stand_alone_function()
#outputs:
#Before the function runs
#I am a stand alone function, don't you dare modify me
#After the function runs

# That’s EXACTLY what decorators do!

الديكور الغموض

المثال السابق ، باستخدام بناء الجملة decorator:

@my_shiny_new_decorator
def another_stand_alone_function():
    print("Leave me alone")

another_stand_alone_function()  
#outputs:  
#Before the function runs
#Leave me alone
#After the function runs

نعم ، هذا كل شيء ، الأمر بهذه البساطة. @decorator مجرد اختصار لـ:

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

المصممون هم مجرد مجموعة متنوعة من نمط تصميم الديكور . هناك العديد من أنماط التصميم الكلاسيكية المضمنة في بايثون لتسهيل التطوير (مثل التكرارات).

بالطبع ، يمكنك تجميع الديكورات:

def bread(func):
    def wrapper():
        print("</''''''\>")
        func()
        print("<\______/>")
    return wrapper

def ingredients(func):
    def wrapper():
        print("#tomatoes#")
        func()
        print("~salad~")
    return wrapper

def sandwich(food="--ham--"):
    print(food)

sandwich()
#outputs: --ham--
sandwich = bread(ingredients(sandwich))
sandwich()
#outputs:
#</''''''\>
# #tomatoes#
# --ham--
# ~salad~
#<\______/>

استخدام بنية زخرفة بيثون:

@bread
@ingredients
def sandwich(food="--ham--"):
    print(food)

sandwich()
#outputs:
#</''''''\>
# #tomatoes#
# --ham--
# ~salad~
#<\______/>

الترتيب الذي تقوم بتعيينه للديكور الأمور:

@ingredients
@bread
def strange_sandwich(food="--ham--"):
    print(food)

strange_sandwich()
#outputs:
##tomatoes#
#</''''''\>
# --ham--
#<\______/>
# ~salad~

الآن: للإجابة على السؤال ...

في الختام ، يمكنك بسهولة معرفة كيفية الإجابة عن السؤال:

# The decorator to make it bold
def makebold(fn):
    # The new function the decorator returns
    def wrapper():
        # Insertion of some code before and after
        return "<b>" + fn() + "</b>"
    return wrapper

# The decorator to make it italic
def makeitalic(fn):
    # The new function the decorator returns
    def wrapper():
        # Insertion of some code before and after
        return "<i>" + fn() + "</i>"
    return wrapper

@makebold
@makeitalic
def say():
    return "hello"

print(say())
#outputs: <b><i>hello</i></b>

# This is the exact equivalent to 
def say():
    return "hello"
say = makebold(makeitalic(say))

print(say())
#outputs: <b><i>hello</i></b>

يمكنك الآن فقط أن تغادر سعيدًا ، أو تحرق عقلك أكثر قليلاً وتشاهد الاستخدامات المتقدمة للمصممين.

أخذ الزخارف إلى المستوى التالي

تمرير الحجج إلى وظيفة مزينة

# It’s not black magic, you just have to let the wrapper 
# pass the argument:

def a_decorator_passing_arguments(function_to_decorate):
    def a_wrapper_accepting_arguments(arg1, arg2):
        print("I got args! Look: {0}, {1}".format(arg1, arg2))
        function_to_decorate(arg1, arg2)
    return a_wrapper_accepting_arguments

# Since when you are calling the function returned by the decorator, you are
# calling the wrapper, passing arguments to the wrapper will let it pass them to 
# the decorated function

@a_decorator_passing_arguments
def print_full_name(first_name, last_name):
    print("My name is {0} {1}".format(first_name, last_name))

print_full_name("Peter", "Venkman")
# outputs:
#I got args! Look: Peter Venkman
#My name is Peter Venkman

أساليب تزيين

شيء واحد أنيق حول بايثون هو أن الأساليب والوظائف هي نفسها. والفرق الوحيد هو أن الطرق تتوقع أن تكون أول حجة لها مرجعا للكائن الحالي ( self ).

وهذا يعني أنه يمكنك بناء ديكور للأساليب بنفس الطريقة! فقط تذكر أن تأخذ بعين الاعتبار في الاعتبار:

def method_friendly_decorator(method_to_decorate):
    def wrapper(self, lie):
        lie = lie - 3 # very friendly, decrease age even more :-)
        return method_to_decorate(self, lie)
    return wrapper


class Lucy(object):

    def __init__(self):
        self.age = 32

    @method_friendly_decorator
    def sayYourAge(self, lie):
        print("I am {0}, what did you think?".format(self.age + lie))

l = Lucy()
l.sayYourAge(-3)
#outputs: I am 26, what did you think?

إذا كنت *args, **kwargs على أي وظيفة أو طريقة ، بغض النظر عن حججها - *args, **kwargs سوى استخدام *args, **kwargs :

def a_decorator_passing_arbitrary_arguments(function_to_decorate):
    # The wrapper accepts any arguments
    def a_wrapper_accepting_arbitrary_arguments(*args, **kwargs):
        print("Do I have args?:")
        print(args)
        print(kwargs)
        # Then you unpack the arguments, here *args, **kwargs
        # If you are not familiar with unpacking, check:
        # http://www.saltycrane.com/blog/2008/01/how-to-use-args-and-kwargs-in-python/
        function_to_decorate(*args, **kwargs)
    return a_wrapper_accepting_arbitrary_arguments

@a_decorator_passing_arbitrary_arguments
def function_with_no_argument():
    print("Python is cool, no argument here.")

function_with_no_argument()
#outputs
#Do I have args?:
#()
#{}
#Python is cool, no argument here.

@a_decorator_passing_arbitrary_arguments
def function_with_arguments(a, b, c):
    print(a, b, c)

function_with_arguments(1,2,3)
#outputs
#Do I have args?:
#(1, 2, 3)
#{}
#1 2 3 

@a_decorator_passing_arbitrary_arguments
def function_with_named_arguments(a, b, c, platypus="Why not ?"):
    print("Do {0}, {1} and {2} like platypus? {3}".format(a, b, c, platypus))

function_with_named_arguments("Bill", "Linus", "Steve", platypus="Indeed!")
#outputs
#Do I have args ? :
#('Bill', 'Linus', 'Steve')
#{'platypus': 'Indeed!'}
#Do Bill, Linus and Steve like platypus? Indeed!

class Mary(object):

    def __init__(self):
        self.age = 31

    @a_decorator_passing_arbitrary_arguments
    def sayYourAge(self, lie=-3): # You can now add a default value
        print("I am {0}, what did you think?".format(self.age + lie))

m = Mary()
m.sayYourAge()
#outputs
# Do I have args?:
#(<__main__.Mary object at 0xb7d303ac>,)
#{}
#I am 28, what did you think?

تمرير الحجج إلى الديكور

عظيم ، الآن ماذا كنت تقول عن تمرير الحجج إلى الديكور نفسه؟

يمكن الحصول على هذا الملتوية بعض الشيء ، حيث يجب أن يقبل الديكور وظيفة كحجة. لذلك ، لا يمكنك تمرير وسائط الدالة المزينة مباشرة إلى الديكور.

قبل الاندفاع إلى الحل ، دعنا نكتب تذكيرًا صغيرًا:

# Decorators are ORDINARY functions
def my_decorator(func):
    print("I am an ordinary function")
    def wrapper():
        print("I am function returned by the decorator")
        func()
    return wrapper

# Therefore, you can call it without any "@"

def lazy_function():
    print("zzzzzzzz")

decorated_function = my_decorator(lazy_function)
#outputs: I am an ordinary function

# It outputs "I am an ordinary function", because that’s just what you do:
# calling a function. Nothing magic.

@my_decorator
def lazy_function():
    print("zzzzzzzz")

#outputs: I am an ordinary function

انها بالضبط نفس الشيء. يتم استدعاء " my_decorator ". لذا عندما تكون @my_decorator ، فأنت تخبر Python أن تستدعي الوظيفة "مصنفة حسب المتغير" my_decorator "'.

هذا مهم! يمكن أن تشير العلامة التي تعطيها مباشرة إلى الديكور - أو لا .

دعونا نحصل على الشر. ☺

def decorator_maker():

    print("I make decorators! I am executed only once: "
          "when you make me create a decorator.")

    def my_decorator(func):

        print("I am a decorator! I am executed only when you decorate a function.")

        def wrapped():
            print("I am the wrapper around the decorated function. "
                  "I am called when you call the decorated function. "
                  "As the wrapper, I return the RESULT of the decorated function.")
            return func()

        print("As the decorator, I return the wrapped function.")

        return wrapped

    print("As a decorator maker, I return a decorator")
    return my_decorator

# Let’s create a decorator. It’s just a new function after all.
new_decorator = decorator_maker()       
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator

# Then we decorate the function

def decorated_function():
    print("I am the decorated function.")

decorated_function = new_decorator(decorated_function)
#outputs:
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function

# Let’s call the function:
decorated_function()
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

لا مفاجأة هنا.

دعونا نفعل بالضبط نفس الشيء ، ولكن تخطي جميع المتغيرات المتوسطة المزعجة:

def decorated_function():
    print("I am the decorated function.")
decorated_function = decorator_maker()(decorated_function)
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function.

# Finally:
decorated_function()    
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

دعونا نجعلها أقصر :

@decorator_maker()
def decorated_function():
    print("I am the decorated function.")
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function.

#Eventually: 
decorated_function()    
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

هل رأيت ذلك؟ استخدمنا استدعاء دالة مع بناء الجملة " @ "! :-)

لذا ، عد إلى المصممين بالحجج. إذا استطعنا استخدام وظائف لإنشاء الديكور على الطاير ، يمكننا تمرير الحجج إلى هذه الوظيفة ، أليس كذلك؟

def decorator_maker_with_arguments(decorator_arg1, decorator_arg2):

    print("I make decorators! And I accept arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

    def my_decorator(func):
        # The ability to pass arguments here is a gift from closures.
        # If you are not comfortable with closures, you can assume it’s ok,
        # or read: https://.com/questions/13857/can-you-explain-closures-as-they-relate-to-python
        print("I am the decorator. Somehow you passed me arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

        # Don't confuse decorator arguments and function arguments!
        def wrapped(function_arg1, function_arg2) :
            print("I am the wrapper around the decorated function.\n"
                  "I can access all the variables\n"
                  "\t- from the decorator: {0} {1}\n"
                  "\t- from the function call: {2} {3}\n"
                  "Then I can pass them to the decorated function"
                  .format(decorator_arg1, decorator_arg2,
                          function_arg1, function_arg2))
            return func(function_arg1, function_arg2)

        return wrapped

    return my_decorator

@decorator_maker_with_arguments("Leonard", "Sheldon")
def decorated_function_with_arguments(function_arg1, function_arg2):
    print("I am the decorated function and only knows about my arguments: {0}"
           " {1}".format(function_arg1, function_arg2))

decorated_function_with_arguments("Rajesh", "Howard")
#outputs:
#I make decorators! And I accept arguments: Leonard Sheldon
#I am the decorator. Somehow you passed me arguments: Leonard Sheldon
#I am the wrapper around the decorated function. 
#I can access all the variables 
#   - from the decorator: Leonard Sheldon 
#   - from the function call: Rajesh Howard 
#Then I can pass them to the decorated function
#I am the decorated function and only knows about my arguments: Rajesh Howard

ومن هنا: الديكور مع الحجج. يمكن ضبط الوسيطات كمتغير:

c1 = "Penny"
c2 = "Leslie"

@decorator_maker_with_arguments("Leonard", c1)
def decorated_function_with_arguments(function_arg1, function_arg2):
    print("I am the decorated function and only knows about my arguments:"
           " {0} {1}".format(function_arg1, function_arg2))

decorated_function_with_arguments(c2, "Howard")
#outputs:
#I make decorators! And I accept arguments: Leonard Penny
#I am the decorator. Somehow you passed me arguments: Leonard Penny
#I am the wrapper around the decorated function. 
#I can access all the variables 
#   - from the decorator: Leonard Penny 
#   - from the function call: Leslie Howard 
#Then I can pass them to the decorated function
#I am the decorated function and only know about my arguments: Leslie Howard

كما ترون ، يمكنك تمرير الحجج إلى الديكور مثل أي وظيفة باستخدام هذه الخدعة. يمكنك حتى استخدام *args, **kwargs إذا كنت ترغب في ذلك. ولكن تذكر تذكير المعلقين مرة واحدة فقط . فقط عندما تستورد بايثون النص البرمجي. لا يمكنك تعيين الوسائط بشكل ديناميكي بعد ذلك. عندما تقوم بـ "import x" ، فإن الوظيفة مزينة بالفعل ، لذا لا يمكنك تغيير أي شيء.

دعونا نتدرب على: تزيين الديكور

حسنًا ، كمكافأة ، سأعطيك مقتطفًا لجعل أي مصمم يقبل أي حجة بشكل عام. بعد كل شيء ، من أجل قبول الحجج ، أنشأنا لدينا الديكور باستخدام وظيفة أخرى.

لقد لفنا الديكور.

أي شيء آخر رأيناه مؤخرا أن وظيفة ملفوفة؟

أوه نعم ، والديكور!

دعونا نحصل على بعض المرح وكتابة ديكور للمصممين:

def decorator_with_args(decorator_to_enhance):
    """ 
    This function is supposed to be used as a decorator.
    It must decorate an other function, that is intended to be used as a decorator.
    Take a cup of coffee.
    It will allow any decorator to accept an arbitrary number of arguments,
    saving you the headache to remember how to do that every time.
    """

    # We use the same trick we did to pass arguments
    def decorator_maker(*args, **kwargs):

        # We create on the fly a decorator that accepts only a function
        # but keeps the passed arguments from the maker.
        def decorator_wrapper(func):

            # We return the result of the original decorator, which, after all, 
            # IS JUST AN ORDINARY FUNCTION (which returns a function).
            # Only pitfall: the decorator must have this specific signature or it won't work:
            return decorator_to_enhance(func, *args, **kwargs)

        return decorator_wrapper

    return decorator_maker

يمكن استخدامه على النحو التالي:

# You create the function you will use as a decorator. And stick a decorator on it :-)
# Don't forget, the signature is "decorator(func, *args, **kwargs)"
@decorator_with_args 
def decorated_decorator(func, *args, **kwargs): 
    def wrapper(function_arg1, function_arg2):
        print("Decorated with {0} {1}".format(args, kwargs))
        return func(function_arg1, function_arg2)
    return wrapper

# Then you decorate the functions you wish with your brand new decorated decorator.

@decorated_decorator(42, 404, 1024)
def decorated_function(function_arg1, function_arg2):
    print("Hello {0} {1}".format(function_arg1, function_arg2))

decorated_function("Universe and", "everything")
#outputs:
#Decorated with (42, 404, 1024) {}
#Hello Universe and everything

# Whoooot!

وأنا أعلم ، في المرة الأخيرة التي كان لديك هذا الشعور ، كان بعد الاستماع إلى رجل يقول: "قبل فهم العودية ، يجب عليك أولا فهم العودية". لكن الآن ، ألا تشعر بالرضا عن إتقان هذا؟

أفضل الممارسات: الديكور

  • تم تقديم Decorators في Python 2.4 ، لذا تأكد من تشغيل الكود على> = 2.4.
  • الديكور يبطئ استدعاء الوظيفة. ضع ذلك في الاعتبار.
  • لا يمكنك إلغاء تزييف وظيفة. (هناك اختراقات لإنشاء ديكورات يمكن إزالتها ، ولكن لا أحد يستخدمها). لذلك بمجرد أن يتم تزيين إحدى الوظائف ، يتم تزيينها بكل التعليمات البرمجية .
  • وظائف التفاف الديكور ، والتي يمكن أن تجعل من الصعب تصحيحها. (هذا أفضل من Python> = 2.5 ؛ انظر أدناه.)

تم إدخال وحدة functools في Python 2.5. تتضمن الدالة functools.wraps() ، التي تقوم بنسخ الاسم functools.wraps() النمطية و docstring الخاصة بالوظيفة المزخرفة إلى الغلاف الخاص بها.

(حقيقة ممتعة: functools.wraps() هو الديكور! ☺)

# For debugging, the stacktrace prints you the function __name__
def foo():
    print("foo")

print(foo.__name__)
#outputs: foo

# With a decorator, it gets messy    
def bar(func):
    def wrapper():
        print("bar")
        return func()
    return wrapper

@bar
def foo():
    print("foo")

print(foo.__name__)
#outputs: wrapper

# "functools" can help for that

import functools

def bar(func):
    # We say that "wrapper", is wrapping "func"
    # and the magic begins
    @functools.wraps(func)
    def wrapper():
        print("bar")
        return func()
    return wrapper

@bar
def foo():
    print("foo")

print(foo.__name__)
#outputs: foo

كيف يمكن للديكور أن يكون مفيدا؟

الآن السؤال الكبير: ما الذي يمكنني استخدامه للديكور؟

تبدو باردة وقوية ، ولكن مثال عملي سيكون رائعا. حسنا ، هناك 1000 الاحتمالات. الاستخدامات الكلاسيكية تمدد سلوك وظيفة من lib خارجي (لا يمكنك تعديله) ، أو لتصحيح الأخطاء (لا تريد تعديله لأنه مؤقت).

يمكنك استخدامها لتوسيع العديد من الوظائف بطريقة DRY ، مثل:

def benchmark(func):
    """
    A decorator that prints the time a function takes
    to execute.
    """
    import time
    def wrapper(*args, **kwargs):
        t = time.clock()
        res = func(*args, **kwargs)
        print("{0} {1}".format(func.__name__, time.clock()-t))
        return res
    return wrapper


def logging(func):
    """
    A decorator that logs the activity of the script.
    (it actually just prints it, but it could be logging!)
    """
    def wrapper(*args, **kwargs):
        res = func(*args, **kwargs)
        print("{0} {1} {2}".format(func.__name__, args, kwargs))
        return res
    return wrapper


def counter(func):
    """
    A decorator that counts and prints the number of times a function has been executed
    """
    def wrapper(*args, **kwargs):
        wrapper.count = wrapper.count + 1
        res = func(*args, **kwargs)
        print("{0} has been used: {1}x".format(func.__name__, wrapper.count))
        return res
    wrapper.count = 0
    return wrapper

@counter
@benchmark
@logging
def reverse_string(string):
    return str(reversed(string))

print(reverse_string("Able was I ere I saw Elba"))
print(reverse_string("A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!"))

#outputs:
#reverse_string ('Able was I ere I saw Elba',) {}
#wrapper 0.0
#wrapper has been used: 1x 
#ablE was I ere I saw elbA
#reverse_string ('A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!',) {}
#wrapper 0.0
#wrapper has been used: 2x
#!amanaP :lanac a ,noep a ,stah eros ,raj a ,hsac ,oloR a ,tur a ,mapS ,snip ,eperc a ,)lemac a ro( niaga gab ananab a ,gat a ,nat a ,gab ananab a ,gag a ,inoracam ,elacrep ,epins ,spam ,arutaroloc a ,shajar ,soreh ,atsap ,eonac a ,nalp a ,nam A

بالطبع الشيء الجيد مع الديكور هو أنه يمكنك استخدامها على الفور على أي شيء تقريبا دون إعادة الكتابة. جافة ، قلت:

@counter
@benchmark
@logging
def get_random_futurama_quote():
    from urllib import urlopen
    result = urlopen("http://subfusion.net/cgi-bin/quote.pl?quote=futurama").read()
    try:
        value = result.split("<br><b><hr><br>")[1].split("<br><br><hr>")[0]
        return value.strip()
    except:
        return "No, I'm ... doesn't!"


print(get_random_futurama_quote())
print(get_random_futurama_quote())

#outputs:
#get_random_futurama_quote () {}
#wrapper 0.02
#wrapper has been used: 1x
#The laws of science be a harsh mistress.
#get_random_futurama_quote () {}
#wrapper 0.01
#wrapper has been used: 2x
#Curse you, merciful Poseidon!

بيثون نفسها توفر العديد من الديكورات: property ، staticmethod ، الخ.

  • يستخدم Django أدوات الديكور لإدارة التخزين المؤقت وعرض الأذونات.
  • ملتوية إلى المزيف المضمن استدعاءات الدوال غير المتزامنة.

هذا حقا ملعب كبير.


لقد تمت الإجابة على هذا الجواب منذ فترة طويلة ، لكنني اعتقدت أنني سأشارك حصة الديكور الخاصة بي مما يجعل كتابة ديكورات جديدة سهلة ومدمجة.

from abc import ABCMeta, abstractclassmethod

class Decorator(metaclass=ABCMeta):
    """ Acts as a base class for all decorators """

    def __init__(self):
        self.method = None

    def __call__(self, method):
        self.method = method
        return self.call

    @abstractclassmethod
    def call(self, *args, **kwargs):
        return self.method(*args, **kwargs)

بالنسبة لأحدهم ، أعتقد أن هذا يجعل سلوك الزخارف واضحًا جدًا ، ولكنه أيضًا يجعل من السهل تحديد مصممي الديكور الجدد بإيجاز شديد. بالنسبة للمثال المذكور أعلاه ، يمكنك بعد ذلك حلها على النحو التالي:

class MakeBold(Decorator):
    def call():
        return "<b>" + self.method() + "</b>"

class MakeItalic(Decorator):
    def call():
        return "<i>" + self.method() + "</i>"

@MakeBold()
@MakeItalic()
def say():
   return "Hello"

يمكنك أيضًا استخدامه للقيام بمهام أكثر تعقيدًا ، على سبيل المثال ديكورًا يجعل تلقائيًا الوظيفة يتم تطبيقها بشكل متكرر على جميع الوسائط في التكرار:

class ApplyRecursive(Decorator):
    def __init__(self, *types):
        super().__init__()
        if not len(types):
            types = (dict, list, tuple, set)
        self._types = types

    def call(self, arg):
        if dict in self._types and isinstance(arg, dict):
            return {key: self.call(value) for key, value in arg.items()}

        if set in self._types and isinstance(arg, set):
            return set(self.call(value) for value in arg)

        if tuple in self._types and isinstance(arg, tuple):
            return tuple(self.call(value) for value in arg)

        if list in self._types and isinstance(arg, list):
            return list(self.call(value) for value in arg)

        return self.method(arg)


@ApplyRecursive(tuple, set, dict)
def double(arg):
    return 2*arg

print(double(1))
print(double({'a': 1, 'b': 2}))
print(double({1, 2, 3}))
print(double((1, 2, 3, 4)))
print(double([1, 2, 3, 4, 5]))

الذي يطبع:

2
{'a': 2, 'b': 4}
{2, 4, 6}
(2, 4, 6, 8)
[1, 2, 3, 4, 5, 1, 2, 3, 4, 5]

لاحظ أن هذا المثال لم يتضمن listالنوع في تأطير الديكور ، لذلك في البيان المطبوع النهائي يتم تطبيق الطريقة على القائمة نفسها ، وليس على عناصر القائمة.


كيف يمكنني صنع اثنين من الديكور في بيثون من شأنه أن يفعل ما يلي؟

تريد الوظيفة التالية ، عندما تسمى:

@makebold
@makeitalic
def say():
    return "Hello"

لكي ترجع:

<b><i>Hello</i></b>

حل بسيط

لمعظم ببساطة القيام بذلك ، وجعل الديكور الذي يعيد lambdas (وظائف مجهولة الهوية) التي تغلق على وظيفة (إغلاق) وتسمى:

def makeitalic(fn):
    return lambda: '<i>' + fn() + '</i>'

def makebold(fn):
    return lambda: '<b>' + fn() + '</b>'

استخدمها الآن حسب الرغبة:

@makebold
@makeitalic
def say():
    return 'Hello'

و الأن:

>>> say()
'<b><i>Hello</i></b>'

مشاكل مع الحل البسيط

ولكن يبدو أننا فقدنا الوظيفة الأصلية تقريبًا.

>>> say
<function <lambda> at 0x4ACFA070>

للعثور عليه ، سوف نحتاج إلى حفر إغلاق كل lambda ، واحد منها مدفون في الآخر:

>>> say.__closure__[0].cell_contents
<function <lambda> at 0x4ACFA030>
>>> say.__closure__[0].cell_contents.__closure__[0].cell_contents
<function say at 0x4ACFA730>

لذلك إذا وضعنا وثائق حول هذه الوظيفة ، أو أردنا أن نتمكن من تزيين الوظائف التي تتطلب أكثر من حجة واحدة ، أو أردنا فقط معرفة الوظيفة التي كنا ننظر إليها في جلسة تصحيح الأخطاء ، نحتاج إلى بذل المزيد من الجهد غلاف.

الحل الكامل المميز - التغلب على معظم هذه المشاكل

لدينا الديكور wrapsمن functoolsالوحدة في المكتبة القياسية!

from functools import wraps

def makeitalic(fn):
    # must assign/update attributes from wrapped function to wrapper
    # __module__, __name__, __doc__, and __dict__ by default
    @wraps(fn) # explicitly give function whose attributes it is applying
    def wrapped(*args, **kwargs):
        return '<i>' + fn(*args, **kwargs) + '</i>'
    return wrapped

def makebold(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return '<b>' + fn(*args, **kwargs) + '</b>'
    return wrapped

من المؤسف أنه لا يزال هناك بعض النمطي ، ولكن هذا الأمر بسيط بقدر ما يمكننا تحقيقه.

في Python 3 ، يمكنك أيضًا الحصول __qualname__عليها __annotations__وتعيينها افتراضيًا.

و الآن:

@makebold
@makeitalic
def say():
    """This function returns a bolded, italicized 'hello'"""
    return 'Hello'

و الأن:

>>> say
<function say at 0x14BB8F70>
>>> help(say)
Help on function say in module __main__:

say(*args, **kwargs)
    This function returns a bolded, italicized 'hello'

استنتاج

لذلك نرى أن wrapsوظيفة الالتفاف تقوم بكل شيء تقريباً باستثناء أن تخبرنا بالضبط ما هي الوظيفة التي تأخذها كحجج.

هناك وحدات أخرى قد تحاول معالجة المشكلة ، ولكن الحل ليس بعد في المكتبة القياسية.


هل يمكن جعل اثنين الديكور منفصلة أن تفعل ما تريد كما هو موضح أدناه مباشرة. لاحظ استخدام *args, **kwargsإعلان wrapped()الدالة الذي يدعم الوظيفة المزودة بخصائص متعددة (وهي ليست ضرورية فعلاً say()للوظيفة المثالية ، ولكنها متضمنة للعمومية).

لأسباب مماثلة ، functools.wrapsيتم استخدام الديكور لتغيير السمات الفوقية للوظيفة الملفوفة لتكون تلك الموجودة في الزينة. هذا يجعل رسائل الخطأ ووثائق الوظائف المدمجة ( func.__doc__) هي تلك الخاصة بالوظيفة المزخرفة بدلاً من wrapped()s.

from functools import wraps

def makebold(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return "<b>" + fn(*args, **kwargs) + "</b>"
    return wrapped

def makeitalic(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return "<i>" + fn(*args, **kwargs) + "</i>"
    return wrapped

@makebold
@makeitalic
def say():
    return 'Hello'

print(say())  # -> <b><i>Hello</i></b>

التحسينات

كما ترى ، هناك الكثير من الشفرات المكررة في هذين المصممين. بالنظر إلى هذا التشابه ، سيكون من الأفضل لك بدلاً من ذلك أن تصنع نوعًا عامًا كان في الواقع مصنعًا للديكور - وبعبارة أخرى ، مصممًا يزيّن الديكورات الأخرى. بهذه الطريقة سيكون هناك تكرار أقل للكود - ويسمح بمتابعة مبدأ DRY .

def html_deco(tag):
    def decorator(fn):
        @wraps(fn)
        def wrapped(*args, **kwargs):
            return '<%s>' % tag + fn(*args, **kwargs) + '</%s>' % tag
        return wrapped
    return decorator

@html_deco('b')
@html_deco('i')
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

لجعل الشفرة أكثر قابلية للقراءة ، يمكنك تعيين اسم وصفي أكثر للديكور الذي تولده المصنع:

makebold = html_deco('b')
makeitalic = html_deco('i')

@makebold
@makeitalic
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

أو حتى الجمع بينهما مثل هذا:

makebolditalic = lambda fn: makebold(makeitalic(fn))

@makebolditalic
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

نجاعة

في حين أن الأمثلة المذكورة أعلاه تعمل بكاملها ، فإن الشفرة التي تم إنشاؤها تنطوي على قدر كبير من النفقات العامة في شكل مكالمات دالة غريبة عندما يتم تطبيق ديكور متعدد في وقت واحد. هذا قد لا يهم ، اعتمادا على الاستخدام الدقيق (الذي قد يكون I / O- ملزمة ، على سبيل المثال).

إذا كانت سرعة الوظيفة المزخرفة مهمة ، فيمكن الحفاظ على الحمل العلوي لمكالمة واحدة إضافية عن طريق كتابة وظيفة مصنع ديكور مختلفة بعض الشيء والتي تنفذ إضافة كل العلامات في وقت واحد ، حتى تتمكن من توليد كود يتجنب المكالمات الدالة الإضافية التي تكبدتها باستخدام ديكورات منفصلة لكل علامة.

وهذا يتطلب المزيد من التعليمات البرمجية في الديكور نفسه ، ولكن هذا لا يعمل إلا عندما يتم تطبيقه على التعريفات الوظيفية ، وليس لاحقًا عندما يتم استدعاؤها. ينطبق هذا أيضًا عند إنشاء أسماء أكثر قابلية للقراءة باستخدام lambdaوظائف كما هو موضح مسبقًا. عينة:

def multi_html_deco(*tags):
    start_tags, end_tags = [], []
    for tag in tags:
        start_tags.append('<%s>' % tag)
        end_tags.append('</%s>' % tag)
    start_tags = ''.join(start_tags)
    end_tags = ''.join(reversed(end_tags))

    def decorator(fn):
        @wraps(fn)
        def wrapped(*args, **kwargs):
            return start_tags + fn(*args, **kwargs) + end_tags
        return wrapped
    return decorator

makebolditalic = multi_html_deco('b', 'i')

@makebolditalic
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

طريقة أخرى لفعل نفس الشيء:

class bol(object):
  def __init__(self, f):
    self.f = f
  def __call__(self):
    return "<b>{}</b>".format(self.f())

class ita(object):
  def __init__(self, f):
    self.f = f
  def __call__(self):
    return "<i>{}</i>".format(self.f())

@bol
@ita
def sayhi():
  return 'hi'

أو أكثر مرونة:

class sty(object):
  def __init__(self, tag):
    self.tag = tag
  def __call__(self, f):
    def newf():
      return "<{tag}>{res}</{tag}>".format(res=f(), tag=self.tag)
    return newf

@sty('b')
@sty('i')
def sayhi():
  return 'hi'

يمكن للمرء استخدام @classmethod عندما يرغب / ترغب في تغيير سلوك الطريقة بناءً على الفئة الفرعية التي تتصل بالطريقة. تذكر أن لدينا مرجع لفئة الاتصال في أسلوب الفصل.

أثناء استخدام static ، قد ترغب في بقاء السلوك بدون تغيير عبر الفئات الفرعية

مثال:

class Hero:

  @staticmethod
  def say_hello():
     print("Helllo...")

  @classmethod
  def say_class_hello(cls):
     if(cls.__name__=="HeroSon"):
        print("Hi Kido")
     elif(cls.__name__=="HeroDaughter"):
        print("Hi Princess")

class HeroSon(Hero):
  def say_son_hello(self):
     print("test  hello")



class HeroDaughter(Hero):
  def say_daughter_hello(self):
     print("test  hello daughter")


testson = HeroSon()

testson.say_class_hello() #Output: "Hi Kido"

testson.say_hello() #Outputs: "Helllo..."

testdaughter = HeroDaughter()

testdaughter.say_class_hello() #Outputs: "Hi Princess"

testdaughter.say_hello() #Outputs: "Helllo..."




python decorator python-decorators