ロギングを行うためのデコレータを作成しようとしています。
def logger(myFunc):
def new(*args, **keyargs):
print 'Entering %s.%s' % (myFunc.im_class.__name__, myFunc.__name__)
return myFunc(*args, **keyargs)
return new
class C(object):
@logger
def f():
pass
C().f()
これを印刷したい：
Entering C.f
しかし、代わりに次のエラーメッセージが表示されます。
AttributeError: 'function' object has no attribute 'im_class'
おそらくこれは「ロガー」内の「myFunc」のスコープと関係がありますが、私には何がわかりません。
Claudiu の答えは正しいですが、self引数からクラス名を取得することでごまかすこともできます。これにより、継承の場合に誤解を招くログ ステートメントが表示されますが、メソッドが呼び出されているオブジェクトのクラスがわかります。例えば：
from functools import wraps # use this to preserve function signatures and docstrings
def logger(func):
@wraps(func)
def with_logging(*args, **kwargs):
print "Entering %s.%s" % (args[0].__class__.__name__, func.__name__)
return func(*args, **kwargs)
return with_logging
class C(object):
@logger
def f(self):
pass
C().f()
前述したように、親クラスから関数を継承した場合、これは適切に機能しません。この場合、あなたは言うかもしれません
class B(C):
pass
b = B()
b.f()
それが正しいクラスであるEntering B.fため、実際にメッセージを取得したい場所でメッセージを取得します。Entering C.f一方、これは受け入れられるかもしれません。その場合、Claudius の提案よりもこのアプローチをお勧めします。
関数は実行時にのみメソッドになります。つまり、 を取得C.fすると、バインドされた関数 (およびC.f.im_class is C) が取得されます。関数が定義された時点では、それは単なる関数であり、どのクラスにもバインドされていません。このバインドされておらず関連付けが解除された関数が、ロガーによって装飾されます。
self.__class__.__name__クラスの名前が表示されますが、記述子を使用して、より一般的な方法でこれを実現することもできます。このパターンはDecorators and Descriptors に関するブログ投稿で説明されており、特にロガー デコレーターの実装は次のようになります。
class logger(object):
def __init__(self, func):
self.func = func
def __get__(self, obj, type=None):
return self.__class__(self.func.__get__(obj, type))
def __call__(self, *args, **kw):
print 'Entering %s' % self.func
return self.func(*args, **kw)
class C(object):
@logger
def f(self, x, y):
return x+y
C().f(1, 2)
# => Entering <bound method C.f of <__main__.C object at 0x...>>
明らかに、出力は (たとえば を使用して) 改善できますがgetattr(self.func, 'im_class', None)、この一般的なパターンはメソッドと関数の両方で機能します。ただし、古いスタイルのクラスでは機能しません(ただし、それらを使用しないでください ;)
ここで提案されているアイデアは優れていますが、いくつかの欠点があります。
inspect.getouterframes単純な関数とargs[0].__class__.__name__静的メソッドには適していません。__get__によって拒否されるクラスにある必要があります@wraps。@wrapsそれ自体が痕跡をよりよく隠すはずです。そのため、このページ、リンク、ドキュメント、および自分の頭からいくつかのアイデアを組み合わせて、
最終的に上記の 3 つの欠点をすべて欠いた解決策を見つけました。
その結果、method_decorator:
functools.wraps()します。使用法：
pip install method_decorator
from method_decorator import method_decorator
class my_decorator(method_decorator):
# ...
使用方法の詳細については、完全な単体テストを参照してください。
method_decoratorそして、これがクラスのコードです：
class method_decorator(object):
def __init__(self, func, obj=None, cls=None, method_type='function'):
# These defaults are OK for plain functions
# and will be changed by __get__() for methods once a method is dot-referenced.
self.func, self.obj, self.cls, self.method_type = func, obj, cls, method_type
def __get__(self, obj=None, cls=None):
# It is executed when decorated func is referenced as a method: cls.func or obj.func.
if self.obj == obj and self.cls == cls:
return self # Use the same instance that is already processed by previous call to this __get__().
method_type = (
'staticmethod' if isinstance(self.func, staticmethod) else
'classmethod' if isinstance(self.func, classmethod) else
'instancemethod'
# No branch for plain function - correct method_type for it is already set in __init__() defaults.
)
return object.__getattribute__(self, '__class__')( # Use specialized method_decorator (or descendant) instance, don't change current instance attributes - it leads to conflicts.
self.func.__get__(obj, cls), obj, cls, method_type) # Use bound or unbound method with this underlying func.
def __call__(self, *args, **kwargs):
return self.func(*args, **kwargs)
def __getattribute__(self, attr_name): # Hiding traces of decoration.
if attr_name in ('__init__', '__get__', '__call__', '__getattribute__', 'func', 'obj', 'cls', 'method_type'): # Our known names. '__class__' is not included because is used only with explicit object.__getattribute__().
return object.__getattribute__(self, attr_name) # Stopping recursion.
# All other attr_names, including auto-defined by system in self, are searched in decorated self.func, e.g.: __module__, __class__, __name__, __doc__, im_*, func_*, etc.
return getattr(self.func, attr_name) # Raises correct AttributeError if name is not found in decorated self.func.
def __repr__(self): # Special case: __repr__ ignores __getattribute__.
return self.func.__repr__()
クラスが作成されている間、Python は通常の関数オブジェクトを作成しているようです。その後、バインドされていないメソッド オブジェクトになるだけです。それを知っているので、これがあなたが望むことをするために私が見つけることができる唯一の方法です:
def logger(myFunc):
def new(*args, **keyargs):
print 'Entering %s.%s' % (myFunc.im_class.__name__, myFunc.__name__)
return myFunc(*args, **keyargs)
return new
class C(object):
def f(self):
pass
C.f = logger(C.f)
C().f()
これにより、目的の結果が出力されます。
クラス内のすべてのメソッドをラップしたい場合は、おそらく次のように使用できる wrapClass 関数を作成する必要があります。
C = wrapClass(C)
inspectライブラリを使用して、非常によく似た問題に対する別の解決策を見つけました。デコレーターが呼び出されると、関数がまだクラスにバインドされていなくても、スタックを調べて、デコレーターを呼び出しているクラスを見つけることができます。それが必要な場合は、少なくともクラスの文字列名を取得できます (作成中のため、おそらくまだ参照できません)。クラスが作成された後は、何も呼び出す必要はありません。
import inspect
def logger(myFunc):
classname = inspect.getouterframes(inspect.currentframe())[1][3]
def new(*args, **keyargs):
print 'Entering %s.%s' % (classname, myFunc.__name__)
return myFunc(*args, **keyargs)
return new
class C(object):
@logger
def f(self):
pass
C().f()
これは必ずしも他の方法よりも優れているわけではありませんが、デコレータの呼び出し中に future メソッドのクラス名を見つけることができる唯一の方法です。inspectライブラリのドキュメントにフレームへの参照を保持しないことに注意してください。
クラス関数は常に最初の引数として self を取る必要があるため、im_class の代わりにそれを使用できます。
def logger(myFunc):
def new(self, *args, **keyargs):
print 'Entering %s.%s' % (self.__class__.__name__, myFunc.__name__)
return myFunc(self, *args, **keyargs)
return new
class C(object):
@logger
def f(self):
pass
C().f()
最初は使用したかったself.__name__のですが、インスタンスに名前がないため機能しません。self.__class__.__name__クラスの名前を取得するために使用する必要があります。
Asa Ayers' answerに示されているように、クラス オブジェクトにアクセスする必要はありません。__qualname__Python 3.3 以降では、完全修飾名を与えるも使用できることを知っておく価値があります。
>>> def logger(myFunc):
... def new(*args, **keyargs):
... print('Entering %s' % myFunc.__qualname__)
... return myFunc(*args, **keyargs)
...
... return new
...
>>> class C(object):
... @logger
... def f(self):
... pass
...
>>> C().f()
Entering C.f
これには、 PEP 3155から取得したこの例に示すように、ネストされたクラスの場合にも機能するという利点があります。
>>> class C:
... def f(): pass
... class D:
... def g(): pass
...
>>> C.__qualname__
'C'
>>> C.f.__qualname__
'C.f'
>>> C.D.__qualname__
'C.D'
>>> C.D.g.__qualname__
'C.D.g'
また、Python 3 ではim_class属性がなくなっていることにも注意してください。そのため、本当にデコレータでクラスにアクセスしたい場合は、別のメソッドが必要です。私が現在使用しているアプローチには、「インスタンス メソッドの Python デコレータはクラスにアクセスできますか?」に対する私の回答object.__set_name__が含まれ、詳しく説明されています。
new.instancemethod()を使用して、関数からインスタンス メソッド (バインドまたは非バインド) を作成することもできます。