o i+>@s0dZddlZddlZddlZddlZddlZddlZddlmZddlm Z m Z m Z m Z m Z ddlmZddlmZddlmZmZmZmZddlmZmZd d lmZd d lmZd d lmZd d l 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. N)datetime)AnyCallable CoroutineOptionalUnion)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__rrP/var/www/edux/Edux_v2/venv/lib/python3.10/site-packages/jupyter_events/logger.pyrrc@r) ModifierErrorzRAn exception to raise when a modifier does not show the proper signature. Nrrrrrr "rr c@r)CoreMetadataErrorz:An exception raised when event core metadata is not valid.Nrrrrrr!(rr!oncec@r) ListenerErrorzRAn exception to raise when a listener does not show the proper signature. Nrrrrrr#1rr#c seZdZdZegdddjddZeeddZ e iddZ e id dZ e id dZ eZd d Zed defddZfddZd1fdd ZdeddfddZdejddfddZdejddfddZdddeedfd eeegefddfd!d"Zddde ed eeegefddfd#d$Z!ddd%d&e"deedfd'edeege#e$e$dffddfd(d)Z%ddde ed'edeege#e$e$dffddfd*d+Z&dd,ded-ed.e e'de efd/d0Z(Z)S)2 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. TzA 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.cstj|jddiIdHS)z#Gather all of the active listeners.return_exceptionsTN)asynciogather_active_listenersselfrrrgather_listeners[szEventLogger.gather_listenersschemasreturncCstSNrr-rrr_default_schemas_szEventLogger._default_schemascsltj|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.argskwargslog_namehandler __class__rrr6cs   zEventLogger.__init__NcsL||}|dgfdd}||d<td|i}tj|ddddS)zLoad EventLogger traits from a Config object, patching the handlers trait in the Config object to avoid deepcopy errors. r?csSr2rrr?rr get_handlers}sz.EventLogger._load_config..get_handlersr$N) section_namestraits)_find_my_configpoprr5 _load_config)r.cfgrIrJmy_cfgrHeventlogger_cfgrErGrrMus    zEventLogger._load_configschemacCs:|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)r0registerr8set _modifiers_modified_listeners_unmodified_listeners)r.rQ event_schemakeyrrrregister_event_schemas   z!EventLogger.register_event_schemarDcCsHdd}tj|d}|||j|||jvr"|j|dSdS)zRegister a new logging handler to the Event Logger. All outgoing messages will be formatted as a JSON string. c[s|d=tj|fi|S)z Remove 'message' from log record. It is always emitted with 'null', and we do not want it, since we are always emitting events only message)jsondumps)recordrBrrr _skip_messagesz3EventLogger.register_handler.._skip_message)json_serializerN)r JsonFormatter setFormatterr; addHandlerr?append)r.rDr^ formatterrrrr@s   zEventLogger.register_handlercCs*|j|||jvr|j|dSdS)z>Remove a logging handler from the logger and list of handlers.N)r; removeHandlerr?remove)r.rDrrrremove_handlers  zEventLogger.remove_handler) schema_idrhmodifiercCst|s d}t|t|}dtdtdtfdd}t|}||krG|r/|j||dS|jD]}|dus<||krD|j||q2dSd|d }t|) 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 callablerhdatar1cSsdS)zSignature to enforceNrrhrjrrrmodifier_signaturesz4EventLogger.add_modifier..modifier_signatureNzvModifiers are required to follow an exact function/method signature. The signature should look like: def my_modifierT: Check that you are using type annotations for each argument and the return value.) callable TypeErrorinspect signaturer7dictrTaddr )r.rhrimsgrqrlexpected_signaturer8rrr add_modifiers4   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)rTdiscardr0 schema_ids)r.rhrirrrremove_modifiers  zEventLogger.remove_modifier)modifiedrhrzlistenerc Cst|s d}t|t|}dtdtdtddfdd}t|}||kr_|r;|r3|j||dS|j |||j j D]}|dusI||kr\|rT|j||q?|j ||q?dSd |d }t |) 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 callableloggerrhrjr1NcsdS)zAn interface for a listener.Nrr|rhrjrrrlistener_signaturesz4EventLogger.add_listener..listener_signaturez|Listeners are required to follow an exact function/method signature. The signature should look like: async def my_listenerrm) rnrorprqr$r7rrrUrsrVr0rxr#) r.rzrhr{rtrqr~rur8rrr add_listeners0   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)rUrwrVr0rx)r.rhr{rrrremove_listener/s zEventLogger.remove_listener)timestamp_overriderjrc sjsj|sj|sdS|jvrt|dtdSj|}t |}j |j D]}|||d}q0j|j rFj ||j |||durVt }n|}|d||jtd}zt|Wntyz} zt| d} ~ ww||j|dtjddffdd } j|D]} t| ||d } j| | | qj|D]#} t| ||d } j| dtjddffd d } | | 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.rkZ) __timestamp__ __schema____schema_version____metadata_version__taskr1c(|}|r j|j|dSr2 exceptionlogerrorr,rwrerrr-rr_listener_task_done z-EventLogger.emit.._listener_task_doner}crr2rrr-rrrr)r?rUrVr0warningswarnrgetcopydeepcopyrTr8validate_eventrutcnow isoformatversionEVENTS_METADATA_VERSIONrvalidaterr!updater;infor*Task create_taskr,rsadd_done_callback) r.rhrjrrQ modified_datari timestampcapsulerrr{rrr-remitJsj             zEventLogger.emit)NN)*rrrrrtagr?r rr0r rTrUrVr r,r/r r3r6rMrrYr9Handlerr@rgrr7rrrrvrryboolrrrrrr __classcell__rrrErr$7s         4   ; r$)+rr*rrpr[r9rrtypingrrrrr jsonschemarpythonjsonloggerr traitletsr r r r traitlets.configrrrQrschema_registryrrJr validatorsrrWarningr Exceptionr r! simplefilterr#r$rrrrs0