G@dEdZddlmZddlZddlZddlZddlmZddl Z ddl m Z m Z ddl Z ddlmZmZmZmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lm Z dd l!m"Z"ddl!m#Z#ddl$m%Z%ddl&m'Z'm(Z(ddl)m*Z*ddl+m,Z,ddl-m.Z.ddl/m0Z0ddl1m2Z2ej3e4Z5Gddee"eeZ6Gdde6Z7dS)zd New API for plugins. All plugins in Spyder 5+ must inherit from the classes present in this file. ) OrderedDictN)ListUnion)QObjectQtSignalSlot)QCursor) QApplication)SpyderConfigurationObserver)SpyderAPIError)SpyderPluginObserver)_)PluginMainWidget)SpyderActionMixin)SpyderWidgetMixin) get_options)get_color_schemeget_font) NoDefault)ima)IMAGE_PATH_MANAGER)Plugins)SpyderPluginWidgetcneZdZdZdZgZgZdZdZdZ dZ dZ dZ dZ dZgZdZdZdZdZdZeZ eZ eZ eZ eeeZ eeZ eeZ edZ! edZ" ede#fZ$ ee#Z% dZ&d3fd Z'd4d Z(d Z)d Z*d Z+dZ,dZ-d5dZ.dZ/dZ0dZ1e2dfdZ3e4ee#e4ee#e d6dZ5d3dZ6d5dZ7d3dZ8d3dZ9e4ee4eed7dZ:dZ;d8dZe?d Z@eAd4d!ZBd"ZCe?d#ZDd$ZEd%ZFd&ZGe?d'ZHd(ZId)ZJd*ZKd4d+ZLd,efd-ZMd.ZNd/ZOd0ZPd1eQeReeSffd2ZTxZUS)9SpyderPluginV2z A Spyder plugin to extend functionality without a dockable widget. If you want to create a plugin that adds a new pane, please use SpyderDockablePlugin. NTr QResizeEvent QMoveEventct|tj|tj|||_d|_||_tj tj |j |_ d|_t|_i|_d|_d|_||_|j|_|jS||j||x|_}t1|t2r(|||j|j|j|j|j|j|j |j |j!|j!|j"|j"|#tI|dr|%|j&rBtOj(|)|j&}tUj+|dSdS)N)namepluginparent_setup),super__init__rr _main_widget_confospathdirnameinspectgetfile __class__ _plugin_path _containerr_added_toolbars_actions is_compatible is_registeredmainNAME PLUGIN_NAMECONTAINER_CLASS isinstancersetupupdate_actionssig_free_memory_requestedconnectsig_quit_requestedsig_restart_requestedsig_redirect_stdio_requestedsig_exception_occurredsig_unmaximize_plugin_requestedafter_container_creationhasattrr%IMG_PATHospjoinget_pathradd_image_path)selfr$ configuration container plugin_pathr0s :lib/python3.11/site-packages/spyder/api/plugins/new_api.pyr'zSpyderPluginV2.__init__*s[    %d+++#,T222  " GOOGODN,K,KLL*}} !!  9   +*.*>*>Y+?++ DOi )%677 +!!!((***  / 7 7. 0 0 0  ( 0 01H I I I  + 3 3D4N O O O  2 : :1 3 3 3  , 4 4+ - - -  5 = =4 6 6 6  ) ) + + +y(++ #  """ = ;(4==??DMBBK  -k : : : : : ; ;Fc|jtd|j|s|j|d|_|dS)zl Setup and register plugin in Spyder's main window and connect it to other plugins. Nz%A Spyder Plugin must define a `NAME`!T)r8r r*register_pluginr6 update_font)rL omit_confs rP _registerzSpyderPluginV2._registeresb 9  !HII I : !) ! J & &t , , ," rQcr|j|j|d|_d|_d|_dS)zs Disconnect signals and clean up the plugin to be able to stop it while Spyder is running. NF)r*unregister_pluginr2r5r6rLs rP _unregisterzSpyderPluginV2._unregisterzs? : ! J ( ( . . .!"rQc|jS)z2 Return the plugin's system path. )r1rYs rPrJzSpyderPluginV2.get_paths   rQc|jS)z3 Return the plugin main container. )r2rYs rP get_containerzSpyderPluginV2.get_containers rQc|jS)z9 Return the Spyder configuration object. )r*rYs rPget_configurationz SpyderPluginV2.get_configuration zrQc|jS)z1 Return the Spyder main window.. )r(rYs rPget_mainzSpyderPluginV2.get_mainr`rQcBt|jpg}t|jpg}||z}||vstj|vr; |j||S#t$r}||vrYd}~dS|d}~wwxYwtd|)a8 Get a plugin instance by providing its name. Parameters ---------- plugin_name: str Name of the plugin from which its instance will be returned. error: bool Whether to raise errors when trying to return the plugin's instance. )errorNz:Plugin "{}" not part of REQUIRES or OPTIONAL requirements!) setREQUIRESOPTIONALrAllr( get_pluginr format)rL plugin_namerdrequiresoptionalfull_setes rPrizSpyderPluginV2.get_pluginst}*++t}*++h& ( " "gkX&=&= z,,[,FFF!   (**44444G   !))/ )<)< sA!! A<+A75A77A<c6|j|S)z2Determine if a given plugin is going to be loaded.)r(is_plugin_enabledrLrks rPrqz SpyderPluginV2.is_plugin_enabledsz++K888rQc6|j|S)z)Determine if a given plugin is available.)r(is_plugin_availablerrs rPrtz"SpyderPluginV2.is_plugin_availablesz--k:::rQct|jpg}g}|jD]H\}}||vstj|vr1t |ttfr| |I|S)z Return a list of the required plugin instances. Only required plugins that extend SpyderDockablePlugin are returned. ) rerfr(get_dockable_pluginsrrhr;SpyderDockablePluginrappend)rLrldockable_plugins_requiredr"plugin_instances rPrvz#SpyderPluginV2.get_dockable_pluginss t}*++$&!%)Z%D%D%F%F B B !D/  GK8$;$;#)+=>B@B@$;*00AAA((rQc|j8||jn|}|td|j|||SdS)a Get an option from Spyder configuration system. Parameters ---------- option: str Name of the option to get its value from. default: bool, int, str, tuple, list, dict, NoDefault Value to get from the configuration system, passed as a Python object. section: str Section in the configuration system, e.g. `shortcuts`. Returns ------- bool, int, str, tuple, list, dict Value associated with `option`. N=A spyder plugin must define a `CONF_SECTION` class attribute!)r* CONF_SECTIONr get)rLoptiondefaultsections rPget_confzSpyderPluginV2.get_confs[& : !+2?d''G$!:>>'67;; ; " !rQc|jS||jn|}|td|j||||||hddSdS)aj Set an option in Spyder configuration system. Parameters ---------- option: str Name of the option (e.g. 'case_sensitive') value: bool, int, str, tuple, list, dict Value to save in the configuration system, passed as a Python object. section: str Section in the configuration system, e.g. `shortcuts`. recursive_notification: bool If True, all objects that observe all changes on the configuration section and objects that observe partial tuple paths are notified. For example if the option `opt` of section `sec` changes, then the observers for section `sec` are notified. Likewise, if the option `(a, b, c)` changes, then observers for `(a, b, c)`, `(a, b)` and a are notified as well. Nr|)recursive_notificationF)r*r}r re apply_conf)rLrvaluerrs rPset_confzSpyderPluginV2.set_confs0 : !+2?d''G$! JNN7FE2H  J J J OOVHe , , , , , " !rQc|jP||jn|}|td|j||||hddSdS)a& Delete an option in the Spyder configuration system. Parameters ---------- option: Union[str, Tuple[str, ...]] Name of the option, either a string or a tuple of strings. section: str Section in the configuration system. Nr|F)r*r}r remove_optionrrLrrs rP remove_confzSpyderPluginV2.remove_confsw : !+2?d''G$! J $ $Wf 5 5 5 OOVHe , , , , , " !rQcl|j(|r(|r(|t|dSdSdSdS)z> Apply `options_set` to this plugin's widget. N)r*after_configuration_updatelist)rL options_setnotifys rPrzSpyderPluginV2.apply_conf.sV : !k ! C//[0A0ABBBBB " ! ! ! C CrQc|j9||jn|}|td|j||dSdS)a9 Disable notifications for an option in the Spyder configuration system. Parameters ---------- option: Union[str, Tuple[str, ...]] Name of the option, either a string or a tuple of strings. section: str Section in the configuration system. Nr|)r*r}r disable_notificationsrs rP disable_confzSpyderPluginV2.disable_conf6a : !+2?d''G$! J , ,Wf = = = = = " !rQc|j9||jn|}|td|j||dSdS)a9 Restore notifications for an option in the Spyder configuration system. Parameters ---------- option: Union[str, Tuple[str, ...]] Name of the option, either a string or a tuple of strings. section: str Section in the configuration system. Nr|)r*r}r restore_notificationsrs rP restore_confzSpyderPluginV2.restore_confJrrQc<|j||dS)z Show message in status bar. Parameters ---------- message: str Message to display in the status bar. timeout: int Amount of time to display the message. N)sig_status_message_requestedemit)rLmessagetimeouts rPshow_status_messagez"SpyderPluginV2.show_status_message^s# )..w@@@@@rQc|r||tjttjtjdS)a Show a message in main window's status bar and change the mouse pointer to Qt.WaitCursor when starting a long process. Parameters ---------- message: str Message to show in the status bar when the long process starts. N)rr setOverrideCursorr r WaitCursor processEventsrLrs rPbefore_long_processz"SpyderPluginV2.before_long_processmsP  .  $ $W - - -&wr}'='=>>>"$$$$$rQctj||dtjdS)a Clear main window's status bar after a long process and restore mouse pointer to the OS deault. Parameters ---------- message: str Message to show in the status bar when the long process finishes. i)rN)r restoreOverrideCursorrrrs rPafter_long_processz!SpyderPluginV2.after_long_process}sA *,,,   $ 777"$$$$$rQcd|j(t|jddSdS)aJ Get the current color scheme. Returns ------- dict Dictionary with properties and colors of the color scheme used in the Editor. Notes ----- This is useful to set the color scheme of all instances of CodeEditor used by the plugin. N appearanceselected)r*rr~rYs rPrzSpyderPluginV2.get_color_schemes2 : !#DJNN<$L$LMM M " !rQc`||jdS)a Initialize a plugin instance. Notes ----- This method should be called to initialize the plugin, but it should not be overridden, since it internally calls `on_initialize` and emits the `sig_plugin_ready` signal. N) on_initializesig_plugin_readyrrYs rP initializezSpyderPluginV2.initializes1  ""$$$$$rQc*tj|S)z@ Provide icons from the theme and icon manager. )ricon)r"s rP create_iconzSpyderPluginV2.create_icons x~~rQcN|r d}|j}n d}|j}t||S)a Return plain or rich text font used in Spyder. Parameters ---------- rich_text: bool Return rich text font (i.e. the one used in the Help pane) or plain text one (i.e. the one used in the Editor). Returns ------- QFont QFont object to be passed to other Qt widgets. Notes ----- All plugins in Spyder use the same, global font. This is a convenience method in case some plugins want to use a delta size based on the default one. That can be controlled by using FONT_SIZE_DELTA or RICH_FONT_SIZE_DELTA (declared in `SpyderPlugin`). rich_fontfont)rfont_size_delta)RICH_FONT_SIZE_DELTAFONT_SIZE_DELTAr)cls rich_textrrs rPrzSpyderPluginV2.get_fonts;.  2 F!6OOF!1OvGGGGrQcx|j |jjStjdg}t |dS)z Get command line options passed by the user when they started Spyder in a system terminal. See app/cli_options.py for the option names. Nr)r( _cli_optionssysargvr)rLsys_argvs rPget_command_line_optionsz'SpyderPluginV2.get_command_line_optionss9 : !:* * }Hx((+ +rQc td)z Return the plugin localized name. Returns ------- str Localized name of the plugin. Notes ----- This is a method to be able to update localization without a restart. zA plugin name must be defined!NotImplementedErrorr rQrPget_namezSpyderPluginV2.get_names""BCCCrQc td)a Return the plugin localized description. Returns ------- str Localized description of the plugin. Notes ----- This is a method to be able to update localization without a restart. z%A plugin description must be defined!rrYs rPget_descriptionzSpyderPluginV2.get_descriptions""IJJJrQc td)z~ Return the plugin associated icon. Returns ------- QIcon QIcon instance zA plugin icon must be defined!rrYs rPget_iconzSpyderPluginV2.get_icons""BCCCrQct|drtdtdt|d)z Setup the plugin. Notes ----- All calls performed on this method should not call other plugins. registerzmregister was replaced by on_initialize, please check the Spyder 5.1.0 migration guide to get more informationz The plugin z. is missing an implementation of on_initialize)rFr rtyperYs rPrzSpyderPluginV2.on_initialize sb 4 $ $ H GHH H" $t**    rQcd}d}||fS)a This method can be reimplemented to check compatibility of a plugin with the user's current environment. Returns ------- (bool, str) The first value tells Spyder if the plugin has passed the compatibility test defined in this method. The second value is a message that must explain users why the plugin was found to be incompatible (e.g. 'This plugin does not work with PyQt4'). It will be shown at startup in a QMessageBox. Trr )validrs rPcheck_compatibilityz"SpyderPluginV2.check_compatibilitysg~rQcdS)a Actions to be performed the first time the plugin is started. It can also be used to perform actions that are needed only the first time this is loaded after installation. This method is called after the main window is visible. Nr rYs rPon_first_registrationz$SpyderPluginV2.on_first_registration1  rQcdS)zj Actions to be performed after setup but before the main window's has been shown. Nr rYs rPbefore_mainwindow_visiblez(SpyderPluginV2.before_mainwindow_visible<s rQcdS)zQ Actions to be performed after the main window's has been shown. Nr rYs rPon_mainwindow_visiblez$SpyderPluginV2.on_mainwindow_visibleCs  rQcRt|drtjddSdS)z Perform actions before the plugin is closed. This method **must** only operate on local attributes and not other plugins. unregisterzThe unregister method was deprecated and it was replaced by `on_close`. Please see the Spyder 5.2.0 migration guide to get more information.N)rFwarningswarn)rL cancelables rPon_closezSpyderPluginV2.on_closeIsC 4 & & * M) * * * * * * *rQreturncdS)z Determine if a plugin can be closed. Returns ------- close: bool True if the plugin can be closed, False otherwise. Tr rYs rP can_closezSpyderPluginV2.can_closeVs trQcdS)z This must be reimplemented by plugins that need to adjust their fonts. The following plugins illustrate the usage of this method: * spyder/plugins/help/plugin.py * spyder/plugins/onlinehelp/plugin.py Nr rYs rPrTzSpyderPluginV2.update_fonta  rQcdS)aT This must be reimplemented by plugins that need to adjust their style. Changing from the dark to the light interface theme might require specific styles or stylesheets to be applied. When the theme is changed by the user through our Preferences, this method will be called for all plugins. Nr rYs rP update_stylezSpyderPluginV2.update_stylekrrQcdS)a Perform necessary operations before setting up the container. This must be reimplemented by plugins whose containers emit signals in on_option_update that need to be connected before applying those options to our config system. Nr rYs rPrEz'SpyderPluginV2.after_container_creationvrrQoptionscdS)ar Perform additional operations after updating the plugin configuration values. This can be implemented by plugins that do not have a container and need to act on configuration updates. Parameters ---------- options: List[Union[str, tuple]] A list that contains the options that were updated. Nr )rLrs rPrz)SpyderPluginV2.after_configuration_updates  rQNF)T)NT)rr)V__name__ __module__ __qualname____doc__r8rfrgr:r} CONF_FILE CONF_DEFAULTS CONF_VERSIONCONF_WIDGET_CLASSADDITIONAL_CONF_OPTIONSADDITIONAL_CONF_TABSCUSTOM_LAYOUTSrGrr CONTEXT_NAMECAN_BE_DISABLEDrr>rr@rAstrintrboolrBdictrCsig_mainwindow_resizedsig_mainwindow_movedobjectrDsig_mainwindow_state_changed_CONF_NAME_MAPr'rVrZrJr]r_rbrirqrtrvrrr rrrrrrrrrr staticmethodr classmethodrrrrrrrrrrrrrTrrErrtupler __classcell__r0s@rPrr3s DHH O LIML #  N HOL O !' vxx #FHH$*6#s#3#3  $*6$<< $VD\\<$VN33 "6,// '-fR&&;&;#$*6&>> N7;7;7;7;7;7;v* # # #!!!    @999;;; ) ) )(1$<<<<8 T#v T#vs.2(, - - - -D----,CCCC>>>>(>>>>( T#YY T#s^^ A A A^Y A%%% % % % %NNN$ % % %\ HHH[H> , , ,  D D\ D K K K D D D&\$          * * * * 4                $uS%Z7H2I         rQrcJeZdZdZdZgZdZdZeZ ee Z ee e Z eZ fdZfdZdfd Zd Zd Zd Zedd Zd ZedZedZedZdZdZddZddZdZ xZ!S)rwzJ A Spyder plugin to enhance functionality with a dockable widget. NTFct|jtstd|j|_t ||d|_|j|_ |j }|tdt|tstd|j |_ |j |_ | |||j||j|j|j|jdS)NzBA SpyderDockablePlugin must define a valid WIDGET_CLASS attribute!)rMz-A dockable plugin must define a WIDGET_CLASS!zMThe WIDGET_CLASS of a dockable plugin must be a subclass of PluginMainWidget!) issubclass WIDGET_CLASSrr r:r&r' _shortcutr2r)r;DISABLE_ACTIONS_WHEN_HIDDENRAISE_AND_FOCUSset_iconrset_namer8render_toolbarssig_toggle_view_changedr?sig_update_ancestor_requested)rLr$rMwidgetr0s rPr'zSpyderDockablePlugin.__init__s_$+-=>>    $0 }===  > ?AA A&"233 % $%% %.2-M*!%!5 ((( """     &..t/KLLL,44  . 0 0 0 0 0rQc|t|dS)a' Show a message in main window's status bar, change the mouse pointer to Qt.WaitCursor and start spinner when starting a long process. Parameters ---------- message: str Message to show in the status bar when the long process starts. N) get_widget start_spinnerr&rrLrr0s rPrz(SpyderDockablePlugin.before_long_processs? ''))) ##G,,,,,rQrct||dS)a Clear main window's status bar after a long process, restore mouse pointer to the OS deault and stop spinner. Parameters ---------- message: str Message to show in the status bar when the long process finishes. N)r&rr stop_spinnerrs rPrz'SpyderDockablePlugin.after_long_processs? ""7+++ &&(((((rQc<|jtd|jS)z0 Return the plugin main widget. Nz)Dockable Plugin must have a WIDGET_CLASS!)r)r rYs rPrzSpyderDockablePlugin.get_widgets# <  !LMM M|rQcR|dS)zG Update plugin title, i.e. dockwidget or window title. N)r update_titlerYs rPrz!SpyderDockablePlugin.update_titles& &&(((((rQcT||dS)zG Update margins of main widget inside dockable plugin. N)rupdate_margins)rLmargins rPrz#SpyderDockablePlugin.update_margins$s( ((00000rQcr|j|j||dSdS)zN Switch to plugin and define if focus should be given or not. N)r windowwidgetsig_switch_to_plugin_requestedr)rL force_focuss rPswitch_to_pluginz%SpyderDockablePlugin.switch_to_plugin*s> ??   ) 1  / 4 4T; G G G G G 2 1rQcT||dS)zM Update the ancestor/parent of child widgets when undocking. N)r set_ancestor)rLancestor_widgets rPr"z!SpyderDockablePlugin.set_ancestor2s( &&77777rQc4|jSr)r dockwidgetrYs rPr%zSpyderDockablePlugin.dockwidget:s  ++rQcN|Sr)rget_options_menurYs rP options_menuz!SpyderDockablePlugin.options_menu>s  11333rQc4|jSr)rtoggle_view_actionrYs rPr*z'SpyderDockablePlugin.toggle_view_actionBs  33rQcP||Sr)rcreate_dockwidget)rL mainwindows rPr,z&SpyderDockablePlugin.create_dockwidgetFs   22:>>>rQcR|dSr)r create_windowrYs rPr/z"SpyderDockablePlugin.create_windowIs$ '')))))rQcV||dS)N) save_undocked)r close_window)rLr1s rPr2z!SpyderDockablePlugin.close_windowLs) &&]&CCCCCrQcV|||dSr)rchange_visibility)rLstaters rPr4z&SpyderDockablePlugin.change_visibilityOs( ++E;?????rQcT||dSr)r toggle_view)rLrs rPr7z SpyderDockablePlugin.toggle_viewRs& %%e,,,,,rQrr)"rrrrrTABIFYrr rsig_focus_changedrr rrrr'rrrrrr r r"propertyr%r(r*r,r/r2r4r7rrs@rPrwrwsL F#' O%fTll &,VFD%9%9"%+FHH!'0'0'0'0'0V - - - - - ) ) ) ) ) )))) 111  TVVHHH VH888,,X,44X444X4???***DDDD@@@@-------rQrw)8r collectionsrr.loggingr+os.pathr,rHrtypingrrr qtpy.QtCorerrrr qtpy.QtGuir qtpy.QtWidgetsr spyder.api.config.mixinsr spyder.api.exceptionsr %spyder.api.plugin_registration.mixinsrspyder.api.translationsrspyder.api.widgets.main_widgetrspyder.api.widgets.mixinsrrspyder.app.cli_optionsrspyder.config.guirrspyder.config.userrspyder.utils.icon_managerrspyder.utils.image_path_managerrenumrold_apir getLoggerrloggerrrwr rQrPrQsY$#####  211111111111''''''A@@@@@000000FFFFFF%%%%%%;;;;;;777777777777......88888888(((((())))))>>>>>>''''''  8 $ $Z  Z  Z  Z  Z  W/1L)Z  Z  Z  zC-C-C-C-C->C-C-C-C-C-rQ