o ^i?@sdZddlmZddlZddlZddlmZddlmZddl m Z m Z m Z m Z mZmZmZmZmZddl mZddlmZd d lmZd d lmZmZmZmZGd d d e ZGdddeZGdddeZ dS)zThe extension manager.) annotationsN)starmap)multi) AnyBoolDict HasTraitsInstanceListUnicodedefaultobservevalidate)LoggingConfigurable)ExtensionConfigManager)ExtensionMetadataErrorExtensionModuleNotFound get_loader get_metadatac@seZdZdZedZedddZeZ e e j Z edddZed d d Zed d ZeddZeddZeddZeddZeddZddZddZddZddZd d!Zd"d#Zd$d%ZdS)&ExtensionPointzA simple API for connecting to a Jupyter Server extension point defined by metadata and importable from a Python package. FNT allow_nonelogcCs tdS)Nr)logging getLoggerselfr[/home/ubuntu/hpml_nyu/venv/lib/python3.10/site-packages/jupyter_server/extension/manager.py _default_logs zExtensionPoint._default_logmetadatacCs|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)rproposedr"msgrrr _valid_metadata"s"      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%_linkedrrrr linked:szExtensionPoint.linkedcC|jS)z'If the metadata includes an `app` field)r,rrrr r%EzExtensionPoint.appcCs|jr|jSiS)z:Return any configuration provided by this extension point.)r%_jupyter_server_configrrrr configJs zExtensionPoint.configcCr2)zuName of the Python package module where the extension's _load_jupyter_server_extension can be found. )r&rrrr module_nameTszExtensionPoint.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)r%r7r"getr6rrrr r7[szExtensionPoint.namecCr2)z3The imported module (using importlib.import_module))r*rrrr r$fr3zExtensionPoint.modulecCs(|jr |jj}|St|jddd}|S)z Get a linker._link_jupyter_server_extensioncSsdSNr serverapprrr usz,ExtensionPoint._get_linker..)r%r9getattrr$)rlinkerrrr _get_linkerks zExtensionPoint._get_linkercCs|j}|s|j}t|}|S)z Get a loader.)r%r$r)rlocloaderrrr _get_loaderys zExtensionPoint._get_loadercCs,|jr |jj}|Sdd}t|jd|}|S)zGet a starter function.csdSr:rr;rrr _noop_startsz0ExtensionPoint._get_starter.._noop_start_start_jupyter_server_extension)r%rEr>r$)rr?rDrrr _get_starters zExtensionPoint._get_startercCs,z ||WdStyYdSw)z+Check that both a linker and loader exists.FT)r@rC Exceptionrrrr rs  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)r1r@r0)rr<r?rrr 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. )rC)rr<rBrrr loadszExtensionPoint.loadcs|}||IdHS)zCall's the extensions 'start' hook where it can start (possibly async) tasks _after_ the event loop is running. N)rF)rr<starterrrr startszExtensionPoint.start) __name__ __module__ __qualname____doc__rr0rr,rr"r rLoggerrr r!validate_traitr/propertyr1r%r5r6r7r$r@rCrFrrHrIrKrrrr rs:            rcseZdZdZeddZedddZeZ eZ e dddZ e ed dZed dZed d d ZfddZddZddZddZddZddZddZddZddZZS) 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)rrUz5Extension 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__)enabledr>r$rrrr _load_versionszExtensionPackage._load_versionc s(tjdi||jr|dSdS)z Initialize an extension package.Nr)super__init__rY_load_metadata)rkwargs __class__rr r\s zExtensionPackage.__init__c Cs|j}z t||jd\|_|_Wnty*}zd|d|d}t|dd}~ww|jD]}t||jd}||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"r) r7rrr$r"r+rrextension_points)rr7er.mpointrrr r]s  zExtensionPackage._load_metadatacCstdd|jDS)z.Validate all extension points in this package.css|]}|VqdSr:r).0 extensionrrr sz,ExtensionPackage.validate..)allrbvaluesrrrr rszExtensionPackage.validatecCs.|j|d}|s|j|}||dSdS)zLink an extension point.FN)_linked_pointsr8rbrH)r point_namer<r1rerrr link_points  zExtensionPackage.link_pointcCs|j|}||S)Load an extension point.)rbrIrrlr<rerrr load_points  zExtensionPackage.load_pointcs|j|}||IdHS)rnN)rbrKrorrr start_points zExtensionPackage.start_pointcCs|jD]}|||qdS)zLink all extension points.N)rbrmrr<rlrrr link_all_pointss z ExtensionPackage.link_all_pointscsfddjDS)Load all extension points.csg|]}|qSr)rp)rfrlrr<rr z4ExtensionPackage.load_all_points..)rbrurrur load_all_points sz ExtensionPackage.load_all_pointscs$|jD] }|||IdHqdS)rtN)rbrqrrrrr start_all_pointss z!ExtensionPackage.start_all_points)rLrMrNrOr r7rrYrrkrbrr$r r"rVr rZr\r]rrmrprqrsrxry __classcell__rrr_r rSs,     rSc@seZdZdZeeddZeZe dddZ e dddZ e d d Zed d Ze d d ZeddZeddZddZddZddZd.ddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Z d-S)/ExtensionManagerzHigh level interface for finding, validating, linking, loading, and managing Jupyter Server extensions. Usage: m = ExtensionManager(config_manager=...) Trconfig_managercCst}|||Sr:)r_load_config_managerrr|rrr _load_default_config_manager!s z-ExtensionManager._load_default_config_managercCs|jr ||jdSdSr:)newr})rchangerrr _config_manager_changed'sz(ExtensionManager._config_manager_changedzq Dictionary with extension package names as keys and ExtensionPackage objects as values. rTcCstt|jS)z8Returns an extensions dictionary, sorted alphabetically.)dictsorted extensionsitemsrrrr sorted_extensions7sz"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%)rfrerrr Lrwz=ExtensionManager.extension_apps...)rbrj)rfr7rgrrr Ksz3ExtensionManager.extension_apps..)rrrrrr extension_appsHzExtensionManager.extension_appscCr)zCReturn mapping of extension point names and ExtensionPoint objects.cSs&i|]}|jD]\}}||q qSr)rbr)rfr#r7rerrr rSsz5ExtensionManager.extension_points..)rrjrrrr rbPrz!ExtensionManager.extension_pointscCs ||_dS)z1Add extensions found by an ExtensionConfigManagerN)r|r~rrr from_config_managerYs z$ExtensionManager.from_config_managercCs|}||dS)z Actually load our config managerN)get_jpserver_extensionsfrom_jpserver_extensions)rr|jpserver_extensionsrrr r}^sz%ExtensionManager._load_config_managercCs$|D] \}}|j||dqdS)z:Add extensions from 'jpserver_extensions'-like dictionary.)rYN)r add_extension)rrr7rYrrr rcsz)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. )r7rYTz-%s | error adding extension (enabled: %s): %sexc_infoNF)rSrrGr<!reraise_server_extension_failuresrwarning)rextension_namerYextpkgrcrrr rhs"  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: %srN) linked_extensionsr8rrYrsr<rinforGrr)rr7r1rgrcrrr link_extension}s    "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: %rTrNz'%s | extension was successfully loaded.) rr8rYrxr<rGrrrrrr7rgrcrrr load_extensions  zExtensionManager.load_extensionc s|j|}|rF|jrHz ||jIdHWn%ty<}z|jr'|jjr'|jjd||ddWYd}~dSd}~ww|j d|dSdSdS)zStart an extension by name.Nz/%s | extension failed starting with message: %rTrz(%s | extension was successfully started.) rr8rYryr<rGrrrdebugrrrr start_extensions  z ExtensionManager.start_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)rrr7stop_extension)rr7appsr%rrr rs zExtensionManager.stop_extensioncC|jD]}||qdS)zHLink all enabled extensions to an instance of ServerApp N)rrrr7rrr link_all_extensions  z$ExtensionManager.link_all_extensionscCr)zULoad all enabled extensions and append them to the parent ServerApp. N)rrrrrr load_all_extensionsrz$ExtensionManager.load_all_extensionscs$tfddjDIdHdS)zStart all enabled extensions.csg|]}|qSr)r)rfr7rrr rvsz9ExtensionManager.start_all_extensions..N)rrrrrr start_all_extensionss"z%ExtensionManager.start_all_extensionscs.ttt|jtt|jIdHdS)z*Call the shutdown hooks in all extensions.N)rlistrrrrrrrrrr stop_all_extensionss,z$ExtensionManager.stop_all_extensionscCs:tt|jD]\}}|D] }|rdSqq dS)zMCheck for any activity currently happening across all extension applications.TN)rrrrcurrent_activity)r_rr%rrr any_activityszExtensionManager.any_activityN)F)!rLrMrNrOr rr|rr<r rr rrrrRrrrrbrr}rrrrrrrrrrrrrrr r{sB          r{)!rO __future__rr(r itertoolsr tornado.genr traitletsrrrrr r r r r rrQtraitlets.configrr5rutilsrrrrrrSr{rrrr s   ,   )[