a
    ø£Be7  ã                   @   s´   d Z ddlZddlmZ ddlmZmZmZmZm	Z	m
Z
mZmZmZ ddlmZ ddlmZ ddlmZ dd	lmZmZmZmZ G d
d„ deƒZG dd„ deƒZG dd„ deƒZdS )zThe extension manager.é    N)Úmulti)	ÚAnyÚBoolÚDictÚ	HasTraitsÚInstanceÚListÚUnicodeÚdefaultÚobserve©Úvalidate)ÚLoggingConfigurableé   )ÚExtensionConfigManager)ÚExtensionMetadataErrorÚExtensionModuleNotFoundÚ
get_loaderÚget_metadatac                   @   sª   e Zd ZdZedƒZeddd�Zeƒ Z	e
dƒdd„ ƒZed	d
„ ƒZedd„ ƒZedd„ ƒZedd„ ƒZedd„ ƒZedd„ ƒZdd„ Zdd„ Zdd„ Zdd„ Zdd„ ZdS )ÚExtensionPointz‚A simple API for connecting to a Jupyter Server extension
    point defined by metadata and importable from a Python package.
    FNT©Ú
allow_noneÚmetadatac                 C   sŽ   |d }z|d | _ W n  ty6   d}t|ƒd‚Y n0 zt | j ¡| _W n* tyt   d| j › d�}t|ƒd‚Y n0 d|v rŠ|d ƒ | _|S )zValidate metadata.ÚvalueÚmodulez<There is no 'module' key in the extension's metadata packet.NzThe submodule 'z>' could not be found. Are you sure the extension is installed?Úapp)	Ú_module_nameÚKeyErrorr   Ú	importlibÚimport_moduleÚ_moduleÚImportErrorr   Ú_app)ÚselfZproposedr   Úmsg© r%   úc/home/yuhw/wc/wire-cell-python/wcpy/lib/python3.9/site-packages/jupyter_server/extension/manager.pyÚ_valid_metadata   s    ÿzExtensionPoint._valid_metadatac                 C   s   | j r| j jS | jS )z Has this extension point been linked to the server.

        Will pull from ExtensionApp's trait, if this point
        is an instance of ExtensionApp.
        )r   Ú_linked©r#   r%   r%   r&   Úlinked/   s    zExtensionPoint.linkedc                 C   s   | j S )z'If the metadata includes an `app` field)r"   r)   r%   r%   r&   r   :   s    zExtensionPoint.appc                 C   s   | j r| j  ¡ S i S dS )z:Return any configuration provided by this extension point.N)r   Z_jupyter_server_configr)   r%   r%   r&   Úconfig?   s    
zExtensionPoint.configc                 C   s   | j S )zuName of the Python package module where the extension's
        _load_jupyter_server_extension can be found.
        )r   r)   r%   r%   r&   Úmodule_nameI   s    zExtensionPoint.module_namec                 C   s   | j r| j jS | j d| j¡S )z„Name of the extension.

        If it's not provided in the metadata, `name` is set
        to the extensions' module name.
        Úname)r   r-   r   Úgetr,   r)   r%   r%   r&   r-   P   s    zExtensionPoint.namec                 C   s   | j S )z3The imported module (using importlib.import_module))r    r)   r%   r%   r&   r   [   s    zExtensionPoint.modulec                 C   s&   | j r| j j}nt| jddd„ ƒ}|S )zGet a linker.Ú_link_jupyter_server_extensionc                 S   s   d S ©Nr%   )Ú	serverappr%   r%   r&   Ú<lambda>j   ó    z,ExtensionPoint._get_linker.<locals>.<lambda>)r   r/   Úgetattrr   )r#   Úlinkerr%   r%   r&   Ú_get_linker`   s    
ûzExtensionPoint._get_linkerc                 C   s   | j }|s| j}t|ƒ}|S )zGet a loader.)r   r   r   )r#   ÚlocÚloaderr%   r%   r&   Ú_get_loadern   s
    zExtensionPoint._get_loaderc                 C   s2   z|   ¡  |  ¡  W n ty(   Y dS 0 dS dS )z+Check that both a linker and loader exists.FTN)r6   r9   Ú	Exceptionr)   r%   r%   r&   r   v   s    zExtensionPoint.validatec                 C   s    | j s|  ¡ }||ƒ d| _dS )z·Link the extension to a Jupyter ServerApp object.

        This looks for a `_link_jupyter_server_extension` function
        in the extension's module or ExtensionApp class.
        TN)r*   r6   r(   )r#   r1   r5   r%   r%   r&   Úlink€   s    zExtensionPoint.linkc                 C   s   |   ¡ }||ƒS )z·Load the extension in a Jupyter ServerApp object.

        This looks for a `_load_jupyter_server_extension` function
        in the extension's module or ExtensionApp class.
        )r9   )r#   r1   r8   r%   r%   r&   ÚloadŒ   s    zExtensionPoint.load)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   r(   r   r"   r   r   Úvalidate_traitr'   Úpropertyr*   r   r+   r,   r-   r   r6   r9   r   r;   r<   r%   r%   r%   r&   r      s.   




	




r   c                       s¦   e Zd ZdZedd�Zeddd�Zeƒ Z	eƒ Z
eddd�Zeeƒ d	d�Zed
d�Zedƒdd„ ƒZ‡ fdd„Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Z‡  ZS )ÚExtensionPackagez�An API for interfacing with a Jupyter Server extension package.

    Usage:

    ext_name = "my_extensions"
    extpkg = ExtensionPackage(name=ext_name)
    z)Name of the an importable Python package.©ÚhelpFz)Whether the extension package is enabled.Tz:The module for this extension package. None if not enabled)r   rE   z5Extension metadata loaded from the extension package.z|
            The version of this extension package, if it can be found.
            Otherwise, an empty string.
            Úversionc                 C   s   | j s
dS t| jddƒS )NÚ Ú__version__)Úenabledr4   r   r)   r%   r%   r&   Ú_load_version­   s    zExtensionPackage._load_versionc                    s$   t ƒ jf i |¤Ž | jr |  ¡  dS )z Initialize an extension package.N)ÚsuperÚ__init__rI   Ú_load_metadata)r#   Úkwargs©Ú	__class__r%   r&   rL   ³   s    zExtensionPackage.__init__c              
   C   sˆ   | j }zt|| jd�\| _| _W n@ ty` } z(d|› d|› d�}t|ƒd‚W Y d}~n
d}~0 0 | jD ]}t|d�}|| j|j < qh|S )z\Import package and load metadata

        Only used if extension package is enabled
        )ÚloggerzThe module 'z' could not be found (z+). Are you sure the extension is installed?N)r   )	r-   r   Úlogr   r   r!   r   r   Úextension_points)r#   r-   Úer$   ÚmÚpointr%   r%   r&   rM   ¹   s    ÿ 

zExtensionPackage._load_metadatac                 C   s   t dd„ | j ¡ D ƒƒS )z.Validate all extension points in this package.c                 s   s   | ]}|  ¡ V  qd S r0   r   )Ú.0Ú	extensionr%   r%   r&   Ú	<genexpr>Ï   r3   z,ExtensionPackage.validate.<locals>.<genexpr>)ÚallrS   Úvaluesr)   r%   r%   r&   r   Í   s    zExtensionPackage.validatec                 C   s*   | j  |d¡}|s&| j| }| |¡ dS )zLink an extension point.FN)Ú_linked_pointsr.   rS   r;   )r#   Ú
point_namer1   r*   rV   r%   r%   r&   Ú
link_pointÑ   s    
zExtensionPackage.link_pointc                 C   s   | j | }| |¡S )zLoad an extension point.)rS   r<   )r#   r]   r1   rV   r%   r%   r&   Ú
load_pointØ   s    
zExtensionPackage.load_pointc                 C   s   | j D ]}|  ||¡ qdS )zLink all extension points.N)rS   r^   )r#   r1   r]   r%   r%   r&   Úlink_all_pointsÝ   s    
z ExtensionPackage.link_all_pointsc                    s   ‡ ‡fdd„ˆ j D ƒS )zLoad all extension points.c                    s   g | ]}ˆ   |ˆ¡‘qS r%   )r_   )rW   r]   ©r#   r1   r%   r&   Ú
<listcomp>ä   r3   z4ExtensionPackage.load_all_points.<locals>.<listcomp>)rS   ra   r%   ra   r&   Úload_all_pointsâ   s    z ExtensionPackage.load_all_points)r=   r>   r?   r@   r	   r-   r   rI   r   r\   rS   r   r   r   r   rF   r
   rJ   rL   rM   r   r^   r_   r`   rc   Ú__classcell__r%   r%   rO   r&   rC   –   s&   
ÿ
rC   c                   @   sÔ   e Zd ZdZeedd�Zeƒ Ze	dƒdd„ ƒZ
edƒdd„ ƒZed	d
�Zedd„ ƒZedd
�Zedd„ ƒZedd„ ƒZdd„ Zdd„ Zdd„ Zd*dd„Zdd„ Zdd„ Zdd „ Zd!d"„ Zd#d$„ Zd%d&„ Zd'd(„ Zd)S )+ÚExtensionManagerz©High level interface for findind, validating,
    linking, loading, and managing Jupyter Server extensions.

    Usage:
    m = ExtensionManager(config_manager=...)
    Tr   Úconfig_managerc                 C   s   t ƒ }|  |¡ |S r0   )r   Ú_load_config_manager©r#   rf   r%   r%   r&   Ú_load_default_config_manageró   s    
z-ExtensionManager._load_default_config_managerc                 C   s   |j r|  |j ¡ d S r0   )Únewrg   )r#   Zchanger%   r%   r&   Ú_config_manager_changedù   s    z(ExtensionManager._config_manager_changedzq
        Dictionary with extension package names as keys
        and ExtensionPackage objects as values.
        rD   c                 C   s   t t| j ¡ ƒƒS )z8Returns an extensions dictionary, sorted alphabetically.)ÚdictÚsortedÚ
extensionsÚitemsr)   r%   r%   r&   Úsorted_extensions	  s    z"ExtensionManager.sorted_extensionsz|
        Dictionary with extension names as keys

        values are True if the extension is linked, False if not.
        c                 C   s   dd„ | j  ¡ D ƒS )zCReturn mapping of extension names and sets of ExtensionApp objects.c                 S   s&   i | ]\}}|d d„ |j  ¡ D ƒ“qS )c                 S   s   h | ]}|j r|j ’qS r%   )r   )rW   rV   r%   r%   r&   Ú	<setcomp>  r3   z=ExtensionManager.extension_apps.<locals>.<dictcomp>.<setcomp>)rS   r[   )rW   r-   rX   r%   r%   r&   Ú
<dictcomp>  s   ÿz3ExtensionManager.extension_apps.<locals>.<dictcomp>)rn   ro   r)   r%   r%   r&   Úextension_apps  s    þzExtensionManager.extension_appsc                 C   s   dd„ | j  ¡ D ƒS )zCReturn mapping of extension point names and ExtensionPoint objects.c                 S   s&   i | ]}|j  ¡ D ]\}}||“qqS r%   )rS   ro   )rW   r   r-   rV   r%   r%   r&   rr   %  s   þz5ExtensionManager.extension_points.<locals>.<dictcomp>)rn   r[   r)   r%   r%   r&   rS   "  s    þz!ExtensionManager.extension_pointsc                 C   s
   || _ dS )z1Add extensions found by an ExtensionConfigManagerN)rf   rh   r%   r%   r&   Úfrom_config_manager+  s    z$ExtensionManager.from_config_managerc                 C   s   |  ¡ }|  |¡ dS )z Actually load our config managerN)Zget_jpserver_extensionsÚfrom_jpserver_extensions)r#   rf   Újpserver_extensionsr%   r%   r&   rg   0  s    z%ExtensionManager._load_config_managerc                 C   s$   |  ¡ D ]\}}| j||d� qdS )z:Add extensions from 'jpserver_extensions'-like dictionary.)rI   N)ro   Úadd_extension)r#   rv   r-   rI   r%   r%   r&   ru   5  s    z)ExtensionManager.from_jpserver_extensionsFc              
   C   sl   zt ||d�}|| j|< W dS  tyf } z2| jr<| jjr<‚ | jjd|||dd� W Y d}~n
d}~0 0 dS )zeTry to add extension to manager, return True if successful.
        Otherwise, return False.
        )r-   rI   Tz-%s | error adding extension (enabled: %s): %s©Úexc_infoNF)rC   rn   r:   r1   Ú!reraise_server_extension_failuresrR   Úwarning)r#   Zextension_namerI   ZextpkgrT   r%   r%   r&   rw   :  s    
ûzExtensionManager.add_extensionc              
   C   s˜   | j  |d¡}| j| }|s”|jr”z(| | j¡ d| j |< | j d|¡ W nH ty’ } z0| jrj| jj	rj‚ | jj
d||dd� W Y d}~n
d}~0 0 dS )zLink an extension by name.FTz'%s | extension was successfully linked.z %s | error linking extension: %srx   N)Úlinked_extensionsr.   rn   rI   r`   r1   rR   Úinfor:   rz   r{   )r#   r-   r*   rX   rT   r%   r%   r&   Úlink_extensionO  s    


zExtensionManager.link_extensionc              
   C   s‚   | j  |¡}|r~|jr~z| | j¡ W nH tyn } z0| jrF| jjrF‚ | jjd||dd� W Y d}~nd}~0 0 | j 	d|¡ dS )zLoad an extension by name.z.%s | extension failed loading with message: %rTrx   Nz'%s | extension was successfully loaded.)
rn   r.   rI   rc   r1   r:   rz   rR   r{   r}   )r#   r-   rX   rT   r%   r%   r&   Úload_extension^  s    
ÿzExtensionManager.load_extensionc                 Ã   s@   |D ]6}| j  d||j¡ | ¡ I dH  | j  d||j¡ qdS )z.Call the shutdown hooks in the specified apps.z%s | extension app %r stoppingNz%s | extension app %r stopped)rR   Údebugr-   Ústop_extension)r#   r-   Úappsr   r%   r%   r&   r�   n  s    zExtensionManager.stop_extensionc                 C   s   | j D ]}|  |¡ qdS )zHLink all enabled extensions
        to an instance of ServerApp
        N)rp   r~   ©r#   r-   r%   r%   r&   Úlink_all_extensionsu  s    
z$ExtensionManager.link_all_extensionsc                 C   s   | j D ]}|  |¡ qdS )zULoad all enabled extensions and append them to
        the parent ServerApp.
        N)rp   r   rƒ   r%   r%   r&   Úload_all_extensions~  s    
z$ExtensionManager.load_all_extensionsc                 ƒ   s.   t ‡ fdd„ttˆ jƒ ¡ ƒD ƒƒI dH  dS )z*Call the shutdown hooks in all extensions.c                    s   g | ]\}}ˆ   ||¡‘qS r%   )r�   )rW   r-   r‚   r)   r%   r&   rb   Š  s   ÿz8ExtensionManager.stop_all_extensions.<locals>.<listcomp>N)r   rm   rl   rs   ro   r)   r%   r)   r&   Ústop_all_extensions‡  s
    
þÿz$ExtensionManager.stop_all_extensionsc                 C   s:   t t| jƒ ¡ ƒD ]"\}}|D ]}| ¡ r  dS qqdS )zMCheck for any activity currently happening across all extension applications.TN)rm   rl   rs   ro   Zcurrent_activity)r#   Ú_r‚   r   r%   r%   r&   Úany_activity�  s    zExtensionManager.any_activityN)F)r=   r>   r?   r@   r   r   rf   r   r1   r
   ri   r   rk   r   rn   rB   rp   r|   rs   rS   rt   rg   ru   rw   r~   r   r�   r„   r…   r†   rˆ   r%   r%   r%   r&   re   ç   s<   

ÿ
ÿ


			re   )r@   r   Ztornado.genr   Z	traitletsr   r   r   r   r   r   r	   r
   r   r   rA   Ztraitlets.configr   r+   r   Úutilsr   r   r   r   r   rC   re   r%   r%   r%   r&   Ú<module>   s   , 
Q