}tf=\dZddlmZddlZddlZddlZddlZddlZddl 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 jLde"Gdde#Z'GddeZ(y)z? Emit structured, discrete events when various actions happen. ) annotationsN)datetimetimezone)ValidationError) jsonlogger)DictInstanceSetdefault)ConfigLoggingConfigurable) SchemaTypeSchemaRegistry)Handlers)JUPYTER_EVENTS_CORE_VALIDATORceZdZdZy)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___/var/www/html/software/conda/envs/higlass/lib/python3.12/site-packages/jupyter_events/logger.pyrrrrceZdZdZy) ModifierErrorzRAn exception to raise when a modifier does not show the proper signature. Nrrrrr r #rrr ceZdZdZy)CoreMetadataErrorz:An exception raised when event core metadata is not valid.Nrrrrr"r")sDrr"onceceZdZdZy) ListenerErrorzRAn exception to raise when a listener does not show the proper signature. Nrrrrr%r%2rrr%ceZdZUdZedddj dZeedZ e id Z e id Z e id Z eZd ed <ddZedddZd fd Z d! d"fd Zd#dZd$dZd$dZdd d%dZdd d%dZddd d&dZdd d'dZdd d(dZxZS)) 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_listenersc\Ktj|jddid{S7w)z#Gather all of the active listeners.return_exceptionsTN)asynciogatherr,selfs rgather_listenerszEventLogger.gather_listeners\s&^^T%;%;TtTTTTs #,*,schemasctSNrr1s r_default_schemaszEventLogger._default_schemas`s rcft||i|tdztt |z}t j ||_d|j_|jjt j|jr#|jD]}|j|yy)zInitialize the logger..FN) super__init__rstridlogging getLogger_logger propagatesetLevelINFOhandlersregister_handler)r2argskwargslog_namehandler __class__s rr;zEventLogger.__init__ds $)&)c>C4M1((2 !&  gll+ ==== /%%g. / rc|j|}|jdgdfd }||d<td|i}t||ddy)zLoad EventLogger traits from a Config object, patching the handlers trait in the Config object to avoid deepcopy errors. rDcSr6r)rDsr get_handlersz.EventLogger._load_config..get_handlerssOrr'N) section_namestraits)returnzlist[logging.Handler])_find_my_configpopr r: _load_config) r2cfgrNrOmy_cfgrMeventlogger_cfgrDrJs @rrSzEventLogger._load_configvs[%%c**0**Z*D *z!-!89 _DNrc2|jj|}|j}||jvrt |j|<||j vrt |j |<||j vrt |j |<yy)zRegister this schema with the schema registry. Get this registered schema using the EventLogger.schema.get() method. N)r4registerr= _modifiersset_modified_listeners_unmodified_listeners)r2schema event_schemakeys rregister_event_schemaz!EventLogger.register_event_schemas ||,,V4 oo doo %#&5DOOC d.. .,/ED $ $S ) d00 0.1eD & &s + 1rcdfd }tj|}|j|jj ||j vrj j |yy)zRegister a new logging handler to the Event Logger. All outgoing messages will be formatted as a JSON string. cjj|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)r4get propertiesjsondumps)recordrGr]r2s r_handle_message_fieldz;EventLogger.register_handler.._handle_message_fieldsH\\%%f\&:;F 1 119%::f// /r)json_serializerN)rit.AnyrGrlrPr<)r JsonFormatter setFormatterr@ addHandlerrDappend)r2rIrj formatters` rrEzEventLogger.register_handlersb 0,,1  Y' ( $-- ' MM  ) (rc|jj|||jvr|jj|yy)z>Remove a logging handler from the logger and list of handlers.N)r@ removeHandlerrDremove)r2rIs rremove_handlerzEventLogger.remove_handlers7 ""7+ dmm # MM  ) $r) schema_idc0t|s d}t||rE|jj|t }|j |||j|<y|jD](}|||k(s |j|j |*y)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 TypeErrorrYrerZadd)r2rvmodifiermsg modifiersid_s r add_modifierzEventLogger.add_modifiers"!1CC.  ++Isu=I MM( #)2DOOI & ?? 3C C9$4$((2 3rc|r|j|j|y|jjD]>}|j|j||j|j|@y)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)rYdiscardr4 schema_ids)r2rvr{s rremove_modifierzEventLogger.remove_modifiersg"  OOI & . .x 8"\\44 =  *228< *228< =r)modifiedrvct|s d}t||r|rE|jj|t }|j |||j|<y|j j|t }|j |||j |<y|jjD]I}|||k(s |r|j|j |,|j |j |Ky)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) rxryr[rerZrzr\r4r)r2rrvlistenerr| listenersr~s r add_listenerzEventLogger.add_listeners&!1CC.  !4488CEJ  h'6?((32266y#%HI MM( #4=D & &y 1 <<** BC C9$4,,S155h?..s377A  Brc0|r=|j|j||j|j|y|jjD]>}|j|j||j|j|@y)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)r[rr\r4r)r2rvrs rremove_listenerzEventLogger.remove_listener$s"   $ $Y / 7 7 A  & &y 1 9 9( C"\\44 H ((3;;HE**95==hG Hr)timestamp_overridecjsj|sj|sy|jvr t j |dt dyjj|}tj|}j|jD] }|||}j|jrjj||jj|||$tjtj n|}|j#dz||j$t&d} t)j*||j1|j2j5|d fd } j|D]L} t7j8| || } j:j=| | j?| Nj|D]R} t7j8| || } j:j=| d fd } | j?| T|S#t,$r } t.| d} ~ wwxYw) 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)rvdata)tzZ) __timestamp__rc__schema_version____metadata_version__c|j}|rjj|jj |yr6 exceptionlogerrorr,rtaskerrr2s r_listener_task_donez-EventLogger.emit.._listener_task_dones8.."Cs#  " " * *4 0r)loggerrvrc|j}|rjj|jj |yr6rrs rrz-EventLogger.emit.._listener_task_dones8nn&HHNN3'&&..t4r)rzasyncio.Task[t.Any]rPNone) rDr[r\r4warningswarnrrecopydeepcopyrYr=validate_eventrnowrutc isoformatversionEVENTS_METADATA_VERSIONrvalidaterr"updater@infor/ create_taskr,rzadd_done_callback) r2rvrrr] modified_datar{ timestampcapsulerrrrs ` remitzEventLogger.emit?sT, ,,Y7..y9 DLL ( MM+22$  !!), d+  2 NH$y}MM N  % %fii 0 LL ' ' 4 8 ##I}=.@-GHLLHLL )M_ '002S8#"(..$;    - ) 2 27 ; }% '" 100; 8H&&'&D  " " & &t ,  " "#6 7 8229= 8H&&xtyW['\]D  " " & &t , 5  " "#6 7 8 c -# , -sI I3'I..I3)rPz list[t.Any])rPr)rFrlrGrlrPr)NN)rTr rNlist[str] | NonerOrrPr)r]rrPr)rIzlogging.HandlerrPr)rv str | Noner{z5t.Callable[[str, dict[str, t.Any]], dict[str, t.Any]]rPr)rboolrvrrQt.Callable[[EventLogger, str, dict[str, t.Any]], t.Coroutine[t.Any, t.Any, None]]rPr)rvrrrrPr)rvr<rzdict[str, t.Any]rzdatetime | NonerPzdict[str, t.Any] | None)rrrrrtagrDr rr4rrYr[r\r r,__annotations__r3r r7r;rSr`rErurrrrr __classcell__)rJs@rr'r'8s  cc  GbQRJr(cd  R36%/7U Y  /*+/#' O O(O! O  O,4 *4*!% 3 3H 3  3J!%==H =  =: $ *B*B *B d *B  *B^!%HHd H  H8`dss'7sM\s srr'))r __future__rr/rrgr>typingtrrr jsonschemarpythonjsonloggerr traitletsrr r r traitlets.configr r r]rschema_registryrrOr validatorsrrWarningr Exceptionr r" simplefilterr%r'rrrrs# '&'228+5' I E E f12I z%zr