फ़ंक्शन डेकोरेटर्स की एक श्रृंखला कैसे बनाएं?


2754

मैं पायथन में दो सज्जाकार कैसे बना सकता हूं जो निम्नलिखित कार्य करेंगे?

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

... जो लौटना चाहिए:

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

मैं HTMLइस तरह से एक वास्तविक अनुप्रयोग बनाने की कोशिश नहीं कर रहा हूं - बस यह समझने की कोशिश कर रहा हूं कि सज्जाकार और डेकोरेटर कैसे काम करता है।

जवाबों:


2925

की जाँच करें प्रलेखन कैसे सज्जाकार काम को देखने के लिए। यहाँ आप के लिए पूछा है:

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 hello():
    return "hello world"

@makebold
@makeitalic
def log(s):
    return s

print hello()        # returns "<b><i>hello world</i></b>"
print hello.__name__ # with functools.wraps() this returns "hello"
print log('hello')   # returns "<b><i>hello</i></b>"

261
फंक्शनलबुलस्वैप्स या बेहतर, अभी तक, PyPI से डेकोरेटर मॉड्यूल का उपयोग करने पर विचार करें : वे कुछ महत्वपूर्ण मेटाडेटा (जैसे कि __name__और, डेकोरेटर पैकेज, फ़ंक्शन हस्ताक्षर के बारे में बोलते हुए) को संरक्षित करते हैं ।
मारियस गेदमिनस

31
*argsऔर **kwargsउत्तर में जोड़ा जाना चाहिए। सजाए गए फ़ंक्शन में तर्क हो सकते हैं, और निर्दिष्ट नहीं होने पर वे खो जाएंगे।
ब्लुसकी

3
हालाँकि इस उत्तर का केवल stdlib का उपयोग करने का महान लाभ है, और इस सरल उदाहरण के लिए काम करता है जहाँ कोई डेकोरेटर तर्क नहीं हैं और न ही फ़ंक्शन तर्क हैं, इसकी 3 प्रमुख सीमाएँ हैं: (1) वैकल्पिक डेकोरेटर तर्कों के लिए कोई सरल समर्थन नहीं है (2) नहीं हस्ताक्षर के संरक्षण (3) कोई सरल तरीका से एक नामित तर्क को निकालने के लिए *args, **kwargs। इन 3 मुद्दों को एक बार में हल करने का एक आसान तरीका है, decopatchजैसा कि यहाँ बताया गया हैdecoratorअंक 2 और 3 को हल करने के लिए आप Marius Gedminas द्वारा पहले ही बताए अनुसार उपयोग कर सकते हैं
Smarie

4209

यदि आप लंबे समय तक स्पष्टीकरण में नहीं हैं, तो पाओलो बर्गेंटिनो का जवाब देखें

डेकोरेटर बेसिक्स

पायथन के कार्य ऑब्जेक्ट हैं

डेकोरेटर्स को समझने के लिए, आपको पहले समझना चाहिए कि फ़ंक्शन पायथन में ऑब्जेक्ट हैं। इसके महत्वपूर्ण परिणाम हैं। आइए देखें कि एक साधारण उदाहरण के साथ क्यों:

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 as 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 as 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_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!

डेकोरेटर्स ध्वस्त हो गए

पिछले उदाहरण, डेकोरेटर सिंटैक्स का उपयोग कर:

@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) का संदर्भ है ।

इसका मतलब है कि आप उसी तरह तरीकों के लिए एक डेकोरेटर बना सकते हैं! बस ध्यान रखना याद रखें 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:

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, आप पायथन को '' वेरिएबल द्वारा लेबल '' फंक्शन को कॉल करने के लिए कह रहे हैं 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.

यहां कोई आश्चर्य नहीं।

चलो एक ही बात करते हैं, लेकिन सभी pesky मध्यवर्ती चर छोड़ें:

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: /programming/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चाहें तो उपयोग भी कर सकते हैं । लेकिन याद रखें डेकोरेटर्स को केवल एक बार बुलाया जाता है । जब पायथन स्क्रिप्ट का आयात करता है। आप गतिशील रूप से तर्कों को बाद में सेट नहीं कर सकते। जब आप "आयात 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!

मुझे पता है, पिछली बार जब आप यह महसूस कर रहे थे, तो यह एक आदमी को यह कहते हुए सुनने के बाद था: "पुनरावृत्ति को समझने से पहले, आपको पहले पुनरावृत्ति को समझना होगा"। लेकिन अब, क्या आपको इसमें महारत हासिल करना अच्छा नहीं लगता?


सर्वोत्तम अभ्यास: सज्जाकार

  • पायथन 2.4 में सज्जाकार पेश किए गए थे, इसलिए सुनिश्चित करें कि आपका कोड> = 2.4 पर चलाया जाएगा।
  • सज्जाकार फ़ंक्शन कॉल को धीमा कर देते हैं। यह याद रखना।
  • आप किसी फ़ंक्शन को अन-डेकोरेट नहीं कर सकते। ( डेकोरेटर बनाने के लिए हैक होते हैं जिन्हें हटाया जा सकता है, लेकिन कोई भी उनका उपयोग नहीं करता है।) इसलिए एक बार किसी फ़ंक्शन को सजाने के बाद, इसे सभी कोड के लिए सजाया जाता है ।
  • डेकोरेटर फ़ंक्शंस लपेटते हैं, जिससे उन्हें डीबग करना मुश्किल हो सकता है। (यह पायथन से बेहतर हो जाता है> = 2.5; नीचे देखें।)

functoolsमॉड्यूल अजगर 2.5 में पेश किया गया था। इसमें फ़ंक्शन शामिल है functools.wraps(), जो अपने आवरण के लिए सजाए गए फ़ंक्शन के नाम, मॉड्यूल और डॉकस्ट्रिंग की प्रतिलिपि बनाता है।

(मजेदार तथ्य: functools.wraps()एक डेकोरेटर है! A)

# 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 संभावनाएं हैं। क्लासिक उपयोग बाहरी व्यवहार से एक फ़ंक्शन व्यवहार का विस्तार कर रहे हैं (आप इसे संशोधित नहीं कर सकते हैं), या डिबगिंग के लिए (आप इसे संशोधित नहीं करना चाहते क्योंकि यह अस्थायी है)।

आप डीआरवाई के तरीके से कई कार्यों का विस्तार करने के लिए उनका उपयोग कर सकते हैं, जैसे:

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

बेशक डेकोरेटर्स के साथ अच्छी बात यह है कि आप उन्हें बिना राइटिंग के लगभग किसी भी चीज पर तुरंत इस्तेमाल कर सकते हैं। DRY, मैंने कहा:

@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 सज्जाकारों का उपयोग कैशिंग प्रबंधन करने और अनुमतियाँ देखने के लिए करता है।
  • अतुल्यकालिक कार्यों कॉल नकली नकली करने के लिए मुड़।

यह वास्तव में एक बड़ा खेल का मैदान है।


15
"आप किसी फ़ंक्शन को अन-डेकोरेट नहीं कर सकते।" - जबकि सामान्य रूप से सच है, __closure__मूल अघोषित फ़ंक्शन को बाहर निकालने के लिए एक डेकोरेटर (यानी अपनी विशेषता के माध्यम से ) फ़ंक्शन द्वारा क्लोजर के अंदर पहुंचना संभव है । एक उदाहरण के उपयोग को इस उत्तर में प्रलेखित किया गया है जो यह बताता है कि सीमित परिस्थितियों में एक डेकोरेटर फ़ंक्शन को निचले स्तर पर कैसे इंजेक्ट करना संभव है।
मेटेटास्टर

7
हालांकि यह एक महान जवाब है, मुझे लगता है कि यह कुछ मायनों में भ्रामक है। पायथन का @decoratorसिंटैक्स संभवतः सबसे अधिक बार एक फ़ंक्शन को रैपर क्लोजर के साथ बदलने के लिए उपयोग किया जाता है (जैसा कि उत्तर बताता है)। लेकिन यह फ़ंक्शन को कुछ और के साथ भी बदल सकता है। Builtin property, classmethodऔर staticmethodसज्जाकार उदाहरण के लिए, एक विवरणक के साथ समारोह की जगह। एक डेकोरेटर एक फ़ंक्शन के साथ भी कुछ कर सकता है, जैसे कि किसी प्रकार की रजिस्ट्री में इसके संदर्भ को सहेजना, फिर बिना किसी आवरण के इसे अनमॉडिफाइड लौटा दें।
ब्लोकनाथ

3
यह तथ्य कि "कार्य वस्तुएं हैं", जबकि पायथन में पूरी तरह से सच है, थोड़ा भ्रामक है। चर में कार्य करना, उन्हें तर्क के रूप में पारित करना, और परिणाम के रूप में उन्हें वापस करना सभी कार्यों के बिना संभव है वास्तव में ऑब्जेक्ट्स हैं, और ऐसी विभिन्न भाषाएं हैं जिनके पास प्रथम श्रेणी के कार्य हैं लेकिन कोई वस्तु नहीं है।
00dani

1
यह एक महाकाव्य जवाब है वहीं ... धन्यवाद एक टन! एक फ़ंक्शन के लिए डिफ़ॉल्ट तर्क कैसे दिखते हैं, या तो डेकोरेटर के रैपर में args / kwargs नहीं दिखाते हैं, हालांकि?
नाज़

इस उत्तर के शीर्ष पर वापस जाने के लिए सभी तरह से स्क्रॉल किया क्योंकि "डेकोरेटर कैसे उपयोगी हो सकते हैं?" सेक्शन इतना मददगार था।
नौमेनन

145

वैकल्पिक रूप से, आप फ़ैक्टरी फ़ंक्शन लिख सकते हैं जो एक डेकोरेटर को लौटाता है जो फ़ैक्टरी फ़ंक्शन को दिए गए टैग में सजाए गए फ़ंक्शन के रिटर्न मान को लपेटता है। उदाहरण के लिए:

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)))

5
मेरी राय में, जहां तक ​​संभव हो एक से अधिक डेकोरेटर से बचना बेहतर है। अगर मैं एक कारखाने समारोह लिखना पड़ा मैं की तरह * kwargs साथ यह कोड होता def wrap_in_tag(*kwargs)तो@wrap_in_tag('b','i')
guneysus

120

ऐसा लगता है कि अन्य लोगों ने आपको पहले ही बता दिया है कि समस्या को कैसे हल किया जाए। मुझे उम्मीद है कि इससे आपको समझने में मदद मिलेगी कि सज्जाकार क्या हैं।

डेकोरेटर्स सिंटैक्टिकल चीनी हैं।

इस

@decorator
def func():
    ...

तक फैलता है

def func():
    ...
func = decorator(func)

3
यह इतना सुंदर, सरल, समझने में आसान है। आपके लिए 10000 अपवोट सर ओखम।
एरिक

2
शानदार और सरल जवाब। यह जोड़ना चाहते हैं कि जब @decorator()(के बजाय @decorator) का उपयोग कर के लिए यह वाक्यात्मक चीनी है func = decorator()(func)। यह भी आम बात है जब आपको डेकोरेटर्स को "फ्लाई पर" उत्पन्न करने की आवश्यकता होती है
ओमर डेगन

64

और निश्चित रूप से आप लैम्ब्डा के साथ-साथ डेकोरेटर फ़ंक्शन से भी लौट सकते हैं:

def makebold(f): 
    return lambda: "<b>" + f() + "</b>"
def makeitalic(f): 
    return lambda: "<i>" + f() + "</i>"

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

print say()

12
और एक कदम आगे:makebold = lambda f : lambda "<b>" + f() + "</b>"
रोब

13
@ रोब @: वाक्यात्मक रूप से सही होने के लिए:makebold = lambda f: lambda: "<b>" + f() + "</b>"
मार्टीन्यू

11
पार्टी के लिए देर हो चुकी है, लेकिन मैं वास्तव में सुझाव makebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>"
दूंगा

functools.wrapsडॉकस्ट्रिंग / हस्ताक्षर / नाम का त्याग नहीं करने की आवश्यकता हैsay
एरिक

खैर, क्या मायने रखता है कि यह आपके उत्तर में उल्लिखित है। @wrapsइस पृष्ठ पर कहीं और होने से मुझे मदद नहीं मिलेगी जब मैं प्रिंट करता हूं help(say)और "हेल्प ऑन फंक्शन कहने" के बजाय " फंक्शन ऑन फंक्शन <lambda> " प्राप्त करता हूं
एरिक

61

पायथन डेकोरेटर्स दूसरे फ़ंक्शन में अतिरिक्त कार्यक्षमता जोड़ते हैं

एक इटैलिक डेकोरेटर की तरह हो सकता है

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

ध्यान दें कि एक फ़ंक्शन किसी फ़ंक्शन के अंदर परिभाषित किया गया है। यह मूल रूप से क्या करता है एक फ़ंक्शन को नए परिभाषित के साथ बदल दिया जाता है। उदाहरण के लिए, मेरे पास यह वर्ग है

class foo:
    def bar(self):
        print "hi"
    def foobar(self):
        print "hi again"

अब कहते हैं, मैं चाहता हूं कि दोनों कार्य "---" प्रिंट होने के बाद और इससे पहले कि वे किए जाएं। मैं प्रत्येक प्रिंट स्टेटमेंट से पहले और बाद में एक प्रिंट "---" जोड़ सकता था। लेकिन क्योंकि मुझे खुद को दोहराना पसंद नहीं है, मैं एक डेकोरेटर बनाऊंगा

def addDashes(fn): # notice it takes a function as an argument
    def newFunction(self): # define a new function
        print "---"
        fn(self) # call the original function
        print "---"
    return newFunction
    # Return the newly defined function - it will "replace" the original

इसलिए अब मैं अपनी कक्षा को बदल सकता हूं

class foo:
    @addDashes
    def bar(self):
        print "hi"

    @addDashes
    def foobar(self):
        print "hi again"

डेकोरेटर पर अधिक जानकारी के लिए, http://www.ibm.com/developerworks/linux/library/l-cpdecor.html


@Rune Kaagard द्वारा प्रस्तावित लंबो कार्यों के रूप में सुरुचिपूर्ण के रूप में नोट करें
rds

1
@Phoenix: selfतर्क की आवश्यकता है क्योंकि newFunction()परिभाषित किया addDashes()गया था विशेष रूप से एक विधि सज्जाकार के लिए डिज़ाइन किया गया था न कि सामान्य फ़ंक्शन डेकोरेटर। selfतर्क वर्ग उदाहरण का प्रतिनिधित्व करता है और क्या वे इसका इस्तेमाल करते हैं या नहीं वर्ग तरीकों को पारित कर दिया है - शीर्षक अनुभाग देखें सजा तरीकों @ ई-काफ़ी के जवाब में।
मार्टिन

1
कृपया आउटपुट भी प्रिंट करें।
user1767754

मिसिंगfunctools.wraps
एरिक

39

आप दो अलग-अलग डेकोरेटर बना सकते हैं, जो आप जैसा चाहते हैं वैसा सीधे नीचे दर्शाया गया है। फ़ंक्शन *args, **kwargsकी घोषणा में उपयोग पर ध्यान दें, wrapped()जो कई तर्कों वाले सजाए गए फ़ंक्शन का समर्थन करता है (जो कि उदाहरण say()फ़ंक्शन के लिए वास्तव में आवश्यक नहीं है , लेकिन सामान्यता के लिए शामिल है)।

इसी तरह के कारणों के लिए, functools.wrapsडेकोरेटर का उपयोग लिपटे हुए फ़ंक्शन की मेटा विशेषताओं को बदलने के लिए किया जाता है ताकि उन्हें सजाया जा सके। यह त्रुटि संदेश और एम्बेडेड फ़ंक्शन प्रलेखन ( func.__doc__) सजाए गए फ़ंक्शन के बजाय है wrapped()

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>


"@Wraps (मज़ा)" explaination :) के लिए धन्यवाद
walknotes

20

एक ही काम करने का दूसरा तरीका:

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'

functools.update_wrapperरखने की आवश्यकता हैsayhi.__name__ == "sayhi"
एरिक

19

मैं पायथन में दो सज्जाकार कैसे बना सकता हूं जो निम्नलिखित कार्य करेंगे?

आप निम्नलिखित फ़ंक्शन चाहते हैं, जब कहा जाता है:

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

वापस देना:

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

सरल उपाय

ऐसा करने के लिए, डेकोरेटर को लैम्बदास (अनाम फ़ंक्शन) लौटाएं जो फ़ंक्शन (क्लोजर) पर बंद हो और कॉल करें:

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>

इसे खोजने के लिए, हमें प्रत्येक लैम्ब्डा के बंद होने पर खुदाई करने की आवश्यकता होगी, जिसमें से एक को दूसरे में दफन किया गया है:

>>> 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

यह दुर्भाग्यपूर्ण है कि अभी भी कुछ बॉयलरप्लेट है, लेकिन यह उतना ही सरल है जितना हम इसे बना सकते हैं।

पायथन 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रैपिंग फंक्शन लगभग सब कुछ कर देता है, सिवाय इसके कि हमें बताएं कि फंक्शन को तर्कों के रूप में क्या कहते हैं।

अन्य मॉड्यूल हैं जो समस्या से निपटने का प्रयास कर सकते हैं, लेकिन समाधान अभी तक मानक पुस्तकालय में नहीं है।


14

डेकोरेटर को सरल तरीके से समझाने के लिए:

साथ में:

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

जब करते हैं:

func(*args, **kwargs)

आपने सचमुच किया:

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

13

एक डेकोरेटर फ़ंक्शन की परिभाषा लेता है और एक नया फ़ंक्शन बनाता है जो इस फ़ंक्शन को निष्पादित करता है और परिणाम को बदल देता है।

@deco
def do():
    ...

के बराबर है:

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

इसके बराबर है

def do2(number):
    return chr(number)

do2 = deco(do2)

65 <=> 'ए'

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

डेकोरेटर को समझने के लिए, यह नोटिस करना महत्वपूर्ण है, कि डेकोरेटर ने एक नया फंक्शन किया जो आंतरिक है जो फ़ंक्शन को निष्पादित करता है और परिणाम को रूपांतरित करता है।


के उत्पादन में नहीं करना चाहिए print(do(65))और print(do2(65))हो Aऔर A?
ट्रीफ़िश झांग

8
#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")

1
यहां एक वर्ग को पसंद करने का कारण स्पष्ट रूप से संबंधित व्यवहार है, जिसमें दो उदाहरण हैं। मापदंडों को फिर से पुनरावृत्त करने के बजाय, आप वास्तव में अपने दो डेकोरेटर्स को निर्माण किए गए नामों को असाइन कर सकते हैं। यह एक फ़ंक्शन के साथ करना कठिन है। इसे उदाहरण से जोड़ना यह इंगित करेगा कि यह केवल निरर्थक क्यों नहीं है।
जॉन जे ओबेरमार्क

8

यह उत्तर लंबे समय से उत्तर दिया गया है, लेकिन मैंने सोचा कि मैं अपने डेकोरेटर वर्ग को साझा करूंगा जो नए सज्जाकारों को लिखना आसान और कॉम्पैक्ट बनाता है।

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में डेकोरेटर की तात्कालिकता में प्रकार शामिल नहीं था , इसलिए अंतिम प्रिंट स्टेटमेंट में विधि को सूची में ही लागू किया जाता है, सूची के तत्वों पर नहीं।


7

यहाँ सजावट करने वालों का एक सरल उदाहरण है। अंतिम पंक्ति पर ध्यान दें - यह दिखाता है कि कवर के तहत क्या हो रहा है।

############################################################
#
#    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>

6

काउंटर उदाहरण का बोलना - जैसा कि ऊपर दिया गया है, काउंटर सभी कार्यों के बीच साझा किया जाएगा जो डेकोरेटर का उपयोग करते हैं:

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), और काउंटर चर प्रत्येक के लिए निजी रहेगा।


6

विभिन्न प्रकार के तर्कों के साथ कार्यों को सजाएं:

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  

1
यह आसानी से भी माध्यम से कीवर्ड तर्क के लिए सहायता प्रदान करके और भी अधिक बहुमुखी बनाया जा सकता है def wrapper(*args, **kwargs):और fn(*args, **kwargs)
मार्टिउ

5

पाओलो बर्गेंटिनो के जवाब में केवल स्टैडलिब का उपयोग करने का बड़ा फायदा है, और इस सरल उदाहरण के लिए काम करता है, जहां न तो डेकोरेटर तर्क हैं और न ही सजाए गए फ़ंक्शन तर्क हैं।

हालाँकि इसकी 3 प्रमुख सीमाएँ हैं यदि आप अधिक सामान्य मामलों से निपटना चाहते हैं:

  • जैसा कि पहले से ही कई उत्तरों में बताया गया है, आप वैकल्पिक डेकोरेटर तर्कों को जोड़ने के लिए कोड को आसानी से संशोधित नहीं कर सकते । उदाहरण के लिए एक makestyle(style='bold')डेकोरेटर बनाना गैर-तुच्छ है।
  • इसके अलावा, बनाए गए रैपर @functools.wraps हस्ताक्षर को संरक्षित नहीं करते हैं , इसलिए यदि खराब तर्क प्रदान किए जाते हैं तो वे निष्पादित करना शुरू कर देंगे, और सामान्य से अलग तरह की त्रुटि उठा सकते हैं TypeError
  • अंत में, अपने नाम के आधार पर किसी तर्क तक पहुंचने के@functools.wraps लिए बनाए गए रैपर में यह काफी मुश्किल है । वास्तव में तर्क में , या में प्रकट हो सकता है, या बिल्कुल भी प्रकट नहीं हो सकता है (यदि यह वैकल्पिक है)।*args**kwargs

मैंने decopatchपहले मुद्दे makefun.wrapsको हल करने के लिए लिखा, और अन्य दो को हल करने के लिए लिखा । ध्यान दें कि makefunप्रसिद्ध decoratorलिबास की तुलना में समान चाल का लाभ उठाता है ।

यह है कि आप तर्कों के साथ एक डेकोरेटर बनाएंगे, जो वास्तव में हस्ताक्षर-संरक्षण वाले रैपर लौटाएगा:

from decopatch import function_decorator, DECORATED
from makefun import wraps

@function_decorator
def makestyle(st='b', fn=DECORATED):
    open_tag = "<%s>" % st
    close_tag = "</%s>" % st

    @wraps(fn)
    def wrapped(*args, **kwargs):
        return open_tag + fn(*args, **kwargs) + close_tag

    return wrapped

decopatchआपको दो अन्य विकास शैलियों प्रदान करता है जो आपकी प्राथमिकताओं के आधार पर विभिन्न अजगर अवधारणाओं को छिपाते हैं या दिखाते हैं। सबसे कॉम्पैक्ट शैली निम्नलिखित है:

from decopatch import function_decorator, WRAPPED, F_ARGS, F_KWARGS

@function_decorator
def makestyle(st='b', fn=WRAPPED, f_args=F_ARGS, f_kwargs=F_KWARGS):
    open_tag = "<%s>" % st
    close_tag = "</%s>" % st
    return open_tag + fn(*f_args, **f_kwargs) + close_tag

दोनों मामलों में आप जांच सकते हैं कि डेकोरेटर अपेक्षा के अनुसार काम करता है:

@makestyle
@makestyle('i')
def hello(who):
    return "hello %s" % who

assert hello('world') == '<b><i>hello world</i></b>'    

कृपया विवरण के लिए प्रलेखन देखें।

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.