python - 如何包装类的每个方法？

Question

我想在 python 中包装特定类的每个方法，并且我想通过最少地编辑类的代码来做到这一点。我该怎么办？

Answer 1

Michael Foord 的 Voidspace 博客中的一篇关于什么是元类以及如何在标题为 方法装饰元类的部分中使用它们的条目中描述了一种优雅的方法。稍微简化一下并将其应用于您的情况会导致：

from functools import wraps
from types import FunctionType

def wrapper(method):
    @wraps(method)
    def wrapped(*args, **kwargs):
    #   ... <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 MyClass(metaclass=MetaClass)  # apply method-wrapping metaclass
    ...

代替：

class MyClass(object):
    __metaclass__ = MetaClass  # wrap all the methods
    ...

如果需要，可以编写与 Python 2.x和3.x 兼容的代码，但这样做需要使用稍微复杂一点的技术，即动态创建一个继承所需元类的新基类，从而避免由于以下原因导致的错误两个版本的 Python 之间的语法差异。这基本上就是本杰明彼得森的六个模块的with_metaclass()功能。

from types import FunctionType
from functools import wraps

def wrapper(method):
    @wraps(method)
    def wrapped(*args, **kwargs):
        print('{!r} executing'.format(method.__name__))
        return method(*args, **kwargs)
    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

Answer 2

您的意思是以编程方式为类的方法设置包装器？好吧，这可能是一个非常糟糕的做法，但您可以这样做：

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于class 中定义的所有Test方法。谨慎使用！实际上，根本不要使用它！

Answer 3

如果需要大量修改默认类行为，则 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在创建包装器时使用，如果包装器用于调试，则更是如此，因为它提供了合理的 TraceBacks。

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