所有 Python 双下划线方法的列表 - 您需要实施哪些方法才能正确代理对象？

Question

我正在尝试创建一个对象代理。 Attribute/property 查找可以通过简单地实现 __getattribute__、__setattr__ 和 __delattr__ 方法来完成。但是，len(x), x[], bool(x) 等其他功能需要实现 __len__, __getitem__, __bool__ 等其他 dunder 方法。如果您不在代理上实现这些 class，但您代理的对象支持它们，您的代理将不完整并导致运行时错误。

因此，我想要一份包含我需要实施的所有事情的综合清单，但我在网上找不到任何可靠的清单。

这是我从 typing 和 builtins 模块中获得的 97 个独特的 dunder 方法名称。我知道他们中的很多人在做什么，但有些我不知道。为我的代理 class 实现全部或大部分它们会很痛苦，所以如果有解决方法，我会很高兴。

__abs__
__add__
__aenter__
__aexit__
__aiter__
__and__
__anext__
__await__
__bool__
__bytes__
__call__
__class__
__cmp__
__complex__
__contains__
__delattr__
__delete__
__delitem__
__delslice__
__dir__
__div__
__divmod__
__enter__
__eq__
__exit__
__float__
__floordiv__
__format__
__fspath__
__ge__
__get__
__getattribute__
__getitem__
__getnewargs__
__getslice__
__gt__
__hash__
__iadd__
__iand__
__import__
__imul__
__index__
__init__
__init_subclass__
__instancecheck__
__int__
__invert__
__ior__
__isub__
__iter__
__ixor__
__le__
__len__
__lshift__
__lt__
__mod__
__mul__
__ne__
__neg__
__new__
__next__
__nonzero__
__or__
__pos__
__pow__
__prepare__
__radd__
__rand__
__rdiv__
__rdivmod__
__reduce__
__reduce_ex__
__repr__
__reversed__
__rfloordiv__
__rlshift__
__rmod__
__rmul__
__ror__
__round__
__rpow__
__rrshift__
__rshift__
__rsub__
__rtruediv__
__rxor__
__set__
__setattr__
__setitem__
__setslice__
__sizeof__
__str__
__sub__
__subclasscheck__
__subclasses__
__truediv__
__xor__

Answer 1

要代理一个对象，您只需要实现该对象具有的 dunder 方法，因此在最简单的世界中，您不需要做任何您尚未对代理做的特殊事情来代理它们对象的其他属性。

然而，问题是 dunder 方法是在 class 上查找的，而不是在对象上查找的，所以例如 Foo().bar 将在之前的实例上查找 bar如果实例没有 bar 属性，则回退到 class，Foo() + 5 将在 class Foo 上查找 __add__，完全忽略实例。也就是说，如果实例确实有一个名为 __add__ 的实例属性，那么 Foo() + 5 仍然不会使用该实例属性。

所以要代理那些 dunder 方法，它们需要在 class 级别而不是实例级别进行代理。

from functools import wraps

def proxy_function(name, f):
    @wraps(f)
    def proxied_f(*args, **kwargs):
        print('Proxying function:', name)
        return f(*args, **kwargs)
    return proxied_f

def proxy_object(obj):
    class Proxy:
        def __getattr__(self, name):
            print('Proxying getattr:', name)
            return getattr(obj, name)
        def __hasattr__(self, name):
            print('Proxying hasattr:', name)
            return hasattr(obj, name)
        def __setattr__(self, name, value):
            print('Proxying setattr:', name, '=', repr(value))
            setattr(obj, name, value)
        def __delattr__(self, name):
            print('Proxying delattr:', name)
            delattr(obj, name)
    
    for name, f in obj.__class__.__dict__.items():
        # don't try to overwrite __class__, __getattr__, etc.
        if callable(f) and name not in Proxy.__dict__:
            f = proxy_function(name, f)
            setattr(Proxy, name, f)
    
    return Proxy()

用法：

>>> class Foo:
...     def __add__(self, other):
...         return 'Adding with ' + repr(other)
... 
>>> foo = Foo()
>>> proxy_foo = proxy_object(foo)
>>> foo + 5
'Adding with 5'
>>> proxy_foo + 5
Proxying function: __add__
'Adding with 5'

所有 Python 双下划线方法的列表 - 您需要实施哪些方法才能正确代理对象？

List of all Python dunder methods - Which ones do you need to implement to correctly proxy an object?

python-3.x

magic-methods

python-datamodel

proxy-object