Don’t render JSON by default and add min tests (#81)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: flying-sheep

.github/workflows/ci.yml

@@ -14,7 +14,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.10', '3.13']
+        include:
+          - python-version: '3.10'
+          - python-version: '3.13'
+          - python-version: '3.13'
+            extras: min
     steps:
     - uses: actions/checkout@v4
       with:
@@ -26,7 +30,7 @@ jobs:
     - uses: hynek/setup-cached-uv@v2
       with:
         cache-dependency-path: pyproject.toml
-    - run: uv pip install --system -e .[test,jupyter]
+    - run: uv pip install --system -e .[${{ matrix.extras == 'min' && 'test' || 'test,jupyter' }}]
     - uses: pavelzw/pytest-action@v2
       with:
         custom-arguments: --color=yes

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
   hooks:
     - id: pyproject-fmt
 - repo: https://github.com/biomejs/pre-commit
-  rev: v0.6.0
+  rev: v0.6.1
   hooks:
   - id: biome-format
     additional_dependencies: ["@biomejs/[email protected]"]

pyproject.toml

@@ -56,10 +56,17 @@ urls.Source = "https://github.com/flying-sheep/session-info2"
 [tool.hatch.version]
 source = "vcs"
 
+[[tool.hatch.envs.hatch-test.matrix]]
+python = [ "3.10", "3.11", "3.12", "3.13" ]
+deps = [ "all", "min" ]
+
 [tool.hatch.envs.hatch-test]
 default-args = [  ]
-features = [ "test", "jupyter" ]
+features = [ "test" ]
 extra-dependencies = [ "pyinstrument" ]
+overrides.matrix.deps.features = [
+  { if = [ "all" ], value = "jupyter" },
+]
 
 [tool.hatch.envs.notebook]
 # installer = "uv"  # https://github.com/astral-sh/uv/issues/6032

src/session_info2/_repr.py

@@ -2,7 +2,7 @@
 from __future__ import annotations
 
 import json
-import traceback
+import warnings
 from textwrap import dedent, indent
 from types import MappingProxyType
 from typing import TYPE_CHECKING, Any, Literal, TypeAlias
@@ -153,6 +153,9 @@ def repr_widget(si: SessionInfo) -> dict[str, str]:
 )
 
 
+DEFAULT_EXCLUDE = {"application/json"}
+
+
 def repr_mimebundle(
     si: SessionInfo,
     include: Container[str] | None = None,
@@ -170,8 +173,14 @@ def repr_mimebundle(
             continue
         if exclude is not None and mime in exclude:
             continue
+        if mime in DEFAULT_EXCLUDE and (include is None or mime not in include):
+            continue
         try:
             mb[mime] = repr_fn(si)
-        except ImportError:
-            traceback.print_exc()
+        except ImportError as e:
+            msg = (
+                f"Failed to import dependencies for {mime} representation. "
+                f"({type(e).__name__}: {e})"
+            )
+            warnings.warn(msg, RuntimeWarning, stacklevel=8)
     return mb

tests/test_subprocess.py

@@ -5,7 +5,8 @@
 
 import json
 import re
-from typing import TYPE_CHECKING, Any
+from importlib.util import find_spec
+from typing import TYPE_CHECKING, Any, Literal, TypedDict
 
 import pytest
 from jupyter_client.manager import start_new_async_kernel
@@ -18,7 +19,33 @@
 
     from jupyter_client.asynchronous.client import AsyncKernelClient
 
-    Execute = Callable[[str], Awaitable[list[dict[str, str]]]]
+    class Result(TypedDict):  # noqa: D101
+        msg_type: Literal["execute_result"]
+        data: dict[str, str]
+        metadata: dict[str, str]
+
+    class Display(TypedDict):  # noqa: D101
+        msg_type: Literal["display_data"]
+        data: dict[str, str]
+        metadata: dict[str, str]
+
+    class Stream(TypedDict):  # noqa: D101
+        msg_type: Literal["stream"]
+        name: str
+        text: str
+
+    SimpleMsg = Result | Display | Stream
+
+    Execute = Callable[[str], Awaitable[list["SimpleMsg"]]]
+
+
+HAS_IPYWIDGETS = bool(find_spec("ipywidgets"))
+
+
+def simple_msg(msg: dict[str, Any]) -> SimpleMsg | None:
+    if msg["header"]["msg_type"] not in {"execute_result", "display_data", "stream"}:
+        return None
+    return dict(msg_type=msg["header"]["msg_type"], **msg["content"])  # type: ignore[return-value]
 
 
 @pytest.fixture(scope="session")
@@ -33,7 +60,7 @@ async def kernel_client() -> AsyncGenerator[AsyncKernelClient, None]:
 async def execute(
     kernel_client: AsyncKernelClient, libdir_test: Path
 ) -> AsyncGenerator[Execute, None]:
-    async def execute(code: str) -> list[dict[str, str]]:
+    async def execute(code: str) -> list[SimpleMsg]:
         await kernel_client.wait_for_ready()
         msgs: list[dict[str, Any]] = []
         reply = await kernel_client.execute_interactive(  # pyright: ignore[reportUnknownMemberType]
@@ -48,11 +75,7 @@ async def execute(code: str) -> list[dict[str, str]]:
             pytest.fail("{ename}: {evalue}\n{traceback}".format_map(content))
         elif reply["content"]["status"] != "ok":
             pytest.fail(f"Unexpected reply status: {reply['content']['status']}")
-        return [
-            msg["content"]["data"]
-            for msg in msgs
-            if msg["header"]["msg_type"] == "execute_result"
-        ]
+        return [smsg for msg in msgs if (smsg := simple_msg(msg)) is not None]
 
     await execute(
         f"""
@@ -100,15 +123,25 @@ async def execute(code: str) -> list[dict[str, str]]:
 )
 async def test_run(execute: Execute, code: str, expected: str) -> None:
     await execute(code)
-    [mimebundle] = await execute(RUN)
-    assert mimebundle.keys() == {
+    [*msgs, result] = await execute(RUN)
+
+    if HAS_IPYWIDGETS:
+        assert not msgs
+    else:
+        [msg] = msgs
+        assert msg["msg_type"] == "stream"
+        assert msg["name"] == "stderr"
+        assert f"Failed to import dependencies for {MIME_WIDGET}" in msg["text"]
+        assert "ModuleNotFoundError: No module named 'ipywidgets'" in msg["text"]
+
+    assert result["msg_type"] == "execute_result"
+    assert set(result["data"].keys()) == {
         "text/plain",
         "text/markdown",
         "text/html",
-        "application/json",
-        MIME_WIDGET,
+        *([MIME_WIDGET] if HAS_IPYWIDGETS else []),
     }
-    r = mimebundle["text/plain"]
+    r = result["data"]["text/plain"]
     pkgs, info = r.split("\n----\t----\n") if "----" in r else ("", r)
     assert pkgs == expected
     # No CPU info by default