G@dOIdZddlmZmZddlmZddlmZddlm Z m Z ddl m Z Gdde Z Gd d e ZGd d ee ZGd deeZdS)z Old API for plugins. These plugins were supported until Spyder 4, but they will be deprecated in the future. Please don't rely on them for new plugins and use instead the classes present in new_api.py )SignalSlot)QWidget) NoDefault)BasePluginMixinBasePluginWidgetMixin)imac eZdZdZeeeZeeeZ d fd Z e ee eedfd Z e ee dfd Z edffd Zd fd Zfd Zdfd ZxZS) BasePluginzv Basic functionality for Spyder plugins. WARNING: Don't override any methods or attributes present here! Nctt||||_||_|j|j|j |j dSN) superr __init__main_get_plugin_path PLUGIN_PATHsig_show_status_messageconnectshow_status_messagesig_option_changed set_option)selfparent __class__s :lib/python3.11/site-packages/spyder/api/plugins/old_api.pyrzBasePlugin.__init__+s{ j$((000  0022 $,,T-EFFF ''88888rcZtt|||dS)z Show message in main window's status bar. Parameters ---------- message: str Message to display in the status bar. timeout: int Amount of time to display the message. N)rr _show_status_message)rmessagetimeoutrs rrzBasePlugin.show_status_message:s+ j$44WgFFFFFrTc`tt|||||dS)a Set an option in Spyder configuration file. Parameters ---------- option: str Name of the option (e.g. 'case_sensitive') value: bool, int, str, tuple, list, dict Value to save in configuration file, passed as a Python object. Notes ----- * Use sig_option_changed to call this method from widgets of the same or another plugin. * CONF_SECTION needs to be defined for this to work. )sectionrecursive_notificationN)rr _set_option)roptionvaluer"r#rs rrzBasePlugin.set_optionIs@( j$++ E7#9 , ; ; ; ; ;rcZtt||||S)a' Get an option from Spyder configuration file. Parameters ---------- option: str Name of the option to get its value from. Returns ------- bool, int, str, tuple, list, dict Value associated with `option`. r")rr _get_option)rr%defaultr"rs r get_optionzBasePlugin.get_optionas6Z&&2267;B3DD DrcXtt|||S)aE Remove an option from the Spyder configuration file. Parameters ---------- option: Union[str, Tuple[str, ...]] A string or a Tuple of strings containing an option name to remove. section: Optional[str] Name of the section where the option belongs to. r()rr _remove_option)rr%r"rs r remove_optionzBasePlugin.remove_optionrs(Z&&55fg5NNNrcXtt||dS)a Show a message in main window's status bar and changes the mouse 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 _starting_long_processrrrs rstarting_long_processz BasePlugin.starting_long_processs) j$66w?????rcXtt||dS)a Clear main window's status bar after a long process and restore mouse to the OS deault. Parameters ---------- message: str Message to show in the status bar when the long process finishes. N)rr _ending_long_processr1s rending_long_processzBasePlugin.ending_long_processs) j$44W=====rr )r)NT)r3)__name__ __module__ __qualname____doc__rstrintrobjectrrrrrrr+r.r2r6 __classcell__rs@rr r s%fS#.. V,, 9 9 9 9 9 9 T#YY T#s^^ G G G G G^Y G T#v04*.;;;;;;.*3DDDDDDD" O O O O O O @ @ @ @ @ > > > > > > > > > >rr c0eZdZdZdZdZdZdZdZdZ dZ dS) SpyderPluginzh Spyder plugin class. All plugins *must* inherit this class and reimplement its interface. NTcd}d}||fS)a  This method can be reimplemented to check compatibility of a plugin for a given condition. 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. r3T)rrvalids rcheck_compatibilityz SpyderPlugin.check_compatibilitysg~r) r7r8r9r: CONF_SECTION DESCRIPTIONCONFIGWIDGET_CLASS CONF_FILE CONF_DEFAULTS CONF_VERSIONrErCrrrArAsXLKIMLrrAceZdZdZeZddZfdZfdZdfd Z ddZ dd Z d Z d Z fd Zfd ZxZS)BasePluginWidgetz} Basic functionality for Spyder plugin widgets. WARNING: Don't override any methods or attributes present here! Ncftj|tj||d|_dSr )rrr dockwidget)rrs rrzBasePluginWidget.__init__s3&tT222 rcVtt|dS)z0Add the plugin's QDockWidget to the main window.N)rrM_add_dockwidgetrrs radd_dockwidgetzBasePluginWidget.add_dockwidgets& %%5577777rcXtt||dS)a& Tabify plugin next to one of the core plugins. Parameters ---------- core_plugin: SpyderPluginWidget Core Spyder plugin this one will be tabified next to. Examples -------- >>> self.tabify(self.main.variableexplorer) >>> self.tabify(self.main.ipyconsole) Notes ----- The names of variables associated with each of the core plugins can be found in the `setup` method of `MainWindow`, present in `spyder/app/mainwindow.py`. N)rrM_tabify)r core_pluginrs rtabifyzBasePluginWidget.tabifys*( %%--k:::::rFcTtt||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 below in `SpyderPluginWidget`). )rrM _get_font)r rich_textrs rget_fontzBasePluginWidget.get_fonts$.%t,,66yAAArcL|j|||||jdS)a Register a shortcut associated to a QAction or a QShortcut to Spyder main application. Parameters ---------- qaction_or_qshortcut: QAction or QShortcut QAction to register the shortcut for or QShortcut. context: str Name of the plugin this shortcut applies to. For instance, if you pass 'Editor' as context, the shortcut will only work when the editor is focused. Note: You can use '_' if you want the shortcut to be work for the entire application. name: str Name of the action the shortcut refers to (e.g. 'Debug exit'). add_shortcut_to_tip: bool If True, the shortcut is added to the action's tooltip. This is useful if the action is added to a toolbar and users hover it to see what it does. N)rregister_shortcutrFrqaction_or_qshortcutcontextnameadd_shortcut_to_tips rr]z"BasePluginWidget.register_shortcut,s:0 ##           rcL|j|||||jdS)a Unregister a shortcut associated to a QAction or a QShortcut to Spyder main application. Parameters ---------- qaction_or_qshortcut: QAction or QShortcut QAction to register the shortcut for or QShortcut. context: str Name of the plugin this shortcut applies to. For instance, if you pass 'Editor' as context, the shortcut will only work when the editor is focused. Note: You can use '_' if you want the shortcut to be work for the entire application. name: str Name of the action the shortcut refers to (e.g. 'Debug exit'). add_shortcut_to_tip: bool If True, the shortcut is added to the action's tooltip. This is useful if the action is added to a toolbar and users hover it to see what it does. N)runregister_shortcutrFr^s rrdz$BasePluginWidget.unregister_shortcutKs:0 %%           rcj|D]\}}}||||dS)a Register shortcuts defined by a plugin's widget so they take effect when the plugin is focused. Parameters ---------- widget: QWidget Widget to register shortcuts for. Notes ----- The widget interface must have a method called `get_shortcut_data` for this to work. Please see `spyder/widgets/findreplace.py` for an example. N)get_shortcut_datar]rwidget qshortcutr`ras rregister_widget_shortcutsz*BasePluginWidget.register_widget_shortcutsjsK )/(@(@(B(B = = $Iw  " "9gt < < < < = =rcj|D]\}}}||||dS)av Unregister shortcuts defined by a plugin's widget. Parameters ---------- widget: QWidget Widget to register shortcuts for. Notes ----- The widget interface must have a method called `get_shortcut_data` for this to work. Please see `spyder/widgets/findreplace.py` for an example. N)rfrdrgs runregister_widget_shortcutsz,BasePluginWidget.unregister_widget_shortcuts}sK)/(@(@(B(B ? ? $Iw  $ $Y > > > > ? ?rcRtt|S)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. )rrM_get_color_schemerRs rget_color_schemez!BasePluginWidget.get_color_schemes"%t,,>>@@@rcVtt|dS)z Switch to this plugin. Notes ----- This operation unmaximizes the current plugin (if any), raises this plugin to view (if it's hidden) and gives it focus (if possible). N)rrM_switch_to_pluginrRs rswitch_to_pluginz!BasePluginWidget.switch_to_plugins( %%7799999rr F)r7r8r9r:rsig_update_plugin_titlerrSrWr[r]rdrjrlrorrr>r?s@rrMrMs)%fhh88888;;;;;,BBBBBB4/4@16>===&???$AAAAA" : : : : : : : : :rrMcpeZdZdZdZdZdZdZdZdZ dZ dZ dd Z d Z d Zd ZdZdZdZdZdZdS)SpyderPluginWidgetzv Spyder plugin widget class. All plugin widgets *must* inherit this class and reimplement its interface. imagesrTNct)zr Get plugin's title. Returns ------- str Name of the plugin. NotImplementedErrorrs rget_plugin_titlez#SpyderPluginWidget.get_plugin_titles "!rc*tjdS)zy Get plugin's associated icon. Returns ------- QIcon QIcon instance outline_explorer)r iconr{s rget_plugin_iconz"SpyderPluginWidget.get_plugin_iconsx*+++rcdS)z Get the plugin widget to give focus to. Returns ------- QWidget QWidget to give focus to. Notes ----- This is applied when plugin's dockwidget is raised on top-level. NrCr{s rget_focus_widgetz#SpyderPluginWidget.get_focus_widgets  rFcdS)a Perform actions before the main window is closed. Returns ------- bool Whether the plugin may be closed immediately or not. Notes ----- The returned value is ignored if *cancelable* is False. TrC)r cancelables rclosing_pluginz!SpyderPluginWidget.closing_plugins trcdS)z Refresh plugin after it receives focus. Notes ----- For instance, this is used to maintain in sync the Variable Explorer with the currently focused IPython console. NrCr{s rrefresh_pluginz!SpyderPluginWidget.refresh_plugins  rcgS)z Return a list of QAction's related to plugin. Notes ----- These actions will be shown in the plugins Options menu (i.e. the hambuger menu on the right of each plugin). rCr{s rget_plugin_actionsz%SpyderPluginWidget.get_plugin_actions s  rc.|dS)a  Register plugin in Spyder's main window and connect it to other plugins. Notes ----- Below is the minimal call necessary to register the plugin. If you override this method, please don't forget to make that call here too. N)rSr{s rregister_pluginz"SpyderPluginWidget.register_plugins rct)z Action to be performed on first plugin registration. Notes ----- This is mostly used to tabify the plugin next to one of the core plugins, like this: self.tabify(self.main.variableexplorer) ryr{s ron_first_registrationz(SpyderPluginWidget.on_first_registration$s "!rcdS)zN Determine what to do to apply configuration plugin settings. NrC)roptionss rapply_plugin_settingsz(SpyderPluginWidget.apply_plugin_settings1  rcdS)z` This must be reimplemented by plugins that need to adjust their fonts. NrCr{s r update_fontzSpyderPluginWidget.update_font7s rc|jsdS|r4|j|jdS|jdS)a Toggle dockwidget's visibility when its entry is selected in the menu `View > Panes`. Parameters ---------- checked: bool Is the entry in `View > Panes` checked or not? Notes ----- Redefining this method can be useful to execute certain actions when the plugin is made visible. For an example, please see `spyder/plugins/ipythonconsole/plugin.py` N)rOshowraise_hide)rcheckeds r toggle_viewzSpyderPluginWidget.toggle_view>sc   F  # O " " " O " " $ $ $ $ $ O " " " " "rcdS)zW Needed to update the ancestor/parent of child widgets when undocking. NrC)rancestors r set_ancestorzSpyderPluginWidget.set_ancestorVrrrs)r7r8r9r:IMG_PATHFONT_SIZE_DELTARICH_FONT_SIZE_DELTADISABLE_ACTIONS_WHEN_HIDDENshortcutr|rrrrrrrrrrrrCrrrvrvsH O #' H " " " , , ,                   " " "      ###0     rrvN)r: qtpy.QtCorerrqtpy.QtWidgetsrspyder.config.userrspyder.plugins.baserrspyder.utils.icon_managerr r rArMrvrCrrrsV%$$$$$$$"""""")(((((FFFFFFFF)))))) {>{>{>{>{>{>{>{>|EEEEE:EEEVE:E:E:E:E:w 5E:E:E:Pm m m m m '7m m m m m r