apsbits.utils.helper_functions#

Generic utility helper functions#

`register_bluesky_magics`()	Register Bluesky IPython magics.
`running_in_queueserver`()	Check if we are running in a Bluesky queueserver.
`debug_python`([xmode_level])	Enable detailed debugging for Python exceptions in the IPython environment.
`mpl_setup`()	Configure the Matplotlib backend based on the current environment.
`is_notebook`()	Detect if the current environment is a Jupyter Notebook.

Functions

`debug_python`([xmode_level])	Enable detailed debugging for Python exceptions in the IPython environment.
`get_xmode_level`()	Get the current XMode debug level.
`is_notebook`()	Detect if the current environment is a Jupyter Notebook.
`mpl_setup`()	Configure the Matplotlib backend based on the current environment.
`register_bluesky_magics`()	Register Bluesky IPython magics.
`running_in_queueserver`()	Check if we are running in a Bluesky queueserver.

apsbits.utils.helper_functions.debug_python(xmode_level: str = 'Plain') → None[source]#

Enable detailed debugging for Python exceptions in the IPython environment.

This function adjusts the xmode settings for exception tracebacks based on the provided xmode_level argument.

Args:

xmode_level (str): The level of detail for exception tracebacks.: Defaults to “Minimal”.

apsbits.utils.helper_functions.get_xmode_level() → str[source]#

Get the current XMode debug level.

apsbits.utils.helper_functions.is_notebook() → bool[source]#

Detect if the current environment is a Jupyter Notebook.

Returns:: bool: True if running in a notebook (Jupyter notebook or qtconsole), False otherwise.

apsbits.utils.helper_functions.mpl_setup() → None[source]#

Configure the Matplotlib backend based on the current environment.

For non-queueserver and non-notebook environments, attempts to use the ‘qtAgg’: backend.
If ‘qtAgg’ is not available due to missing dependencies, falls back to the ‘Agg’: backend.
Returns:: None

apsbits.utils.helper_functions.register_bluesky_magics() → None[source]#: Register Bluesky IPython magics.

apsbits.utils.helper_functions.running_in_queueserver() → bool[source]#

Check if we are running in a Bluesky queueserver.