将回调绑定到对象实例

Question

我想将一个类方法绑定到对象实例，这样当方法作为回调调用时，它仍然可以访问对象实例。我正在使用事件发射器来生成和触发事件。

这是我的代码：

#!/usr/bin/env python3
from pyee import EventEmitter

class Component(object):
  _emiter = EventEmitter()

  def emit(self, event_type, event):
    Component._emiter.emit(event_type, event)

def listen_on(event):
  def listen_on_decorator(func):
    print("set event")
    Component._emiter.on(event, func)
    def method_wrapper(*args, **kwargs):
      return func(*args, **kwargs)
    return method_wrapper
  return listen_on_decorator

class TestComponent(Component):

  @listen_on('test')
  def on_test(self, event):
    print("self is " + str(self))
    print("FF" + str(event))

if __name__ == '__main__':
  t = TestComponent()
  t.emit('test', { 'a': 'dfdsf' })

如果您运行此代码，则会引发错误：

  File "component.py", line 29, in <module>                                                                                                                                                         [0/1889]
    t.emit('test', { 'a': 'dfdsf' })
  File "component.py", line 8, in emit
    Component._emiter.emit('test', event)
  File "/Users/giuseppe/.virtualenvs/Forex/lib/python3.4/site-packages/pyee/__init__.py", line 117, in emit
    f(*args, **kwargs)
  File "component.py", line 14, in method_wrapper
    return func(*args, **kwargs)
TypeError: on_test() missing 1 required positional argument: 'event'

这是由于调用方法on_test时缺少self引起的。

Answer 1

基于 OP 在 cmets 上对另一个答案提出的额外要求，有这种替代方法。

这里，装饰器仅用于标记哪些方法将作为发射器工作 - 发射器的实际注册仅在实际实例化类时完成，基于标记的方法。

#!/usr/bin/env python3
from pyee import EventEmitter

class Component(object):
    _emiter = EventEmitter()
    def __init__(self):
        for attr_name in dir(self):
            method = getattr(self, attr_name)
            if hasattr(method, "_component_emitter_on"):
                for event in method._component_emitter_on:
                    self._emiter.on(event, method)
            self.attr_name = method

    def emit(self, event_type, event):
        Component._emiter.emit(event_type, event)


def listen_on(event):
    def listen_on_decorator(func):
        print("set event")
        func._component_emitter_on = getattr(func, "_component_emitter_on", []) + [event]
        return func
    return listen_on_decorator


class TestComponent(Component):

    @listen_on('test')
    def on_test(self, event):
        print("self is " + str(self))
        print("FF" + str(event))

if __name__ == '__main__':
    t = TestComponent()
    t.emit('test', { 'a': 'dfdsf' })

（请注意，我还删除了装饰器上的冗余间接级别 - 如果装饰器不会替换可调用对象本身，只需对其（或使用它）进行注释，它们就不需要创建另一个可调用对象）

Answer 2

实例绑定方法不存在，因为很难想象否则，在解析类主体时 - 即应用装饰器时。

这意味着您的 on_test 方法的行为就像一个函数，此时没有“意识到”它的类或实例。当从对象实例中检索方法时，Python 确实会创建一个特殊的可调用对象（具有“方法”类型），它本质上会在对原始函数的调用中插入 self 参数。

使其工作的一种方法是装饰这个可调用对象（绑定方法本身）而不是原始函数。当然，它只存在于类被实例化的时候。

幸运的是，在 Python 中，decorators are mostly a syntactic shortcut to a function call passing the decorated function as a parameter - 所以你可以或多或少地重写你的 TestComponent 类：

class TestComponent(Component):

  def __init__(self, *args, **kw):
      super().__init__(*args, **kw)
      self.on_test = listen_on('test')(self.on_test)

  def on_test(self, event):
    print("self is " + str(self))
    print("FF" + str(event))

请注意，当我们在修饰后重新分配 self.on_test 实例成员时，它在通过实例调用时不再表现为方法 - 这将只是一个函数调用，没有 self 的魔法插入 - 但是，在self.on_test 被检索并作为参数传递给该行右侧的装饰器时，self 参数已经绑定到该可调用对象。

** 替代 ** cmets 建议上述使用看起来不像使用了装饰器 - 可以重写它以实际使用装饰器语法，只需这样做 - 尽管这将隐藏静态代码检查器的方法，例如 IDE 自动完成引擎和 linter：

class TestComponent(Component):

  def __init__(self, *args, **kw):
      super().__init__(*args, **kw)

      @listen_on('test')
      def on_test(self, event):
          print("self is " + str(self))
          print("FF" + str(event))

      self.on_test = on_test