web-dev-qa-db-ja.com

クラスのすべてのメソッドをラップする方法は？

特定のクラスのすべてのメソッドをPythonでラップしたいのですが、クラスのコードを最小限に編集することでラップしたいと思います。どうすればいいですか？

pythonwrappermetaclass
25
rjkaplan

これを行うためのエレガントな方法は、Michael FoordのVoidspaceブログのメタクラスとは何か、およびメタクラスを使用する方法についてのエントリの メタクラスを装飾するメソッド というタイトルのセクションで説明されています。少し単純化して状況に適用すると、次のようになります。

_from types import FunctionType
from functools import wraps

def wrapper(method):
    @wraps(method)
    def wrapped(*args, **kwrds):
    #   ... <do something to/with "method" or the result of calling it>
    return wrapped

class MetaClass(type):
    def __new__(meta, classname, bases, classDict):
        newClassDict = {}
        for attributeName, attribute in classDict.items():
            if isinstance(attribute, FunctionType):
                # replace it with a wrapped version
                attribute = wrapper(attribute)
            newClassDict[attributeName] = attribute
        return type.__new__(meta, classname, bases, newClassDict)

class MyClass(object):
    __metaclass__ = MetaClass  # wrap all the methods
    def method1(self, ...):
        # ...etc ...
_

Pythonでは、関数/メソッドデコレータは、関数ラッパーに加えて、それらを簡単に（そしてよりきれいに）使用できるようにするための構文糖衣構文です。

Python 3互換性アップデート

前のコードはPython 2.xメタクラス構文を使用しています。これはPython 3.xで使用するために変換する必要がありますが、そうでない場合は以前のバージョンではより長く機能します。これは、以下を使用する必要があることを意味します。

_class MyBase(metaclass=MetaClass)
    ...
_

の代わりに：

_class MyBase(object): 
    __metaclass__ = MetaClass"
    ...
_

必要に応じて、Python 2.xと3.xの両方と互換性のあるコードを記述できますが、そのためには少し使用する必要があります目的のメタクラスを継承する新しい基本クラスを動的に作成し、Pythonの2つのバージョン間の構文の違いによるエラーを回避する、より複雑な手法。これは基本的に、Benjamin Petersonの six モジュールの with_metaclass() 関数は行います。

_from types import FunctionType
from functools import wraps

def wrapper(method):
    @wraps(method)
    def wrapped(*args, **kwrds):
        print('{!r} executing'.format(method.__name__))
        return method(*args, **kwrds)
    return wrapped


class MetaClass(type):
    def __new__(meta, classname, bases, classDict):
        newClassDict = {}
        for attributeName, attribute in classDict.items():
            if isinstance(attribute, FunctionType):
                # replace it with a wrapped version
                attribute = wrapper(attribute)
            newClassDict[attributeName] = attribute
        return type.__new__(meta, classname, bases, newClassDict)


def with_metaclass(meta):
    """ Create an empty class with the supplied bases and metaclass. """
    return type.__new__(meta, "TempBaseClass", (object,), {})


if __name__ == '__main__':

    # Inherit metaclass from a dynamically-created base class.
    class MyClass(with_metaclass(MetaClass)):
        @staticmethod
        def a_static_method():
            pass

        @classmethod
        def a_class_method(cls):
            pass

        def a_method(self):
            pass

    instance = MyClass()
    instance.a_static_method()  # Not decorated.
    instance.a_class_method()   # Not decorated.
    instance.a_method()         # -> 'a_method' executing
_
22
martineau

プログラムでクラスのメソッドにラッパーを設定するということですか？まあ、これはおそらく本当に悪い習慣ですが、これがあなたがそれをするかもしれない方法です：

def wrap_methods( cls, wrapper ):
    for key, value in cls.__dict__.items( ):
        if hasattr( value, '__call__' ):
            setattr( cls, key, wrapper( value ) )

たとえば、クラスがある場合

class Test( ):
    def fire( self ):
        return True
    def fire2( self ):
        return True

とラッパー

def wrapper( fn ):
    def result( *args, **kwargs ):
        print 'TEST'
        return fn( *args, **kwargs )
    return result

その後、呼び出します

wrap_methods( Test, wrapper )

wrapperをallクラスTestで定義されたメソッドに適用します。 注意して使用してください！実際には、まったく使用しないでください！

8
freakish

デフォルトのクラス動作を大幅に変更する必要がある場合は、MetaClassesが最適です。別のアプローチがあります。

ユースケースがクラスのインスタンスメソッドのラップのみに限定されている場合は、__getattribute__マジックメソッドをオーバーライドしてみてください。

from functools import wraps
def wrapper(func):
    @wraps(func)
    def wrapped(*args, **kwargs):
        print "Inside Wrapper. calling method %s now..."%(func.__name__)
        return func(*args, **kwargs)
    return wrapped

ラッパーを作成するときは必ずfunctools.wrapsを使用してください。ラッパーが適切なトレースバックを提供するため、デバッグ用の場合はさらにそうです。

import types
class MyClass(object): # works only for new-style classes
    def method1(self):
        return "Inside method1"
    def __getattribute__(self, name):
        attr = super(MyClass, self).__getattribute__(name)
        if type(attr) == types.MethodType:
            attr = wrapper(attr)
        return attr
2
farthVader

pythonデコレータを使用するのが、これを行う最もクリーンな方法です。デバッグするか、少なくとも表示されるコードをトレースするように見えるからです。

0
sean