o tf6@sdZddlmZddlZddlmZddlmZddlm Z m Z m Z m Z m Z mZmZmZmZddlmZddlmZd d lmZd d lmZmZmZmZGd d d e ZGdddeZGdddeZdS)zThe extension manager.) annotationsN)starmap)multi) AnyBoolDict HasTraitsInstanceListUnicodedefaultobservevalidate)LoggingConfigurable)ExtensionConfigManager)ExtensionMetadataErrorExtensionModuleNotFound get_loader get_metadatac@seZdZdZedZedddZeZ e dddZ e d d Z e d d Ze d dZe ddZe ddZe ddZddZddZddZddZddZdS)ExtensionPointzA simple API for connecting to a Jupyter Server extension point defined by metadata and importable from a Python package. FNT allow_nonemetadatacCs|d}z|d|_Wntyd}t|dwz t|j|_Wnty6d|jd}t|dwd|vrA|d|_|S)zValidate metadata.valuemodulez' could not be found. Are you sure the extension is installed?app) _module_nameKeyErrorr importlib import_module_module ImportErrorr_app)selfZproposedrmsgr'i/var/www/html/software/conda/envs/catlas/lib/python3.10/site-packages/jupyter_server/extension/manager.py_valid_metadatas"      zExtensionPoint._valid_metadatacCs|jr|jjS|jS)zHas this extension point been linked to the server. Will pull from ExtensionApp's trait, if this point is an instance of ExtensionApp. )r_linkedr%r'r'r(linked3szExtensionPoint.linkedcC|jS)z'If the metadata includes an `app` field)r$r+r'r'r(r>zExtensionPoint.appcCs|jr|jSiS)z:Return any configuration provided by this extension point.)rZ_jupyter_server_configr+r'r'r(configCs zExtensionPoint.configcCr-)zuName of the Python package module where the extension's _load_jupyter_server_extension can be found. )rr+r'r'r( module_nameMszExtensionPoint.module_namecCs|jr|jjS|jd|jS)zName of the extension. If it's not provided in the metadata, `name` is set to the extensions' module name. name)rr1rgetr0r+r'r'r(r1TszExtensionPoint.namecCr-)z3The imported module (using importlib.import_module))r"r+r'r'r(r_r.zExtensionPoint.modulecCs(|jr |jj}|St|jddd}|S)z Get a linker._link_jupyter_server_extensioncSsdSNr') serverappr'r'r(nsz,ExtensionPoint._get_linker..)rr3getattrr)r%linkerr'r'r( _get_linkerds zExtensionPoint._get_linkercCs|j}|s|j}t|}|S)z Get a loader.)rrr)r%locloaderr'r'r( _get_loaderrs zExtensionPoint._get_loadercCs,z ||WdStyYdSw)z+Check that both a linker and loader exists.FT)r9r< Exceptionr+r'r'r(rzs  zExtensionPoint.validatecCs$|js|}||d|_dSdS)zLink 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,r9r*)r%r5r8r'r'r(links  zExtensionPoint.linkcCs|}||S)zLoad the extension in a Jupyter ServerApp object. This looks for a `_load_jupyter_server_extension` function in the extension's module or ExtensionApp class. )r<)r%r5r;r'r'r(loadszExtensionPoint.load)__name__ __module__ __qualname____doc__rr*rr$rrvalidate_traitr)propertyr,rr/r0r1rr9r<rr>r?r'r'r'r(rs0         rcseZdZdZeddZedddZeZ eZ e dddZ e ed dZed dZed d d ZfddZddZddZddZddZddZddZZS)ExtensionPackagezAn 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)rrHz5Extension metadata loaded from the extension package.z| The version of this extension package, if it can be found. Otherwise, an empty string. versioncCs|jsdSt|jddS)N __version__)enabledr7rr+r'r'r( _load_versionszExtensionPackage._load_versionc s(tjdi||jr|dSdS)z Initialize an extension package.Nr')super__init__rL_load_metadata)r%kwargs __class__r'r(rOs zExtensionPackage.__init__c Cs||j}z t||jd\|_|_Wnty*}zd|d|d}t|dd}~ww|jD] }t|d}||j|j<q.|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) r1rlogrrr#rrextension_points)r%r1er&mpointr'r'r(rPs   zExtensionPackage._load_metadatacCstdd|jDS)z.Validate all extension points in this package.css|]}|VqdSr4r).0 extensionr'r'r( sz,ExtensionPackage.validate..)allrVvaluesr+r'r'r(rszExtensionPackage.validatecCs.|j|d}|s|j|}||dSdS)zLink an extension point.FN)_linked_pointsr2rVr>)r% point_namer5r,rYr'r'r( link_points  zExtensionPackage.link_pointcCs|j|}||S)zLoad an extension point.)rVr?)r%r`r5rYr'r'r( load_points  zExtensionPackage.load_pointcCs|jD]}|||qdS)zLink all extension points.N)rVra)r%r5r`r'r'r(link_all_pointss z ExtensionPackage.link_all_pointscsfddjDS)zLoad all extension points.csg|]}|qSr')rb)rZr`r%r5r'r( z4ExtensionPackage.load_all_points..)rVrdr'rdr(load_all_pointssz ExtensionPackage.load_all_points)r@rArBrCr r1rrLrr_rVrrr rrIr rMrOrPrrarbrcrg __classcell__r'r'rRr(rFs(     rFc@seZdZdZeeddZeZe dddZ e dddZ e d d Zed d Ze d d ZeddZeddZddZddZddZd*ddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)S)+ExtensionManagerzHigh level interface for findind, validating, linking, loading, and managing Jupyter Server extensions. Usage: m = ExtensionManager(config_manager=...) Trconfig_managercCst}|||Sr4)r_load_config_managerr%rjr'r'r(_load_default_config_managers z-ExtensionManager._load_default_config_managercCs|jr ||jdSdSr4)newrk)r%Zchanger'r'r(_config_manager_changedsz(ExtensionManager._config_manager_changedzq Dictionary with extension package names as keys and ExtensionPackage objects as values. rGcCstt|jS)z8Returns an extensions dictionary, sorted alphabetically.)dictsorted extensionsitemsr+r'r'r(sorted_extensions sz"ExtensionManager.sorted_extensionsz| Dictionary with extension names as keys values are True if the extension is linked, False if not. cCdd|jDS)zCReturn mapping of extension names and sets of ExtensionApp objects.cSs&i|]\}}|dd|jDqS)cSsh|]}|jr|jqSr')r)rZrYr'r'r( "rfz=ExtensionManager.extension_apps...)rVr^)rZr1r[r'r'r( !sz3ExtensionManager.extension_apps..)rrrsr+r'r'r(extension_appszExtensionManager.extension_appscCru)zCReturn mapping of extension point names and ExtensionPoint objects.cSs&i|]}|jD]\}}||q qSr')rVrs)rZrr1rYr'r'r(rw)sz5ExtensionManager.extension_points..)rrr^r+r'r'r(rV&ryz!ExtensionManager.extension_pointscCs ||_dS)z1Add extensions found by an ExtensionConfigManagerN)rjrlr'r'r(from_config_manager/s z$ExtensionManager.from_config_managercCs|}||dS)z Actually load our config managerN)Zget_jpserver_extensionsfrom_jpserver_extensions)r%rjjpserver_extensionsr'r'r(rk4sz%ExtensionManager._load_config_managercCs$|D] \}}|j||dqdS)z:Add extensions from 'jpserver_extensions'-like dictionary.)rLN)rs add_extension)r%r|r1rLr'r'r(r{9sz)ExtensionManager.from_jpserver_extensionsFc Csjzt||d}||j|<WdSty4}z|jr|jjr|jjd|||ddWYd}~dSd}~ww)zeTry to add extension to manager, return True if successful. Otherwise, return False. )r1rLTz-%s | error adding extension (enabled: %s): %sexc_infoNF)rFrrr=r5!reraise_server_extension_failuresrUwarning)r%Zextension_namerLZextpkgrWr'r'r(r}>s"  zExtensionManager.add_extensionc Cs|j|d}|j|}|sL|jrNz||jd|j|<|jd|WdStyK}z|jr6|jj r6|jj d||ddWYd}~dSd}~wwdSdS)zLink an extension by name.FTz'%s | extension was successfully linked.z %s | error linking extension: %sr~N) linked_extensionsr2rrrLrcr5rUinfor=rr)r%r1r,r[rWr'r'r(link_extensionSs    "zExtensionManager.link_extensionc Cs|j|}|rB|jrDz||jWn%ty8}z|jr#|jjr#|jjd||ddWYd}~dSd}~ww|j d|dSdSdS)zLoad an extension by name.z.%s | extension failed loading with message: %rTr~Nz'%s | extension was successfully loaded.) rrr2rLrgr5r=rrUrr)r%r1r[rWr'r'r(load_extensionbs  zExtensionManager.load_extensioncsB|D]}|jd||j|IdH|jd||jqdS)z.Call the shutdown hooks in the specified apps.z%s | extension app %r stoppingNz%s | extension app %r stopped)rUdebugr1stop_extension)r%r1appsrr'r'r(rrs zExtensionManager.stop_extensioncC|jD]}||qdS)zHLink all enabled extensions to an instance of ServerApp N)rtrr%r1r'r'r(link_all_extensionsy  z$ExtensionManager.link_all_extensionscCr)zULoad all enabled extensions and append them to the parent ServerApp. N)rtrrr'r'r(load_all_extensionsrz$ExtensionManager.load_all_extensionscs.ttt|jtt|jIdHdS)z*Call the shutdown hooks in all extensions.N)rlistrrrqrprxrsr+r'r'r(stop_all_extensionss,z$ExtensionManager.stop_all_extensionscCs:tt|jD]\}}|D] }|rdSqq dS)zMCheck for any activity currently happening across all extension applications.TN)rqrprxrsZcurrent_activity)r%_rrr'r'r( any_activityszExtensionManager.any_activityN)F)r@rArBrCr rrjrr5r rmr rorrrrErtrrxrVrzrkr{r}rrrrrrrr'r'r'r(ris>         ri) rC __future__rr itertoolsrZ tornado.genrZ traitletsrrrrr r r r r rrDZtraitlets.configrr/rutilsrrrrrrFrir'r'r'r(s   ,    Q