JeydZddlZddlmZmZmZmZmZmZm Z m Z ddl m Z m Z ddlmZddlmZmZddlmZddlmZdd lmZdd lmZdd lmZmZmZmZm Z dd l!m"Z"eeefZ#ee efZ$ee$e#fZ%e&eDcgc]!}|jOd s|dk7r e(e|#c}Z)ejTe+Z,GddeZ-Gdde e-Z.e.Z/ycc}w)zGlobal plugin registry.N)DictListUnionTypeAnySetOptionalTuple)QObjectSignal) dependencies)_running_under_pytest)CONF)SpyderConfigurationAccessor)PluginsConfigPage)SpyderAPIError)PluginsSpyderPluginV2SpyderDockablePluginSpyderPluginWidget SpyderPlugin)imarAllc0eZdZeZdZdZdZdZdZ dZ dZ y)PreferencesAdapterplugin_registryNcyNself_unuseds I/usr/lib/python3/dist-packages/spyder/api/plugin_registration/registry.pyapply_plugin_settingsz(PreferencesAdapter.apply_plugin_settings3 cyr r!r"s r% apply_confzPreferencesAdapter.apply_conf6r'r() __name__ __module__ __qualname__rCONF_WIDGET_CLASSNAME CONF_VERSIONADDITIONAL_CONF_OPTIONSADDITIONAL_CONF_TABS CONF_SECTIONr&r*r!r(r%rr*s-) DL"L  r(rc deZdZdZeeeZ fdZdededefdZ dededefdZ d ed e ed e efd Z d e deededefdZd e deededededef dZd efdZd efdZd efdZddd e deededededef dZ d6d ededefdZd edefdZ d7d edefd Z d8d ed!ed"edefd#Zd7defd$Z d9d%ee edefd&Z! d:d%ee ed'edefd(Z"d edefd)Z#d efd*Z$d edefd+Z%d edefd,Z&d-Z'd.e(eeeffd/Z)d.e(eeeffd0Z*d1Z+d2Z,d3Z-d edefd4Z.d5Z/xZ0S);SpyderPluginRegistrya' Global plugin registry. This class handles a plugin initialization/teardown lifetime, including notifications when a plugin is available or not. This registry alleviates the limitations of a topological sort-based plugin initialization by enabling plugins to have bidirectional dependencies instead of unidirectional ones. Notes ----- 1. This class should be instantiated as a singleton. 2. A plugin should not depend on other plugin to perform its initialization since it could cause deadlocks. c.t|tj|d|_i|_i|_i|_i|_ti|_ ti|_ ti|_ ti|_ i|_ i|_yr )super__init__rmainplugin_dependentsplugin_dependenciesrplugin_availabilityset old_pluginsenabled_pluginsinternal_pluginsexternal_pluginsall_internal_pluginsall_external_plugins)r# __class__s r%r8zSpyderPluginRegistry.__init__Xs ##D) "$$&  "$& r7 #2w!$B!$B%'!%'!r(plugindependent_pluginkeyc|jj|i}|j|g}|j||||<||j|<y)z=Add `dependent_plugin` to the list of dependents of `plugin`.N)r:getappend)r#rErFrGr:plugin_strict_dependentss r%_update_dependentsz'SpyderPluginRegistry._update_dependentssX 2266vrB#4#8#8b#A  ''(89!9#):v&r(required_pluginc|jj|i}|j|g}|j||||<||j|<y)z>Add `required_plugin` to the list of dependencies of `plugin`.N)r;rIrJ)r#rErMrGr;plugin_strict_dependenciess r%_update_dependenciesz)SpyderPluginRegistry._update_dependenciessY#66::62F%8%<%  (r( plugin_namerequired_pluginsoptional_pluginsc|D](}|j||d|j||d*|D](}|j||d|j||d*y)z8Update the dependencies and dependents of `plugin_name`.requiresoptionalN)rPrL)r#rQrRrSrEs r%_update_plugin_infoz(SpyderPluginRegistry._update_plugin_infosp' EF  % %k6: F  # #FK D E' EF  % %k6: F  # #FK D Er( main_window PluginClassexternalreturnc ttj}ttj}j t j d djrtjt|D]1}|tjk(stt|tz}3t|D]1}|tjk(stt|tz}3j |||t}|j <|jj! fd|j#j% |rxj& hzc_nxj( hzc_|r]j*}j,} j.} |j1} t3j4|| | | dt2j6|S)z,Instantiate and register a Spyder 5+ plugin.zRegistering plugin z - ) configurationc>jjS)N) omit_conf)notify_plugin_availability CONF_FILE)rYrQr#sr%zBSpyderPluginRegistry._instantiate_spyder5_plugin..s"D33{'<'<4>r(N)kind)listr=REQUIRESOPTIONALr/loggerdebugrarregister_pluginrr ALL_PLUGINSrWrsig_plugin_readyconnect initialize_notify_plugin_dependenciesrAr@_spyder_module_name_spyder_package_name_spyder_versionget_descriptionr addPLUGIN) r#rXrYrZrRrSrEplugin_instancemodule package_nameversion descriptionrQs ` ` @r%_instantiate_spyder5_pluginz0SpyderPluginRegistry._instantiate_spyder5_plugins  K$8$8 9:K$8$8 9:!&&  *;-s;-HI    -+, MF$#',<{,J(K#L  M+, MF$#',<{,J(K#L  M   .>!1 3&kF,;[) ((00 > ? ""$ ((5   ! !k] 2 !  ! !k] 2 !  44F&;;L!11G)99;K   V\; 'L4G4G Ir(argskwargsc|j}||g|i|}t|drCtj|vrA|j tj}|j |n|j ||j|<|r|xj|hzc_n|xj|hzc_ |j tj} | j||j|d|S)z+Instantiate and register a Spyder 4 plugin.COMPLETION_PROVIDER_NAMEF) r/hasattrr Completions get_pluginregister_completion_pluginrirrAr@ Preferencesregister_plugin_preferencesr`) r#rXrYrZr{r|rQru completions preferencess r%_instantiate_spyder4_pluginz0SpyderPluginRegistry._instantiate_spyder4_plugins "&& &kCDCFC ?$> ?""d*"oog.A.AB 66G  + + --<[)   ! !k] 2 !  ! !k] 2 !oog&9&9: //@ '' U;r(cb|j|}|jj|i}|jdg}|jdg}||zD]X}||jvs|jj|ds/tj d|d|j |Zy)z.Notify a plugin of its available dependencies.rUrVFPlugin z has already loadedN)rr;rIr<rgrh_on_plugin_availabler#rQrur;rRrSrEs r%rnz0SpyderPluginRegistry._notify_plugin_dependenciess..{;"66::;K.22:rB.22:rB&)99 AF---++//>LL76(2E!FG#88@  Ar(ch|jj|i}|jdg}|jdg}||zD]j}||jvs|jj|ds/tj d|d|d|j|}|j |ly)z>Notify dependents of a plugin that is going to be unavailable.rUrVFzNotifying plugin z that z is going to be turned offN)r:rIrr<rgrh_on_plugin_teardown)r#rQr:rRrSrErus r%_notify_plugin_teardownz,SpyderPluginRegistry._notify_plugin_teardown s 2266{BG,00R@,00R@&)99 EF---++//>LL#4VHF$/=0J"LM&*&:&:6&BO#77 D  Er(cf|j|}|jj|i}|jdg}|jdg}||zD]Z}||jvs|jj|ds/tj d|d||j |\y)z*Disconnect a plugin from its dependencies.rUrVFzDisconnecting z from N)rr;rIr<rgrhrrs r%_teardown_pluginz%SpyderPluginRegistry._teardown_plugins..{;"66::;K.22:rB.22:rB&)99 @F---++//>LL>+fVH!MN#77?  @r(F)rZct|ttfst|dtdtd}t|tr|j |||}|St|tr|j |||||}|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 TypeErrorrzr)r#rXrYrZr{r|instances r%riz$SpyderPluginRegistry.register_plugin'sP+ 'EF{m+B-.eL>CD D k> 277[(4H  \ 277[(D&BHr( notify_mainr_ctjd|dd|j|<|r|jj |||j j |i}|j dg}|j dg}||zD]1}||jvs|j|}|j|3|tjk(r,ts!|j|}|j|yyy)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 notificationsTrUrVN) rgrhr<rkemitr:rIrrrrrr) r#rQrr_r:rRrSrErus r%r`z/SpyderPluginRegistry.notify_plugin_availability_s"  w{m,-- .15  -   ! ! & &{I >!2266{BG,00R@,00R@&)99 BF---"&"6"6v">44[A B '-- -6J6L"22;?O  7 7 =7M -r(c|j|}d}t|tr|j}|St|tr|j 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#rQru can_deletes r%can_delete_pluginz&SpyderPluginRegistry.can_delete_plugins[..{; o~ 6(224J 6(77=Jr( save_undockedc|j|}t|tr|j|yt|trD|j r|r|j ddn|j dd|jyy)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)rrr close_windowr_undocked_window set_option _close_window)r#rQrrus r%dock_undocked_pluginz)SpyderPluginRegistry.dock_undocked_plugins ..{; o'; <  ( (} ( E ); <//M**.6 **.7  ) ) +=r(teardowncheck_can_deletecBtjd||j|}|r|j|}|syt |t rt |t r> |jj|jjn3|j}|r! |j|j |j|r"|j||j| |jdn4t |tr$ |j|r|j||j j#|d|j$j#|d|j&rt)j*||j D]@}|j |}dD]*} |j-| g} || vs| j/|,B|j$D]@}|j$|} dD]*} | j-| g} || vs| j/|,B|j0j#||xj2|hzc_|xj4|hzc_|xj6|hzc_|xj8|hzc_|jj#|y#t$rYwxYw#t$rYwxYw#t$rYwxYw#t$rYwxYw#t$rYwxYw)a Remove and delete a plugin from the registry by its name. Paremeters ---------- plugin_name: str Name of the plugin to delete. teardown: bool True if the teardown notification to other plugins should be sent when deleting the plugin, False otherwise. check_can_delete: bool True if the plugin should validate if it can be closed when this method is called, False otherwise. Returns ------- plugin_deleted: bool True if the registry was able to teardown and remove the plugin. False otherwise. zDeleting plugin FTN>rVrU)rgrhrrrrr get_widgetclose deleteLater RuntimeError get_containerrron_closerr:popr;rarunregister_pluginrIremover<r>r?r@rA) r#rQrrrur containerrEall_plugin_dependentsrGr:all_plugin_dependenciesr;s r% delete_pluginz"SpyderPluginRegistry.delete_plugins,  ' }56..{; // ,99; !)!--/  ++-%%k2,,[9 ((. 6 ++-,,[9 "";5   $$[$7  $ $  " "? 3,, :F$($:$:6$B !/ :$9$=$=c2$F!"33%,,[9 : :.. &>v&F #/ <&=&A&A#r&J#"55'..{; < <   $$[1 [M)  - +. +.   -I$(           sZ=K> L L LLct|jt|jzD]}|j||y)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)r=rAr@r)r#rrQs r%dock_all_undocked_pluginsz.SpyderPluginRegistry.dock_all_undocked_plugins-sFD))*S1F1F-GG :K  % %= & : :r( excludingc|xs ti}d}t|jt|jzD]@}||vs|j|}t |t s(||j |z}|r?|S|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)r=rAr@rrrr)r#rrrQrus r%can_delete_all_pluginsz+SpyderPluginRegistry.can_delete_all_plugins@s(R  D))*S1F1F-GG K)+"&"6"6{"Co|<!7!7 !DDI$ r(close_immediatelycz|xs ti}d}|j|}|s|sy|jdt|jD]E}||vs|j|}t |t s(||j|ddz}|rB|rEn|syt|jD]E}||vs|j|}t |t s(||j|ddz}|rB|rEn|syt|jD]E}||vs|j|}t |ts(||j|ddz}|rB|rEn|s|syt|jD]F}||vs|j|}t |ts(||j|ddz}|rB|rE|S|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) r=rrrArrrrr@r)r#rrrrQrus r%delete_all_pluginsz'SpyderPluginRegistry.delete_all_plugins^s!*(R  //)/D !2 &&T&:t445 K)+"&"6"6{"Co|<!3!3#ee"4"MMI$-> t445 K)+"&"6"6{"Co|<!3!3#ee"4"MMI$-> t445 K)+"&"6"6{"Co~>!3!3#ee"4"MMI$-> !2t445 K)+"&"6"6{"Co~>!3!3#ee"4"MMI$-> r(c^||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)rr)r#rQrus r%rzSpyderPluginRegistry.get_pluginsE& $.. ."22;?O" " 7;-80"01 1r(c0|xj|hzc_y)z Add a plugin name to the set of enabled plugins. Parameters ---------- plugin_name: str Name of the plugin to add. Nr?r#rQs 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_enabledd2222r(c:|jj|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)r<rIrs r%is_plugin_availablez(SpyderPluginRegistry.is_plugin_availables''++K??r(ci|_i|_i|_i|_t i|_t i|_t i|_t i|_ |jjy#ttf$rYywxYw)z$Reset and empty the plugin registry.N) r:r;rr<r=r>r?r@rArk disconnectrrr#s r%resetzSpyderPluginRegistry.resets"$$&  "$& r7 #2w!$B!$B   ! ! , , .<(   sA99B  B  all_pluginsc||_yr )rBr#rs r%set_all_internal_pluginsz-SpyderPluginRegistry.set_all_internal_plugins $/!r(c||_yr )rCrs r%set_all_external_pluginsz-SpyderPluginRegistry.set_all_external_pluginsrr(c||_yr )r9)r#r9s r%set_mainzSpyderPluginRegistry.set_main"s  r(c,tjdS)Nplugins)riconrs r%get_iconzSpyderPluginRegistry.get_icon%sxx ""r(ctdS)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. )rrs r% __contains__z!SpyderPluginRegistry.__contains__+rr(c,t|jSr )iterrrs r%__iter__zSpyderPluginRegistry.__iter__<sD(())r()TF)F)TTr )NF)1r+r,r-__doc__r strboolrkr8rLrPrrWrrSpyder5PluginClassrzSpyder4PluginClasstupledictrrnrrSpyderPluginClassrir`rrrrr rrrrrrrrrrrrrrrr __classcell__)rDs@r%r5r5:s"c4( %'P;;;#;?3??"%? Es E.23i E.23i E9"90199 29v$"$01$$ $"& $+= $L As A E3 E @C @",16"6/066%)6 6 1 6r8<5:'>c'>04'>.2'>RST2;@,",37,B@D/3jjj(,j8<jX:t:(@D*23s8*<HL<BF5:RHSX,>R.2R?CRh1c1.?14 .c .3S3T3"@s@t@ D0#C.?)@$@A00#C.?)@$@A0#333"*r(r5)0rloggingtypingrrrrrrr r qtpy.QtCorer r spyderr spyder.config.baserrspyder.config.managerrspyder.api.config.mixinsr(spyder.api.plugin_registration._confpagerspyder.api.exceptionsrspyder.api.pluginsrrrrrspyder.utils.icon_managerrrrrdir startswithgetattrrj getLoggerr+rgrr5PLUGIN_REGISTRY)attrs0r%rsEEE( 6&@F0* >+??@<);;<,.@@A36g,>$ooc*tu}w%>    8 $  4  C *7$6C *L'(y>s<&C