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

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

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

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

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

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

11.04.2009 07:05:31
17 ОТВЕТОВ
РЕШЕНИЕ

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

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>"
2906
3.04.2019 16:23:00
Подумайте об использовании functools.wraps или, еще лучше, модуля декоратора из PyPI : они сохраняют определенные важные метаданные (такие как __name__и, говоря о пакете декоратора, сигнатуру функции).
Marius Gedminas 11.03.2011 02:30:48
*argsи **kwargsдолжен быть добавлен в ответ. Декорированная функция может иметь аргументы, и они будут потеряны, если не указано иное.
Blusky 2.04.2017 11:47:29
Хотя этот ответ имеет большое преимущество только использования stdlib и работает для этого простого примера, где нет аргументов декоратора или аргументов декорированной функции , он имеет 3 основных ограничения: (1) нет простой поддержки необязательных аргументов декоратора (2) нет подпись сохраняющих (3) не простой способ извлечения имени аргумента из *args, **kwargs. Простой способ решить эти 3 проблемы одновременно - использовать, decopatchкак описано здесь . Вы также можете использовать, decoratorкак уже упоминалось Мариус Гедминас, для решения пунктов 2 и 3.
smarie 11.03.2019 15:28:59

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

61
11.04.2009 07:19:12
Обратите внимание , как элегантно , как лямбда - функции , предложенные @Rune Kaagaard
rds 19.08.2011 10:46:49
@Phoenix: selfАргумент необходим, потому что newFunction()определенный в addDashes()был специально разработан, чтобы быть декоратором метода, а не обычным декоратором функции. selfАргумент представляет собой экземпляр класса и передается методы класса , используют ли они это или нет - смотрите раздел под названием Украшать методы в ответ @ E-Satis в.
martineau 12.07.2013 15:46:27
Распечатайте вывод, пожалуйста.
user1767754 26.05.2015 17:38:44
Пропалfunctools.wraps
Eric 17.09.2018 06:58:18

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

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)))
145
11.04.2009 09:29:28
На мой взгляд, лучше избегать более одного декоратора, насколько это возможно. Если бы мне пришлось написать фабричную функцию, я бы закодировал ее с * kwargs, как def wrap_in_tag(*kwargs)тогда@wrap_in_tag('b','i')
guneysus 29.10.2013 22:29:45

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

Декораторы просто синтаксический сахар.

Эта

@decorator
def func():
    ...

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

def func():
    ...
func = decorator(func)
119
11.04.2009 08:00:42
Это так элегантно, просто, легко понять. 10000 голосов за вас, сэр Окхем.
eric 2.09.2017 17:01:13
Отличный и простой ответ. Хотелось бы добавить, что при использовании @decorator()(а не @decorator) это синтаксический сахар для func = decorator()(func). Это также обычная практика, когда нужно создавать декораторы «на лету»
Omer Dagan 28.09.2017 11:00:59

Если у вас нет длинных объяснений, посмотрите ответ Паоло Бергантино .

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

Функции 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 импортирует скрипт. Вы не можете динамически устанавливать аргументы впоследствии. Когда вы делаете «import x», функция уже оформлена , поэтому вы ничего не можете изменить.


Давайте потренируемся: украшать декоратор

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

Мы завернули декоратор.

Что-нибудь еще, что мы недавно видели, что завернутая функция?

О да, декораторы!

Давайте немного повеселимся и напишем декоратор для декораторов:

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

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

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

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

        return decorator_wrapper

    return decorator_maker

Может использоваться следующим образом:

# You create the function you will use as a decorator. And stick a decorator on it :-)
# Don't forget, the signature is "decorator(func, *args, **kwargs)"
@decorator_with_args 
def decorated_decorator(func, *args, **kwargs): 
    def wrapper
  
4184
29.04.2019 00:06:42
«Вы не можете отменить декорацию функции». - Хотя обычно это правда, в замыкании функции можно получить возврат, возвращаемый декоратором (то есть через его __closure__атрибут), чтобы извлечь исходную недекорированную функцию. Один пример использования документирован в этом ответе, который охватывает, как можно ввести функцию декоратора на более низком уровне в ограниченных обстоятельствах.
metatoaster 22.10.2015 00:04:23
Хотя это отличный ответ, я думаю, что он в некотором смысле вводит в заблуждение. @decoratorСинтаксис Python, вероятно, чаще всего используется для замены функции закрытием оболочки (как описано в ответе). Но он также может заменить функцию чем-то другим. Встроенная команда property, classmethodи staticmethodдекораторы заменить функцию с дескриптором, например. Декоратор также может сделать что-то с функцией, например, сохранить ссылку на нее в каком-либо реестре, а затем вернуть ее без изменений, без какой-либо оболочки.
Blckknght 11.04.2016 13:04:10
Тот факт, что «функции - это объекты», хотя в Python полностью верны, немного вводит в заблуждение. Хранение функций в переменных, передача их в качестве аргументов и возврат их в качестве результатов возможны без функций, фактически являющихся объектами, и существуют различные языки, которые имеют функции первого класса, но не имеют объектов.
00dani 15.12.2016 02:18:43
это один эпический ответ прямо здесь ... Спасибо за тонну! Почему аргументы по умолчанию для функции не отображаются как аргументы / kwargs в оболочке декоратора?
Naz 6.01.2019 01:13:57
Это единственный лучший ответ на декораторов. Лучше, чем любые учебники, блоги или видео, которые я смотрел. Спасибо!
Nahua 13.11.2019 19:01:48

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

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

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

print say()
64
25.10.2010 06:18:12
И еще один шаг вперед:makebold = lambda f : lambda "<b>" + f() + "</b>"
Robᵩ 4.03.2013 22:26:00
@ Robᵩ: чтобы быть синтаксически правильным:makebold = lambda f: lambda: "<b>" + f() + "</b>"
martineau 20.12.2013 16:01:44
Поздно на вечеринку, но я бы действительно предложилmakebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>"
seequ 6.02.2015 18:19:40
Это необходимо functools.wrapsдля того, чтобы не выбросить строку документации / подпись / имяsay
Eric 17.09.2018 06:58:45
Ну, важно то, упоминается ли это в вашем ответе. Имея в @wrapsдругом месте на этой странице , не собирается , чтобы помочь мне , когда я печатаю help(say)и получить «Помощь на функцию <лямбда>` вместо „Справка о функции говорят“ .
Eric 18.09.2018 18:02:11

Еще один способ сделать то же самое:

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'
20
19.10.2014 18:47:01
Нужно functools.update_wrapper, чтобы сохранитьsayhi.__name__ == "sayhi"
Eric 17.09.2018 06:57:56

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

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), и переменная counter останется закрытой для каждой функции.

6
2.03.2012 21:47:17

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

@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

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

13
19.09.2019 14:33:34
Не должен ли вывод print(do(65))и print(do2(65))быть Aи A?
Treefish Zhang 31.01.2017 19:59:20

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

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  
6
15.02.2014 19:09:04
Это можно легко сделать еще более универсальным, предоставив поддержку аргументов ключевых слов через def wrapper(*args, **kwargs):и fn(*args, **kwargs).
martineau 17.05.2015 02:33:50

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

############################################################
#
#    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>
7
17.06.2013 04:43:25
#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")
8
24.07.2017 14:14:06
Причина, по которой здесь нравится класс, заключается в том, что поведение явно связано с двумя примерами. Вы можете получить два декоратора, назначив сконструированные классы нужным именам, а не повторяя параметры. Это сложнее сделать с функцией. Добавление его в пример указывает, почему это не просто избыточно.
Jon Jay Obermark 28.08.2014 15:46:58

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

С:

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

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

func(*args, **kwargs)

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

decor1(decor2(func))(*args, **kwargs)
12
7.02.2020 01:46:43

Вы можете сделать два отдельных декоратора, которые будут делать то, что вы хотите, как показано ниже. Обратите внимание на использование *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>
37
17.10.2019 12:14:36
upvote для обращения к DRY :-)
nitin3685 13.11.2019 08:41:41

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

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

19
5.12.2016 17:33:41

На этот ответ уже давно дан ответ, но я подумал, что поделюсь своим классом 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тип в экземпляре декоратора, поэтому в последнем операторе print метод применяется к самому списку, а не к элементам списка.

8
11.11.2018 15:02:23

Ответ Паоло Бергантино имеет большое преимущество, заключающееся в использовании только stdlib, и работает для этого простого примера, где нет аргументов декоратора или аргументов декорированной функции .

Однако он имеет 3 основных ограничения, если вы хотите заняться более общими случаями:

  • как уже отмечалось в нескольких ответах, вы не можете легко изменить код, добавив необязательные аргументы декоратора . Например, создание makestyle(style='bold')декоратора нетривиально.
  • кроме того, оболочки, созданные с помощью @functools.wraps , не сохраняют сигнатуру , поэтому, если предоставлены неверные аргументы, они начнут выполняться и могут вызвать ошибку другого типа, чем обычно TypeError.
  • наконец, это довольно сложно в обертках , созданные с помощью, @functools.wrapsчтобы получить доступ к аргументу , основанный на его имя . Действительно, аргумент может появляться в *args, в **kwargsили может не появляться вообще (если это необязательно).

Я написал, decopatchчтобы решить первую проблему, и написал, makefun.wrapsчтобы решить две другие. Обратите внимание, что makefunиспользует тот же трюк, что и знаменитый decoratorlib.

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

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

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

5
11.03.2019 15:24:57