Skip to content

Utils

utils #

EnvironmentType #

Bases: str, enum.Enum

Enumeration of different Python execution environments.

Attributes:

Name Type Description
JUPYTER_NOTEBOOK str

Jupyter Notebook or Jupyter Lab.
JUPYTER_QTCONSOLE str

Jupyter QtConsole.
GOOGLE_COLAB str

Google Colaboratory (Cloud-based Jupyter).
VSCODE_NOTEBOOK str

Jupyter Kernel running inside VSCode.
IPYTHON_TERMINAL str

IPython interactive shell in a terminal.
STANDARD_PYTHON str

Standard Python interpreter (script or REPL).

Methods:

Name Description
detect

Detect the current Python execution environment.

detect classmethod #

detect() -> imgtools.vizualize.utils.EnvironmentType

Detect the current Python execution environment.

Returns:

Type Description
imgtools.vizualize.utils.EnvironmentType

The detected environment type.
Source code in src/imgtools/vizualize/utils.py 
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
@classmethod
def detect(cls) -> "EnvironmentType":
    """
    Detect the current Python execution environment.

    Returns
    -------
    EnvironmentType
        The detected environment type.
    """
    try:
        from IPython import get_ipython

        shell = get_ipython().__class__.__name__

        if "COLAB_GPU" in os.environ:
            return cls.GOOGLE_COLAB
        if "VSCODE_PID" in os.environ:
            return cls.VSCODE_NOTEBOOK
        if shell == "ZMQInteractiveShell":
            return cls.JUPYTER_NOTEBOOK  # QtConsole also uses this
        if shell == "TerminalInteractiveShell":
            return cls.IPYTHON_TERMINAL
    except (ImportError, AttributeError):
        pass

    return cls.STANDARD_PYTHON  # Default to standard Python