Як я можу зробити двох декораторів на Python, які б зробили наступне?

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

... що має повернутись:

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

Я не намагаюся зробити HTMLцей шлях справжнім додатком - просто намагаюся зрозуміти, як працюють декоратори та ланцюги декораторів.

Перегляньте документацію, щоб побачити, як працюють декоратори. Ось що ви попросили:

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

Якщо ви не стикаєтеся з довгими поясненнями, дивіться відповідь Паоло Бергантіно .

Основи декораторів

Функції Python - це об'єкти

Щоб зрозуміти декораторів, спочатку потрібно зрозуміти, що функції - це об’єкти в Python. Це має важливі наслідки. Давайте розберемося, чому на простому прикладі:

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

Майте це на увазі. Незабаром ми повернемося до цього кола.

Ще одна цікава властивість функцій Python - це те, що їх можна визначити всередині іншої функції!

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)

Декоратори - це лише пітонічний варіант візерунка дизайну декораторів . Існує кілька класичних моделей дизайну, вбудованих у Python для полегшення розробки (як ітератори).

Звичайно, ви можете накопичувати декораторів:

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~
#<\______/>

Використання синтаксису декоратора Python:

@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

Способи декорування

Одна з найтонших речей щодо Python - це те, що методи та функції дійсно однакові. Різниця полягає лише в тому, що методи очікують, що їх перший аргумент - це посилання на поточний об'єкт ( 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, ви говорите 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: /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якщо хочете. Але пам’ятайте, що декораторів називають лише один раз . Тільки коли Python імпортує сценарій. Ви не можете динамічно встановлювати аргументи після цього. Коли ви "імпортуєте 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!

Я знаю, востаннє у вас виникло таке відчуття, це було після прослуховування хлопця, який говорив: "перш ніж зрозуміти рекурсію, ви повинні спочатку зрозуміти рекурсію". Але тепер, чи не почуваєтесь ви добре в освоєнні цього?

Кращі практики: декоратори

• Декоратори були представлені в Python 2.4, тому переконайтеся, що ваш код буде працювати на> = 2.4.
• Декоратори сповільнюють виклик функції. Майте це на увазі.
• Ви не можете скасувати декорування функції. (Там є зломи для створення декораторів , які можуть бути видалені, але ніхто не використовує їх.) Таким чином , коли функція оформлена, він прикрашений для всього коду .
• Декоратори завершують функції, що може ускладнити їх налагодження. (Це стає краще від Python> = 2.5; див. Нижче.)

functoolsМодуль був введений в Python 2.5. Вона включає в себе функцію functools.wraps(), яка копіює назву, модуль та доктрину прикрашеної функції в її обгортку.

(Веселий факт: 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 можливостей. Класичне використання поширює функціональну поведінку із зовнішньої вкладки (ви не можете її змінити) або для налагодження (ви не хочете її змінювати, оскільки це тимчасово).

Ви можете використовувати їх для розширення декількох функцій 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!

Сам Python надає кілька декораторів: property, staticmethodі т.д.

• Django використовує декоратори для кешування кешування та перегляду дозволів.
• Скручений для підроблених вбудованих асинхронних викликів функцій.

Це дійсно великий дитячий майданчик.

Крім того, ви можете написати заводську функцію, яка поверне декоратор, який обертає повернене значення декорованої функції в тег, переданий заводській функції. Наприклад:

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

Схоже, інші люди вже розповіли, як вирішити проблему. Сподіваюся, це допоможе вам зрозуміти, що таке декоратори.

Декоратори - це просто синтаксичний цукор.

Це

@decorator
def func():
    ...

розширюється до

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

І звичайно, ви можете повернути лямбдаси і з функції декоратора:

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

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

print say()

Декоратори Python додають додаткову функціональність іншій функції

Декоратив курсивом може бути таким

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

Ви можете зробити два окремих декоратори, які роблять те, що ви хочете, як проілюстровано нижче. Зверніть увагу на використання *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>

Ефективність

Хоча вищезазначені приклади виконують усі роботи, генерований код передбачає неабияку кількість накладних витрат у вигляді сторонніх викликів функцій, коли одночасно застосовується кілька декораторів. Це може не мати значення, залежно від точного використання (наприклад, можливо, пов'язане введення / виведення).

Якщо швидкість оформленої функції важлива, накладні дані можуть бути збережені до одного додаткового виклику функції, записавши дещо іншу заводську функцію декоратора, яка реалізує додавання всіх тегів одразу, так що вона може генерувати код, що дозволяє уникнути виникнення додаткових викликів функції. використовуючи окремі декоратори для кожного тегу.

Для цього потрібно більше коду в самому декораторі, але це працює лише тоді, коли він застосовується до визначень функцій, а не пізніше, коли вони самі викликаються. Це також стосується створення більш читаних імен за допомогою 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'

Як я можу зробити двох декораторів на Python, які б зробили наступне?

Коли вам потрібна така функція, вам потрібно:

@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

Прикро, що ще є якась котельня, але це приблизно так просто, як ми можемо це зробити.

У 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змушує функцію обгортання робити майже все, крім того, щоб сказати нам саме те, що функція сприймає як аргументи.

Є й інші модулі, які можуть спробувати вирішити цю проблему, але рішення ще немає в стандартній бібліотеці.

Пояснити декоратора просто:

З:

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

Коли робити:

func(*args, **kwargs)

Ви дійсно робите:

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

Декоратор приймає визначення функції та створює нову функцію, яка виконує цю функцію та перетворює результат.

@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

Щоб зрозуміти декоратора, важливо помітити, що декоратор створив нову функцію, яка є внутрішньою, яка виконує функцію та перетворює результат.

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

На цю відповідь вже давно відповіли, але я думав, що поділюсь своїм класом «Декоратор», який робить написання нових декораторів простим і компактним.

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тип в екземплярі декоратора, тому в остаточному операторі друку метод застосовується до самого списку, а не до елементів списку.

Ось простий приклад прикування декораторів. Зверніть увагу на останній рядок - він показує, що відбувається під обкладинками.

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

Якщо говорити про приклад лічильника - як зазначено вище, лічильник буде розділений між усіма функціями, які використовують декоратор:

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  

Відповідь Паоло Бергантіно має велику перевагу лише в тому, щоб використовувати stdlib, і працює для цього простого прикладу, коли немає аргументів декоратора і аргументованих функцій .

Однак у нього є три основні обмеження, якщо ви хочете вирішити більш загальні випадки:

• як уже зазначалося в кількох відповідях, ви не можете легко змінити код, щоб додати необов'язкові аргументи декоратора . Наприклад, створення 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надає вам ще два стилі розробки, які приховують або показують різні поняття python, залежно від ваших уподобань. Найбільш компактний стиль такий:

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

Для отримання детальної інформації зверніться до документації .