\ jIhdZddlZddlmZddlmZdZdZGddeZ Gdd Z dS) aEvent dispatch framework. All objects that produce events in pyglet implement :py:class:`~pyglet.event.EventDispatcher`, providing a consistent interface for registering and manipulating event handlers. A commonly used event dispatcher is `pyglet.window.Window`. Event types =========== For each event dispatcher there is a set of events that it dispatches; these correspond with the type of event handlers you can attach. Event types are identified by their name, for example, ''on_resize''. If you are creating a new class which implements :py:class:`~pyglet.event.EventDispatcher`, you must call `EventDispatcher.register_event_type` for each event type. Attaching event handlers ======================== An event handler is simply a function or method. You can attach an event handler by setting the appropriate function on the instance:: def on_resize(width, height): # ... dispatcher.on_resize = on_resize There is also a convenience decorator that reduces typing:: @dispatcher.event def on_resize(width, height): # ... You may prefer to subclass and override the event handlers instead:: class MyDispatcher(DispatcherClass): def on_resize(self, width, height): # ... Event handler stack =================== When attaching an event handler to a dispatcher using the above methods, it replaces any existing handler (causing the original handler to no longer be called). Each dispatcher maintains a stack of event handlers, allowing you to insert an event handler "above" the existing one rather than replacing it. There are two main use cases for "pushing" event handlers: * Temporarily intercepting the events coming from the dispatcher by pushing a custom set of handlers onto the dispatcher, then later "popping" them all off at once. * Creating "chains" of event handlers, where the event propagates from the top-most (most recently added) handler to the bottom, until a handler takes care of it. Use `EventDispatcher.push_handlers` to create a new level in the stack and attach handlers to it. You can push several handlers at once:: dispatcher.push_handlers(on_resize, on_key_press) If your function handlers have different names to the events they handle, use keyword arguments:: dispatcher.push_handlers(on_resize=my_resize, on_key_press=my_key_press) After an event handler has processed an event, it is passed on to the next-lowest event handler, unless the handler returns `EVENT_HANDLED`, which prevents further propagation. To remove all handlers on the top stack level, use `EventDispatcher.pop_handlers`. Note that any handlers pushed onto the stack have precedence over the handlers set directly on the instance (for example, using the methods described in the previous section), regardless of when they were set. For example, handler ``foo`` is called before handler ``bar`` in the following example:: dispatcher.push_handlers(on_resize=foo) dispatcher.on_resize = bar Dispatching events ================== pyglet uses a single-threaded model for all application code. Event handlers are only ever invoked as a result of calling EventDispatcher.dispatch_events`. It is up to the specific event dispatcher to queue relevant events until they can be dispatched, at which point the handlers are called in the order the events were originally generated. This implies that your application runs with a main loop that continuously updates the application state and checks for new events:: while True: dispatcher.dispatch_events() # ... additional per-frame processing Not all event dispatchers require the call to ``dispatch_events``; check with the particular class documentation. .. note:: In order to prevent issues with garbage collection, the :py:class:`~pyglet.event.EventDispatcher` class only holds weak references to pushed event handlers. That means the following example will not work, because the pushed object will fall out of scope and be collected:: dispatcher.push_handlers(MyHandlerClass()) Instead, you must make sure to keep a reference to the object before pushing it. For example:: my_handler_instance = MyHandlerClass() dispatcher.push_handlers(my_handler_instance) N)partial) WeakMethodTceZdZdZdS)EventExceptionzEAn exception raised when an event handler could not be attached. N)__name__ __module__ __qualname____doc__F/DATA/AppData/hermes/venv/lib/python3.11/site-packages/pyglet/event.pyrrsDr rc~eZdZdZdZedZdZdZdZ dZ dZ d Z d Z d Zd Zed ZdZdS)EventDispatcherzQGeneric event dispatcher interface. See the module docstring for usage. r cht|dsg|_|j||S)aFRegister an event type with the dispatcher. Registering event types allows the dispatcher to validate event handler names as they are attached, and to search attached objects for suitable handlers. :Parameters: `name` : str Name of the event to register. event_types)hasattrrappend)clsnames r register_event_typez#EventDispatcher.register_event_types8sM** ! CO t$$$ r ct|jturg|_|jdi|j|i|dS)atPush a level onto the top of the handler stack, then attach zero or more event handlers. If keyword arguments are given, they name the event type to attach. Otherwise, a callable's `__name__` attribute will be used. Any other object may also be specified, in which case it will be searched for callables with event names. rN)type _event_stacktupleinsert set_handlers)selfargskwargss r push_handlerszEventDispatcher.push_handlerss[ ! " "e + + "D    B'''4*6*****r c #K|D]}tj|re|j}||jvrt d|ztj|r(|t |t|j|fVt||fV{t|D]B}||jvr7t||}|t |t|j|fVC| D]b\}}||jvrt d|ztj|r(|t |t|j|fV\||fVcdS)z^Implement handler matching on arguments for set_handlers and remove_handlers. zUnknown event "%s"N) inspect isroutinerrrismethodrr_remove_handlerdirgetattritems)rrrobjrmethhandlers r _get_handlerszEventDispatcher._get_handlerss Z ZC %% Z|t///()=)DEEE#C(($ 38Ld0S0S T TTTTTT)OOOO HHZZDt///&sD11"JtWT=QSW5X5X$Y$YYYYYZ $\\^^ $ $MD'4+++$%9D%@AAA(( $Jw8Ld0S0STTTTTTTGm#### $ $r ct|jturig|_|||D]\}}|||dS)zAttach one or more event handlers to the top level of the handler stack. See :py:meth:`~pyglet.event.EventDispatcher.push_handlers` for the accepted argument types. N)rrrr, set_handler)rrrrr+s r rzEventDispatcher.set_handlerssj ! " "e + +!#D !//f== , ,MD'   T7 + + + + , ,r clt|jturig|_||jd|<dS)zAttach a single event handler. :Parameters: `name` : str Name of the event type to attach to. `handler` : callable Event handler to attach. rN)rrr)rrr+s r r.zEventDispatcher.set_handlers< ! " "e + +!#D %,!T"""r c*|jrnJ|jd=dS)z;Pop the top level of event handlers off the stack. zNo handlers pushedrN)r)rs r pop_handlerszEventDispatcher.pop_handlerss' 9999  a r ct||fd}|}|sdSD]%\}} |||kr||=#t$rY"wxYw|sj|dSdS)aRemove event handlers from the event stack. See :py:meth:`~pyglet.event.EventDispatcher.push_handlers` for the accepted argument types. All handlers are removed from the first stack frame that contains any of the given handlers. No error is raised if any handler does not appear in that frame, or if no stack frame contains any of the given handlers. If the stack frame is empty after removing the handlers, it is removed from the stack. Note that this interferes with the expected symmetry of :py:meth:`~pyglet.event.EventDispatcher.push_handlers` and :py:meth:`~pyglet.event.EventDispatcher.pop_handlers`. crjD]-}D](\}} |||kr|ccS#t$rY%wxYw.dSNrKeyError)framerr+handlersrs r find_framez3EventDispatcher.remove_handlers..find_frame(s}*  %-MD' ;'11#(LLLLL2#   s & 33N)listr,r6rremove)rrrr9r7rr+r8s` @r remove_handlerszEventDispatcher.remove_handlerss**48899         F&  MD' ;'))d      ,   $ $U + + + + + , ,sA AAc`|jD]%} |||kr||=dS#t$rY"wxYwdS)aWRemove a single event handler. The given event handler is removed from the first handler stack frame it appears in. The handler must be the exact same callable as passed to `set_handler`, `set_handlers` or :py:meth:`~pyglet.event.EventDispatcher.push_handlers`; and the name must match the event type it is bound to. No error is raised if the event handler is not set. :Parameters: `name` : str Name of the event type to remove. `handler` : callable Event handler to remove. Nr5rrr+r7s r remove_handlerzEventDispatcher.remove_handlerCsi"&  E ;'))d EE*       s  ++ct|jD]1}||vr+|||kr||=|s|j|2dS)zUsed internally to remove all handler instances for the given event name. This is normally called from a dead ``WeakMethod`` to remove itself from the event stack. N)r:rr;r>s r r%zEventDispatcher._remove_handler\sf$+,, 4 4Eu}}t!7!7$K4%,,U333  4 4r c t|ds Jd||jvsJ|d|d|jd}t|jD]~}||d}|st |t r|}|J d}||r tcSP#t$r"}| ||||Yd}~wd}~wwxYw t|||rtS d}nq#t$r,}t||d}t|r|Yd}~n@d}~wt$r0}| ||t|||Yd}~nd}~wwxYw|rtSdS)a{Dispatch a single event to the attached handlers. The event is propagated to all handlers from from the top of the stack until one returns `EVENT_HANDLED`. This method should be used only by :py:class:`~pyglet.event.EventDispatcher` implementors; applications should call the ``dispatch_events`` method. Since pyglet 1.2, the method returns `EVENT_HANDLED` if an event handler returned `EVENT_HANDLED` or `EVENT_UNHANDLED` if all events returned `EVENT_UNHANDLED`. If no matching event handlers are in the stack, ``False`` is returned. :Parameters: `event_type` : str Name of the event. `args` : sequence Arguments to pass to the event handler. :rtype: bool or None :return: (Since pyglet 1.2) `EVENT_HANDLED` if an event handler returned `EVENT_HANDLED`; `EVENT_UNHANDLED` if one or more event handlers were invoked but returned only `EVENT_UNHANDLED`; otherwise ``False``. In pyglet 1.1 and earlier, the return value is always ``None``. rzNo events registered on this EventDispatcher. You need to register events with the class method EventDispatcher.register_event_type('event_name').z not found in z.event_types == FNT)rrr:rget isinstancer EVENT_HANDLED TypeError_raise_dispatch_exceptionr'AttributeErrorcallableEVENT_UNHANDLED) r event_typerinvokedr7r+ exceptioneevent_ops r dispatch_eventzEventDispatcher.dispatch_eventis;6t]++   A  + T----6@jj$$$HXHX Y.--$+,, U UEii D11G ':.. +!'))*** U7D>)(((() U U U..z4)TTTTTTTT U (wtZ(($/ %$$ %GG   tZ66H!!       c c c  * *:tWT:=V=VXa b b b b b b b b c  #" "us< B!! C +CC C// E9"D  E-&EEc Vt|}tj|}|j}|j}|j}t|} tj|r |jr| dz} |rt| |} | |cxkr| t|z krnn|r|} | |krtj |stj|r%d|j d|j j d|j j } nt|} td|dt|d| d| d |) N'z' at :zThe 'z' event was dispatched with z arguments, but your handler z accepts only z arguments.)lenr"getfullargspecrvarargsdefaultsr$__self__max isfunctionr__code__ co_filenameco_firstlinenoreprrE) rJrr+rLn_argsargspecs handler_argshandler_varargshandler_defaultsn_handler_argsdescrs r rFz)EventDispatcher._raise_dispatch_exceptionsT)'22} "*#,\**  G $ $ )9 a N  9 88N F L L L Lns;K7L7L&L L L L L LQa L#N V # #!'** &g.>w.G.G &sG,ss73C3OssRYRbRqssW aJaaCPTIIaa05aaESaaabb bOr c"t|dkrfd}|Stj|dr-|d}|j||dSt |dt r|dfd}|SdS)a7Function decorator for an event handler. Usage:: win = window.Window() @win.event def on_resize(self, width, height): # ... or:: @win.event('on_resize') def foo(self, width, height): # ... rcB|j}|||Sr4)rr.)func func_namers r decoratorz(EventDispatcher.event..decorators% M   D111 r c4||Sr4)r.)rhrrs r rjz(EventDispatcher.event..decorators  t,,, r N)rTr"r#rr.rCstr)rrrjrhrs` @r eventzEventDispatcher.events$ t99>>         tAw ' ' 7D=D   T4 ( ( (7N Q % % 7D         r N)rrr r r classmethodrr r,rr.r1r<r?r%rO staticmethodrFrmr r r rrs L["+++"$$$< , , ,--- !!!*,*,*,X2 4 4 4DDDL**\*X%%%%%r r) r r" functoolsrweakrefrrDrI Exceptionrrr r r rssHuun      Y   WWWWWWWWWWr