o ^i>@sbdZddlmZddlZddlZddlZddlZddlZddl Z ddl m Z m Z ddl m Z ddlmZddlmZddlmZmZmZmZdd lmZmZd d lmZd d lmZd d lmZd dl m!Z!e dZ"ee"edkryddl#m$Z$nddl%m$Z$d Z&Gddde'Z(Gddde)Z*Gddde)Z+e ,de(Gddde)Z-GdddeZ.dS)z? Emit structured, discrete events when various actions happen. ) annotationsN)datetimetimezone)version)ValidationError)parse)DictInstanceSetdefault)ConfigLoggingConfigurable) SchemaTypeSchemaRegistry)Handlers)JUPYTER_EVENTS_CORE_VALIDATORzpython-json-loggerz3.1.0) JsonFormatterc@eZdZdZdS)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__rrP/home/ubuntu/hpml_nyu/venv/lib/python3.10/site-packages/jupyter_events/logger.pyr%rc@r) ModifierErrorzRAn exception to raise when a modifier does not show the proper signature. Nrrrrrr+rrc@r)CoreMetadataErrorz:An exception raised when event core metadata is not valid.Nrrrrrr 1rr oncec@r) ListenerErrorzRAn exception to raise when a listener does not show the proper signature. Nrrrrrr":rr"cseZdZUdZeddddjddZeeddZ e id dZ e id dZ e id dZ eZd ed <dHddZeddIddZdJfdd Z  dKdLfd!d" ZdMd%d&ZdNd)d*ZdNd+d,Zdd-dOd2d3Zdd-dOd4d5Zddd6dPd;d<Zdd-dQd=d>Zdd?dRdFdGZZS)S 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]cstj|jddiIdHS)z#Gather all of the active listeners.return_exceptionsTN)asynciogatherr(selfrrrgather_listenersdszEventLogger.gather_listenersschemasrcCstSNrr.rrr_default_schemashszEventLogger._default_schemasargst.AnykwargsNonecsltj|i|tdtt|}t||_d|j_|j tj |j r2|j D] }| |q*dSdS)zInitialize the logger..FN) super__init__rstridlogging getLogger_logger propagatesetLevelINFOhandlersregister_handler)r/r4r6log_namehandler __class__rrr:ls   zEventLogger.__init__cfgr section_nameslist[str] | NonetraitscsN||}|dgd fdd }||d<td|i}tj|ddddS) zLoad EventLogger traits from a Config object, patching the handlers trait in the Config object to avoid deepcopy errors. rCr)list[logging.Handler]csSr2rrrCrr get_handlerssz.EventLogger._load_config..get_handlersr#N)rJrL)r)rM)_find_my_configpopr r9 _load_config)r/rIrJrLmy_cfgrOeventlogger_cfgrGrNrrR~s  zEventLogger._load_configschemarcCs\|j|}|j}||jvrt|j|<||jvrt|j|<||jvr,t|j|<dSdS)zRegister this schema with the schema registry. Get this registered schema using the EventLogger.schema.get() method. N)r1registerr< _modifiersset_modified_listeners_unmodified_listeners)r/rU event_schemakeyrrrregister_event_schemas      z!EventLogger.register_event_schemarFlogging.HandlercsLd fdd }t|d}||j||jvr$j|d Sd S) zRegister a new logging handler to the Event Logger. All outgoing messages will be formatted as a JSON string. recordr5r6r)r;cs2j|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)r1get propertiesjsondumps)r_r6rUr.rr_handle_message_fields z;EventLogger.register_handler.._handle_message_field)json_serializerN)r_r5r6r5r)r;)r setFormatterr? addHandlerrCappend)r/rFrf formatterrr.rrDs    zEventLogger.register_handlercCs*|j|||jvr|j|dSdS)z>Remove a logging handler from the logger and list of handlers.N)r? removeHandlerrCremove)r/rFrrrremove_handlers  zEventLogger.remove_handler) schema_idro str | Nonemodifier5t.Callable[[str, dict[str, t.Any]], dict[str, t.Any]]cCspt|s d}t||r |j|t}||||j|<dS|jD]}|dus-||kr5|j||q#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 TypeErrorrWrbrXadd)r/rorqmsg modifiersid_rrr add_modifiers   zEventLogger.add_modifiercCsJ|r |j||dS|jjD]}|j|||j||qdS)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)rWdiscardr1 schema_ids)r/rorqrrrremove_modifiers  zEventLogger.remove_modifier)modifiedror}boollistenerQt.Callable[[EventLogger, str, dict[str, t.Any]], t.Coroutine[t.Any, t.Any, None]]cCst|s d}t||r6|r"|j|t}||||j|<dS|j|t}||||j|<dS|jjD]}|dusD||krW|rO|j||q:|j||q:dS)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) rsrtrYrbrXrurZr1r{)r/r}rorrv listenersrxrrr add_listeners(     zEventLogger.add_listenercCsZ|r|j|||j||dS|jjD]}|j|||j||qdS)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)rYrzrZr1r{)r/rorrrrremove_listener,s zEventLogger.remove_listener)timestamp_overrider;datadict[str, t.Any]rdatetime | Nonedict[str, t.Any] | Nonec sjsj|sj|sdS|jvr#tj|dtdddSj|}t |}j |j D]}|||d}q4j|j rJj ||j |||dur\t jtjdn|}|d||jtd}zt|Wnty} zt| d} ~ ww||j|dfd d } j|D]} t| ||d} j| | | qj|D]} t| ||d} j| dfdd } | | q|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)ror)tzZ) __timestamp__r`__schema_version____metadata_version__taskasyncio.Task[t.Any]r)r7c(|}|r j|j|dSr2 exceptionlogerrorr(rzrerrr.rr_listener_task_done z-EventLogger.emit.._listener_task_done)loggerrorcrr2rrr.rrrr)rrr)r7) rCrYrbrZr1warningswarnrcopydeepcopyrWr<validate_eventrnowrutc isoformatrEVENTS_METADATA_VERSIONrvalidaterr updater?infor, create_taskr(ruadd_done_callback) r/rorrrU modified_datarq timestampcapsulerrrrrr.remitGsj              zEventLogger.emit)r)r*)r)r)r4r5r6r5r)r7)NN)rIr rJrKrLrKr)r7)rUrr)r7)rFr^r)r7)rorprqrrr)r7)r}r~rorprrr)r7)rorprrr)r7)ror;rrrrr)r)rrrrrtagrCr rr1rrWrYrZr r(__annotations__r0r r3r:rRr]rDrnryr|rrr __classcell__rrrGrr#@sP           %/r#)/r __future__rr,rrdr=typingtrrrimportlib.metadatar jsonschemarpackaging.versionr traitletsrr r r traitlets.configr r rUrschema_registryrrLr validatorsr version_infopythonjsonlogger.jsonrpythonjsonlogger.jsonloggerrWarningr Exceptionrr simplefilterr"r#rrrrs: