spyder.api

Base classes, mixins and widgets for creating plugins to extend Spyder.

This API should be considered production-ready as of Spyder 6.0. The API version is modified according to the following rules:

• If a module/class/method/function/signal is added, then the minor version will be incremented.

• If a module/class/method/function/signal is removed, renamed or changes its signature, then the major version will be incremented.

• Whenever possible, deprecation warnings and alerts will be employed to inform developers of breaking-compatibility changes in a future API release In such cases, the minor version will be increased and once the deprecated APIs are removed then the major version will be updated.

Module Attributes

VERSION_INFO

Tuple form of API version, broken down into (major, minor, micro).

spyder.api.VERSION_INFO: tuple[int, int, int] = (2, 0, 0)

Tuple form of API version, broken down into (major, minor, micro).

spyder.api.__version__: str = '2.0.0'

Spyder API version; minor bumped for additions/deprecations, major for breaks.

The minor version will be incremented when adding or deprecating an API, (for example, a module, class, method, function, signal, constant, or similar) while the major version will be incremented for all breaking API changes, such as removing, renaming or changing the signature of an API.

Modules

asyncdispatcher	Class decorator and helpers for running code in async loops within Spyder.
config	Mixins, decorators and enums to access the Spyder configuration system.
exceptions	The API-related exception classes emitted by Spyder and its plugins.
fonts	Helper classes to get and set the fonts used in Spyder.
plugin_registration	Global registry of Spyder plugins and decorators for setup and teardown.
plugins	Base classes for constructing and accessing top-level Spyder plugin objects.
preferences	API to create an entry in Spyder Preferences associated to a given plugin.
shellconnect	Classes to connect a plugin to the shell widgets in the IPython console.
shortcuts	Helper classes to get and set keyboard shortcuts in Spyder.
translations	The gettext-based translation and internationalization (i18n) API for Spyder.
utils	Helper functions to work with the Spyder plugin API.
widgets	Widgets to extend Spyder through its API.