将回调绑定到对象实例

时间:2016-03-11 07:40:18

标签: python python-3.x events callback

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

这是我的代码:

#!/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时缺少的自身引起的。

2 个答案:

答案 0 :(得分:1)

实例绑定方法不存在,因为在解析类主体时很难想象 - 这就是应用装饰器的时候。

这意味着您的on_test方法就像一个函数,而不是&#34;意识到&#34;那时它的类或实例。当从对象实例中检索方法时,Python会创建一个特殊的可调用对象(使用&#34;方法&#34;类型),它基本上会在对原始函数的调用中插入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实例成员时,它在通过实例调用时不再表现为方法 - 它只是一个函数调用,没有{{1}的魔术插入但是,self参数已被检索self时绑定到该可调参数,并作为参数传递给该行右侧的装饰器。

**替代** 注释表明上面的使用看起来并不像装饰器那样 - 人们可以重写实际使用装饰器语法,只是这样做 - 尽管这会隐藏静态代码检查器的方法,例如IDE自动完成引擎和linters:

self.on_test

答案 1 :(得分:1)

根据OP对其他答案的评论中提出的额外要求,有另一种方法。

这里,装饰器仅用于标记哪些方法将用作发射器 - 并且只有在实际实例化类时,才会根据标记的方法完成实际的发射器注册表。

#!/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' })

(注意我还删除了装饰器上的冗余间接级别 - 如果装饰者不能替换可调用本身,只需对其进行注释(或使用它),他们就不需要创建另一个可调用)