如何在新样式类中拦截对 python 的“魔术”方法的调用？

Question

我正在尝试在新样式类中拦截对 python 双下划线魔术方法的调用。这是一个简单的例子，但它表明了意图：

class ShowMeList(object):
    def __init__(self, it):
        self._data = list(it)

    def __getattr__(self, name):
        attr = object.__getattribute__(self._data, name)
        if callable(attr):
            def wrapper(*a, **kw):
                print "before the call"
                result = attr(*a, **kw)
                print "after the call"
                return result
            return wrapper
        return attr

如果我在列表周围使用该代理对象，我会得到非魔法方法的预期行为，但我的包装函数永远不会为魔法方法调用。

>>> l = ShowMeList(range(8))

>>> l #call to __repr__
<__main__.ShowMeList object at 0x9640eac>

>>> l.append(9)
before the call
after the call

>> len(l._data)
9

如果我不从对象继承（第一行 class ShowMeList:），一切都会按预期工作：

>>> l = ShowMeList(range(8))

>>> l #call to __repr__
before the call
after the call
[0, 1, 2, 3, 4, 5, 6, 7]

>>> l.append(9)
before the call
after the call

>> len(l._data)
9

如何使用新的样式类完成这种拦截？

Answer 1

出于性能原因，Python 总是在类（和父类的）__dict__ 中查找魔术方法，并且不使用正常的属性查找机制。一种解决方法是在创建类时使用元类自动为魔术方法添加代理；例如，我使用这种技术来避免为包装类编写样板调用方法。

class Wrapper(object):
    """Wrapper class that provides proxy access to an instance of some
       internal instance."""

    __wraps__  = None
    __ignore__ = "class mro new init setattr getattr getattribute"

    def __init__(self, obj):
        if self.__wraps__ is None:
            raise TypeError("base class Wrapper may not be instantiated")
        elif isinstance(obj, self.__wraps__):
            self._obj = obj
        else:
            raise ValueError("wrapped object must be of %s" % self.__wraps__)

    # provide proxy access to regular attributes of wrapped object
    def __getattr__(self, name):
        return getattr(self._obj, name)

    # create proxies for wrapped object's double-underscore attributes
    class __metaclass__(type):
        def __init__(cls, name, bases, dct):

            def make_proxy(name):
                def proxy(self, *args):
                    return getattr(self._obj, name)
                return proxy

            type.__init__(cls, name, bases, dct)
            if cls.__wraps__:
                ignore = set("__%s__" % n for n in cls.__ignore__.split())
                for name in dir(cls.__wraps__):
                    if name.startswith("__"):
                        if name not in ignore and name not in dct:
                            setattr(cls, name, property(make_proxy(name)))

用法：

class DictWrapper(Wrapper):
    __wraps__ = dict

wrapped_dict = DictWrapper(dict(a=1, b=2, c=3))

# make sure it worked....
assert "b" in wrapped_dict                        # __contains__
assert wrapped_dict == dict(a=1, b=2, c=3)        # __eq__
assert "'a': 1" in str(wrapped_dict)              # __str__
assert wrapped_dict.__doc__.startswith("dict()")  # __doc__

Answer 2

使用__getattr__ 和__getattribute__ 是类中响应获取属性的最后资源。

考虑以下几点：

>>> class C:
    x = 1
    def __init__(self):
        self.y = 2
    def __getattr__(self, attr):
        print(attr)

>>> c = C()
>>> c.x
1
>>> c.y
2
>>> c.z
z

__getattr__ 方法仅在其他方法不起作用时才被调用（它不适用于运算符，您可以阅读 here 的相关信息）。

在您的示例中，__repr__ 和许多其他魔术方法已在 object 类中定义。

想一想，可以做一件事，就是定义那些神奇的方法，然后调用__getattr__方法。检查我的另一个问题及其答案 (link) 以查看执行此操作的代码。

Answer 3

根据Asymmetric behavior for __getattr__, newstyle vs oldstyle classes 的答案（另请参阅Python docs），用__getattr__ 或__getattribute__ 修改对“魔术”方法的访问对于新型类来说是不可能的。这种限制使解释器更快。

Answer 4

从文档中剪切和复制：

对于旧式类，查找特殊方法的方式始终与查找任何其他方法或属性的方式完全相同。

对于新型类，特殊方法的隐式调用只有在对象类型上定义时才能保证正常工作，而不是在对象的实例字典中。