3 da@s|dZddlZddlZddlZddlmZddlmZddlZddlm Z ddl Z ddl Z ddl m Z mZddlmZdd lmZd*adad d Zd d ZGdddeZGdddeZeZejZejZejZ da!da"d+ddZ#ddZ$ddZ%ej&ddZ'GdddeZ(Gddde(Z)Gddde(Z*Gd d!d!eZ+Gd"d#d#e+Z,Gd$d%d%e+Z-Gd&d'd'e+Z.d(d)Z/dS),zM Classes that implement and support the Traits change notification mechanism N)local)Thread) MethodType)ComparisonMode TraitKind) Uninitialized)TraitNotificationErrorcCs|atjjadS)z0 Sets up the user interface thread handler. N) ui_handler threadingcurrent_threadident ui_thread)handlerr8/tmp/pip-build-7vycvbft/traits/traits/trait_notifiers.pyset_ui_handler%srcOs.tjjtkr|||nt|f||dS)N)r r r rr )rargskwrrr ui_dispatch.s rc@seZdZddZdS)!NotificationExceptionHandlerStatecCs||_||_||_dS)N)rreraise_exceptionslocked)selfrrrrrr__init__6sz*NotificationExceptionHandlerState.__init__N)__name__ __module__ __qualname__rrrrrr5src@sFeZdZddZdddZddZd d Zd d Zd dZddZ dS)NotificationExceptionHandlercCsd|_d|_t|_dS)N) traits_logger main_thread thread_local)rrrrr=sz%NotificationExceptionHandler.__init__NFcCsD|j}|j||dkr |j}|jt||||r<||_|dS)a~ Pushes a new traits notification exception handler onto the stack, making it the new exception handler. Returns a NotificationExceptionHandlerState object describing the previous exception handler. Parameters ---------- handler : handler The new exception handler, which should be a callable or None. If None (the default), then the default traits notification exception handler is used. If *handler* is not None, then it must be a callable which can accept four arguments: object, trait_name, old_value, new_value. reraise_exceptions : bool Indicates whether exceptions should be reraised after the exception handler has executed. If True, exceptions will be re-raised after the specified handler has been executed. The default value is False. main : bool Indicates whether the caller represents the main application thread. If True, then the caller's exception handler is made the default handler for any other threads that are created. Note that a thread can explicitly set its own exception handler if desired. The *main* flag is provided to make it easier to set a global application policy without having to explicitly set it for each thread. The default value is False. locked : bool Indicates whether further changes to the Traits notification exception handler state should be allowed. If True, then any subsequent calls to _push_handler() or _pop_handler() for that thread will raise a TraitNotificationError. The default value is False. N) _get_handlers _check_lock_log_exceptionappendrr )rrrmainrhandlersrrr _push_handlerDs%  z*NotificationExceptionHandler._push_handlercCs4|j}|j|t|dkr(|jntddS)a Pops the traits notification exception handler stack, restoring the exception handler in effect prior to the most recent _push_handler() call. If the stack is empty or locked, a TraitNotificationError exception is raised. Note that each thread has its own independent stack. See the description of the _push_handler() method for more information on this. rzFAttempted to pop an empty traits notification exception handler stack.N)r$r%lenpopr )rr)rrr _pop_handlerws    z)NotificationExceptionHandler._pop_handlercCsHtjdd\}}|jd}|j|||||js@t|trD|dS)z Handles a traits notification exception using the handler defined by the topmost stack entry for the corresponding thread. Nr"r)sysexc_infor$rr isinstancer )robject trait_nameoldnew excp_classexcpZ handler_inforrr_handle_exceptions  z.NotificationExceptionHandler._handle_exceptioncCs|j}t|tr&tjj}|j|}n t|dd}|dkr~|jdk rP|jd}nt |j dd}|g}t|trx|||<n||_ |S)z_ Returns the handler stack associated with the currently executing thread. r)NrFr.) r!r1dictr r r getgetattrr rr&r))rr!idr)rrrrr$s         z*NotificationExceptionHandler._get_handlerscCs|djrtddS)zG Raises an exception if the specified handler stack is locked. rzLThe traits notification exception handler is locked. No changes are allowed.Nr.)rr )rr)rrrr%s z(NotificationExceptionHandler._check_lockc Cstjdd\}}|tkrbt|jdkrb|jddkrbtjjd||||djtj tjf|j }|dkrt j d|_ }y|j d||||fWntk rYnXdS) a Logs any exceptions generated in a trait notification handler. This method defines the default notification exception handling behavior of traits. However, it can be completely overridden by pushing a new handler using the '_push_handler' method. Nr"rz maximum recursion depth exceededznException occurred in traits notification handler for object: %s, trait: %s, old value: %s, new value: %s. %s ZtraitsziException occurred in traits notification handler for object: %s, trait: %s, old value: %s, new value: %s)r/r0 RuntimeErrorr+r __stderr__writejoin tracebackformat_exceptionrlogging getLogger exception Exception)rr2r3r4r5r6r7loggerrrrr&s( z+NotificationExceptionHandler._log_exception)NFFF) rrrrr*r-r8r$r%r&rrrrr<s 2  rcCs |a|adS)a Set the global trait change event tracers. The global tracers are called whenever a trait change event is dispatched. There are two tracers: `pre_tracer` is called before the notification is sent; `post_tracer` is called after the notification is sent, even if the notification failed with an exception (in which case the `post_tracer` is called with a reference to the exception, then the exception is sent to the `notification_exception_handler`). The tracers should be a callable taking 5 arguments: :: tracer(obj, trait_name, old, new, handler) `obj` is the source object, on which trait `trait_name` was changed from value `old` to value `new`. `handler` is the function or method that will be notified of the change. The post-notification tracer also has a keyword argument, `exception`, that is `None` if no exception has been raised, and the a reference to the raise exception otherwise. :: post_tracer(obj, trait_name, old, new, handler, exception=None) Note that for static trait change listeners, `handler` is not a method, but rather the function before class creation, since this is the way Traits works at the moment. N)_pre_change_event_tracer_post_change_event_tracer) pre_tracer post_tracerrrrset_change_event_tracerssrMcCsttfS)z= Get the currently active global trait change event tracers. )rIrJrrrrget_change_event_tracerssrNcCs dadadS)z- Clear the global trait change event tracer. N)rIrJrrrrclear_change_event_tracerssrOc cs0t\}}t||z dVWdt||XdS)zA Context manager to temporarily change the global event tracers. N)rNrM)rKrLZold_pre_tracerZold_post_tracerrrrchange_event_tracers"s    rPc@s,eZdZdZiZddZddZddZdS) !AbstractStaticChangeNotifyWrappera  Concrete implementation must define the 'argument_transforms' class argument, a dictionary mapping the number of arguments in the event handler to a function that takes the arguments (obj, trait_name, old, new) and returns the arguments tuple for the actual handler. cCs8|jj}|dkr"td|j|f|j||_||_dS)NzInvalid number of arguments for the static anytrait change notification handler: %s. A maximum of 4 arguments is allowed, but %s were specified.)__code__ co_argcountr rargument_transformsargument_transformr)rr arg_countrrrr7s z*AbstractStaticChangeNotifyWrapper.__init__cCst||||r|j||||}tdk r8t|||||jy|j|WnNtk r}z2tdk rvt|||||j|dt||||WYdd}~Xn Xtdk rt|||||jdddS)z- Dispatch to the appropriate handler method. N)rF)_change_acceptedrVrIrrGrJhandle_exception)rr2r3r4r5rerrr__call__Fs( z*AbstractStaticChangeNotifyWrapper.__call__cCsdS)NFr)rrrrrequalshsz(AbstractStaticChangeNotifyWrapper.equalsN)rrr__doc__Zarguments_transformsrr[r\rrrrrQ-s "rQc@s0eZdZdddddddddddZdS) !StaticAnytraitChangeNotifyWrappercCsfS)Nr)objnamer4r5rrrrsz*StaticAnytraitChangeNotifyWrapper.cCs|fS)Nr)r_r`r4r5rrrrasscCs||fS)Nr)r_r`r4r5rrrratscCs |||fS)Nr)r_r`r4r5rrrrauscCs ||||fS)Nr)r_r`r4r5rrrravs)rrr"rRN)rrrrUrrrrr^ls r^c@s0eZdZdddddddddddZdS) StaticTraitChangeNotifyWrappercCsfS)Nr)r_r`r4r5rrrrasz'StaticTraitChangeNotifyWrapper.cCs|fS)Nr)r_r`r4r5rrrrascCs||fS)Nr)r_r`r4r5rrrrascCs |||fS)Nr)r_r`r4r5rrrrascCs ||||fS)Nr)r_r`r4r5rrrras)rrr"rbrRN)rrrrUrrrrrczs rcc@seZdZdZdddddddddddZdd d Zdd d ZddZddZddZ ddZ ddZ ddZ ddZ ddZd S) TraitChangeNotifyWrapperz Dynamic change notify wrapper. This class is in charge to dispatch trait change events to dynamic listener, typically created using the `on_trait_change` method, or the decorator with the same name. cCsfS)Nr)r_r`r4r5rrrrasz!TraitChangeNotifyWrapper.cCs|fS)Nr)r_r`r4r5rrrrascCs||fS)Nr)r_r`r4r5rrrrascCs |||fS)Nr)r_r`r4r5rrrrascCs ||||fS)Nr)r_r`r4r5rrrras)rrr"rbrRNcCs|j|||dS)N)init)rrownertargetrrrrsz!TraitChangeNotifyWrapper.__init__cCst|tkr|j}|j}|dk rtj||j|_|j|_ ||_ |j j d}|dkrdt d|j|ft|j|_|j||_|Sn|dk rtj||j|_||_ |j j }|dkrt d|j|fd|_ ||_t|j|_|j||_|S)NrrRzInvalid number of arguments for the dynamic trait change notification handler: %s. A maximum of 4 arguments is allowed, but %s were specified.)typer__func____self__weakrefreflistener_deletedr2rr`rfrSrTr _notify_method_listenernotify_listenerrUrVr_notify_function_listener)rrrfrgfuncr2rWrrrres8      zTraitChangeNotifyWrapper.initcCs|j|||||dS)z Dispatch to the appropriate method. We do explicit dispatch instead of assigning to the .__call__ instance attribute to avoid reference cycles. N)ro)rr2r3r4r5rrrr[s z!TraitChangeNotifyWrapper.__call__cGs ||dS)z Dispatch the event to the listener. This method is normally the only one that needs to be overridden in a subclass to implement the subclass's dispatch mechanism. Nr)rrrrrrdispatchsz!TraitChangeNotifyWrapper.dispatchcCsP||kr dSt|tkr<|jdk r<|j|jko:|j|jkS|jdkoN||jkS)NT)rhrrjrr`r2r)rrrrrr\s  zTraitChangeNotifyWrapper.equalsc Cs6y|jj|Wntk r$YnXd|_|_dS)N)rfremove ValueErrorr2)rrlrrrrms z)TraitChangeNotifyWrapper.listener_deletedcCs d|_dS)N)r2)rrrrdisposesz TraitChangeNotifyWrapper.disposecCs|j||||}tdk r(t|||||y|j|f|WnLtk r}z0tdk rjt||||||dt||||WYdd}~XnXtdk rt|||||dddS)z: Prepare and dispatch a trait change event to a listener. N)rF)rVrIrrrGrJrY)rr2r3r4r5rrrZrrr_dispatch_change_events z/TraitChangeNotifyWrapper._dispatch_change_eventcCsL|j}|dk rHt||||rH|}|dk rHt||j}|j|||||dS)z5 Dispatch a trait change event to a method listener. N)r2rXr;r`rv)rr2r3r4r5 obj_weak_refr_listenerrrrrns z0TraitChangeNotifyWrapper._notify_method_listenercCs&t||||r"|j|||||jdS)z7 Dispatch a trait change event to a function listener. N)rXrvr)rr2r3r4r5rrrrp,sz2TraitChangeNotifyWrapper._notify_function_listener)N)N)rrrr]rUrrer[rrr\rmrurvrnrprrrrrds    6   rdc@s(eZdZdZddZddZddZdS) ExtendedTraitChangeNotifyWrappera] Change notify wrapper for "extended" trait change events.. The "extended notifiers" are set up internally when using extended traits, to add/remove traits listeners when one of the intermediate traits changes. For example, in a listener for the extended trait `a.b`, we need to add/remove listeners to `a:b` when `a` changes. c CsL|j||||}y|j|f|Wn"tk rFt||||YnXdS)z: Prepare and dispatch a trait change event to a listener. N)rVrrrGrY)rr2r3r4r5rrrrrrv?s z7ExtendedTraitChangeNotifyWrapper._dispatch_change_eventcCs>|j}|dk r:|}|dk r:t||j}|j|||||dS)z5 Dispatch a trait change event to a method listener. N)r2r;r`rv)rr2r3r4r5rwr_rxrrrrnKs z8ExtendedTraitChangeNotifyWrapper._notify_method_listenercCs|j|||||jdS)z7 Dispatch a trait change event to a function listener. N)rvr)rr2r3r4r5rrrrp[sz:ExtendedTraitChangeNotifyWrapper._notify_function_listenerN)rrrr]rvrnrprrrrry5s ryc@seZdZdZddZdS)FastUITraitChangeNotifyWrappera Dynamic change notify wrapper, dispatching on the UI thread. This class is in charge to dispatch trait change events to dynamic listener, typically created using the `on_trait_change` method and the `dispatch` parameter set to 'ui' or 'fast_ui'. cGs*tjjtkr||nt|f|dS)N)r r r rr )rrrrrrrris z'FastUITraitChangeNotifyWrapper.dispatchN)rrrr]rrrrrrrzasrzc@seZdZdZddZdS)NewTraitChangeNotifyWrapperz Dynamic change notify wrapper, dispatching on a new thread. This class is in charge to dispatch trait change events to dynamic listener, typically created using the `on_trait_change` method and the `dispatch` parameter set to 'new'. cGst||djdS)N)rgr)rstart)rrrrrrrrxsz$NewTraitChangeNotifyWrapper.dispatchN)rrrr]rrrrrrr{psr{c CsX|tkr dS|j|d}|jtjjkrT|jtjkrTy t ||kSt k rRYnXdS)a Return true if notifications should be emitted for the change. Parameters ---------- object : HasTraits The object on which the trait is changed. name : str The name of the trait changed. old : any The old value new : any The new value Returns ------- accepted : bool Whether the event should be emitted. Fr"T) rZ_traitrhrtraitr`Zcomparison_moderZequalityboolrG)r2r`r4r5r}rrrrX|s   rXr.)NN)0r] contextlibrDr rr!rrBtypesrrkr/ constantsrrZ trait_baserZ trait_errorsr rr rrr2rrZnotification_exception_handlerr*Zpush_exception_handlerr-Zpop_exception_handlerr8rYrIrJrMrNrOcontextmanagerrPrQr^rcrdryrzr{rXrrrr sL      , " ?.,