spyder.api.shellconnect.status#

Status bar widget to show content from the IPython console.

Classes

Base class for status bar widgets whose info depends on the current shell.

class spyder.api.shellconnect.status.ShellConnectStatusBarWidget(parent: PluginMainWidget)[source]#

Base class for status bar widgets whose info depends on the current shell.

Create a new status bar widget to display content from a shell widget.

Parameters:: parent (PluginMainWidget) – The parent widget to this one.
Return type:: None

shellwidget_to_status: dict[spyder.plugins.ipythonconsole.widgets.ShellWidget, Any]#

Mapping from shell widgets to their corresponding statuses.

The specific type of status information stored will depend on what the implementing class needs to display.

current_shellwidget: spyder.plugins.ipythonconsole.widgets.ShellWidget | None#: Currently active associated shell widget.

update_status(status: Any)[source]#

Actions to take to update the widget status after switching consoles.

Parameters:: status (Any) – The shell widget status information needed by the status widget. To be defined by the implementing class.

on_kernel_start(shellwidget: spyder.plugins.ipythonconsole.widgets.ShellWidget) → None[source]#

Actions to take after the kernel starts.

Parameters:: shellwidget (spyder.plugins.ipythonconsole.widgets.ShellWidget) – The shell widget whose kernel was started.
Return type:: None

config_spyder_kernel(shellwidget: spyder.plugins.ipythonconsole.widgets.ShellWidget) → None[source]#

Actions to take to configure the kernel.

Parameters:: shellwidget (spyder.plugins.ipythonconsole.widgets.ShellWidget) – The shell widget whose kernel will be configured.
Return type:: None

set_shellwidget(shellwidget: spyder.plugins.ipythonconsole.widgets.ShellWidget) → None[source]#

Actions to take when setting (i.e. giving focus to) a shell widget.

Parameters:: shellwidget (spyder.plugins.ipythonconsole.widgets.ShellWidget) – The shell widget that will be given focus.
Return type:: None

add_shellwidget(shellwidget: spyder.plugins.ipythonconsole.widgets.ShellWidget) → None[source]#

Actions to take when adding a shell widget.

Parameters:: shellwidget (spyder.plugins.ipythonconsole.widgets.ShellWidget) – The shell widget that will be added.
Return type:: None

remove_shellwidget(shellwidget: spyder.plugins.ipythonconsole.widgets.ShellWidget) → None[source]#

Actions to take when removing a shell widget.

Parameters:: shellwidget (spyder.plugins.ipythonconsole.widgets.ShellWidget) – The shell widget that will have its associated widget removed.
Return type:: None

add_errored_shellwidget(shellwidget: spyder.plugins.ipythonconsole.widgets.ShellWidget) → None[source]#

Actions to take when a shell widget has failed with an error.

Parameters:: shellwidget (spyder.plugins.ipythonconsole.widgets.ShellWidget) – The shell widget that failed with an error.
Return type:: None

spyder.api.shellconnect.status