Как составить цепочку декораторов функций?

Question

Как я могу создать в Python два декоратора, которые будут делать следующее?

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

... который должен вернуть:

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

я не пытаюсь сделать HTML таким образом в реальном приложении - просто пытаюсь понять, как работают декораторы и цепочка декораторов.

Answer 1

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

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

Answer 2

Если вы не любите длинные объяснения, см. Ответ Паоло Бергантино.

Основы декоратора

Функции 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: https://stackoverflow.com/questions/13857/can-you-explain-closures-as-they-relate-to-python
        print("I am the decorator. Somehow you passed me arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

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

        return wrapped

    return my_decorator

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

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

Вот:декоратор с аргументами.Аргументы могут быть установлены как переменные:

c1 = "Penny"
c2 = "Leslie"

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

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

Как видите, с помощью этого трюка вы можете передавать аргументы декоратору, как и любую другую функцию.Вы даже можете использовать *args, **kwargs если хотите.Но помните, что декораторы называются только один раз.Просто когда 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 использует декораторы для управления разрешениями на кэширование и просмотр.
• Искажено для подделки встраивания вызовов асинхронных функций.

Это действительно большая игровая площадка.

Answer 3

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

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

Answer 4

Похоже, другие люди уже рассказали вам, как решить проблему.Надеюсь, это поможет вам понять, что такое декораторы.

Декораторы — это всего лишь синтаксический сахар.

Этот

@decorator
def func():
    ...

расширяется до

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

Answer 5

И, конечно же, вы также можете возвращать лямбды из функции декоратора:

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

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

print say()

Answer 6

Декораторы 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

Answer 7

Ты мог создайте два отдельных декоратора, которые будут делать то, что вы хотите, как показано ниже.Обратите внимание на использование *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>

Уточнения

Как видите, в этих двух декораторах много дублированного кода.Учитывая это сходство, вам было бы лучше вместо этого создать общий вариант, который на самом деле был бы Фабрика декораторов— другими словами, декоратор, который создает других декораторов.Таким образом, будет меньше повторений кода и будет разрешено СУХОЙ принцип, которому следует следовать.

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>

Answer 8

Другой способ сделать то же самое:

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'

Answer 9

Как я могу создать в 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 заставляет функцию-обертку делать почти все, кроме того, что точно сообщает нам, что функция принимает в качестве аргументов.

Существуют и другие модули, которые могут попытаться решить эту проблему, но решения еще нет в стандартной библиотеке.

Answer 10

Декоратор берет определение функции и создает новую функцию, которая выполняет эту функцию и преобразует результат.

@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 (номер):вернуть chr(число)

do2 = deco(do2)

65 <=> 'а'

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

Чтобы понять работу декоратора, важно отметить, что декоратор создал новую внутреннюю функцию do, которая выполняет func и преобразует результат.

Answer 11

Чтобы объяснить декоратор более простым способом:

С:

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

Когда делать:

func(*args, **kwargs)

Вы действительно делаете:

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

Answer 12

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

Answer 13

Вот простой пример объединения декораторов.Обратите внимание на последнюю строку — она показывает, что происходит под одеялом.

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

Answer 14

На этот ответ уже давно был дан ответ, но я решил поделиться своим классом Decorator, который делает написание новых декораторов простым и компактным.

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

Answer 15

Говоря о примере счетчика, как указано выше, счетчик будет использоваться всеми функциями, использующими декоратор:

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)), и переменная счетчика останется частной для каждого.

Answer 16

Украсьте функции разным количеством аргументов:

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  

Answer 17

Ответ Паоло Бергантино имеет большое преимущество использования только 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>'    

Пожалуйста, обратитесь к документация для получения подробной информации.