回答:
ドキュメントをチェックして、デコレータの動作を確認してください。ここにあなたが求めたものがあります:
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>"
*args
と**kwargs
答えに追加する必要があります。デコレートされた関数は引数を持つことができ、指定されないとそれらは失われます。
長い説明に詳しくない場合は、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!'
これを覚えておいてください。すぐに戻ります。
Python関数のもう1つの興味深いプロパティは、別の関数内で定義できることです。
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)
デコレータは、デコレータデザインパターンの単なるpythonicバリアントです。開発を容易にするために、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の気の利いた点の1つは、メソッドと関数がまったく同じであることです。唯一の違いは、メソッドは最初の引数が現在のオブジェクト(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
「変数 " "でラベル付けされた」関数を呼び出すようにPythonに指示しています。
これは重要!あなたが与えるラベルは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
希望の方にもご利用いただけます。ただし、デコレータは一度だけ呼び出されることを覚えておいてください。Pythonがスクリプトをインポートしたとき。後で引数を動的に設定することはできません。"import x"を実行すると、関数は既に装飾されているため、何も変更できません。
おまけとして、おまけとして、どんなデコレータも一般的にどんな引数も受け入れるようにするスニペットをあげます。結局のところ、引数を受け入れるために、別の関数を使用してデコレーターを作成しました。
デコレータをラッピングしました。
最近、ラップされた関数を他に見ましたか?
そうそう、デコレータ!
楽しみながら、デコレータのデコレータを書いてみましょう。
def decorator_with_args(decorator_to_enhance):
"""
This function is supposed to be used as a decorator.
It must decorate an other function, that is intended to be used as a decorator.
Take a cup of coffee.
It will allow any decorator to accept an arbitrary number of arguments,
saving you the headache to remember how to do that every time.
"""
# We use the same trick we did to pass arguments
def decorator_maker(*args, **kwargs):
# We create on the fly a decorator that accepts only a function
# but keeps the passed arguments from the maker.
def decorator_wrapper(func):
# We return the result of the original decorator, which, after all,
# IS JUST AN ORDINARY FUNCTION (which returns a function).
# Only pitfall: the decorator must have this specific signature or it won't work:
return decorator_to_enhance(func, *args, **kwargs)
return decorator_wrapper
return decorator_maker
次のように使用できます。
# You create the function you will use as a decorator. And stick a decorator on it :-)
# Don't forget, the signature is "decorator(func, *args, **kwargs)"
@decorator_with_args
def decorated_decorator(func, *args, **kwargs):
def wrapper(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!
私が知っている、あなたがこの感覚を最後に感じたのは、「再帰を理解する前に、再帰を最初に理解しなければならない」という男の言うことを聞いた後だった。しかし、今、これを習得することについて気分がいいですか?
この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から関数の動作を拡張すること(変更できない)、またはデバッグ用(一時的なものであるため変更したくない)です。
これらを使用して、次のようにDRYの方法でいくつかの関数を拡張できます。
def benchmark(func):
"""
A decorator that prints the time a function takes
to execute.
"""
import time
def wrapper(*args, **kwargs):
t = time.clock()
res = func(*args, **kwargs)
print("{0} {1}".format(func.__name__, time.clock()-t))
return res
return wrapper
def logging(func):
"""
A decorator that logs the activity of the script.
(it actually just prints it, but it could be logging!)
"""
def wrapper(*args, **kwargs):
res = func(*args, **kwargs)
print("{0} {1} {2}".format(func.__name__, args, kwargs))
return res
return wrapper
def counter(func):
"""
A decorator that counts and prints the number of times a function has been executed
"""
def wrapper(*args, **kwargs):
wrapper.count = wrapper.count + 1
res = func(*args, **kwargs)
print("{0} has been used: {1}x".format(func.__name__, wrapper.count))
return res
wrapper.count = 0
return wrapper
@counter
@benchmark
@logging
def reverse_string(string):
return str(reversed(string))
print(reverse_string("Able was I ere I saw Elba"))
print(reverse_string("A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!"))
#outputs:
#reverse_string ('Able was I ere I saw Elba',) {}
#wrapper 0.0
#wrapper has been used: 1x
#ablE was I ere I saw elbA
#reverse_string ('A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!',) {}
#wrapper 0.0
#wrapper has been used: 2x
#!amanaP :lanac a ,noep a ,stah eros ,raj a ,hsac ,oloR a ,tur a ,mapS ,snip ,eperc a ,)lemac a ro( niaga gab ananab a ,gat a ,nat a ,gab ananab a ,gag a ,inoracam ,elacrep ,epins ,spam ,arutaroloc a ,shajar ,soreh ,atsap ,eonac a ,nalp a ,nam A
もちろん、デコレータの良い点は、書き直さなくてもほとんど何でもすぐに使用できることです。乾燥、私は言った:
@counter
@benchmark
@logging
def get_random_futurama_quote():
from urllib import urlopen
result = urlopen("http://subfusion.net/cgi-bin/quote.pl?quote=futurama").read()
try:
value = result.split("<br><b><hr><br>")[1].split("<br><br><hr>")[0]
return value.strip()
except:
return "No, I'm ... doesn't!"
print(get_random_futurama_quote())
print(get_random_futurama_quote())
#outputs:
#get_random_futurama_quote () {}
#wrapper 0.02
#wrapper has been used: 1x
#The laws of science be a harsh mistress.
#get_random_futurama_quote () {}
#wrapper 0.01
#wrapper has been used: 2x
#Curse you, merciful Poseidon!
Pythonの自分自身いくつかのデコレータを提供していますproperty
、staticmethod
など
これは本当に大きな遊び場です。
__closure__
属性を介して)関数の戻りのクロージャの内部に到達して、元の装飾されていない関数を取り出すことができます。使用例の1つがこの回答に記載されており、限られた状況で、デコレータ関数を下位レベルに挿入する方法を説明しています。
@decorator
構文は、おそらく関数をラッパークロージャに置き換えるために最もよく使用されます(回答で説明されています)。ただし、関数を別の関数に置き換えることもできます。組み込みproperty
、classmethod
およびstaticmethod
デコレータは、たとえば、関数を記述子に置き換えます。デコレータは、ある種のレジストリにそれへの参照を保存し、ラッパーなしで変更せずにそれを返すなど、関数で何かを行うこともできます。
あるいは、修飾された関数の戻り値をファクトリ関数に渡されたタグでラップするデコレータを返すファクトリ関数を書くこともできます。例えば:
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)))
def wrap_in_tag(*kwargs)
、その後@wrap_in_tag('b','i')
他の人が問題を解決する方法をすでにあなたに言っているようです。これがデコレータとは何かを理解するのに役立つことを願っています。
デコレータは構文上の砂糖です。
この
@decorator
def func():
...
に拡大する
def func():
...
func = decorator(func)
@decorator()
(の代わりに@decorator
)を使用する場合、それはの構文糖です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()
makebold = lambda f : lambda "<b>" + f() + "</b>"
makebold = lambda f: lambda: "<b>" + f() + "</b>"
makebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>"
functools.wraps
、docstring /署名/の名前を破棄しないために必要ですsay
@wraps
、このページ上の他の場所は、私が印刷したときに私を助けるために行っていないhelp(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を確認して ください
self
ため、引数が必要です。引数は、クラスのインスタンスを表し、彼らはそれを使用するかどうかをクラスメソッドに渡される-というタイトルのセクションを参照する方法飾る @電子Satisでの答えでは。newFunction()
addDashes()
self
functools.wraps
あなたは可能性が真下に示すように、あなたがやりたい二つの別々のデコレータを作ります。複数の引数を持つ装飾され*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>
ご覧のとおり、これら2つのデコレータには重複したコードがたくさんあります。この類似性を考えると、実際にはデコレータファクトリである一般的なもの、つまり、他のデコレータを作成するデコレータ関数を作成する方がよいでしょう。そうすれば、コードの繰り返しが少なくなり、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バウンドの可能性があります)。
デコレートされた関数の速度が重要な場合は、すべてのタグを一度に追加することを実装する少し異なるデコレータファクトリ関数を作成することにより、オーバーヘッドを1つの追加の関数呼び出しに維持できるため、発生する追加の関数呼び出しを回避するコードを生成できます。タグごとに個別のデコレータを使用する。
これにはデコレーター自体にさらに多くのコードが必要ですが、これは関数定義に適用されているときにのみ実行され、後でそれら自体が呼び出されたときに実行されません。これは、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>
同じことをする別の方法:
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"
Pythonで次のような2つのデコレータを作成するにはどうすればよいですか?
呼び出されたときに、次の関数が必要です。
@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
、ラッピング関数は、関数が引数として取るものを正確に伝えることを除いて、ほとんどすべてを実行することがわかります。
問題に対処しようとする他のモジュールがありますが、解決策はまだ標準ライブラリにありません。
簡単な方法でデコレータを説明するには:
と:
@decor1
@decor2
def func(*args, **kwargs):
pass
いつ:
func(*args, **kwargs)
あなたは本当にします:
decor1(decor2(func))(*args, **kwargs)
デコレータは関数定義を受け取り、この関数を実行して結果を変換する新しい関数を作成します。
@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 <=> 'a'
print(do(65))
print(do2(65))
>>> B
>>> B
デコレータを理解するには、デコレータが関数を実行して結果を変換する内部関数である新しい関数doを作成したことに注意することが重要です。
print(do(65))
と print(do2(65))
なるA
と A
?
#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")
この答えは長い間返答されてきましたが、新しいデコレータを簡単かつコンパクトに作成できるようにするDecoratorクラスを共有したいと思いました。
from abc import ABCMeta, abstractclassmethod
class Decorator(metaclass=ABCMeta):
""" Acts as a base class for all decorators """
def __init__(self):
self.method = None
def __call__(self, method):
self.method = method
return self.call
@abstractclassmethod
def call(self, *args, **kwargs):
return self.method(*args, **kwargs)
これにより、デコレータの動作が非常に明確になると思いますが、新しいデコレータを非常に簡潔に定義することも簡単です。上記の例の場合、次のように解決できます。
class MakeBold(Decorator):
def call():
return "<b>" + self.method() + "</b>"
class MakeItalic(Decorator):
def call():
return "<i>" + self.method() + "</i>"
@MakeBold()
@MakeItalic()
def say():
return "Hello"
これを使用して、たとえば、関数をイテレータのすべての引数に再帰的に自動的に適用するデコレータなどの、より複雑なタスクを実行することもできます。
class ApplyRecursive(Decorator):
def __init__(self, *types):
super().__init__()
if not len(types):
types = (dict, list, tuple, set)
self._types = types
def call(self, arg):
if dict in self._types and isinstance(arg, dict):
return {key: self.call(value) for key, value in arg.items()}
if set in self._types and isinstance(arg, set):
return set(self.call(value) for value in arg)
if tuple in self._types and isinstance(arg, tuple):
return tuple(self.call(value) for value in arg)
if list in self._types and isinstance(arg, list):
return list(self.call(value) for value in arg)
return self.method(arg)
@ApplyRecursive(tuple, set, dict)
def double(arg):
return 2*arg
print(double(1))
print(double({'a': 1, 'b': 2}))
print(double({1, 2, 3}))
print(double((1, 2, 3, 4)))
print(double([1, 2, 3, 4, 5]))
どのプリント:
2
{'a': 2, 'b': 4}
{2, 4, 6}
(2, 4, 6, 8)
[1, 2, 3, 4, 5, 1, 2, 3, 4, 5]
この例ではlist
、デコレータのインスタンス化にタイプが含まれていないため、最後のprintステートメントでは、メソッドはリストの要素ではなくリスト自体に適用されます。
以下は、デコレータをチェーンする簡単な例です。最後の行に注意してください-それは裏で何が起こっているかを示しています。
############################################################
#
# 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 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)
)、カウンター変数はそれぞれにプライベートのままになります。
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
def wrapper(*args, **kwargs):
、およびを介してキーワード引数のサポートを提供することにより、さらに用途を広げることも簡単にできますfn(*args, **kwargs)
。
Paolo Bergantinoの回答にはstdlibのみを使用するという大きな利点があり、デコレーター引数も装飾された関数引数もないこの単純な例で機能します。
ただし、より一般的なケースに取り組む場合、3つの主要な制限があります。
makestyle(style='bold')
デコレータを作成するのは簡単ではありません。@functools.wraps
は署名を保持しないため、不正な引数が提供されると実行が開始され、通常とは異なる種類のエラーが発生する可能性がありますTypeError
。@functools.wraps
にアクセスすることは非常に困難です。実際の引数はで表示することができ*args
、中**kwargs
、または(それがオプションである場合)、すべてでは表示されない場合があります。私はdecopatch
最初の問題を解決するために書きmakefun.wraps
、他の2つを解決するために書きました。makefun
有名なdecorator
lib と同じトリックを利用していることに注意してください。
これは、引数を指定してデコレータを作成し、本当に署名を保持するラッパーを返す方法です。
from decopatch import function_decorator, DECORATED
from makefun import wraps
@function_decorator
def makestyle(st='b', fn=DECORATED):
open_tag = "<%s>" % st
close_tag = "</%s>" % st
@wraps(fn)
def wrapped(*args, **kwargs):
return open_tag + fn(*args, **kwargs) + close_tag
return wrapped
decopatch
は、好みに応じて、さまざまなpythonの概念を非表示または表示する他の2つの開発スタイルを提供します。最もコンパクトなスタイルは次のとおりです。
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>'
詳細については、ドキュメントを参照してください。
__name__
デコレーターパッケージについては、関数のシグネチャなど)を保持します。