o tf=@s$dZddlmZddlZddlZddlZddlZddlZddl Z ddl m Z m Z ddl m Z ddlmZddlmZmZmZmZddlmZmZd d lmZd d lmZd d lmZd d lmZd Z Gddde!Z"Gddde#Z$Gddde#Z%e &de"Gddde#Z'GdddeZ(dS)z? Emit structured, discrete events when various actions happen. ) annotationsN)datetimetimezone)ValidationError) jsonlogger)DictInstanceSetdefault)ConfigLoggingConfigurable) SchemaTypeSchemaRegistry)Handlers)JUPYTER_EVENTS_CORE_VALIDATORc@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__rr^/var/www/html/software/conda/envs/catlas/lib/python3.10/site-packages/jupyter_events/logger.pyrrc@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)rroncec@r) ListenerErrorzRAn exception to raise when a listener does not show the proper signature. Nrrrrrr 2rr 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_listeners\szEventLogger.gather_listenersschemasrcCstSNrr,rrr_default_schemas`szEventLogger._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-r2r4Zlog_namehandler __class__rrr8ds   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. rAr'list[logging.Handler]csSr0rrrArr get_handlerssz.EventLogger._load_config..get_handlersr!N)rGrI)r'rJ)Z_find_my_configpopr r7 _load_config)r-rFrGrIZmy_cfgrLZeventlogger_cfgrDrKrrNvs  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)r/registerr: _modifiersset_modified_listeners_unmodified_listeners)r-rOZ event_schemakeyrrrregister_event_schemas      z!EventLogger.register_event_schemarClogging.HandlercsNd fdd }tj|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. recordr3r4r'r9cs2j|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)r/get propertiesjsondumps)rXr4rOr,rr_handle_message_fields z;EventLogger.register_handler.._handle_message_field)Zjson_serializerN)rXr3r4r3r'r9)rZ JsonFormatter setFormatterr= addHandlerrAappend)r-rCr_ formatterrr,rrBs    zEventLogger.register_handlercCs*|j|||jvr|j|dSdS)z>Remove a logging handler from the logger and list of handlers.N)r= removeHandlerrAremove)r-rCrrrremove_handlers  zEventLogger.remove_handler) schema_idrg 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 TypeErrorrQr[rRadd)r-rgrimsg 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)rQdiscardr/ schema_ids)r-rgrirrrremove_modifiers  zEventLogger.remove_modifier)modifiedrgruboollistenerQt.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) rkrlrSr[rRrmrTr/rs)r-rurgrwrnZ listenersrprrr 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)rSrrrTr/rs)r-rgrwrrrremove_listener$s zEventLogger.remove_listener)timestamp_overrider9datadict[str, t.Any]r{datetime | Nonedict[str, t.Any] | Nonec sjsj|sj|sdS|jvr!tj|dtdddSj|}t |}j |j D]}|||d}q2j|j rHj ||j |||durZt 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)rgr|)tzZ)Z __timestamp__rYZ__schema_version__Z__metadata_version__taskasyncio.Task[t.Any]r'r5c(|}|r j|j|dSr0 exceptionlogerrorr&rrrerrr,rr_listener_task_done z-EventLogger.emit.._listener_task_done)loggerrgr|crr0rrr,rrrr)rrr'r5) rArSrTr/warningswarnrr[copydeepcopyrQr:Zvalidate_eventrnowrutc isoformatversionEVENTS_METADATA_VERSIONrvalidaterrupdater=infor* create_taskr&rmadd_done_callback) r-rgr|r{rOZ modified_datari timestampZcapsulerrrwrrr,remit?sj            zEventLogger.emit)r'r()r'r)r2r3r4r3r'r5)NN)rFr rGrHrIrHr'r5)rOrr'r5)rCrWr'r5)rgrhrirjr'r5)rurvrgrhrwrxr'r5)rgrhrwrxr'r5)rgr9r|r}r{r~r'r)rrrrrtagrArrr/rrQrSrTr r&__annotations__r.r r1r8rNrVrBrfrqrtryrzr __classcell__rrrDrr!8sP           %/r!))r __future__rr*rr]r;typingtrrrZ jsonschemarZpythonjsonloggerrZ traitletsrrr r Ztraitlets.configr r rOrZschema_registryrrIr validatorsrrWarningr Exceptionrr simplefilterr r!rrrrs0