refactor: one isnotebook() for the whole package

src/roboticstoolbox/backends/PyPlot/PyPlot.py

@@ -18,6 +18,7 @@
 from roboticstoolbox.backends.Connector import Connector
 from roboticstoolbox.backends.PyPlot.EllipsePlot import EllipsePlot, ShapePlot
 from roboticstoolbox.backends.PyPlot.RobotPlot import RobotPlot
+from roboticstoolbox.tools.plot import isnotebook as _isnotebook
 from roboticstoolbox.tools.plot import plane_view, set_window_title
 from roboticstoolbox.tools.types import ArrayLike
 
@@ -848,41 +849,6 @@ def update(val: float, text: list[Any], robot: Any) -> None:  # pragma: no cover
         self.step()
 
 
-def _isnotebook() -> bool:
-    """
-    Determine if code is being run from a Jupyter notebook or JupyterLite
-
-    ``_isnotebook`` is True if running Jupyter notebook, JupyterLite, Google Colab, or
-    similar, else False
-
-    :references:
-
-        - https://stackoverflow.com/questions/15411967/how-can-i-check-if-code-
-        is-executed-in-the-ipython-notebook/39662359#39662359
-    """
-    import sys
-
-    # Check if running in Pyodide/JupyterLite
-    if sys.platform == "emscripten":
-        return True
-
-    # Colab's shell is google.colab._shell.Shell, not a ZMQInteractiveShell
-    if "google.colab" in sys.modules:
-        return True
-
-    # Fall back to checking IPython shell type
-    try:
-        shell = get_ipython().__class__.__name__  # type: ignore[name-defined]
-        if shell == "ZMQInteractiveShell":
-            return True  # Jupyter notebook or qtconsole
-        elif shell == "TerminalInteractiveShell":
-            return False  # Terminal running IPython
-        else:
-            return False  # Other type (?)
-    except NameError:
-        return False  # Probably standard Python interpreter
-
-
 def _resolve_render_mode(
     render_mode: str | None = None, animation: bool = False
 ) -> str:

src/roboticstoolbox/mobile/Vehicle.py

@@ -27,6 +27,7 @@
 from roboticstoolbox.mobile.Animations import VehicleAnimationBase, VehiclePolygon
 from roboticstoolbox.mobile.drivers import VehicleDriverBase
 from roboticstoolbox.mobile.workspace import WorkspaceLike, resolve_workspace
+from roboticstoolbox.tools.plot import isnotebook as _isnotebook
 from roboticstoolbox.tools.plot import set_window_title
 from roboticstoolbox.tools.types import ArrayLike, NDArray
 
@@ -36,27 +37,6 @@
 )
 
 
-def _isnotebook() -> bool:
-    """
-    Determine if code is being run from a Jupyter notebook or JupyterLite.
-    """
-    if sys.platform == "emscripten":
-        return True
-
-    if "ipykernel" in sys.modules or "google.colab" in sys.modules:
-        return True
-
-    try:
-        get_ipython_fn = globals().get("get_ipython", None)
-        if callable(get_ipython_fn):
-            shell = get_ipython_fn().__class__.__name__
-            if shell == "ZMQInteractiveShell":
-                return True
-        return False
-    except Exception:
-        return False
-
-
 def _refresh_animation_frame(
     fig: Figure | SubFigure | None, dt: float, pause: bool
 ) -> None:

src/roboticstoolbox/tools/plot.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import sys
 from typing import Any
 
 import matplotlib.pyplot as plt
@@ -232,3 +233,36 @@ def xplot(
     apply_block(block)
 
     return fig.get_axes()
+
+
+def isnotebook() -> bool:
+    """
+    Determine if code is being run from a Jupyter notebook or JupyterLite
+
+    ``isnotebook`` is True if running Jupyter notebook, JupyterLite, Google Colab, or
+    similar, else False
+
+    :references:
+
+        - https://stackoverflow.com/questions/15411967/how-can-i-check-if-code-
+        is-executed-in-the-ipython-notebook/39662359#39662359
+    """
+    # Check if running in Pyodide/JupyterLite
+    if sys.platform == "emscripten":
+        return True
+
+    # Colab's shell is google.colab._shell.Shell, not a ZMQInteractiveShell
+    if "google.colab" in sys.modules:
+        return True
+
+    # Fall back to checking IPython shell type
+    try:
+        shell = get_ipython().__class__.__name__  # type: ignore[name-defined]
+        if shell == "ZMQInteractiveShell":
+            return True  # Jupyter notebook or qtconsole
+        elif shell == "TerminalInteractiveShell":
+            return False  # Terminal running IPython
+        else:
+            return False  # Other type (?)
+    except NameError:
+        return False  # Probably standard Python interpreter

tests/test_render_mode.py

@@ -186,3 +186,47 @@ def test_colab_with_ipympl_is_a_widget_for_a_static_plot(monkeypatch):
 
     assert _resolve_render_mode(None) == "notebook-widget"
     assert _resolve_render_mode(None, animation=True) == "notebook-inline"
+
+
+# --- one notebook check for the whole package ---------------------------------
+
+
+def test_mobile_uses_the_same_notebook_check():
+    from roboticstoolbox.tools.plot import isnotebook
+
+    # the package also exports a class called Vehicle, so ask for the module
+    vehicle_module = sys.modules["roboticstoolbox.mobile.Vehicle"]
+
+    assert pyplot_module._isnotebook is isnotebook
+    assert vehicle_module._isnotebook is isnotebook
+
+
+def _shell(monkeypatch, name):
+    import builtins
+
+    monkeypatch.delitem(sys.modules, "google.colab", raising=False)
+    monkeypatch.setattr(sys, "platform", "linux")
+    shell = type(name, (), {})()
+    monkeypatch.setattr(builtins, "get_ipython", lambda: shell, raising=False)
+
+
+def test_a_jupyter_kernel_is_a_notebook(monkeypatch):
+    from roboticstoolbox.tools.plot import isnotebook
+
+    _shell(monkeypatch, "ZMQInteractiveShell")
+
+    assert isnotebook() is True
+
+
+def test_ipython_in_a_terminal_is_not_a_notebook_even_if_ipykernel_is_loaded(
+    monkeypatch,
+):
+    # the check the mobile module used to have counted a loaded ipykernel
+    import types
+
+    from roboticstoolbox.tools.plot import isnotebook
+
+    _shell(monkeypatch, "TerminalInteractiveShell")
+    monkeypatch.setitem(sys.modules, "ipykernel", types.ModuleType("ipykernel"))
+
+    assert isnotebook() is False