He:xdZddlmZddlZddlZddlZddlZddlZddl Z ddl m Z m Z ddl m Z ddlmZddlmZmZmZmZddlmZmZd d lmZd d lmZd d lmZd d lmZd Z Gdde!Z"Gdde#Z$Gdde#Z%e j&de"Gdde#Z'GddeZ(dS)z? Emit structured, discrete events when various actions happen. ) annotationsN)datetimetimezone)ValidationError) jsonlogger)DictInstanceSetdefault)ConfigLoggingConfigurable) SchemaTypeSchemaRegistry)Handlers)JUPYTER_EVENTS_CORE_VALIDATORceZdZdZdS)SchemaNotRegisteredzzA warning to raise when an event is given to the logger but its schema has not be registered with the EventLogger N__name__ __module__ __qualname____doc__5lib/python3.11/site-packages/jupyter_events/logger.pyrrrrceZdZdZdS) ModifierErrorzRAn exception to raise when a modifier does not show the proper signature. Nrrrrr r #rrr ceZdZdZdS)CoreMetadataErrorz:An exception raised when event core metadata is not valid.Nrrrrr"r")sDDDDrr"onceceZdZdZdS) ListenerErrorzRAn exception to raise when a listener does not show the proper signature. Nrrrrr%r%2rrr%ceZdZUdZeddddZeedZ e id Z e id Z e id Z eZd ed <dfd Z d?d@fd ZdAd!ZdBd$ZdBd%Zdd&dCd+Zdd&dCd,Zddd-dDd2Zdd&dEd3Zdd4dFd;ZxZS)G EventLoggera An Event logger for emitting structured events. Event schemas must be registered with the EventLogger using the `register_schema` or `register_schema_file` methods. Every schema will be validated against Jupyter Event's metaschema. NTzA list of logging.Handler instances to send events to. When set to None (the default), all events are discarded. ) default_value allow_nonehelp)configzbThe SchemaRegistry for caching validated schemas and their jsonschema validators. )r*z0A mapping of schemas to their list of modifiers.z9A mapping of schemas to the listeners of modified events.z?A mapping of schemas to the listeners of unmodified/raw events.zset[asyncio.Task[t.Any]]_active_listenersreturn list[t.Any]c>Ktj|jddid{VS)z#Gather all of the active listeners.return_exceptionsTN)asynciogatherr,selfs rgather_listenerszEventLogger.gather_listeners\sF^  # 7;         rschemasrctSNrr3s r_default_schemaszEventLogger._default_schemasbsrargst.AnykwargsNonecjtj|i|tdztt |z}t j||_d|j_|j t j |j r|j D]}| |dSdS)zInitialize the logger..FN) super__init__rstridlogging getLogger_logger propagatesetLevelINFOhandlersregister_handler)r4r:r<log_namehandler __class__s rrAzEventLogger.__init__fs $)&)))c>C4MM1(22 !&  gl+++ = /= / /%%g.... / / / /rcfgr section_nameslist[str] | Nonetraitsc||}|dgdfd }||d<td|i}t|dddS) zLoad EventLogger traits from a Config object, patching the handlers trait in the Config object to avoid deepcopy errors. rJr-list[logging.Handler]cSr8r)rJsr get_handlersz.EventLogger._load_config..get_handlerssOrr'N)rPrR)r-rT)_find_my_configpopr r@ _load_config) r4rOrPrRmy_cfgrVeventlogger_cfgrJrNs @rrYzEventLogger._load_configxs%%c***0**Z*D*D      *z!-!899 _DNNNNNrschemarc|j|}|j}t|j|<t|j|<t|j|<dS)zRegister this schema with the schema registry. Get this registered schema using the EventLogger.schema.get() method. N)r6registerrCset _modifiers_modified_listeners_unmodified_listeners)r4r\ event_schemakeys rregister_event_schemaz!EventLogger.register_event_schemasX |,,V44 o"uu(+ %*-%%"3'''rrMlogging.Handlercd fd }tj|}||j||jvrj|dSdS) zRegister a new logging handler to the Event Logger. All outgoing messages will be formatted as a JSON string. recordr;r<r-rBcj|d}d|jvr|d=tj|fi|S)aEPython's logger always emits the "message" field with the value as "null" unless it's present in the schema/data. Message happens to be a common field for event logs, so special case it here and only emit it if "message" is found the in the schema's property list. __schema__message)r6get propertiesjsondumps)rhr<r\r4s r_handle_message_fieldz;EventLogger.register_handler.._handle_message_fieldsM\%%f\&:;;F 1119%:f//// /r)json_serializerN)rhr;r<r;r-rB)r JsonFormatter setFormatterrF addHandlerrJappend)r4rMrp formatters` rrKzEventLogger.register_handlers 0 0 0 0 0 0,1    Y''' ((( $- ' ' M  ) ) ) ) ) ( 'rc|j|||jvr|j|dSdS)z>Remove a logging handler from the logger and list of handlers.N)rF removeHandlerrJremove)r4rMs rremove_handlerzEventLogger.remove_handlersI ""7+++ dm # # M  ) ) ) ) ) $ #r) schema_idr{ str | Nonemodifier5t.Callable[[str, dict[str, t.Any]], dict[str, t.Any]]ct|sd}t||r"|j||dS|jD]*}|||kr |j||+dS)aGAdd a modifier (callable) to a registered event. Parameters ---------- modifier: Callable A callable function/method that executes when the named event occurs. This method enforces a string signature for modifiers: (schema_id: str, data: dict) -> dict: z`modifier` must be a callableN)callable TypeErrorr`add)r4r{r}msgid_s r add_modifierzEventLogger.add_modifiers"!! !1CC..    OI & * *8 4 4 4 F? 3 3C C9$4$4$((222 3 3rc|r"|j||dS|jjD]B}|j|||j||CdS)aRemove a modifier from an event or all events. Parameters ---------- schema_id: str If given, remove this modifier only for a specific event type. modifier: Callable[[str, dict], dict] The modifier to remove. N)r`discardr6 schema_ids)r4r{r}s rremove_modifierzEventLogger.remove_modifiers"  = OI & . .x 8 8 8 8 8"\4 = =  *228<<< *228<<<< = =r)modifiedr{rboollistenerQt.Callable[[EventLogger, str, dict[str, t.Any]], t.Coroutine[t.Any, t.Any, None]]ct|sd}t||rD|r"|j||dS|j|||jjD]M}|||krC|r!|j||-|j||NdS)aAdd a listener (callable) to a registered event. Parameters ---------- modified: bool If True (default), listens to the data after it has been mutated/modified by the list of modifiers. schema_id: str $id of the schema listener: Callable A callable function/method that executes when the named event occurs. z`listener` must be a callableN)rrrarrbr6r)r4rr{rrrs r add_listenerzEventLogger.add_listeners&!! !1CC..   @ (377AAA  &y 1 5 5h ? ? ?<* H HC C9$4$4H,S155h????.y9==hGGG  H Hrc,|rB|j|||j||dS|jjD]B}|j|||j||CdS)a Remove a listener from an event or all events. Parameters ---------- schema_id: str If given, remove this modifier only for a specific event type. listener: Callable[[EventLogger, str, dict], dict] The modifier to remove. N)rarrbr6r)r4r{rs rremove_listenerzEventLogger.remove_listeners"  H  $Y / 7 7 A A A  &y 1 9 9( C C C C C"\4 H H (3;;HEEE*95==hGGGG H Hr)timestamp_overriderBdatadict[str, t.Any]rdatetime | Nonedict[str, t.Any] | Nonecjsj|sj|sdS|jvr!t j|dt ddSj|}tj |}j |j D]}|||}j|j rj ||j |||tjtjn|}|dz||jt&d} t)j|n#t,$r } t.| d} ~ wwxYw||j|dfd } j|D]Q} t7j| ||} j| | | Rj|D]W} t7j| ||} j| dfd } | | X|S)a Record given event with schema has occurred. Parameters ---------- schema_id: str $id of the schema data: dict The event to record timestamp_override: datetime, optional Optionally override the event timestamp. By default it is set to the current timestamp. Returns ------- dict The recorded event data Nz has not been registered yet. If this was not intentional, please register the schema using the `register_event_schema` method.) stacklevel)r{r)tzZ) __timestamp__rj__schema_version____metadata_version__taskasyncio.Task[t.Any]r-r=c|}|rj|j|dSr8 exceptionlogerrorr,rrerrr4s r_listener_task_donez-EventLogger.emit.._listener_task_done}sM..""C $s###  " * *4 0 0 0 0 0r)loggerr{rc|}|rj|j|dSr8rrs rrz-EventLogger.emit.._listener_task_donesMnn&&(HNN3'''&..t44444r)rrr-r=) rJrarbr6warningswarnrrlcopydeepcopyr`rCvalidate_eventrnowrutc isoformatversionEVENTS_METADATA_VERSIONrvalidaterr"updaterFinfor1 create_taskr,radd_done_callback) r4r{rrr\ modified_datar} timestampcapsulerrrrs ` remitzEventLogger.emit2s,  ,Y7 .y9  4 DL ( ( M222$     4!!),, d++  2 N NH$Hy}MMMMM  %fi 0 9 L ' ' 4 8 8 8 ##I}===.@-GHLHL ) ) ) )M_ '0022S8#"(.$;     - ) 27 ; ; ; ; - - -# , - }%%% '""" 1 1 1 1 1 10; 8 8H&'&D  " & &t , , ,  " "#6 7 7 7 729= 8 8H&xxtyW['\'\'\]]D  " & &t , , , 5 5 5 5 5 5  " "#6 7 7 7 7s1E EEE)r-r.)r-r)r:r;r<r;r-r=)NN)rOr rPrQrRrQr-r=)r\rr-r=)rMrfr-r=)r{r|r}r~r-r=)rrr{r|rrr-r=)r{r|rrr-r=)r{rBrrrrr-r)rrrrrtagrJr rr6rr`rarbr r,__annotations__r5r r9rArYrerKrzrrrrr __classcell__)rNs@rr'r'8s}x  cc h GbQRRRJ$r(cddd D R36#%%7777     WY    //////*+/#' OOOOOOO, 0 0 0 0****4****!%333333B!%======: $ #H#H#H#H#H#HP!%HHHHHH8`dssssssssssrr'))r __future__rr1rrnrDtypingtrrr jsonschemarpythonjsonloggerr traitletsrr r r traitlets.configr r r\rschema_registryrrRr validatorsrrWarningr Exceptionr r" simplefilterr%r'rrrrs+#""""" ''''''''&&&&&&''''''22222222222288888888++++++555555' I EEEEE EEE f1222I mmmmm%mmmmmr