/
new_api.py
1038 lines (865 loc) · 34.6 KB
/
new_api.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
#
# Copyright © Spyder Project Contributors
# Licensed under the terms of the MIT License
# (see spyder/__init__.py for details)
"""
New API for plugins.
All plugins in Spyder 5+ must inherit from the classes present in this file.
"""
# Standard library imports
from collections import OrderedDict
import inspect
import logging
import os
import os.path as osp
import sys
from typing import List, Union
import warnings
# Third party imports
from qtpy.QtCore import QObject, Qt, Signal, Slot
from qtpy.QtGui import QCursor
from qtpy.QtWidgets import QApplication
# Local imports
from spyder.api.config.mixins import SpyderConfigurationObserver
from spyder.api.exceptions import SpyderAPIError
from spyder.api.plugin_registration.mixins import SpyderPluginObserver
from spyder.api.translations import get_translation
from spyder.api.widgets.main_container import PluginMainContainer
from spyder.api.widgets.main_widget import PluginMainWidget
from spyder.api.widgets.mixins import SpyderActionMixin
from spyder.api.widgets.mixins import SpyderWidgetMixin
from spyder.app.cli_options import get_options
from spyder.config.gui import get_color_scheme, get_font
from spyder.config.user import NoDefault
from spyder.utils.icon_manager import ima
from spyder.utils.image_path_manager import IMAGE_PATH_MANAGER
# Package imports
from .enum import Plugins
from .old_api import SpyderPluginWidget
# Localization
_ = get_translation('spyder')
logger = logging.getLogger(__name__)
class SpyderPluginV2(QObject, SpyderActionMixin, SpyderConfigurationObserver,
SpyderPluginObserver):
"""
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.
"""
# --- API: Mandatory attributes ------------------------------------------
# ------------------------------------------------------------------------
# Name of the plugin that will be used to refer to it.
# This name must be unique and will only be loaded once.
NAME = None
# --- API: Optional attributes ------------------------------------------
# ------------------------------------------------------------------------
# List of required plugin dependencies.
# Example: [Plugins.Plots, Plugins.IPythonConsole, ...].
# These values are defined in the `Plugins` class present in this file.
# If a plugin is using a widget from another plugin, that other
# must be declared as a required dependency.
REQUIRES = []
# List of optional plugin dependencies.
# Example: [Plugins.Plots, Plugins.IPythonConsole, ...].
# These values are defined in the `Plugins` class present in this file.
# A plugin might be performing actions when connectiong to other plugins,
# but the main functionality of the plugin does not depend on other
# plugins. For example, the Help plugin might render information from
# the Editor or from the Console or from another source, but it does not
# depend on either of those plugins.
# Methods in the plugin that make use of optional plugins must check
# existence before using those methods or applying signal connections.
OPTIONAL = []
# This must subclass a `PluginMainContainer` for non dockable plugins that
# create a widget, like a status bar widget, a toolbar, a menu, etc.
# For non dockable plugins that do not define widgets of any kind this can
# be `None`, for example a plugin that only exposes a configuration page.
CONTAINER_CLASS = None
# Name of the configuration section that's going to be
# used to record the plugin's permanent data in Spyder
# config system (i.e. in spyder.ini)
CONF_SECTION = None
# Use a separate configuration file for the plugin.
CONF_FILE = True
# Define configuration defaults if using a separate file.
# List of tuples, with the first item in the tuple being the section
# name and the second item being the default options dictionary.
#
# CONF_DEFAULTS_EXAMPLE = [
# ('section-name', {'option-1': 'some-value',
# 'option-2': True,}),
# ('another-section-name', {'option-3': 'some-other-value',
# 'option-4': [1, 2, 3],}),
# ]
CONF_DEFAULTS = None
# Define configuration version if using a separate file
#
# IMPORTANT NOTES:
# 1. If you want to *change* the default value of a current option, you
# need to do a MINOR update in config version, e.g. from 3.0.0 to 3.1.0
# 2. If you want to *remove* options that are no longer needed or if you
# want to *rename* options, then you need to do a MAJOR update in
# version, e.g. from 3.0.0 to 4.0.0
# 3. You don't need to touch this value if you're just adding a new option
CONF_VERSION = None
# Widget to be used as entry in Spyder Preferences dialog.
CONF_WIDGET_CLASS = None
# Some plugins may add configuration options for other plugins.
# Example:
# ADDITIONAL_CONF_OPTIONS = {'section': <new value to add>}
ADDITIONAL_CONF_OPTIONS = None
# Define additional configurable options (via a tab) to
# another's plugin configuration page. All configuration tabs should
# inherit from `SpyderPreferencesTab`.
# Example:
# ADDITIONAL_CONF_TABS = {'plugin_name': [<SpyderPreferencesTab classes>]}
ADDITIONAL_CONF_TABS = None
# Define custom layout classes that the plugin wantes to be registered.
# THe custom classes should extend from
# `spyder.pluginsl.layout.api::BaseGridLayoutType`
CUSTOM_LAYOUTS = []
# Path for images relative to the plugin path
# A Python package can include one or several Spyder plugins. In this case
# the package may be using images from a global folder outside the plugin
# folder
IMG_PATH = None
# Control the font size relative to the global fonts defined in Spyder
FONT_SIZE_DELTA = 0
RICH_FONT_SIZE_DELTA = 0
# Define context to store actions, toolbars, toolbuttons and menus.
CONTEXT_NAME = None
# Define if a plugin can be disabled in preferences.
# If False, the plugin is considered "core" and therefore it cannot be
# disabled. Default: True
CAN_BE_DISABLED = True
# --- API: Signals -------------------------------------------------------
# ------------------------------------------------------------------------
# Signals here are automatically connected by the Spyder main window and
# connected to the the respective global actions defined on it.
sig_free_memory_requested = Signal()
"""
This signal can be emitted to request the main application to garbage
collect deleted objects.
"""
sig_plugin_ready = Signal()
"""
This signal can be emitted to reflect that the plugin was initialized.
"""
sig_quit_requested = Signal()
"""
This signal can be emitted to request the main application to quit.
"""
sig_restart_requested = Signal()
"""
This signal can be emitted to request the main application to restart.
"""
sig_status_message_requested = Signal(str, int)
"""
This signal can be emitted to request the main application to display a
message in the status bar.
Parameters
----------
message: str
The actual message to display.
timeout: int
The timeout before the message disappears.
"""
sig_redirect_stdio_requested = Signal(bool)
"""
This signal can be emitted to request the main application to redirect
standard output/error when using Open/Save/Browse dialogs within widgets.
Parameters
----------
enable: bool
Enable/Disable standard input/output redirection.
"""
sig_exception_occurred = Signal(dict)
"""
This signal can be emitted to report an exception from any plugin.
Parameters
----------
error_data: dict
The dictionary containing error data. The expected keys are:
>>> error_data= {
"text": str,
"is_traceback": bool,
"repo": str,
"title": str,
"label": str,
"steps": str,
}
Notes
-----
The `is_traceback` key indicates if `text` contains plain text or a
Python error traceback.
The `title` and `repo` keys indicate how the error data should
customize the report dialog and Github error submission.
The `label` and `steps` keys allow customizing the content of the
error dialog.
This signal is automatically connected to the main container/widget.
"""
sig_mainwindow_resized = Signal("QResizeEvent")
"""
This signal is emitted when the main window is resized.
Parameters
----------
resize_event: QResizeEvent
The event triggered on main window resize.
Notes
-----
To be used by plugins tracking main window size changes.
"""
sig_mainwindow_moved = Signal("QMoveEvent")
"""
This signal is emitted when the main window is moved.
Parameters
----------
move_event: QMoveEvent
The event triggered on main window move.
Notes
-----
To be used by plugins tracking main window position changes.
"""
# --- Private attributes -------------------------------------------------
# ------------------------------------------------------------------------
# Define configuration name map for plugin to split configuration
# among several files. See spyder/config/main.py
_CONF_NAME_MAP = None
def __init__(self, parent, configuration=None):
super().__init__(parent)
# This is required since the MRO of this class does not go up until to
# SpyderPluginObserver and SpyderConfigurationObserver when using
# super(), see https://fuhm.net/super-harmful/
SpyderPluginObserver.__init__(self)
SpyderConfigurationObserver.__init__(self)
self._main = parent
self._widget = None
self._conf = configuration
self._plugin_path = os.path.dirname(inspect.getfile(self.__class__))
self._container = None
self._added_toolbars = OrderedDict()
self._actions = {}
self.is_compatible = None
self.is_registered = None
self.main = parent
# Attribute used to access the action, toolbar, toolbutton and menu
# registries
self.PLUGIN_NAME = self.NAME
if self.CONTAINER_CLASS is not None:
self._container = container = self.CONTAINER_CLASS(
name=self.NAME,
plugin=self,
parent=parent
)
if isinstance(container, SpyderWidgetMixin):
container.setup()
container.update_actions()
if isinstance(container, PluginMainContainer):
# TODO: This signals should also affect the main_widgets?
# Currently this is not working for
# instances of PluginMainWidget subclasses
# Default signals to connect in main container or main widget.
container.sig_exception_occurred.connect(
self.sig_exception_occurred)
container.sig_free_memory_requested.connect(
self.sig_free_memory_requested)
container.sig_quit_requested.connect(
self.sig_quit_requested)
container.sig_redirect_stdio_requested.connect(
self.sig_redirect_stdio_requested)
container.sig_restart_requested.connect(
self.sig_restart_requested)
self.after_container_creation()
if hasattr(container, '_setup'):
container._setup()
# Load the custom images of the plugin
if self.IMG_PATH:
plugin_path = osp.join(self.get_path(), self.IMG_PATH)
IMAGE_PATH_MANAGER.add_image_path(plugin_path)
# --- Private methods ----------------------------------------------------
# ------------------------------------------------------------------------
def _register(self, omit_conf=False):
"""
Setup and register plugin in Spyder's main window and connect it to
other plugins.
"""
# Checks
# --------------------------------------------------------------------
if self.NAME is None:
raise SpyderAPIError('A Spyder Plugin must define a `NAME`!')
# Setup configuration
# --------------------------------------------------------------------
if self._conf is not None and not omit_conf:
self._conf.register_plugin(self)
# Signals
# --------------------------------------------------------------------
self.is_registered = True
self.update_font()
def _unregister(self):
"""
Disconnect signals and clean up the plugin to be able to stop it while
Spyder is running.
"""
if self._conf is not None:
self._conf.unregister_plugin(self)
self._container = None
self.is_compatible = None
self.is_registered = False
# --- API: available methods ---------------------------------------------
# ------------------------------------------------------------------------
def get_path(self):
"""
Return the plugin's system path.
"""
return self._plugin_path
def get_container(self):
"""
Return the plugin main container.
"""
return self._container
def get_configuration(self):
"""
Return the Spyder configuration object.
"""
return self._conf
def get_main(self):
"""
Return the Spyder main window..
"""
return self._main
def get_plugin(self, plugin_name):
"""
Return a plugin instance by providing the plugin's NAME.
"""
# Ensure that this plugin has the plugin corresponding to
# `plugin_name` listed as required or optional.
requires = set(self.REQUIRES or [])
optional = set(self.OPTIONAL or [])
full_set = requires | optional
if plugin_name in full_set or Plugins.All in full_set:
try:
return self._main.get_plugin(plugin_name)
except SpyderAPIError as e:
if plugin_name in optional:
return None
else:
raise e
else:
raise SpyderAPIError(
'Plugin "{}" not part of REQUIRES or '
'OPTIONAL requirements!'.format(plugin_name)
)
def is_plugin_enabled(self, plugin_name):
"""Determine if a given plugin is going to be loaded."""
return self._main.is_plugin_enabled(plugin_name)
def is_plugin_available(self, plugin_name):
"""Determine if a given plugin is available."""
return self._main.is_plugin_available(plugin_name)
def get_dockable_plugins(self):
"""
Return a list of the required plugin instances.
Only required plugins that extend SpyderDockablePlugin are returned.
"""
requires = set(self.REQUIRES or [])
dockable_plugins_required = []
for name, plugin_instance in self._main.get_dockable_plugins():
if (name in requires or Plugins.All in requires) and isinstance(
plugin_instance,
(SpyderDockablePlugin, SpyderPluginWidget)):
dockable_plugins_required.append(plugin_instance)
return dockable_plugins_required
def get_conf(self, option, default=NoDefault, section=None):
"""
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`.
"""
if self._conf is not None:
section = self.CONF_SECTION if section is None else section
if section is None:
raise SpyderAPIError(
'A spyder plugin must define a `CONF_SECTION` class '
'attribute!'
)
return self._conf.get(section, option, default)
@Slot(str, object)
@Slot(str, object, str)
def set_conf(self, option, value, section=None,
recursive_notification=True):
"""
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.
"""
if self._conf is not None:
section = self.CONF_SECTION if section is None else section
if section is None:
raise SpyderAPIError(
'A spyder plugin must define a `CONF_SECTION` class '
'attribute!'
)
self._conf.set(section, option, value,
recursive_notification=recursive_notification)
self.apply_conf({option}, False)
def remove_conf(self, option, section=None):
"""
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.
"""
if self._conf is not None:
section = self.CONF_SECTION if section is None else section
if section is None:
raise SpyderAPIError(
'A spyder plugin must define a `CONF_SECTION` class '
'attribute!'
)
self._conf.remove_option(section, option)
self.apply_conf({option}, False)
def apply_conf(self, options_set, notify=True):
"""
Apply `options_set` to this plugin's widget.
"""
if self._conf is not None and options_set:
if notify:
self.after_configuration_update(list(options_set))
@Slot(str)
@Slot(str, int)
def show_status_message(self, message, timeout=0):
"""
Show message in status bar.
Parameters
----------
message: str
Message to display in the status bar.
timeout: int
Amount of time to display the message.
"""
self.sig_status_message_requested.emit(message, timeout)
def before_long_process(self, message):
"""
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.
"""
if message:
self.show_status_message(message)
QApplication.setOverrideCursor(QCursor(Qt.WaitCursor))
QApplication.processEvents()
def after_long_process(self, message=""):
"""
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.
"""
QApplication.restoreOverrideCursor()
self.show_status_message(message, timeout=2000)
QApplication.processEvents()
def get_color_scheme(self):
"""
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.
"""
if self._conf is not None:
return get_color_scheme(self._conf.get('appearance', 'selected'))
def initialize(self):
"""
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.
"""
self.on_initialize()
self.sig_plugin_ready.emit()
@staticmethod
def create_icon(name):
"""
Provide icons from the theme and icon manager.
"""
return ima.icon(name)
@classmethod
def get_font(cls, rich_text=False):
"""
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`).
"""
if rich_text:
option = 'rich_font'
font_size_delta = cls.RICH_FONT_SIZE_DELTA
else:
option = 'font'
font_size_delta = cls.FONT_SIZE_DELTA
return get_font(option=option, font_size_delta=font_size_delta)
def get_command_line_options(self):
"""
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.
"""
if self._main is not None:
return self._main._cli_options
else:
# This is necessary when the plugin has no parent.
sys_argv = [sys.argv[0]] # Avoid options passed to pytest
return get_options(sys_argv)[0]
# --- API: Mandatory methods to define -----------------------------------
# ------------------------------------------------------------------------
@staticmethod
def get_name():
"""
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.
"""
raise NotImplementedError('A plugin name must be defined!')
def get_description(self):
"""
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.
"""
raise NotImplementedError('A plugin description must be defined!')
def get_icon(self):
"""
Return the plugin associated icon.
Returns
-------
QIcon
QIcon instance
"""
raise NotImplementedError('A plugin icon must be defined!')
def on_initialize(self):
"""
Setup the plugin.
Notes
-----
All calls performed on this method should not call other plugins.
"""
if hasattr(self, 'register'):
raise SpyderAPIError(
'register was replaced by on_initialize, please check the '
'Spyder 5.1.0 migration guide to get more information')
raise NotImplementedError(
f'The plugin {type(self)} is missing an implementation of '
'on_initialize')
# --- API: Optional methods to override ----------------------------------
# ------------------------------------------------------------------------
@staticmethod
def check_compatibility():
"""
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.
"""
valid = True
message = '' # Note: Remember to use _('') to localize the string
return valid, message
def on_first_registration(self):
"""
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.
"""
pass
def before_mainwindow_visible(self):
"""
Actions to be performed after setup but before the main window's has
been shown.
"""
pass
def on_mainwindow_visible(self):
"""
Actions to be performed after the main window's has been shown.
"""
pass
def on_close(self, cancelable=False):
"""
Perform actions before the plugin is closed.
This method **must** only operate on local attributes and not other
plugins.
"""
if hasattr(self, 'unregister'):
warnings.warn('The unregister method was deprecated and it '
'was replaced by `on_close`. Please see the '
'Spyder 5.2.0 migration guide to get more '
'information.')
def can_close(self) -> bool:
"""
Determine if a plugin can be closed.
Returns
-------
close: bool
True if the plugin can be closed, False otherwise.
"""
return True
def update_font(self):
"""
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
"""
pass
def update_style(self):
"""
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.
"""
pass
def after_container_creation(self):
"""
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.
"""
pass
def after_configuration_update(self, options: List[Union[str, tuple]]):
"""
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.
"""
pass
class SpyderDockablePlugin(SpyderPluginV2):
"""
A Spyder plugin to enhance functionality with a dockable widget.
"""
# --- API: Mandatory attributes ------------------------------------------
# ------------------------------------------------------------------------
# This is the main widget of the dockable plugin.
# It needs to be a subclass of PluginMainWidget.
WIDGET_CLASS = None
# --- API: Optional attributes -------------------------------------------
# ------------------------------------------------------------------------
# Define a list of plugins next to which we want to to tabify this plugin.
# Example: ['Plugins.Editor']
TABIFY = []
# Disable actions in Spyder main menus when the plugin is not visible
DISABLE_ACTIONS_WHEN_HIDDEN = True
# Raise and focus on switch to plugin calls.
# If False, the widget will be raised but focus will not be given until
# the action to switch is called a second time.
RAISE_AND_FOCUS = False
# --- API: Available signals ---------------------------------------------
# ------------------------------------------------------------------------
sig_focus_changed = Signal()
"""
This signal is emitted to inform the focus of this plugin has changed.
"""
sig_toggle_view_changed = Signal(bool)
"""
This action is emitted to inform the visibility of a dockable plugin
has changed.
This is triggered by checking/unchecking the entry for a pane in the
`View > Panes` menu.
Parameters
----------
visible: bool
New visibility of the dockwidget.
"""
sig_switch_to_plugin_requested = Signal(object, bool)
"""
This signal can be emitted to inform the main window that this plugin
requested to be displayed.
Notes
-----
This is automatically connected to main container/widget at plugin's
registration.
"""
sig_update_ancestor_requested = Signal()
"""
This signal is emitted to inform the main window that a child widget
needs its ancestor to be updated.
"""
# --- Private methods ----------------------------------------------------
# ------------------------------------------------------------------------
def __init__(self, parent, configuration):
if not issubclass(self.WIDGET_CLASS, PluginMainWidget):
raise SpyderAPIError(
'A SpyderDockablePlugin must define a valid WIDGET_CLASS '
'attribute!')
self.CONTAINER_CLASS = self.WIDGET_CLASS
super().__init__(parent, configuration=configuration)
# Defined on mainwindow.py
self._shortcut = None
# Widget setup
# --------------------------------------------------------------------
self._widget = self._container
widget = self._widget
if widget is None:
raise SpyderAPIError(
'A dockable plugin must define a WIDGET_CLASS!')
if not isinstance(widget, PluginMainWidget):
raise SpyderAPIError(
'The WIDGET_CLASS of a dockable plugin must be a subclass of '
'PluginMainWidget!')
widget.DISABLE_ACTIONS_WHEN_HIDDEN = self.DISABLE_ACTIONS_WHEN_HIDDEN
widget.RAISE_AND_FOCUS = self.RAISE_AND_FOCUS
widget.set_icon(self.get_icon())
widget.set_name(self.NAME)
# Render all toolbars as a final separate step on the main window
# in case some plugins want to extend a toolbar. Since the rendering
# can only be done once!
widget.render_toolbars()
# Default Signals
# --------------------------------------------------------------------
widget.sig_toggle_view_changed.connect(self.sig_toggle_view_changed)
widget.sig_update_ancestor_requested.connect(
self.sig_update_ancestor_requested)
# --- API: available methods ---------------------------------------------
# ------------------------------------------------------------------------
def before_long_process(self, message):
"""
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.
"""
self.get_widget().start_spinner()
super().before_long_process(message)
def after_long_process(self, message=""):
"""
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.
"""
super().after_long_process(message)
self.get_widget().stop_spinner()
def get_widget(self):
"""
Return the plugin main widget.
"""
if self._widget is None:
raise SpyderAPIError('Dockable Plugin must have a WIDGET_CLASS!')
return self._widget
def update_title(self):
"""
Update plugin title, i.e. dockwidget or window title.
"""
self.get_widget().update_title()
def update_margins(self, margin):
"""
Update margins of main widget inside dockable plugin.
"""
self.get_widget().update_margins(margin)