Xh?dZddlmZddlZddlZddlmZddlmZddl m Z m Z m Z m Z mZmZmZmZmZddl mZddlmZd d lmZd d lmZmZmZmZGd d e ZGddeZGddeZ y)zThe extension manager.) annotationsN)starmap)multi) AnyBoolDict HasTraitsInstanceListUnicodedefaultobservevalidate)LoggingConfigurable)ExtensionConfigManager)ExtensionMetadataErrorExtensionModuleNotFound get_loader get_metadatac(eZdZdZedZeddZeZ e e jZ eddZedd Zed Zed Zed Zed ZedZedZdZdZdZdZdZdZdZy)ExtensionPointzA simple API for connecting to a Jupyter Server extension point defined by metadata and importable from a Python package. FNT allow_nonelogc,tjdS)Nr)logging getLoggerselfs T/var/www/html/myenv/lib/python3.12/site-packages/jupyter_server/extension/manager.py _default_logzExtensionPoint._default_logs  !122metadatac|d} |d|_ tj|j|_d|vr|d|_|S#t$rd}t|dwxYw#t $rd|jd}t|dwxYw)zValidate metadata.valuemodulez' could not be found. Are you sure the extension is installed?app) _module_nameKeyErrorr importlib import_module_module ImportErrorr_app)r!proposedr%msgs r"_valid_metadatazExtensionPoint._valid_metadata"sG$ 8 ( 2D   9$2243D3DEDL H ')DI 8PC(-4 7 8  9!$"3"3!4533 *#.D 8  9s A $A& A#&&B c^|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 s r"linkedzExtensionPoint.linked:s% 8888## #||r$c|jS)z'If the metadata includes an `app` field)r0r s r"r)zExtensionPoint.appEsyyr$cR|jr|jjSiS)z:Return any configuration provided by this extension point.)r)_jupyter_server_configr s r"configzExtensionPoint.configJs% 8888224 4Ir$c|jS)zuName of the Python package module where the extension's _load_jupyter_server_extension can be found. )r*r s r" module_namezExtensionPoint.module_nameTs    r$c|jr|jjS|jjd|jS)zName 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 s r"r>zExtensionPoint.name[s6 8888== }}  )9)9::r$c|jS)z3The imported module (using importlib.import_module))r.r s r"r(zExtensionPoint.modulefs||r$c~|jr|jj}|St|jdd}|S)z Get a linker._link_jupyter_server_extensioncyN serverapps r"z,ExtensionPoint._get_linker..usr$)r)rBgetattrr()r!linkers r" _get_linkerzExtensionPoint._get_linkerks? 88XX<._noop_starts s_start_jupyter_server_extension)r)rSrIr()r!rJrRs r" _get_starterzExtensionPoint._get_startersD 88XX==F   1 F r$cd |j|jy#t$rYywxYw)z+Check that both a linker and loader exists.TF)rKrO Exceptionr s r"rzExtensionPoint.validates8           s # //c\|js |j}||d|_yy)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)r6rKr5)r!rGrJs r"linkzExtensionPoint.links- {{%%'F 9 DL r$c2|j}||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. )rO)r!rGrNs r"loadzExtensionPoint.loads !!#i  r$cNK|j}||d{S7w)zCall's the extensions 'start' hook where it can start (possibly async) tasks _after_ the event loop is running. N)rT)r!rGstarters r"startzExtensionPoint.starts'##%Y''''s %#%) __name__ __module__ __qualname____doc__rr5rr0rr%r rLoggerrr r#validate_traitr3propertyr6r)r:r<r>r(rKrOrTrrXrZr]rEr$r"rrs5kG t %DvH 7>> "C U^33J .!! ;; $  !(r$rceZdZdZedZeddZeZ eZ e ddZ e ed Zed Zed d Zfd ZdZdZdZdZdZdZdZdZxZS)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. versioncJ|jsyt|jddS)N __version__)enabledrIr(r s r" _load_versionzExtensionPackage._load_versions||t{{M266r$c ^t|di||jr|jyy)z Initialize an extension package.NrE)super__init__rm_load_metadata)r!kwargs __class__s r"rqzExtensionPackage.__init__s+ "6" <<    ! r$c6|j} t||j\|_|_|jD]2}t||j}||j|j<4|S#t $r}d|d|d}t |dd}~wwxYw)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>rrr(r%r/rrextension_points)r!r>er2mpoints r"rrzExtensionPackage._load_metadatas yy 9)5d488)L &DK 6A"A48833 *#.D 8  9s$A55 B>BBcVtd|jjDS)z.Validate all extension points in this package.c3<K|]}|jywrDr).0 extensions r" z,ExtensionPackage.validate..sXI9%%'Xs)allrwvaluesr s r"rzExtensionPackage.validates"X9N9N9U9U9WXXXr$c|jj|d}|s!|j|}|j|yy)zLink an extension point.FN)_linked_pointsr?rwrX)r! point_namerGr6rzs r" link_pointzExtensionPackage.link_points>$$((U;))*5E JJy !r$cB|j|}|j|S)Load an extension point.)rwrZr!rrGrzs r" load_pointzExtensionPackage.load_points!%%j1zz)$$r$c^K|j|}|j|d{S7w)rN)rwr]rs r" start_pointzExtensionPackage.start_points+%%j1[[++++s $-+-cJ|jD]}|j||y)zLink all extension points.N)rwrr!rGrs r"link_all_pointsz ExtensionPackage.link_all_pointss%// 3J OOJ 2 3r$c`|jDcgc]}|j||c}Scc}w)Load all extension points.)rwrrs r"load_all_pointsz ExtensionPackage.load_all_points s'IMI^I^_: I6___s+cfK|jD]}|j||d{y7w)rN)rwrrs r"start_all_pointsz!ExtensionPackage.start_all_pointss4// :J"":y9 9 9 : 9s %1/1)r^r_r`rar r>rrmrrrwrr(r r%rir rnrqrrrrrrrrr __classcell__)rts@r"rfrfs C DD5JKGVNv D'c dFDF!XYHG Y77 " (Y"% , 3 `:r$rfceZdZdZeedZeZe ddZ e ddZ e dZed Ze d Zed Zed Zd ZdZdZddZdZdZdZdZdZdZdZdZdZ y)ExtensionManagerzHigh level interface for finding, validating, linking, loading, and managing Jupyter Server extensions. Usage: m = ExtensionManager(config_manager=...) Trconfig_managerc<t}|j||SrD)r_load_config_managerr!rs r"_load_default_config_managerz-ExtensionManager._load_default_config_manager!s/1 !!.1r$cT|jr|j|jyyrD)newr)r!changes r"_config_manager_changedz(ExtensionManager._config_manager_changed's ::  % %fjj 1 r$zq Dictionary with extension package names as keys and ExtensionPackage objects as values. rgcZtt|jjS)z8Returns an extensions dictionary, sorted alphabetically.)dictsorted extensionsitemsr s r"sorted_extensionsz"ExtensionManager.sorted_extensions7s!F4??002344r$z| Dictionary with extension names as keys values are True if the extension is linked, False if not. c |jjDcic]E\}}||jjDchc]}|js|jc}Gc}}}Scc}wcc}}}w)zCReturn mapping of extension names and sets of ExtensionApp objects.)rrrwrr))r!r>r~rzs r"extension_appszExtensionManager.extension_appsHsi $(??#8#8#:  i )*D*D*K*K*M[QVQZQZ599[ [  [ s%A3A.A.$A3.A3c|jjDcic]'}|jjD]\}}|| )c}}}Scc}}}w)zCReturn mapping of extension point names and ExtensionPoint objects.)rrrwr)r!r'r>rzs r"rwz!ExtensionManager.extension_pointsPsb //1  $55;;= e %K    s,Ac||_y)z1Add extensions found by an ExtensionConfigManagerN)rrs r"from_config_managerz$ExtensionManager.from_config_managerYs -r$cF|j}|j|y)z Actually load our config managerN)get_jpserver_extensionsfrom_jpserver_extensions)r!rjpserver_extensionss r"rz%ExtensionManager._load_config_manager^s ,DDF %%&9:r$cZ|jD]\}}|j||y)z:Add extensions from 'jpserver_extensions'-like dictionary.)rmN)r add_extension)r!rr>rms r"rz)ExtensionManager.from_jpserver_extensionscs10668 6MD'   tW  5 6r$c t||}||j|<y#t$rM}|jr|jjr|j j d|||dYd}~yd}~wwxYw)zeTry to add extension to manager, return True if successful. Otherwise, return False. )r>rmTz-%s | error adding extension (enabled: %s): %sexc_infoNF)rfrrVrG!reraise_server_extension_failuresrwarning)r!extension_namermextpkgrxs r"rzExtensionManager.add_extensionhsz %>7KF.4DOON + ~~$.."R"R HH  ?    s A5AA00A5c|jj|d}|j|}|sU|jrH |j |j d|j|<|j jd|yyy#t$rL}|j r|j jr|j jd||dYd}~yd}~wwxYw)zLink an extension by name.FTz'%s | extension was successfully linked.z %s | error linking extension: %srN) linked_extensionsr?rrmrrGrinforVrr)r!r>r6r~rxs r"link_extensionzExtensionManager.link_extension}s''++D%8OOD) )++ ]))$..9/3&&t, GN ,v  ]>>dnn&V&V  !CT1W[ \\ ]sAB C ACCcz|jj|}|rF|jr9 |j|j|j j d|yyy#t$rL}|jr|jjr|j jd||dYd}~yd}~wwxYw)zLoad an extension by name.z'%s | extension was successfully loaded.z.%s | extension failed loading with message: %rTrN) rr?rmrrGrrrVrrr!r>r~rxs r"load_extensionzExtensionManager.load_extensionsOO''- ** O))$..9 GN+9 >>dnn&V&V  DdAX\! sA%% B:.AB55B:cK|jj|}|rN|jrA |j|jd{|j j d|yyy7##t$rL}|jr|jjr|j jd||dYd}~yd}~wwxYww)zStart an extension by name.Nz(%s | extension was successfully started.z/%s | extension failed starting with message: %rTr) rr?rmrrGrdebugrVrrrs r"start_extensionz ExtensionManager.start_extensionsOO''- ** Q00@@@I4P+9@ >>dnn&V&V  EtQY]! sA*C A1 A/ A1C /A11 C:AC<C CC cK|D]h}|jjd||j|jd{|jjd||jjy7.w)z.Call the shutdown hooks in the specified apps.z%s | extension app %r stoppingNz%s | extension app %r stopped)rrr>stop_extension)r!r>appsr)s r"rzExtensionManager.stop_extensions^ LC HHNN;T388 L$$& & & HHNN:D#(( K L &sAA3A1/A3cH|jD]}|j|y)zHLink all enabled extensions to an instance of ServerApp N)rrr!r>s r"link_all_extensionsz$ExtensionManager.link_all_extensions' ** &D    % &r$cH|jD]}|j|y)zULoad all enabled extensions and append them to the parent ServerApp. N)rrrs r"load_all_extensionsz$ExtensionManager.load_all_extensionsrr$cKt|jDcgc]}|j|c}d{ycc}w7 w)zStart all enabled extensions.N)rrrrs r"start_all_extensionsz%ExtensionManager.start_all_extensionss8D AA Ac Kttt|jt t |j jd{y7w)z*Call the shutdown hooks in all extensions.N)rlistrrrrrrr s r"stop_all_extensionsz$ExtensionManager.stop_all_extensionss?D!4!4fT$BUBU=V=\=\=^6_`abbbsAA AA ctt|jjD]\}}|D]}|j sy!y)zMCheck for any activity currently happening across all extension applications.TN)rrrrcurrent_activity)r!_rr)s r" any_activityzExtensionManager.any_activitysLd4#6#67==?@ GAt '')  r$N)F)!r^r_r`rar rrrrGr rrrrrrdrrrrwrrrrrrrrrrrrrrEr$r"rrs4FNI   22 J55     - ; 6 * ]O Q L&&U c r$r)!ra __future__rr,r itertoolsr tornado.genr traitletsrrrr r r r r rrrctraitlets.configrr:rutilsrrrrrrfrrEr$r"rs]"[[[00*\\e(Ye(PX:*X:v * r$