Merge ability to bypass tmux for graphics

Added an option to select graphic protocol + tmux bypass.

Author: lyovushka

src/netbook/__init__.py

@@ -8,6 +8,7 @@
 import nbformat
 
 import textual
+import textual_image.widget
 
 import traitlets
 
@@ -19,8 +20,20 @@ class JupyterNetbook(jupyter_core.application.JupyterApp, jupyter_client.console
     description = """
         A terminal-based app for jupyter notebooks.
     """
+    graphics = traitlets.Enum(
+        ["auto", "kitty", "sixel", "halfcell", "unicode", "tmux-kitty"],
+        default_value="auto",
+        help="Choice of image rendering protocol",
+        config=True,
+    )
     flags = traitlets.Dict({**jupyter_core.application.base_flags, **jupyter_client.consoleapp.app_flags})
-    aliases = traitlets.Dict({**jupyter_core.application.base_aliases, **jupyter_client.consoleapp.app_aliases})
+    aliases = traitlets.Dict(
+        {
+            **jupyter_core.application.base_aliases,
+            **jupyter_client.consoleapp.app_aliases,
+            **{"graphics": "JupyterNetbook.graphics"},
+        }
+    )
 
     kernel_client_class = jupyter_client.asynchronous.AsyncKernelClient
     # kernel_manager_class = jupyter_client.manager.AsyncKernelManager
@@ -42,6 +55,26 @@ def initialize(self, argv):
         if self._dispatching:
             return
 
+        match self.graphics:
+            case "auto":
+                image_class = textual_image.widget.AutoImage
+            case "kitty":
+                image_class = textual_image.widget.TGPImage
+            case "sixel":
+                image_class = textual_image.widget.SixelImage
+            case "halfcell":
+                image_class = textual_image.widget.HalfcellImage
+            case "unicode":
+                image_class = textual_image.widget.UnicodeImage
+            case "tmux-kitty":
+                import textual_image.renderable as r
+
+                r.tgp._TGP_MESSAGE_START = "\x1bPtmux;\x1b\x1b_G"
+                r.tgp._TGP_MESSAGE_END = "\x1b\x1b\\\x1b\\"
+                image_class = textual_image.widget.TGPImage
+            case _:
+                assert False, "unrichable"
+
         nb = None
         nbkernel = None
         # Determine the notebook name and content
@@ -59,16 +92,16 @@ def initialize(self, argv):
                 suffix = suffix + 1 if suffix else 1
             nbfile = f"Untitled{suffix}.ipynb"
 
-        if nbkernel and (
-            "JupyterNetbook" not in self.cli_config or "kernel_name" not in self.cli_config["JupyterNetbook"]
-        ):
+        if nbkernel and "kernel_name" not in self.cli_config.get("JupyterNetbook", {}):
             # If kernel_name is not explicitly specify but is present in the notebook, use that one
             self.kernel_name = nbkernel
 
         jupyter_client.consoleapp.JupyterConsoleApp.initialize(self, argv)
 
         # TODO: if --existing is specified, then self.kernel_manager is None.
-        self.textual_app = JupyterTextualApp(self.kernel_manager, self.kernel_client, nbfile, nb)
+        self.textual_app = JupyterTextualApp(
+            self.kernel_manager, self.kernel_client, nbfile, nb, image_class=image_class
+        )
 
     def start(self):
         jupyter_core.application.JupyterApp.start(self)

src/netbook/_cell.py

@@ -104,6 +104,7 @@ class DisplayData(Output):
     def __init__(self, data: dict[str, tp.Any], metadata: dict[str, tp.Any]) -> None:
         super().__init__()
         self.data, self.metadata = data, metadata
+        self.app: JupyterTextualApp
 
     @tp.override
     def to_nbformat(self) -> nbformat.NotebookNode:
@@ -124,7 +125,7 @@ def compose(self) -> tp.Iterable[textual.widgets.Widget]:
                     if image_key == "image/svg+xml"
                     else base64.b64decode(self.data[image_key])
                 )
-                image = textual_image.widget.Image(io.BytesIO(image_bytes))
+                image = self.app.image_class(io.BytesIO(image_bytes))
                 # We'll set the width/height explicitly since automatically setting it seems hard / impossible.
                 cell_size = textual_image.widget.get_cell_size()
                 image.styles.width = round(image._image_width / cell_size.width)

src/netbook/_textual_app.py

@@ -70,6 +70,7 @@ def __init__(
         kernel_client: jupyter_client.AsyncKernelClient,
         nbfile: str,
         nb: nbformat.NotebookNode | None,
+        image_class: type,
     ) -> None:
         super().__init__()
         self.kernel_manager = kernel_manager
@@ -100,6 +101,8 @@ def __init__(
         self.repeat_key_count = 0
         self.last_key_press_time = time.monotonic()
 
+        self.image_class = image_class
+
         self._load_language()
         self.call_after_refresh(lambda: self.queue_for_kernel(self._initialize_kernel))
 

tests/conftest.py

@@ -5,6 +5,7 @@
 with unittest.mock.patch("sys.__stdout__", None):
     import textual_image.renderable
 import textual_image._terminal
+import textual_image.widget
 
 # Hardcode the cell size - it throws on windows.
 setattr(textual_image._terminal.get_cell_size, "_result", textual_image._terminal.CellSize(10, 20))
@@ -22,7 +23,7 @@ async def pilot(mocker):
     km.kernel_spec.language = "python"
     kc = mocker.Mock()
     kc.execute_interactive = mocker.AsyncMock()
-    app = netbook.JupyterTextualApp(km, kc, "", nb)
+    app = netbook.JupyterTextualApp(km, kc, "", nb, image_class=textual_image.widget.HalfcellImage)
     async with app.run_test() as pilot:
         await pilot.pause()
         yield pilot
@@ -38,7 +39,7 @@ async def pilot_nb(mocker):
     km.kernel_spec.display_name = nb.metadata.kernelspec.display_name
     kc = mocker.Mock()
     kc.execute_interactive = mocker.AsyncMock()
-    app = netbook.JupyterTextualApp(km, kc, nbfile, nb)
+    app = netbook.JupyterTextualApp(km, kc, nbfile, nb, image_class=textual_image.widget.HalfcellImage)
     async with app.run_test() as pilot:
         await pilot.pause()
         yield pilot

tests/test_app.py

@@ -218,7 +218,7 @@ async def test_load_language(mocker: pytest_mock.MockerFixture):
     km.kernel_spec.language = "julia"
     kc = mocker.Mock()
     kc.execute_interactive = mocker.AsyncMock()
-    app = netbook.JupyterTextualApp(km, kc, "", nb)
+    app = netbook.JupyterTextualApp(km, kc, "", nb, image_class=None)
     assert app.tree_sitter_language is not None
     assert app.language_highlights_query != ""
     async with app.run_test() as pilot:
@@ -228,7 +228,7 @@ async def test_load_language(mocker: pytest_mock.MockerFixture):
     # Test when we can't load the language
     km.kernel_spec.language = "R"
     mocker.patch("netbook._textual_app.JupyterTextualApp.notify")
-    app = netbook.JupyterTextualApp(km, kc, "", nb)
+    app = netbook.JupyterTextualApp(km, kc, "", nb, image_class=None)
     app.notify.assert_called_once_with(
         "Syntax highlighting is not available for R. Try installing the package `tree_sitter_r`"
     )