Питання Як зробити ланцюжок декораторів функцій?


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

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

... який повинен повернутися:

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

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


2382
2018-04-11 07:05


походження




Відповіді:


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

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

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

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

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

2658
2018-04-11 07:16



Подумайте про використання functools.wraps або, ще краще, декоратор модуль від PyPI: вони зберігають певні важливі метадані (наприклад, __name__ і, говорячи про пакет декораторів, функція підпису). - Marius Gedminas
*argsі **kwargs слід додати в відповідь. Декотована функція може містити аргументи, і вони будуть втрачені, якщо вони не вказані. - Blusky


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

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

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


Давайте практикуємо: прикрашати декоратор

Добре, як бонус, я дам тобі фрагмент, щоб будь-який декоратор прийняв загалом будь-який аргумент. Зрештою, щоб прийняти аргументи, ми створили наш декоратор за допомогою іншої функції.

Загорнули декоратора.

Все інше, що ми нещодавно бачили, що обернута функція?

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

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

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; див. Нижче).

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

Ви можете використовувати їх для розширення декількох функцій на сухому шляху, так:

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і т. д.

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

Це справді великий ігровий майданчик.


3811
2018-04-11 08:00



"Ви не можете прибрати функцію". - Хоча, як правило, це правда, можна досягти всередині закриття при поверненні функції декоратором (наприклад, через його __closure__ атрибут) витягнути оригінальну нерозпізнану функцію. Один приклад використання в документації ця відповідь який охоплює як можна вводити функцію декоратора на нижчому рівні за обмежених обставин. - metatoaster
Хоча це чудова відповідь, я думаю, що це дещо помилково. Python's @decorator Синтаксис, найімовірніше, найчастіше використовується для заміни функції закриття обгортки (як описується відповідь). Але це також може замінити функцію на щось інше. Вбудований property, classmethod і staticmethod декоратори замінюють функцію дескриптором, наприклад. Декоратор також може робити щось із функцією, наприклад збереження посилання на нього в певному реєстрі, а потім повернути її, не модифікована, без будь-якої обгортки. - Blckknght
Той факт, що "функції є об'єктами", хоча цілком справедливо в Python, є дещо помилковим. Збереження функцій у змінних, передавання їх як аргументів і повернення їх як результатів - це все можливе без функцій, які фактично є об'єктами, і існують різні мови, які мають першокласні функції, але немає об'єктів. - 00dani
Легко краще пояснення в Інтернеті про декораторів, з дуже добре поясненим прикладом, який ходить вам на кожному кроці. Дійсно ціную увагу на подробиці. - Abhi Tk
Дуже корисне, глибоке пояснення. Приклади дуже допомагають! - Charles


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

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

132
2017-10-25 06:18



На мій погляд, краще уникати більше одного декоратора, наскільки це можливо. Якщо мені довелося написати фабричну функцію, я б називав його кодом * kwargs def wrap_in_tag(*kwargs) потім @wrap_in_tag('b','i') - guneysus


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

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

Це

@decorator
def func():
    ...

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

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

101
2018-04-11 07:19



Це настільки елегантно, просто, легко зрозуміти. 10000 ювілей для вас, сер Оккам. - neuronet
Великий і простий відповідь. Хотіли б додати, що під час використання @decorator() (замість @decorator) це синтаксичний цукор для func = decorator()(func). Це також є звичайною практикою, коли потрібно створити декоратори "на льоту" - Omer Dagan


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

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

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

print say()

59
2018-05-17 03:26



І ще один крок: makebold = lambda f : lambda "<b>" + f() + "</b>" - Robᵩ
@ Роб: бути синтаксично правильним: makebold = lambda f: lambda: "<b>" + f() + "</b>" - martineau
Пізніше до вечірки, але я дійсно запропонував би makebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>" - seequ


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


56
2017-12-26 06:13



Зверніть увагу, як елегантний, як лямбда-функції, запропоновані @ Run Кагаардом - rds
Що таке робота власного ключового слова тут? - asit_dhal
@Phoenix: The self Аргумент необхідний тому, що newFunction() визначено в addDashes() був спеціально розроблений, щоб бути a метод декоратор не загальна функція декоратора. The self аргумент являє собою екземпляр класу і передається до методів класу, незалежно від того, чи використовують вони це чи ні - див. розділ під назвою Методи декорування в відповіді @ e-satis. - martineau
Надрукуйте висновок, будь ласка. - user1767754


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

25
2017-12-03 18:09