/usr/share/pyshared/zope/component/event.txt is in python-zope.component 3.10.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 | Events
======
The Component Architecture provides a way to dispatch events to event
handlers. Event handlers are registered as *subscribers*
a.k.a. *handlers*.
Before we can start we need to import ``zope.component.event`` to make
the dispatching effective:
>>> import zope.component.event
Consider two event classes:
>>> class Event1(object):
... pass
>>> class Event2(Event1):
... pass
Now consider two handlers for these event classes:
>>> called = []
>>> import zope.component
>>> @zope.component.adapter(Event1)
... def handler1(event):
... called.append(1)
>>> @zope.component.adapter(Event2)
... def handler2(event):
... called.append(2)
We can register them with the Component Architecture:
>>> zope.component.provideHandler(handler1)
>>> zope.component.provideHandler(handler2)
Now let's go through the events. We'll see that the handlers have been
called accordingly:
>>> from zope.event import notify
>>> notify(Event1())
>>> called
[1]
>>> del called[:]
>>> notify(Event2())
>>> called.sort()
>>> called
[1, 2]
Object events
-------------
The ``objectEventNotify`` function is a subscriber to dispatch
ObjectEvents to interested adapters.
First create an object class:
>>> class IUseless(zope.interface.Interface):
... """Useless object"""
>>> class UselessObject(object):
... """Useless object"""
... zope.interface.implements(IUseless)
Then create an event class:
>>> class IObjectThrownEvent(zope.component.interfaces.IObjectEvent):
... """An object has been thrown away"""
>>> class ObjectThrownEvent(zope.component.interfaces.ObjectEvent):
... """An object has been thrown away"""
... zope.interface.implements(IObjectThrownEvent)
Create an object and an event:
>>> hammer = UselessObject()
>>> event = ObjectThrownEvent(hammer)
Then notify the event to the subscribers.
Since the subscribers list is empty, nothing happens.
>>> zope.component.event.objectEventNotify(event)
Now create an handler for the event:
>>> events = []
>>> def record(*args):
... events.append(args)
>>> zope.component.provideHandler(record, [IUseless, IObjectThrownEvent])
The event is notified to the subscriber:
>>> zope.component.event.objectEventNotify(event)
>>> events == [(hammer, event)]
True
Following test demonstrates how a subscriber can raise an exception
to prevent an action.
>>> zope.component.provideHandler(zope.component.event.objectEventNotify)
Let's create a container:
>>> class ToolBox(dict):
... def __delitem__(self, key):
... notify(ObjectThrownEvent(self[key]))
... return super(ToolBox,self).__delitem__(key)
>>> container = ToolBox()
And put the object into the container:
>>> container['Red Hammer'] = hammer
Create an handler function that will raise an error when called:
>>> class Veto(Exception):
... pass
>>> def callback(item, event):
... assert(item == event.object)
... raise Veto
Register the handler:
>>> zope.component.provideHandler(callback, [IUseless, IObjectThrownEvent])
Then if we try to remove the object, an ObjectThrownEvent is fired:
>>> del container['Red Hammer']
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
raise Veto
Veto
|