a
    ø£BeÌW  ã                   @   s>  d Z ddlZddlZddlmZmZmZ ddlmZ ddl	m
Z
mZmZmZmZ ddlZddlmZmZ ddlmZmZmZmZmZ dd	d
dœZdd„ Ze d¡e d¡e d¡dœZdd„ Zedd�G dd„ dƒƒZedd�G dd„ dƒƒZeG dd„ dƒƒZ edd�G dd„ dƒƒZ!eG dd„ dƒƒZ"G d d!„ d!eƒZ#dS )"z'Base classes for the extension manager.é    N)Ú	dataclassÚfieldÚreplace)ÚPath)ÚDictÚListÚOptionalÚSetÚTuple)ÚConfigurableÚLoggingConfigurable)Ú_AppHandlerÚ_ensure_optionsÚdisable_extensionÚenable_extensionÚget_app_infoz-alpha.z-beta.z-rc.)ÚaÚbÚrcc                 C   s   t |ƒ}| ¡ | d< dS )z0Ensure that the app info has compat_errors fieldÚcompat_errorsN)r   Z_get_extension_compat)ÚinfoÚapp_optionsÚhandler© r   ú`/home/yuhw/wc/wire-cell-python/wcpy/lib/python3.9/site-packages/jupyterlab/extensions/manager.pyÚ_ensure_compat_errors   s    r   z*(?P<name>.*) needs to be included in buildz+(?P<name>.*) needs to be removed from buildz:(?P<name>.*) changed from (?P<oldver>.*) to (?P<newver>.*)©ÚinstallÚ	uninstallÚupdatec                 C   sb   t | ƒ}|jdd�}g g g dœ}|D ]8}t ¡ D ]*\}}| |¡}|r0||  | d¡¡ q0q$|S )z8Get info about packages scheduled for (un)install/updateT)Úfastr   Úname)r   Zbuild_checkÚ_message_mapÚitemsÚmatchÚappendÚgroup)r   r   ÚmessagesÚstatusÚmsgÚkeyÚpatternr$   r   r   r   Ú_build_check_info'   s    
r,   T)Úfrozenc                   @   s  e Zd ZU dZeed< eed< eed< eed< dZeed< dZeed	< d
Z	e
e ed< dZeed< dZeed< d
Ze
e ed< d
Ze
e ed< dZeed< dZeed< dZeed< d
Ze
e ed< d
Ze
e ed< d
Ze
e ed< d
Ze
e ed< d
Ze
e ed< d
Ze
e ed< d
S )ÚExtensionPackageað  Extension package entry.

    Attributes:
        name: Package name
        description: Package description
        homepage_url: Package home page
        pkg_type: Type of package - ["prebuilt", "source"]
        allowed: [optional] Whether this extension is allowed or not - default True
        approved: [optional] Whether the package is approved by your administrators - default False
        companion: [optional] Type of companion for the frontend extension - [None, "kernel", "server"]; default None
        core: [optional] Whether the package is a core package or not - default False
        enabled: [optional] Whether the package is enabled or not - default False
        install: [optional] Extension package installation instructions - default None
        installed: [optional] Whether the extension is currently installed - default None
        installed_version: [optional] Installed version - default ""
        latest_version: [optional] Latest available version - default ""
        status: [optional] Package status - ["ok", "warning", "error"]; default "ok"
        author: [optional] Package author - default None
        license: [optional] Package license - default None
        bug_tracker_url: [optional] Package bug tracker URL - default None
        documentation_url: [optional] Package documentation URL - default None
        package_manager_url: Package home page in the package manager - default None
        repository_url: [optional] Package code repository URL - default None
    r!   ÚdescriptionÚhomepage_urlÚpkg_typeTÚallowedFÚapprovedNÚ	companionÚcoreÚenabledr   Ú	installedÚ Úinstalled_versionÚlatest_versionÚokr(   ÚauthorÚlicenseÚbug_tracker_urlÚdocumentation_urlÚpackage_manager_urlÚrepository_url)Ú__name__Ú
__module__Ú__qualname__Ú__doc__ÚstrÚ__annotations__r2   Úboolr3   r4   r   r5   r6   r   Údictr7   r9   r:   r(   r<   r=   r>   r?   r@   rA   r   r   r   r   r.   5   s*   
r.   c                   @   s@   e Zd ZU dZeed< dZee ed< ee	d�Z
ee ed< dS )ÚActionResultzòAction result

    Attributes:
        status: Action status - ["ok", "warning", "error"]
        message: Action status explanation
        needs_restart: Required action follow-up - Valid follow-up are "frontend", "kernel" and "server"
    r(   NÚmessage©Údefault_factoryÚneeds_restart)rB   rC   rD   rE   rF   rG   rK   r   r   ÚlistrN   r   r   r   r   r   rJ   f   s   

rJ   c                   @   s\   e Zd ZU dZeed�Zee e	d< eed�Z
ee e	d< dZee	d< eed�Zee	d< dS )	ÚExtensionManagerOptionsa  Extension manager options.

    Attributes:
        allowed_extensions_uris: A list of comma-separated URIs to get the allowed extensions list
        blocked_extensions_uris: A list of comma-separated URIs to get the blocked extensions list
        listings_refresh_seconds: The interval delay in seconds to refresh the lists
        listings_tornado_options: The optional kwargs to use for the listings HTTP requests as described on https://www.tornadoweb.org/en/stable/httpclient.html#tornado.httpclient.HTTPRequest
    rL   Úallowed_extensions_urisÚblocked_extensions_urisi  Úlistings_refresh_secondsÚlistings_tornado_optionsN)rB   rC   rD   rE   r   ÚsetrQ   r	   rF   rG   rR   rS   ÚintrI   rT   r   r   r   r   rP   w   s
   
	rP   c                   @   s6   e Zd ZU dZeed< dZeed< dZe	e ed< dS )ÚExtensionManagerMetadataa#  Extension manager metadata.

    Attributes:
        name: Extension manager name to be displayed
        can_install: Whether the extension manager can un-/install packages (default False)
        install_path: Installation path for the extensions (default None); e.g. environment path
    r!   FÚcan_installNÚinstall_path)
rB   rC   rD   rE   rF   rG   rX   rH   rY   r   r   r   r   r   rW   ˆ   s   
rW   c                   @   sD   e Zd ZU dZeed�Zeee	ee
ef  f ed< dZeed< dS )ÚExtensionsCachez{Extensions cache

    Attributes:
        cache: Extension list per page
        last_page: Last available page result
    rL   Úcacheé   Ú	last_pageN)rB   rC   rD   rE   r   rI   r[   r   rV   r   rF   r.   rG   r]   r   r   r   r   rZ   —   s   
&rZ   c                       s´  e Zd ZdZd4ee ee ee ddœ‡ fdd„Zdd„ Ze	e
dœd	d
„ƒZeee dœdd„Zeeeeeeef ee f dœdd„Zd5eee edœdd„Zeedœdd„Zeedœdd„Zeedœdd„Zeeedœdd„ƒZeedœdd„Zd6ee eeeee ee f dœd!d"„Zee eeddœd#d$„Zddœd%d&„Zd7eeef dœd(d)„Zeee d*œd+d,„Z ee dœd-d.„Z!eed/œd0d1„Z"d8ee eeddœd2d3„Z#‡  Z$S )9ÚExtensionManageraØ  Base abstract extension manager.

    Note:
        Any concrete implementation will need to implement the five
        following abstract methods:
        - :ref:`metadata`
        - :ref:`get_latest_version`
        - :ref:`list_packages`
        - :ref:`install`
        - :ref:`uninstall`

        It could be interesting to override the :ref:`get_normalized_name`
        method too.

    Args:
        app_options: Application options
        ext_options: Extension manager options
        parent: Configurable parent

    Attributes:
        log: Logger
        app_dir: Application directory
        core_config: Core configuration
        app_options: Application options
        options: Extension manager options
    N)r   Úext_optionsÚparentÚreturnc                    sÜ   t ƒ j|d� t|ƒ}|j| _t|jƒ| _|j| _|| _t	f i |pDi ¤Ž| _
i | _d | _d| _d | _t| j
jƒs|t| j
jƒrØt| j
jƒdk| _| js°t| j
jƒdkr°| j d¡ tjj| j| j
jd dd�| _| j ¡  d S )N)r`   Tr   zqYou have define simultaneously blocked and allowed extensions listings. The allowed listing will take precedence.iè  gš™™™™™¹?)Zcallback_timeÚjitter)ÚsuperÚ__init__r   ÚloggerÚlogr   Úapp_dirZcore_configr   rP   ÚoptionsÚ_extensions_cacheÚ_listings_cacheÚ_listings_block_modeÚ_listing_fetchÚlenrQ   rR   ÚwarningÚtornadoZioloopZPeriodicCallbackÚ_fetch_listingsrS   Ústart)Úselfr   r_   r`   ©Ú	__class__r   r   rd   À   s.    ÿ
ýzExtensionManager.__init__c                 C   s   | j d ur| j  ¡  d S )N)rl   Ústop©rr   r   r   r   Ú__del__à   s    
zExtensionManager.__del__)ra   c                 C   s
   t ƒ ‚dS )zExtension manager metadata.N©ÚNotImplementedErrorrv   r   r   r   Úmetadataä   s    zExtensionManager.metadata)Ú	extensionra   c                 Ã   s
   t ƒ ‚dS )z°Return the latest available version for a given extension.

        Args:
            pkg: The extension name
        Returns:
            The latest available version
        Nrx   ©rr   r{   r   r   r   Úget_latest_versioné   s    z#ExtensionManager.get_latest_version)ÚqueryÚpageÚper_pagera   c                 Ã   s
   t ƒ ‚dS )ab  List the available extensions.

        Args:
            query: The search extension query
            page: The result page
            per_page: The number of results per page
        Returns:
            The available extensions in a mapping {name: metadata}
            The results last page; None if the manager does not support pagination
        Nrx   ©rr   r~   r   r€   r   r   r   Úlist_packagesó   s    zExtensionManager.list_packages)r{   Úversionra   c                 Ã   s
   t ƒ ‚dS )a½  Install the required extension.

        Note:
            If the user must be notified with a message (like asking to restart the
            server), the result should be
            {"status": "warning", "message": "<explanation for the user>"}

        Args:
            extension: The extension name
            version: The version to install; default None (i.e. the latest possible)
        Returns:
            The action result
        Nrx   )rr   r{   rƒ   r   r   r   r     s    zExtensionManager.installc                 Ã   s
   t ƒ ‚dS )aj  Uninstall the required extension.

        Note:
            If the user must be notified with a message (like asking to restart the
            server), the result should be
            {"status": "warning", "message": "<explanation for the user>"}

        Args:
            extension: The extension name
        Returns:
            The action result
        Nrx   r|   r   r   r   r     s    zExtensionManager.uninstallc              
   Ã   sX   zt || jd� tddgd�W S  tyR } ztdt|ƒd�W  Y d}~S d}~0 0 dS )z†Disable an extension.

        Args:
            extension: The extension name
        Returns:
            The action result
        ©r   r;   Úfrontend©r(   rN   Úerror©r(   rK   N)r   r   rJ   Ú	ExceptionÚrepr©rr   r{   Úerrr   r   r   Údisable!  s
    zExtensionManager.disablec              
   Ã   sX   zt || jd� tddgd�W S  tyR } ztdt|ƒd�W  Y d}~S d}~0 0 dS )z…Enable an extension.

        Args:
            extension: The extension name
        Returns:
            The action result
        r„   r;   r…   r†   r‡   rˆ   N)r   r   rJ   r‰   rŠ   r‹   r   r   r   Úenable/  s
    zExtensionManager.enable)rƒ   ra   c              	   C   s    t  ddd„ t  dd| ¡d ¡S )a;  Convert a Python version to Semver version.

        It:

        - drops ``.devN`` and ``.postN``
        - converts ``aN``, ``bN`` and ``rcN`` to ``-alpha.N``, ``-beta.N``, ``-rc.N`` respectively

        Args:
            version: Version to convert
        Returns
            Semver compatible version
        z(a|b|rc)(\d+)$c                 S   s   t |  d¡ › |  d¡› �S )Nr\   é   )ÚPYTHON_TO_SEMVERr&   )Úmr   r   r   Ú<lambda>M  ó    z5ExtensionManager.get_semver_version.<locals>.<lambda>z\.(dev|post)\d+r8   r   )ÚreÚsubÚsubn)rƒ   r   r   r   Úget_semver_version=  s
    ýz#ExtensionManager.get_semver_versionc                 C   s   |j S )a  Normalize extension name.

        Extension have multiple parts, npm package, Python package,...
        Sub-classes may override this method to ensure the name of
        an extension from the service provider and the local installed
        listing is matching.

        Args:
            extension: The extension metadata
        Returns:
            The normalized name
        ©r!   r|   r   r   r   Úget_normalized_nameQ  s    z$ExtensionManager.get_normalized_namer\   é   c           	      Ã   sr  || j vs|| j | jvr.|  |||¡I dH  | jdu rR| jdurR| j ¡ I dH  | j | j| }|du rni }t| ¡ ƒ}|du�rb| jdu�rbt| jƒ}g }| j�r| 	¡ D ]P\}}||vrÒ| 
t|dd�¡ q®|jr®| j d|› d�¡ | 
t|dd�¡ q®n`| 	¡ D ]V\}}||v �r0| 
t|dd�¡ n.|j�r
| j d|› d�¡ | 
t|dd�¡ �q
|| j | jfS )aL  List extensions for a given ``query`` search term.

        This will return the extensions installed (if ``query`` is None) or
        available if allowed by the listing settings.

        Args:
            query: [optional] Query search term.

        Returns:
            The extensions
            Last page of results
        NT)r2   zBlocked extension 'z' is installed.FzNot allowed extension ')ri   r[   Úrefreshrj   rl   ÚcallbackrO   Úvaluesrk   r#   r%   r   r9   rf   rn   r]   )	rr   r~   r   r€   r[   Ú
extensionsZlistingr!   Úextr   r   r   Úlist_extensions`  s2    

z ExtensionManager.list_extensionsc                 Ã   s2   || j v rd| j | j|< |  |||¡I dH  dS )zRefresh the list of extensions.N)ri   r[   Ú_update_extensions_listr�   r   r   r   r›   Ž  s    
zExtensionManager.refreshc                 Ã   sþ   g }t j ¡ }| jr€t| jjƒrê| j d| jj› �¡ | jjD ]>}|j	|fi | jj
¤ŽI dH }t |j¡}| | dg ¡¡ q>njt| jjƒrê| j d| jj› �¡ | jjD ]>}|j	|fi | jj
¤ŽI dH }t |j¡}| | dg ¡¡ qªdd„ |D ƒ| _dS )z-Fetch the listings for the extension manager.z!Fetching blocked extensions from NZblocked_extensionsz!Fetching allowed extensions from Zallowed_extensionsc                 S   s   i | ]}|d  |“qS r˜   r   )Ú.0Úrr   r   r   Ú
<dictcomp>°  r“   z4ExtensionManager._fetch_listings.<locals>.<dictcomp>)ro   Z
httpclientZAsyncHTTPClientrk   rm   rh   rR   rf   r   ÚfetchrT   ÚjsonÚloadsÚbodyÚextendÚgetrQ   rj   )rr   ÚrulesÚclientZblocked_extensions_urir£   ÚjZallowed_extensions_urir   r   r   rp   ”  s8    
ÿÿþÿÿþz ExtensionManager._fetch_listingsTc                 Ã   s  | j }t|d�}t|ƒ}t||ƒ i }|d  ¡ D ]ø\}}d}|}	|d  |d¡rVd}|  |¡}
t|
|	 dd¡| d	d¡||d
 vdt 	|d ¡dt 	|d ¡|| di ¡d|  
|¡| di ¡ d| d¡¡| d¡| di ¡ d	¡| di ¡ d	| d¡¡d�}|�r"t||  |j¡I dH d�}|||
< q2|d  ¡ D �]\}}||d v �rT�q8d}|d  |d¡�rpd}n| ¡ D ]}||v �rxd}�qx|  |¡}
t|
| dd¡|d	 ||d
 vdt 	|d ¡dt 	|d ¡|d|  
|¡| di ¡ d| d¡¡| d¡| di ¡ d	¡| di ¡ d	| d¡¡d�}|�rLt||  |j¡I dH d�}|||
< �q8|d D ]´}|  |¡}|du�r`|  |¡}
t|
| dd¡| dd¡dddt 	|d ¡t 	|d ¡dd| di ¡ d| d¡¡| d¡| di ¡ d	¡| di ¡ d	| d¡¡d�}|||
< �q`|S )zßGet the installed extensions.

        Args:
            get_latest_version: Whether to fetch the latest extension version or not.
        Returns:
            The installed extensions as a mapping {name: metadata}
        r„   Zfederated_extensionsr;   r   Nr‡   r/   r8   ÚurlÚdisabledFrƒ   Tr   Zprebuiltr<   r!   r=   ÚbugsÚ
repository)r!   r/   r0   r6   r5   r:   r7   r9   r(   r   r1   r4   r<   r=   r>   rA   )r:   rž   Zshadowed_extsrn   Úsource)r!   r/   r0   r6   r5   r:   r7   r9   r(   r1   r4   r<   r=   r>   rA   r   Zhomepage)r!   r/   r0   r7   r6   r5   r:   r9   r(   r1   r<   r=   r>   rA   )r   r   r,   r   r#   rª   Ú_normalize_namer.   r^   r—   Ú_get_companionr   r}   r!   r�   Ú_get_scheduled_uninstall_info)rr   r}   r   r   Zbuild_check_inforž   r!   Údatar(   Úpkg_infoÚnormalized_nameÚpkgÚpackagesr   r   r   Ú_get_installed_extensions²  s¨    







ð




ñ




òz*ExtensionManager._get_installed_extensions)r¶   ra   c                 C   s>   d }d|d v r:d|d d v r&d}nd|d d v r:d}|S )NZ	discoveryZ
jupyterlabÚserverZkernelr   )rr   r¶   r4   r   r   r   r´     s    zExtensionManager._get_companionc                 C   sZ   | j d d | d }| ¡ rR| ¡ �}t |¡W  d  ƒ S 1 sF0    Y  ndS dS )zDGet information about a package that is scheduled for uninstallationZstagingZnode_moduleszpackage.jsonN)rg   ÚexistsÚopenr¦   Úload)rr   r!   ÚtargetÚfidr   r   r   rµ   %  s
    
*z.ExtensionManager._get_scheduled_uninstall_info)r!   ra   c                 C   s   |S )z˜Normalize extension name; by default does nothing.

        Args:
            name: Extension name
        Returns:
            Normalized name
        r   )rr   r!   r   r   r   r³   .  s    z ExtensionManager._normalize_namec                 Ã   s|   d}|dur&|   |||¡I dH \}}n|  ¡ I dH }|| jv r`|| j| j|< |pTd| j| _nt||i|pndƒ| j|< dS )zUpdate the list of extensionsNr\   )r‚   r»   ri   r[   r]   rZ   )rr   r~   r   r€   r]   rž   r   r   r   r¡   8  s    
z(ExtensionManager._update_extensions_list)NNN)N)Nr\   rš   )T)Nr\   rš   )%rB   rC   rD   rE   r   rI   r   rd   rw   ÚpropertyrW   rz   rF   r}   rV   r
   r   r.   r‚   rJ   r   r   r�   rŽ   Ústaticmethodr—   r™   r   r    r›   rp   r»   r´   rµ   r³   r¡   Ú__classcell__r   r   rs   r   r^   ¤   sV      üû þ ÿ
þ. ÿ
þj		 ÿ
þr^   )$rE   r¦   r”   Údataclassesr   r   r   Úpathlibr   Útypingr   r   r   r	   r
   ro   Ztraitlets.configr   r   Zjupyterlab.commandsr   r   r   r   r   r�   r   Úcompiler"   r,   r.   rJ   rP   rW   rZ   r^   r   r   r   r   Ú<module>   s4   ý0