함수 데코레이터 체인을 만드는 방법?


2755

파이썬에서 다음을 수행하는 데코레이터 두 개를 어떻게 만들 수 있습니까?

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

... 반환해야합니다 :

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

HTML실제 응용 프로그램 에서이 방법 을 만들려고하지는 않습니다 . 데코레이터와 데코레이터 체인이 어떻게 작동하는지 이해하려고합니다.

답변:


2926

확인 설명서를 장식 작동 방식을 볼 수 있습니다. 요청한 내용은 다음과 같습니다.

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

261
functools.wraps를 사용 하거나 PyPI데코레이터 모듈을 사용 하는 것이 좋습니다 __name__. 데코레이터 패키지, 함수 서명과 같은 특정 중요한 메타 데이터를 보존 합니다.
Marius Gedminas

31
*args그리고 **kwargs이 질문에 추가해야합니다. 데코 레이팅 된 함수는 인수를 가질 수 있으며 지정되지 않으면 손실됩니다.
Blusky

3
이 답변은 stdlib 만 사용하는 것의 큰 이점이 있지만 데코레이터 인수 또는 데코레이션 된 함수 인수가 없는이 간단한 예제에서는 작동 하지만 3 가지 주요 제한 사항이 있습니다. (1) 선택적 데코레이터 인수에 대한 간단한 지원 없음 (2) 서명 보존 (3) *args, 에서 명명 된 인수를 추출하는 간단한 방법은 없습니다 **kwargs. 이 3 가지 문제를 한 번에 해결하는 쉬운 방법은 여기decopatch 설명 된대로 사용 하는 입니다. decoratorMarius Gedminas가 이미 언급 한대로 포인트 2와 3을 풀 수 있습니다.
smarie

4209

자세한 설명이 없으면 Paolo Bergantino의 답변을 참조하십시오 .

데코레이터 기본

파이썬의 함수는 객체입니다

데코레이터를 이해하려면 먼저 함수가 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!'

이것을 명심하십시오. 우리는 곧 다시 동그라미 할 것입니다.

파이썬 함수의 또 다른 흥미로운 속성은 다른 함수 안에 정의 할 수 있다는 것입니다!

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)

데코레이터는 단지 데코레이터 디자인 패턴 의 파이썬 변형입니다 . 파이썬과 같은 몇 가지 고전적인 디자인 패턴이 내장되어있어 개발을 쉽게 할 수 있습니다.

물론 데코레이터를 쌓을 수 있습니다.

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

파이썬 데코레이터 구문 사용하기 :

@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

장식 방법

파이썬에 대한 좋은 점은 메소드와 함수가 실제로 동일하다는 것입니다. 유일한 차이점은 메소드가 첫 번째 인수가 현재 오브젝트 ( 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, 당신은 파이썬에게 '변수에 의해 레이블 된' ''함수를 호출하도록 지시하고 있습니다 my_decorator.

이것은 중요합니다! 당신이 줄 레이블은 decorator-에 직접 가리킬 수 있습니다 여부 .

사악 해지자 ☺

def decorator_maker():

    print("I make decorators! I am executed only once: "
          "when you make me create a decorator.")

    def my_decorator(func):

        print("I am a decorator! I am executed only when you decorate a function.")

        def wrapped():
            print("I am the wrapper around the decorated function. "
                  "I am called when you call the decorated function. "
                  "As the wrapper, I return the RESULT of the decorated function.")
            return func()

        print("As the decorator, I return the wrapped function.")

        return wrapped

    print("As a decorator maker, I return a decorator")
    return my_decorator

# Let’s create a decorator. It’s just a new function after all.
new_decorator = decorator_maker()       
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator

# Then we decorate the function

def decorated_function():
    print("I am the decorated function.")

decorated_function = new_decorator(decorated_function)
#outputs:
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function

# Let’s call the function:
decorated_function()
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

놀랍지 않습니다.

정확히 같은 작업을 수행하지만 성가신 중간 변수를 모두 건너 뛰십시오.

def decorated_function():
    print("I am the decorated function.")
decorated_function = decorator_maker()(decorated_function)
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function.

# Finally:
decorated_function()    
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

더 짧게 만들어 보자 .

@decorator_maker()
def decorated_function():
    print("I am the decorated function.")
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function.

#Eventually: 
decorated_function()    
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

저기요? " @"구문 으로 함수 호출을 사용했습니다 ! :-)

그래서 논쟁이있는 데코레이터로 돌아갑니다. 함수를 사용하여 데코레이터를 즉석에서 생성 할 수 있다면 해당 함수에 인수를 전달할 수 있습니다.

def decorator_maker_with_arguments(decorator_arg1, decorator_arg2):

    print("I make decorators! And I accept arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

    def my_decorator(func):
        # The ability to pass arguments here is a gift from closures.
        # If you are not comfortable with closures, you can assume it’s ok,
        # or read: /programming/13857/can-you-explain-closures-as-they-relate-to-python
        print("I am the decorator. Somehow you passed me arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

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

        return wrapped

    return my_decorator

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

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

여기에 인수가있는 데코레이터가 있습니다. 인수는 변수로 설정할 수 있습니다.

c1 = "Penny"
c2 = "Leslie"

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

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

보시다시피,이 트릭을 사용하는 함수처럼 인수를 데코레이터에 전달할 수 있습니다. 원한다면 사용할 수도 있습니다 *args, **kwargs. 그러나 데코레이터는 한 번만 호출 됩니다 . 파이썬이 스크립트를 가져올 때. 나중에 인수를 동적으로 설정할 수 없습니다. "가져 오기 x"를 수행 하면 함수가 이미 장식되어 있으므로 아무 것도 변경할 수 없습니다.


연습하자 : 데코레이터 꾸미기

좋아, 보너스로, 데코레이터가 일반적으로 모든 인수를 수락하도록 스 니펫을 제공합니다. 결국 인수를 받아들이 기 위해 다른 함수를 사용하여 데코레이터를 만들었습니다.

우리는 데코레이터를 감쌌습니다.

최근에 그 래핑 된 기능을 본 적이 있습니까?

예, 데코레이터!

재미있게 놀고 데코레이터를위한 데코레이터를 작성합시다.

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

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

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

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

        return decorator_wrapper

    return decorator_maker

다음과 같이 사용할 수 있습니다.

# You create the function you will use as a decorator. And stick a decorator on it :-)
# Don't forget, the signature is "decorator(func, *args, **kwargs)"
@decorator_with_args 
def decorated_decorator(func, *args, **kwargs): 
    def wrapper(function_arg1, function_arg2):
        print("Decorated with {0} {1}".format(args, kwargs))
        return func(function_arg1, function_arg2)
    return wrapper

# Then you decorate the functions you wish with your brand new decorated decorator.

@decorated_decorator(42, 404, 1024)
def decorated_function(function_arg1, function_arg2):
    print("Hello {0} {1}".format(function_arg1, function_arg2))

decorated_function("Universe and", "everything")
#outputs:
#Decorated with (42, 404, 1024) {}
#Hello Universe and everything

# Whoooot!

마지막으로이 느낌이 들었을 때 "재귀를 이해하기 전에 먼저 재귀를 이해해야합니다"라는 말을 듣고 나서였습니다. 그러나 지금, 이것을 마스터하는 것에 대해 기분이 좋지 않습니까?


모범 사례 : 데코레이터

  • 데코레이터는 Python 2.4에서 도입되었으므로 코드가> = 2.4에서 실행되는지 확인하십시오.
  • 데코레이터는 함수 호출을 느리게합니다. 명심하십시오.
  • 함수를 장식 해제 할 수 없습니다. ( 제거 할 수있는 데코레이터를 만드는 방법 있지만 아무도 사용하지 않습니다.) 따라서 함수가 일단 꾸미면 모든 코드에 맞게 꾸며 집니다.
  • 데코레이터는 함수를 래핑하여 디버그하기가 어려울 수 있습니다. (이것은 Python> = 2.5에서 나아집니다. 아래를 참조하십시오.)

functools모듈은 Python 2.5에서 도입되었습니다. 여기에는 functools.wraps()데코 레이팅 된 함수의 이름, 모듈 및 docstring을 랩퍼에 복사 하는 function이 포함됩니다 .

(재미있는 사실 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에서 함수 동작을 확장하거나 (수정할 수 없음) 디버깅을 위해 (임시이므로 수정하고 싶지 않음) 것입니다.

이를 사용하여 다음과 같이 DRY 방식으로 여러 기능을 확장 할 수 있습니다.

def benchmark(func):
    """
    A decorator that prints the time a function takes
    to execute.
    """
    import time
    def wrapper(*args, **kwargs):
        t = time.clock()
        res = func(*args, **kwargs)
        print("{0} {1}".format(func.__name__, time.clock()-t))
        return res
    return wrapper


def logging(func):
    """
    A decorator that logs the activity of the script.
    (it actually just prints it, but it could be logging!)
    """
    def wrapper(*args, **kwargs):
        res = func(*args, **kwargs)
        print("{0} {1} {2}".format(func.__name__, args, kwargs))
        return res
    return wrapper


def counter(func):
    """
    A decorator that counts and prints the number of times a function has been executed
    """
    def wrapper(*args, **kwargs):
        wrapper.count = wrapper.count + 1
        res = func(*args, **kwargs)
        print("{0} has been used: {1}x".format(func.__name__, wrapper.count))
        return res
    wrapper.count = 0
    return wrapper

@counter
@benchmark
@logging
def reverse_string(string):
    return str(reversed(string))

print(reverse_string("Able was I ere I saw Elba"))
print(reverse_string("A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!"))

#outputs:
#reverse_string ('Able was I ere I saw Elba',) {}
#wrapper 0.0
#wrapper has been used: 1x 
#ablE was I ere I saw elbA
#reverse_string ('A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!',) {}
#wrapper 0.0
#wrapper has been used: 2x
#!amanaP :lanac a ,noep a ,stah eros ,raj a ,hsac ,oloR a ,tur a ,mapS ,snip ,eperc a ,)lemac a ro( niaga gab ananab a ,gat a ,nat a ,gab ananab a ,gag a ,inoracam ,elacrep ,epins ,spam ,arutaroloc a ,shajar ,soreh ,atsap ,eonac a ,nalp a ,nam A

물론 데코레이터의 장점은 다시 작성하지 않고도 거의 모든 것을 즉시 사용할 수 있다는 것입니다. 건조, 나는 말했다 :

@counter
@benchmark
@logging
def get_random_futurama_quote():
    from urllib import urlopen
    result = urlopen("http://subfusion.net/cgi-bin/quote.pl?quote=futurama").read()
    try:
        value = result.split("<br><b><hr><br>")[1].split("<br><br><hr>")[0]
        return value.strip()
    except:
        return "No, I'm ... doesn't!"


print(get_random_futurama_quote())
print(get_random_futurama_quote())

#outputs:
#get_random_futurama_quote () {}
#wrapper 0.02
#wrapper has been used: 1x
#The laws of science be a harsh mistress.
#get_random_futurama_quote () {}
#wrapper 0.01
#wrapper has been used: 2x
#Curse you, merciful Poseidon!

파이썬은 여러 가지 장식을 제공 property, staticmethod

  • Django는 데코레이터를 사용하여 캐싱을 관리하고 권한을 봅니다.
  • 인라인 비동기 함수 호출을 위조하도록 트위스트되었습니다.

이것은 정말로 큰 놀이터입니다.


15
"함수의 장식을 해제 할 수 없습니다." -일반적으로 참이기는하지만 데코레이터 (예 : __closure__속성을 통해)에 의해 리턴 된 함수에서 클로저 내부에 도달 하여 원래 의 데코 레이팅되지 않은 함수를 가져올 수 있습니다. 하나 개의 예시적인 사용이 설명되어 이 응답 은 제한된 상황에서 낮은 레벨의 장식 기능을 주입 할 수있다 방법 다룬다.
metatoaster

8
이것은 훌륭한 답변이지만, 어떤면에서는 약간 오도 된 것 같습니다. 파이썬의 @decorator구문은 아마도 함수가 래퍼 클로저로 대체하는 데 가장 많이 사용됩니다. 그러나 함수를 다른 것으로 바꿀 수도 있습니다. 내장 property, classmethodstaticmethod장식은 예를 들어, 기술자 기능을 대체. 데코레이터는 일종의 레지스트리에 참조를 저장 한 다음 래퍼없이 수정하지 않고 반환하는 것과 같은 함수로 무언가를 할 수 있습니다.
Blckknght

3
"함수는 객체"라는 사실은 파이썬에서는 완전히 사실이지만 약간 오해의 소지가 있습니다. 함수에 변수를 저장하고, 인수로 전달하고, 결과로 함수를 반환하는 것은 실제로 함수가 아닌 함수일 수 있으며 일류 함수는 있지만 오브젝트는없는 다양한 언어가 있습니다.
00dani

1
이것은 바로 거기에 하나의 서사시적인 답변입니다 ... 고마워요! 함수의 기본 인수가 어떻게 데코레이터 래퍼에 args / kwargs로 표시되지 않습니까?
Naz

"데코레이터가 어떻게 유용 할 수 있을까?"하기 때문에 공감하기 위해이 답변의 맨 위로 다시 스크롤했습니다. 섹션이 너무 도움이되었습니다.
누 메논

145

또는 팩토리 함수에 전달 된 태그에 데코 레이팅 된 함수의 반환 값을 래핑하는 데코레이터를 반환하는 팩토리 함수를 작성할 수 있습니다. 예를 들면 다음과 같습니다.

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

5
제 생각에, 한 개 이상의 데코레이터를 가능한 멀리 피하는 것이 좋습니다. 팩토리 함수를 작성해야한다면 def wrap_in_tag(*kwargs)다음 과 같이 * kwargs로 코딩합니다.@wrap_in_tag('b','i')
guneysus

120

다른 사람들이 이미 문제를 해결하는 방법을 알려준 것 같습니다. 이것이 데코레이터가 무엇인지 이해하는 데 도움이되기를 바랍니다.

데코레이터는 단지 구문 설탕입니다.

@decorator
def func():
    ...

~로 확장

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

3
이것은 매우 우아하고 단순하며 이해하기 쉽습니다. Ockham 선생님, 당신을위한 10000 upvotes.
eric sep

2
위대하고 간단한 대답. @decorator()(대신에 @decorator) 대신 사용할 때 문법 설탕이라고 덧붙이고 싶습니다 func = decorator()(func). 이것은 "즉시"데코레이터를 생성해야 할 때도 일반적인 관행입니다.
Omer Dagan

64

물론 데코레이터 함수에서 람다도 반환 할 수 있습니다.

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

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

print say()

12
그리고 한 걸음 더 나아가 :makebold = lambda f : lambda "<b>" + f() + "</b>"
Robᵩ

13
@ Robᵩ : 문법적으로 정확하려면 :makebold = lambda f: lambda: "<b>" + f() + "</b>"
martineau

11
파티에 makebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>"
늦었지만

이것은functools.wrapssay
에릭

글쎄, 중요한 것은 그것이 당신의 대답에 언급되어 있는지 여부입니다. 데 @wraps이 페이지에 다른 곳에서 나는 인쇄 할 때 나에게 도움이 될 것되지 help(say)얻을 "`기능에 대한 도움말 <람다> 대신 "기능 말에 도움말 " .
에릭

61

파이썬 데코레이터는 다른 기능에 추가 기능을 추가합니다

이탤릭체 데코레이터는

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을 확인 하십시오.


@Rune Kaagaard가 제안한 람다 함수만큼 우아함을 주목하십시오
rds

1
@Phoenix : selfnewFunction()정의 된 addDashes()것은 일반 함수 데코레이터가 아닌 메서드 데코레이터 로 특별히 설계 되었기 때문에 인수가 필요합니다 . self인수는 클래스의 인스턴스를 나타냅니다 그들이 사용 여부 클래스 메소드에 전달 - 섹션 참조 방법 장식 @ 전자 satis의 대답을.
martineau

1
출력물도 인쇄하십시오.
user1767754

누락functools.wraps
Eric

39

당신은 할 수 바로 아래 그림과 같이 당신이 원하는 일을 두 개의 별도의 장식을합니다. 여러 인수를 갖는 데코 레이팅 된 함수를 지원 *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>

개선

보시다시피이 두 데코레이터에는 많은 중복 코드가 있습니다. 이러한 유사성을 감안할 때 실제로 데코레이터 팩토리 인 일반 팩터 , 즉 다른 데코레이터를 만드는 데코레이터 기능을 만드는 것이 좋습니다. 이렇게하면 코드 반복 횟수가 줄어들고 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>

능률

위의 예제는 모든 작업을 수행하지만 생성 된 코드에는 여러 데코레이터를 한 번에 적용 할 때 외부 함수 호출 형식으로 상당한 양의 오버 헤드가 발생합니다. 정확한 사용법 (예 : I / O 바운드)에 따라 중요하지 않을 수 있습니다.

데코 레이팅 된 함수의 속도가 중요한 경우, 모든 태그를 한 번에 추가하는 기능을 구현하는 약간 다른 데코레이터 팩토리 함수를 작성하여 오버 헤드를 단일 추가 함수 호출로 유지할 수 있으므로 발생하는 추가 함수 호출을 피하는 코드를 생성 할 수 있습니다 각 태그마다 별도의 데코레이터를 사용합니다.

데코레이터 자체에는 더 많은 코드가 필요하지만 함수 정의에 적용될 때만 실행되며 나중에 호출 될 때는 실행되지 않습니다. 이는 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>

2
:-) DRY 참조에 대한 찬성 투표
nitin3685

"@wraps (fun)"설명 주셔서 감사합니다 :)
walknotes

20

같은 일을하는 또 다른 방법 :

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'

functools.update_wrapper유지할 필요sayhi.__name__ == "sayhi"
Eric

19

파이썬에서 다음을 수행하는 데코레이터 두 개를 어떻게 만들 수 있습니까?

호출 될 때 다음 기능을 원합니다.

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

따라서이 함수에 대한 문서를 작성하거나 하나 이상의 인수를 취하는 함수를 꾸미고 싶거나 디버깅 세션에서 어떤 함수를보고 있는지 알고 싶을 때는 싸개.

모든 기능을 갖춘 솔루션-이러한 문제를 대부분 극복

표준 라이브러리에있는 모듈 의 데코레이터 wrapsfunctools있습니다!

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랩핑 함수가 함수가 인수로 취하는 것을 정확히 알려주는 것을 제외하고는 거의 모든 것을 수행한다는 것을 알 수 있습니다.

문제를 해결하려고 시도 할 수있는 다른 모듈이 있지만 솔루션은 아직 표준 라이브러리에 없습니다.


14

간단한 방법으로 데코레이터를 설명하려면 :

와:

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

언제 :

func(*args, **kwargs)

당신은 정말로 :

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

13

데코레이터는 함수 정의를 가져 와서이 함수를 실행하고 결과를 변환하는 새 함수를 만듭니다.

@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

데코레이터를 이해하려면 데코레이터가 함수를 실행하고 결과를 변환하는 내부의 새로운 함수를 작성했음을 주목해야합니다.


의 출력을 안 print(do(65))하고 print(do2(65))있을 AA?
Treefish Zhang

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

1
여기서 수업을 좋아하는 이유는 두 가지 경우와 관련이있는 행동이 명확하기 때문입니다. 실제로 매개 변수를 반복하지 않고 생성 된 클래스를 원하는 이름에 할당하여 두 데코레이터를 얻을 수 있습니다. 이것은 기능과 관련이 없습니다. 예제에 추가하면 이것이 왜 중복되지 않는지 알 수 있습니다.
Jon Jay Obermark

8

이 답변은 오랫동안 답변을 받았지만 새 데코레이터를 쉽고 컴팩트하게 작성하는 데코레이터 클래스를 공유한다고 생각했습니다.

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 문에서 메소드는 목록의 요소가 아닌 목록 자체에 적용됩니다.


7

다음은 데코레이터 체인의 간단한 예입니다. 마지막 줄에 주목하십시오-표지 아래에서 무슨 일이 일어나고 있는지 보여줍니다.

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

6

카운터 예를 말하면-위에서 주어진 것처럼 카운터는 데코레이터를 사용하는 모든 기능간에 공유됩니다.

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). 카운터 변수는 각 변수에 대해 비공개로 유지됩니다.


6

다른 수의 인수로 함수를 장식하십시오.

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  

1
이것은 쉽게도를 통해 키워드 인자에 대한 지원을 제공함으로써 더욱 다양한 만들어 질 수 def wrapper(*args, **kwargs):fn(*args, **kwargs).
martineau

5

Paolo Bergantino의 대답 은 stdlib 만 사용하는 큰 이점이 있으며 데코레이터 인수 또는 데코레이션 된 함수 인수가 없는이 간단한 예제에서 작동합니다 .

그러나보다 일반적인 경우를 해결하려는 경우 3 가지 주요 제한 사항이 있습니다.

  • 여러 답변에서 이미 언급했듯이 선택적 데코레이터 인수추가 하기 위해 코드를 쉽게 수정할 수 없습니다 . 예를 들어 makestyle(style='bold')데코레이터 를 만드는 것은 쉽지 않습니다.
  • 게다가로 작성된 래퍼 @functools.wraps 는 서명을 유지하지 않으므로 잘못된 인수가 제공되면 실행이 시작되고 평소와 다른 종류의 오류가 발생할 수 있습니다 TypeError.
  • 마지막으로, 래퍼 에서는 name을 기반으로 인수@functools.wraps액세스 하기가 매우 어렵습니다 . 실제로 인수는 *args, in **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환경 설정에 따라 다양한 파이썬 개념을 숨기거나 표시하는 두 가지 다른 개발 스타일을 제공합니다. 가장 컴팩트 한 스타일은 다음과 같습니다.

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

자세한 내용은 설명서 를 참조하십시오.

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.