a
    ø£BeÄ:  ã                   @  s$  d Z ddlmZ ddlZddlZddlZddlZddlZddl	Z	ddl
m
Z
mZ ddlmZ ddlmZ ddlmZmZmZmZ ddlmZmZ d	d
lmZ d	dlmZ d	dlmZ d	dlmZ d	Z G dd„ de!ƒZ"G dd„ de#ƒZ$G dd„ de#ƒZ%e	 &de"¡ G dd„ de#ƒZ'G dd„ deƒZ(dS )z?
Emit structured, discrete events when various actions happen.
é    )ÚannotationsN)ÚdatetimeÚtimezone)ÚValidationError)Ú
jsonlogger)ÚDictÚInstanceÚSetÚdefault)ÚConfigÚLoggingConfigurableé   )Ú
SchemaType©ÚSchemaRegistry)ÚHandlers)ÚJUPYTER_EVENTS_CORE_VALIDATORc                   @  s   e Zd ZdZdS )Ú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__© r   r   úX/home/yuhw/wc/wire-cell-python/wcpy/lib/python3.9/site-packages/jupyter_events/logger.pyr      s   r   c                   @  s   e Zd ZdZdS )ÚModifierErrorzRAn exception to raise when a modifier does not
    show the proper signature.
    Nr   r   r   r   r   r   #   s   r   c                   @  s   e Zd ZdZdS )ÚCoreMetadataErrorz:An exception raised when event core metadata is not valid.Nr   r   r   r   r   r   )   s   r   Úoncec                   @  s   e Zd ZdZdS )ÚListenerErrorzRAn exception to raise when a listener does not
    show the proper signature.
    Nr   r   r   r   r   r   2   s   r   c                      sl  e Zd ZU dZedddd�jdd�Zeedd�Z	e
i d	d�Ze
i d
d�Ze
i dd�Zeƒ Zded< ddœdd„Zedƒddœdd„ƒZddddœ‡ fdd„ZdCdddddœ‡ fdd„Zd dd!œd"d#„Zd$dd%œd&d'„Zd$dd%œd(d)„Zdd*œd+d,dd-œd.d/„Zdd*œd+d,dd-œd0d1„Zddd2œd3d+d4dd5œd6d7„Zdd*œd+d4dd8œd9d:„Zdd;œd<d=d>d?d@œdAdB„Z‡  ZS )DÚ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.
    NTz‚A list of logging.Handler instances to send events to.

        When set to None (the default), all events are discarded.
        )Údefault_valueÚ
allow_noneÚhelp)Ú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.zset[asyncio.Task[t.Any]]Ú_active_listenerszlist[t.Any]©Úreturnc                 Ã  s   t j| jddiŽI dH S )z#Gather all of the active listeners.Úreturn_exceptionsTN)ÚasyncioÚgatherr$   ©Úselfr   r   r   Úgather_listeners\   s
    ÿÿzEventLogger.gather_listenersÚschemasr   c                 C  s   t ƒ S ©Nr   r*   r   r   r   Ú_default_schemasb   s    zEventLogger._default_schemasút.AnyÚNone)ÚargsÚkwargsr&   c                   sh   t ƒ j|i |¤Ž td tt| ƒƒ }t |¡| _d| j_| j 	tj
¡ | jrd| jD ]}|  |¡ qTdS )zInitialize the logger.Ú.FN)ÚsuperÚ__init__r   ÚstrÚidÚloggingÚ	getLoggerÚ_loggerÚ	propagateÚsetLevelÚINFOÚhandlersÚregister_handler)r+   r2   r3   Zlog_nameÚhandler©Ú	__class__r   r   r6   f   s    
zEventLogger.__init__r   zlist[str] | None)ÚcfgÚsection_namesÚtraitsr&   c                   sR   |   |¡}| dg ¡‰ ddœ‡ fdd„}||d< td|iƒ}tƒ j|ddd� dS )	z‰Load EventLogger traits from a Config object, patching the
        handlers trait in the Config object to avoid deepcopy errors.
        r?   zlist[logging.Handler]r%   c                     s   ˆ S r.   r   r   ©r?   r   r   Úget_handlers…   s    z.EventLogger._load_config.<locals>.get_handlersr   N)rE   rF   )Z_find_my_configÚpopr   r5   Ú_load_config)r+   rD   rE   rF   Zmy_cfgrH   Zeventlogger_cfgrB   rG   r   rJ   x   s    	
zEventLogger._load_configr   )Úschemar&   c                 C  s:   | j  |¡}|j}tƒ | j|< tƒ | j|< tƒ | j|< dS )z†Register this schema with the schema registry.

        Get this registered schema using the EventLogger.schema.get() method.
        N)r-   Úregisterr8   ÚsetÚ
_modifiersÚ_modified_listenersÚ_unmodified_listeners)r+   rK   Zevent_schemaÚkeyr   r   r   Úregister_event_schemaŽ   s
    z!EventLogger.register_event_schemazlogging.Handler)rA   r&   c                   sR   ddddœ‡ fdd„}t j|d�}| |¡ ˆ j |¡ |ˆ jvrNˆ j |¡ dS )zRegister a new logging handler to the Event Logger.

        All outgoing messages will be formatted as a JSON string.
        r0   r7   )Úrecordr3   r&   c                   s2   ˆ j  | d ¡}d|jvr | d= tj| fi |¤ŽS )aE  Python'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Ú
propertiesÚjsonÚdumps)rS   r3   rK   r*   r   r   Ú_handle_message_field    s    
z;EventLogger.register_handler.<locals>._handle_message_field)Zjson_serializerN)r   ZJsonFormatterÚsetFormatterr;   Ú
addHandlerr?   Úappend)r+   rA   rZ   Ú	formatterr   r*   r   r@   š   s    ÿ

zEventLogger.register_handlerc                 C  s&   | j  |¡ || jv r"| j |¡ dS )z>Remove a logging handler from the logger and list of handlers.N)r;   ÚremoveHandlerr?   Úremove)r+   rA   r   r   r   Úremove_handler´   s    
zEventLogger.remove_handler)Ú	schema_idz
str | Nonez5t.Callable[[str, dict[str, t.Any]], dict[str, t.Any]])rb   Úmodifierr&   c                C  s\   t |ƒsd}t|ƒ‚|r,| j|  |¡ dS | jD ]$}|du sF||kr2| j|  |¡ q2dS )aG  Add 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Ú	TypeErrorrN   Úadd)r+   rb   rc   ÚmsgÚid_r   r   r   Úadd_modifierº   s    
zEventLogger.add_modifierc                C  sH   |r| j |  |¡ n.| jjD ]$}| j |  |¡ | j |  |¡ qdS )a  Remove 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)rN   Údiscardr-   Ú
schema_ids)r+   rb   rc   r   r   r   Úremove_modifierØ   s
    zEventLogger.remove_modifier)Úmodifiedrb   ÚboolzQt.Callable[[EventLogger, str, dict[str, t.Any]], t.Coroutine[t.Any, t.Any, None]])rm   rb   Úlistenerr&   c                C  sˆ   t |ƒsd}t|ƒ‚|r@|r0| j|  |¡ dS | j|  |¡ | jjD ]:}|du s\||krH|rr| j|  |¡ qH| j|  |¡ qHdS )a•  Add 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)rd   re   rO   rf   rP   r-   rk   )r+   rm   rb   ro   rg   rh   r   r   r   Úadd_listenerò   s    zEventLogger.add_listener)rb   ro   r&   c                C  sX   |r&| j |  |¡ | j|  |¡ n.| jjD ]$}| j |  |¡ | j|  |¡ q.dS )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)rO   rj   rP   r-   rk   )r+   rb   ro   r   r   r   Úremove_listener  s    zEventLogger.remove_listener)Útimestamp_overrider7   zdict[str, t.Any]zdatetime | Nonezdict[str, t.Any] | None)rb   Údatarr   r&   c             
     sÆ  ˆ j sˆ j| sˆ j| sdS |ˆ jvrBtj|› d�tdd� dS ˆ j |¡}t 	|¡}ˆ j
|j D ]}|||d�}qdˆ j|j r�ˆ j ||¡ ˆ j ||¡ |du r´tjtjd�n|}| ¡ d ||jtdœ}zt |¡ W n, t�y
 }	 zt|	‚W Y d}	~	n
d}	~	0 0 | |¡ ˆ j |¡ d	d
dœ‡ fdd„}
ˆ j| D ]0}t |ˆ ||d�¡}ˆ j |¡ | |
¡ �q@ˆ j| D ]D}t |ˆ ||d�¡}ˆ j |¡ d	d
dœ‡ fd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.é   )Ú
stacklevel)rb   rs   )ÚtzÚZ)Z__timestamp__rT   Z__schema_version__Z__metadata_version__zasyncio.Task[t.Any]r1   )Útaskr&   c                   s(   |   ¡ }|rˆ j |¡ ˆ j | ¡ d S r.   ©Ú	exceptionÚlogÚerrorr$   rj   ©rx   Úerrr*   r   r   Ú_listener_task_done}  s    z-EventLogger.emit.<locals>._listener_task_done)Úloggerrb   rs   c                   s(   |   ¡ }|rˆ j |¡ ˆ j | ¡ d S r.   ry   r}   r*   r   r   r   š  s    ) r?   rO   rP   r-   ÚwarningsÚwarnr   rV   ÚcopyÚdeepcopyrN   r8   Zvalidate_eventr   Únowr   ÚutcÚ	isoformatÚversionÚEVENTS_METADATA_VERSIONr   Úvalidater   r   Úupdater;   Úinfor(   Úcreate_taskr$   rf   Úadd_done_callback)r+   rb   rs   rr   rK   Zmodified_datarc   Ú	timestampZcapsuler~   r   ro   rx   r   r*   r   Úemit2  sf    ÿþý
û
ÿ
ü
	ýÿ	zEventLogger.emit)NN)r   r   r   r   r   Útagr?   r   r   r-   r   rN   rO   rP   r	   r$   Ú__annotations__r,   r
   r/   r6   rJ   rR   r@   ra   ri   rl   rp   rq   r�   Ú__classcell__r   r   rB   r   r   8   sN   
	ýù	þÿ  ü	ý!ýü(ýÿr   ))r   Ú
__future__r   r(   rƒ   rX   r9   ÚtypingÚtr�   r   r   Z
jsonschemar   Zpythonjsonloggerr   Z	traitletsr   r   r	   r
   Ztraitlets.configr   r   rK   r   Zschema_registryr   rF   r   Ú
validatorsr   r‰   ÚWarningr   Ú	Exceptionr   r   Úsimplefilterr   r   r   r   r   r   Ú<module>   s.   