Source code for snippets

"""Small Python helpers for interactive analysis and workflow scripts."""

__version__ = "0.1.0"

__all__ = [
    "is_notebook",
    "precision",
    "wrap_sys_exit",
    # modules
    "debugging",
    "monkeypatch",
    "unsupervised",
    "parallel",
    "xr_utils",
]

from contextlib import contextmanager
import numpy as np
from sys import exit


[docs] def is_notebook() -> bool: """Return whether the current interpreter appears to be a notebook shell.""" # CREDIT Gustavo Bezerra https://stackoverflow.com/a/39662359 try: shell = get_ipython().__class__.__name__ # type: ignore if shell == 'ZMQInteractiveShell': return True # Jupyter notebook or qtconsole elif shell == 'TerminalInteractiveShell': return False # Terminal running IPython else: print(f"`get_ipython().__class__.__name__` {shell} is not" "considered notebook.") return False # Other type (?) except NameError: return False # Probably standard Python interpreter
[docs] def precision(uncertainty: float) -> int: """Calculate number of digits to state Use for formating numbers, e.g., in print statements. .. code-block:: python :caption: Example print(f"{value:.{precision(uncertainty)}f}") Args: uncertainty (float): Uncertainty estimate. Returns: int: Number of "significant" decimal digits. """ return max(0, round(1 - np.log10(uncertainty)))
[docs] @contextmanager def wrap_sys_exit(code_dict: set[tuple[Exception, int]] | None = None): """Convert exceptions raised in a context into process exit codes. Args: code_dict: Optional set of ``(exception_type, exit_code)`` pairs. Yields: Control to the wrapped block, then exits with ``0`` on success. """ try: yield except Exception as err: if code_dict is None: exit(1) else: for _exception, exit_code in code_dict: if isinstance(err, _exception): exit(exit_code) exit(1) else: exit(0)