G@dydZddlZddlmZmZmZmZmZmZm Z m Z ddl m Z m Z ddlmZddlmZmZddlmZddlmZdd lmZdd lmZdd lmZmZmZmZm Z dd l!m"Z"eeefZ#ee efZ$ee$e#fZ%d e&eDZ'ej(e)Z*GddeZ+Gdde e+Z,e,Z-dS)zGlobal plugin registry.N)DictListUnionTypeAnySetOptionalTuple)QObjectSignal) dependencies)_running_under_pytest)CONF)SpyderConfigurationAccessor)PluginsConfigPage)SpyderAPIError)PluginsSpyderPluginV2SpyderDockablePluginSpyderPluginWidget SpyderPlugin)imacng|]2}|ds|dktt|3S)rAll) startswithgetattrr).0attrs Glib/python3.11/site-packages/spyder/api/plugin_registration/registry.py r!$sF>>>$ooc**>/3u}}w%%/<}}c2eZdZeZdZdZdZdZdZ dZ dZ dS)PreferencesAdapterplugin_registryNcdSNself_unuseds r apply_plugin_settingsz(PreferencesAdapter.apply_plugin_settings3 r"cdSr(r)r*s r apply_confzPreferencesAdapter.apply_conf6r.r") __name__ __module__ __qualname__rCONF_WIDGET_CLASSNAME CONF_VERSIONADDITIONAL_CONF_OPTIONSADDITIONAL_CONF_TABS CONF_SECTIONr-r0r)r"r r$r$*sS) DL"L        r"r$c eZdZdZeeeZ fdZdededefdZ dededefdZ d ed e ed e efd Z d e deededefdZd e deededededef dZd efdZd efdZd efdZddd e deededededef dZ d8d ededefdZd edefdZ d9d ed efd!Z d:d ed"ed#edefd$Zd9d efd%Z d;d'ee edefd(Z! dzSpyderPluginRegistry.__init__Xs ##D))) "$$&  "$& r77 #2ww!$B!$B%'!%'!!!r"plugindependent_pluginkeyc|j|i}||g}|||||<||j|<dS)z=Add `dependent_plugin` to the list of dependents of `plugin`.N)r@getappend)r+rKrLrMr@plugin_strict_dependentss r _update_dependentsz'SpyderPluginRegistry._update_dependentssd 266vrBB#4#8#8b#A#A  ''(8999!9#):v&&&r"required_pluginc|j|i}||g}|||||<||j|<dS)z>Add `required_plugin` to the list of dependencies of `plugin`.N)rArOrP)r+rKrSrMrAplugin_strict_dependenciess r _update_dependenciesz)SpyderPluginRegistry._update_dependenciesse#6::62FF%8%<% (((r" plugin_namerequired_pluginsoptional_pluginsc|D]0}|||d|||d1|D]0}|||d|||d1dS)z8Update the dependencies and dependents of `plugin_name`.requiresoptionalN)rVrR)r+rWrXrYrKs r _update_plugin_infoz(SpyderPluginRegistry._update_plugin_infos' E EF  % %k6: F F F  # #FK D D D D& E EF  % %k6: F F F  # #FK D D D D E Er" main_window PluginClassexternalreturnc  ttj}ttj}j t d djrtj t|D]6}|tj kr$tt|tz}7t|D]6}|tj kr$tt|tz}7 |||t}|j <|j fd| |rxj hzc_nxj hzc_|rMj}j} j} |} t3j|| | | dt2j|S)z,Instantiate and register a Spyder 5+ plugin.zRegistering plugin z - ) configurationc<jS)N) omit_conf)notify_plugin_availability CONF_FILE)r_rWr+sr zBSpyderPluginRegistry._instantiate_spyder5_plugin..s$D33{'<4>>r"N)kind)listrCREQUIRESOPTIONALr5loggerdebugrgrregister_pluginrr ALL_PLUGINSr]r%sig_plugin_readyconnect initialize_notify_plugin_dependenciesrGrF_spyder_module_name_spyder_package_name_spyder_versionget_descriptionr addPLUGIN) r+r^r_r`rXrYrKplugin_instancemodule package_nameversion descriptionrWs ` ` @r _instantiate_spyder5_pluginz0SpyderPluginRegistry._instantiate_spyder5_pluginsS  K$8 9 9::K$8 9 9::!&  H;HH;HHIII   .   - - -+,, M MF$$#',<{,J(K(K#L#L +,, M MF$$#',<{,J(K(K#L#L    .>!1 3 3 3&+kFFF,;[) (00 > > > > > > ? ? ? ""$$$ ((555  3  ! !k] 2 ! ! !  ! !k] 2 ! !  I 4F&;L!1G)99;;K  V\; 'L4G I I I Ir"argskwargsc|j}||g|Ri|}t|drCtj|vr4|tj}||n|||j|<|r|xj|hzc_n|xj |hzc_ |tj } | || |d|S)z+Instantiate and register a Spyder 4 plugin.COMPLETION_PROVIDER_NAMEF) r5hasattrr Completions get_pluginregister_completion_pluginror%rGrF Preferencesregister_plugin_preferencesrf) r+r^r_r`rrrWr{ completions preferencess r _instantiate_spyder4_pluginz0SpyderPluginRegistry._instantiate_spyder4_plugins "& &+kCDCCCFCC ?$> ? ? ."d**"oog.ABB 66GGG  + + - - --<[)  3  ! !k] 2 ! ! !  ! !k] 2 ! !oog&9:: //@@@ '' U;;;r"cl|j|}|j|i}|dg}|dg}||zD]Y}||jvrN|j|dr3td|d||ZdS)z.Notify a plugin of its available dependencies.r[r\FPlugin z has already loadedN)r%rArOrBrmrn_on_plugin_availabler+rWr{rArXrYrKs r rtz0SpyderPluginRegistry._notify_plugin_dependenciess.{;"6::;KK.22:rBB.22:rBB&)99 A AF---+//>>ALL!F6!F!F!FGGG#88@@@  A Ar"cr|j|i}|dg}|dg}||zD]i}||jvr^|j|drCtd|d|d|j|}||jdS)z>Notify dependents of a plugin that is going to be unavailable.r[r\FzNotifying plugin z that z is going to be turned offN)r@rOr%rBrmrn_on_plugin_teardown)r+rWr@rXrYrKr{s r _notify_plugin_teardownz,SpyderPluginRegistry._notify_plugin_teardown s 266{BGG,00R@@,00R@@&)99 E EF---+//>>ELL"LV"L"L$/"L"L"LMMM&*&:6&BO#77 DDD  E Er"cp|j|}|j|i}|dg}|dg}||zD][}||jvrP|j|dr5td|d|||\dS)z*Disconnect a plugin from its dependencies.r[r\FzDisconnecting z from N)r%rArOrBrmrnrrs r _teardown_pluginz%SpyderPluginRegistry._teardown_plugins.{;"6::;KK.22:rBB.22:rBB&)99 @ @F---+//>>@LL!M+!M!MV!M!MNNN#77???  @ @r"F)r`c:t|ttfs!t|dtdtd}t|tr||||}n.t|tr||||||}|S)a Register a plugin into the Spyder registry. Parameters ---------- main_window: spyder.app.mainwindow.MainWindow Reference to Spyder's main window. PluginClass: type[SpyderPluginClass] The plugin class to register and create. It must be one of `spyder.app.registry.SpyderPluginClass`. *args: tuple Positional arguments used to initialize the plugin instance. external: bool If True, then the plugin is stored as a external plugin. Otherwise it will be marked as an internal plugin. Default: False **kwargs: dict Optional keyword arguments used to initialize the plugin instance. Returns ------- plugin: SpyderPluginClass The instance of the registered plugin. Raises ------ TypeError If the `PluginClass` does not inherit from any of `spyder.app.registry.SpyderPluginClass` Notes ----- The optional `*args` and `**kwargs` will be removed once all plugins are migrated. z does not inherit from z nor N) issubclassrr TypeErrorrr)r+r^r_r`rrinstances r roz$SpyderPluginRegistry.register_plugin'sP+ 'EFF D{CC-CC4@CCDD D k> 2 2 B77[(44HH  \ 2 2 B77[(D&BBHr"T notify_mainrec td|dd|j|<|r|j|||j|i}|dg}|dg}||zD]-}||jvr"|j|}||.|tj kr2ts&|j|}| |dSdSdS)a Notify dependent plugins of a given plugin of its availability. Parameters ---------- plugin_name: str Name of the plugin that is available. notify_main: bool If True, then a signal is emitted to the main window to perform further registration steps. omit_conf: bool If True, then the main window is instructed to not write the plugin configuration into the Spyder configuration file. rz, has finished loading, sending notificationsTr[r\N) rmrnrBrqemitr@rOr%rrrrr) r+rWrrer@rXrYrKr{s r rfz/SpyderPluginRegistry.notify_plugin_availability_s?"  -{--- . . .15 -  ?  ! & &{I > > >!266{BGG,00R@@,00R@@&)99 B BF---"&"6v">44[AAA '- - -6J6L6L -"2;?O  7 7 = = = = = . - - -r"c|j|}d}t|tr|}n*t|tr|d}|S)aE Check if a plugin from the registry can be deleted by its name. Paremeters ---------- plugin_name: str Name of the plugin to check for deletion. Returns ------- plugin_deleted: bool True if the plugin can be deleted. False otherwise. T)r% isinstancer can_closerclosing_plugin)r+rWr{ can_deletes r can_delete_pluginz&SpyderPluginRegistry.can_delete_pluginsf.{; o~ 6 6 >(2244JJ  6 6 >(77==Jr" save_undockedc<|j|}t|tr||dSt|trL|jr|r|ddn|dd|dSdS)aj Dock plugin if undocked and save undocked state if requested Parameters ---------- plugin_name: str Name of the plugin to check for deletion. save_undocked : bool, optional True if the undocked state needs to be saved. The default is False. Returns ------- None. rundocked_on_window_closeTFN)r%rr close_windowr_undocked_window set_option _close_window)r+rWrr{s r dock_undocked_pluginz)SpyderPluginRegistry.dock_undocked_plugins .{; o'; < < ,  ( (} ( E E E E E ); < < ,/ 7M 7**.6666 **.777  ) ) + + + + + , ,r"teardowncheck_can_deletectd||j|}|r||}|sdSt |t rr\r[)rmrnr%rrrr get_widgetclose deleteLater RuntimeError get_containerrron_closerr@poprArgrunregister_pluginrOremoverBrDrErFrG) r+rWrrr{r containerrKall_plugin_dependentsrMr@all_plugin_dependenciesrAs r delete_pluginz"SpyderPluginRegistry.delete_plugins,  5 55666.{;  // <>>>#D,99;; !)))!--////' ++----     :%%k222,,[999 ((....      6 6 : ++----     :,,[999 "";555  $$[$777  $ 4  "? 3 3 3, : :F$($:6$B !/ : :$9$=$=c2$F$F!"333%,,[999 : . < v&F #/ < <&=&A&A#r&J&J#"555'..{;;; <  $$[111 [M)  - +. +.   ---ts[2A B?? C  C &(D DD D55 EE2F FF.G GGct|jt|jzD]}|||dS)a Dock undocked plugins and save undocked state if required. Parameters ---------- save_undocked : bool, optional True if the undocked state needs to be saved. The default is False. Returns ------- None. rN)rCrGrFr)r+rrWs r dock_all_undocked_pluginsz.SpyderPluginRegistry.dock_all_undocked_plugins-s_D)**S1F-G-GG : :K  % %= & : : : : : :r"N excludingc|pti}d}t|jt|jzD]D}||vr>|j|}t |t r|||z}|snE|S)aY Determine if all plugins can be deleted except the ones to exclude. Parameters ---------- excluding: Optional[Set[str]] A set that lists plugins (by name) that will not be deleted. Returns ------- bool True if all plugins can be closed. False otherwise. T)rCrGrFr%rrr)r+rrrWr{s r can_delete_all_pluginsz+SpyderPluginRegistry.can_delete_all_plugins@s(R  D)**S1F-G-GG  K)++"&"6{"Co|<<!7!7 !D!DDI$r"close_immediatelyc|pti}d}||}|s|sdS|dt|jD]I}||vrC|j|}t |t r!|||ddz}|s|snJ|sdSt|jD]I}||vrC|j|}t |t r!|||ddz}|s|snJ|sdSt|jD]I}||vrC|j|}t |tr!|||ddz}|s|snJ|s|sdSt|jD]I}||vrC|j|}t |tr!|||ddz}|s|snJ|S)ap Remove all plugins from the registry. The teardown mechanism will remove external plugins first and then internal ones, where the Spyder 4 plugins will be removed first and then the Spyder 5 ones. Parameters ---------- excluding: Optional[Set[str]] A set that lists plugins (by name) that will not be deleted. close_immediately: bool If true, then the `can_close` status will be ignored. Returns ------- all_deleted: bool True if all the plugins were closed and deleted. False otherwise. T)rFr)rr) rCrrrGr%rrrrFr)r+rrrrWr{s r delete_all_pluginsz'SpyderPluginRegistry.delete_all_plugins^s*(R  //)/DD  !2 5 &&T&:::t455  K)++"&"6{"Co|<<!3!3#ee"4"M"MMI$-> 5t455  K)++"&"6{"Co|<<!3!3#ee"4"M"MMI$-> 5t455  K)++"&"6{"Co~>>!3!3#ee"4"M"MMI$-> !2 5t455  K)++"&"6{"Co~>>!3!3#ee"4"M"MMI$->r"cX||jvr|j|}|Std|d)a Get a reference to a plugin instance by its name. Parameters ---------- plugin_name: str Name of the plugin to retrieve. Returns ------- plugin: SpyderPluginClass The instance of the requested plugin. Raises ------ SpyderAPIError If the plugin name was not found in the registry. rz was not found in the registry)r%r)r+rWr{s r rzSpyderPluginRegistry.get_pluginsM& $. . ."2;?O" " "0;"0"0"011 1r"c(|xj|hzc_dS)z Add a plugin name to the set of enabled plugins. Parameters ---------- plugin_name: str Name of the plugin to add. NrEr+rWs r set_plugin_enabledz'SpyderPluginRegistry.set_plugin_enableds   -r"c||jvS)a> Determine if a given plugin is enabled and is going to be loaded. Parameters ---------- plugin_name: str Name of the plugin to query. Returns ------- plugin_enabled: bool True if the plugin is enabled and False if not. rrs r is_plugin_enabledz&SpyderPluginRegistry.is_plugin_enabledd222r"c8|j|dS)a1 Determine if a given plugin was loaded and is available. Parameters ---------- plugin_name: str Name of the plugin to query. Returns ------- plugin_available: bool True if the plugin is available and False if not. F)rBrOrs r is_plugin_availablez(SpyderPluginRegistry.is_plugin_availables'++K???r"cBi|_i|_i|_i|_t i|_t i|_t i|_t i|_ |j dS#ttf$rYdSwxYw)z$Reset and empty the plugin registry.N) r@rAr%rBrCrDrErFrGrq disconnectrrr+s r resetzSpyderPluginRegistry.resets"$$&  "$& r77 #2ww!$B!$B   ! , , . . . . .<(    DD s.B BB all_pluginsc||_dSr()rHr+rs r set_all_internal_pluginsz-SpyderPluginRegistry.set_all_internal_plugins$/!!!r"c||_dSr()rIrs r set_all_external_pluginsz-SpyderPluginRegistry.set_all_external_pluginsrr"c||_dSr()r?)r+r?s r set_mainzSpyderPluginRegistry.set_main"s  r"c*tjdS)Nplugins)riconrs r get_iconzSpyderPluginRegistry.get_icon%sx """r"c tdS)Nr)rrs r get_namezSpyderPluginRegistry.get_name(s||r"c||jvS)aN Determine if a plugin name is contained in the registry. Parameters ---------- plugin_name: str Name of the plugin to seek. Returns ------- is_contained: bool If True, the plugin name is contained on the registry, False otherwise. )r%rs r __contains__z!SpyderPluginRegistry.__contains__+rr"c*t|jSr()iterr%rs r __iter__zSpyderPluginRegistry.__iter__<sD()))r")TF)F)TTr()NF)1r1r2r3__doc__r strboolrqr>rRrVrr]rrSpyder5PluginClassrSpyder4PluginClasstupledictrrtrrSpyderPluginClassrorfrrrrr rrrrrrrrrrrrrrrr __classcell__)rJs@r r;r;:s"vc4(( %'%'%'%'%'P;;;#;;;;?3??"%???? Es E.23i E.23i E E E E9"90199 29999v$"$01$$ $"& $+= $$$$L As A A A A E3 E E E E @C @ @ @ @",1666"6/066%)6 6 1 6666r8<5:'>'>c'>04'>.2'>'>'>'>RST2;@,,",37,,,,B@D/3jjjj(,j8<jjjjX::t::::(@D*23s8*<HL<BF5:RRHSX,>R.2R?CRRRRh1c1.?11114 .c . . . .3S3T3333"@s@t@@@@   D0#C.?)@$@A00000#C.?)@$@A0000###333333"*******r"r;).rloggingtypingrrrrrrr r qtpy.QtCorer r spyderr spyder.config.baserrspyder.config.managerrspyder.api.config.mixinsr(spyder.api.plugin_registration._confpagerspyder.api.exceptionsrspyder.api.pluginsrrrrrspyder.utils.icon_managerrrrrdirrp getLoggerr1rmr$r;PLUGIN_REGISTRYr)r"r rs EEEEEEEEEEEEEEEEEEEE(''''''' 66666666&&&&&&@@@@@@FFFFFF000000*))))) >+??@<);;<,.@@A>>##g,,>>>   8 $ $      4    C *C *C *C *C *7$6C *C *C *L'&((r"