feat: new layout rendering is optimised for readability on tiny screen

Author: akopdev

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nbcat"
-version = "0.10.0"
+version = "0.11.0"
 description = "cat for jupyter notebooks"
 authors = [
     { name = "Akop Kesheshyan", email = "devnull@akop.dev" }

src/nbcat/__init__.py

@@ -1 +1 @@
-__version__ = "0.10.0"
+__version__ = "0.11.0"

src/nbcat/image.py

@@ -10,19 +10,22 @@
 
 
 class Image:
-    def __init__(self, image: str):
+    def __init__(self, image: str, method: str = "a24h"):
         img = BytesIO(base64.b64decode(image.replace("\n", "")))
         self.image = PilImage.open(img)
-
-    @property
-    def method_class(self):
-        # TODO: auto detect terminal to benefit from sixel protocol support
-        method = "a24h" if system() != "Windows" else "ascii"
-        return METHODS[method]["class"]
+        self.method = method if system() != "Windows" else "ascii"
 
     def __rich_console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
-        img = Renderer()
-        img.load_image(self.image)
-        img.resize(shutil.get_terminal_size()[0] - 1)
-        output = img.to_string(self.method_class)
-        yield Text.from_ansi(output)
+        renderer = Renderer()
+        renderer.load_image(self.image)
+        width = shutil.get_terminal_size()[0] - 1
+        if self.method == "sixel":
+            width = width * 6
+
+        renderer.resize(width)
+
+        if self.method == "sixel":
+            renderer.reduce_colors(16)
+
+        output = renderer.to_string(METHODS[self.method]["class"])
+        yield Text.from_ansi(output, no_wrap=True, end="")

src/nbcat/main.py

@@ -1,18 +1,17 @@
 import argparse
 import sys
 from pathlib import Path
-from typing import Union
 
 import argcomplete
 import requests
 from argcomplete.completers import FilesCompleter
 from pydantic import ValidationError
 from rich import box
-from rich.console import Console, RenderableType
+from rich.console import Console, Group, RenderableType
+from rich.padding import Padding
 from rich.panel import Panel
 from rich.pretty import Pretty
 from rich.syntax import Syntax
-from rich.table import Table
 from rich.text import Text
 
 from . import __version__
@@ -69,7 +68,7 @@ def read_notebook(fp: str, debug: bool = False) -> Notebook:
         raise InvalidNotebookFormatError(f"Invalid notebook: {e}")
 
 
-def render_cell(cell: Cell) -> list[tuple[Union[str, None], RenderableType]]:
+def render_cell(cell: Cell) -> RenderableType:
     """
     Render the content of a notebook cell for display.
 
@@ -86,15 +85,17 @@ def render_cell(cell: Cell) -> list[tuple[Union[str, None], RenderableType]]:
     """
 
     def _render_markdown(input: str) -> Markdown:
-        return Markdown(input)
+        return Markdown(input, code_theme="ansi_dark")
 
-    def _render_code(input: str) -> Panel:
-        return Panel(Syntax(input, "python", theme="ansi_dark"), box=box.SQUARE)
+    def _render_code(input: str, language: str = "python") -> Panel:
+        return Panel(
+            Syntax(input, language, line_numbers=True, theme="ansi_dark", dedent=True), padding=0
+        )
 
     def _render_raw(input: str) -> Text:
         return Text(input)
 
-    def _render_image(input: str) -> None:
+    def _render_image(input: str) -> Image:
         return Image(input)
 
     def _render_json(input: str) -> Pretty:
@@ -111,31 +112,21 @@ def _render_json(input: str) -> Pretty:
         OutputCellType.JSON: _render_json,
     }
 
-    rows: list[tuple[Union[str, None], RenderableType]] = []
+    rows: list[RenderableType] = []
     renderer = RENDERERS.get(cell.cell_type)
     source = renderer(cell.input) if renderer else None
     if source:
-        label = f"[green][{cell.execution_count}][/]" if cell.execution_count else None
-        rows.append(
-            (
-                label,
-                source,
-            )
-        )
+        rows.append(Padding(source, (1, 0)))
+        if not cell.outputs:
+            return source
 
     for o in cell.outputs:
         if o.output:
             renderer = RENDERERS.get(o.output.output_type)
             output = renderer(o.output.text) if renderer else None
             if output:
-                label = f"[blue][{o.execution_count}][/]" if o.execution_count else None
-                rows.append(
-                    (
-                        label,
-                        output,
-                    )
-                )
-    return rows
+                rows.append(Panel(output, style="italic", box=box.MINIMAL))
+    return Group(*rows)
 
 
 def print_notebook(nb: Notebook):
@@ -149,15 +140,17 @@ def print_notebook(nb: Notebook):
         console.print("[bold red]Notebook contains no cells.")
         return
 
-    layout = Table.grid(padding=1)
-    layout.add_column(no_wrap=True, width=6)
-    layout.add_column()
-
     for cell in nb.cells:
-        for label, content in render_cell(cell):
-            layout.add_row(label, content)
-
-    console.print(layout)
+        rendered = render_cell(cell)
+        if isinstance(rendered, Group):
+            out = Panel(
+                rendered,
+                title=f"[green][{cell.execution_count}][/]" if cell.execution_count else None,
+                title_align="left",
+            )
+        else:
+            out = Padding(rendered, (1, 0))
+        console.print(out)
 
 
 def main():

tests/test_render_cell.py

@@ -1,4 +1,5 @@
 import pytest
+from rich.console import Group, RenderableType
 from rich.markdown import Markdown
 from rich.panel import Panel
 from rich.text import Text
@@ -16,14 +17,11 @@
         ("heading", "Heading text", Markdown),
     ],
 )
-def test_render_cell_input_rendering(cell_type: str, source: str, expected):
+def test_render_cell_input_rendering(cell_type: str, source: str, expected: RenderableType):
     cell = Cell(cell_type=cell_type, source=source, execution_count=42, outputs=[])
     rendered = render_cell(cell)
 
-    assert len(rendered) == 1
-    label, content = rendered[0]
-    assert label == "[green][42][/]"
-    assert isinstance(content, expected)
+    assert isinstance(rendered, expected)
 
 
 def test_render_cell_with_outputs():
@@ -39,16 +37,8 @@ def test_render_cell_with_outputs():
 
     rendered = render_cell(cell)
 
-    print(rendered)
-    assert len(rendered) == 3
-    assert rendered[0][0] is None
-    assert isinstance(rendered[0][1], Panel)
-
-    assert rendered[1][0] == "[blue][7][/]"
-    assert isinstance(rendered[1][1], Text)
-
-    assert rendered[2][0] is None
-    assert isinstance(rendered[2][1], Text)
+    assert isinstance(rendered, Group)
+    assert len(rendered.renderables) == 3
 
 
 def test_render_cell_skips_empty_outputs():
@@ -62,6 +52,4 @@ def test_render_cell_skips_empty_outputs():
 
     rendered = render_cell(cell)
 
-    assert len(rendered) == 1  # Only source input is rendered
-    assert rendered[0][0] == "[green][1][/]"
-    assert isinstance(rendered[0][1], Text)
+    assert isinstance(rendered, Group)