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

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

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

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

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

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

15 ответов


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

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

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

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

функции 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?

передача аргументов декоратору

отлично, теперь что бы вы сказали о передаче аргументов сам декоратор?

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

прежде чем прибегать к решению, давайте напишем небольшое напоминание:

# 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.
  • декораторы замедляют вызов функции. Имейте это в виду.
  • вы не можете отменить украшение функции. (здесь are хаки для создания декораторов, которые могут быть удалены, но никто не использует их.) Так как только функция украшена, она украшенный для всего кода.
  • декораторы оборачивают функции, которые могут затруднить их отладку. (Это становится лучше от Python >= 2.5; см. ниже.)

на functools модуль был представлен в Python 2.5. Он включает в себя функцию functools.wraps(), который копирует имя, модуль и docstring оформленной функции в ее оболочку.

(забавный факт: 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

конечно, хорошая вещь с декораторами заключается в том, что вы можете использовать их сразу на почти все без переписывания. Сухой, я сказал:--49-->

@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, etc.

  • Django использует декораторы для управления разрешениями кэширования и просмотра.
  • Twisted для поддельных встроенных асинхронных вызовов функций.

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


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

from functools import wraps

def wrap_in_tag(tag):
    def factory(func):
        @wraps(func)
        def decorator():
            return '<%(tag)s>%(rv)s</%(tag)s>' % (
                {'tag': tag, 'rv': func()})
        return decorator
    return factory

это позволит вам написать:

@wrap_in_tag('b')
@wrap_in_tag('i')
def say():
    return 'hello'

или

makebold = wrap_in_tag('b')
makeitalic = wrap_in_tag('i')

@makebold
@makeitalic
def say():
    return 'hello'

лично я написал бы декоратору несколько иначе:

from functools import wraps

def wrap_in_tag(tag):
    def factory(func):
        @wraps(func)
        def decorator(val):
            return func('<%(tag)s>%(val)s</%(tag)s>' %
                        {'tag': tag, 'val': val})
        return decorator
    return factory

что бы выход:

@wrap_in_tag('b')
@wrap_in_tag('i')
def say(val):
    return val
say('hello')

не забудьте конструкцию, для которой декоратор синтаксис-это стенография:

say = wrap_in_tag('b')(wrap_in_tag('i')(say)))

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

декораторы - это просто синтаксический сахар.

этой

@decorator
def func():
    ...

увеличивается до

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

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

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

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

print say()

декораторы Python добавляют дополнительную функциональность в другую функцию

курсив декоратор может быть как

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

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

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

теперь скажите, Я хочу, чтобы обе функции печатали "- - - " после и до того, как они будут сделаны. Я мог бы добавить печать "- - - " до и после каждого оператора печати. Но ведь я не словно повторяясь, я сделаю декоратора

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

Итак, теперь я могу изменить свой класс

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

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

подробнее о декораторами, проверить http://www.ibm.com/developerworks/linux/library/l-cpdecor.html


вы мог бы сделать два отдельных декораторов, которые делают то, что вы хотите, как показано ниже. Обратите внимание на использование *args, **kwargs в заявлении wrapped() функция, которая поддерживает украшенную функцию, имеющую несколько аргументов (что на самом деле не обязательно для примера


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

class bol(object):
  def __init__(self, f):
    self.f = f
  def __call__(self):
    return "<b>{}</b>".format(self.f())

class ita(object):
  def __init__(self, f):
    self.f = f
  def __call__(self):
    return "<i>{}</i>".format(self.f())

@bol
@ita
def sayhi():
  return 'hi'

или, более гибко:

class sty(object):
  def __init__(self, tag):
    self.tag = tag
  def __call__(self, f):
    def newf():
      return "<{tag}>{res}</{tag}>".format(res=f(), tag=self.tag)
    return newf

@sty('b')
@sty('i')
def sayhi():
  return 'hi'

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

при вызове требуется следующая функция:

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

вернуться:

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

простое решение

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

def makeitalic(fn):
    return lambda: '<i>' + fn() + '</i>'

def makebold(fn):
    return lambda: '<b>' + fn() + '</b>'

теперь используйте их как желаемое:

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

и так:

>>> say()
'<b><i>Hello</i></b>'

проблемы с простым решением

но мы, кажется, почти потеряли исходную функцию.

>>> say
<function <lambda> at 0x4ACFA070>

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

>>> say.__closure__[0].cell_contents
<function <lambda> at 0x4ACFA030>
>>> say.__closure__[0].cell_contents.__closure__[0].cell_contents
<function say at 0x4ACFA730>

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

полнофункциональное решение-преодоление большинства из этих проблем

у нас есть декоратор wraps С functools модуль в стандартной библиотеке!

from functools import wraps

def makeitalic(fn):
    # must assign/update attributes from wrapped function to wrapper
    # __module__, __name__, __doc__, and __dict__ by default
    @wraps(fn) # explicitly give function whose attributes it is applying
    def wrapped(*args, **kwargs):
        return '<i>' + fn(*args, **kwargs) + '</i>'
    return wrapped

def makebold(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return '<b>' + fn(*args, **kwargs) + '</b>'
    return wrapped

к сожалению, есть еще некоторые шаблонные, но это примерно так просто, как мы можем это сделать.

в Python 3, вы также получаете __qualname__ и __annotations__ назначается по умолчанию.

Итак:

@makebold
@makeitalic
def say():
    """This function returns a bolded, italicized 'hello'"""
    return 'Hello'

и так:

>>> say
<function say at 0x14BB8F70>
>>> help(say)
Help on function say in module __main__:

say(*args, **kwargs)
    This function returns a bolded, italicized 'hello'

вывод

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

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


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

@deco
def do():
    ...

является eqivarent:

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

является ли eqivalent к этому деф вы. Ц2(количество): вернуть chr (номер)

do2 = deco(do2)

65 'a'

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

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


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

С:

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

когда:

func(*args, **kwargs)

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

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

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

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

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


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

############################################################
#
#    decorators
#
############################################################

def bold(fn):
    def decorate():
        # surround with bold tags before calling original function
        return "<b>" + fn() + "</b>"
    return decorate


def uk(fn):
    def decorate():
        # swap month and day
        fields = fn().split('/')
        date = fields[1] + "/" + fields[0] + "/" + fields[2]
        return date
    return decorate

import datetime
def getDate():
    now = datetime.datetime.now()
    return "%d/%d/%d" % (now.day, now.month, now.year)

@bold
def getBoldDate(): 
    return getDate()

@uk
def getUkDate():
    return getDate()

@bold
@uk
def getBoldUkDate():
    return getDate()


print getDate()
print getBoldDate()
print getUkDate()
print getBoldUkDate()
# what is happening under the covers
print bold(uk(getDate))()

вывод выглядит так:

17/6/2013
<b>17/6/2013</b>
6/17/2013
<b>6/17/2013</b>
<b>6/17/2013</b>

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

def 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