nbsync 0.3.3__tar.gz → 0.3.5__tar.gz

{nbsync-0.3.3 → nbsync-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbsync
-Version: 0.3.3
+Version: 0.3.5
 Summary: A core library to synchronize Jupyter notebooks and Markdown documents, enabling seamless integration and dynamic content execution
 Project-URL: Documentation, https://daizutabi.github.io/nbsync/
 Project-URL: Source, https://github.com/daizutabi/nbsync

{nbsync-0.3.3 → nbsync-0.3.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "nbsync"
-version = "0.3.3"
+version = "0.3.5"
 description = "A core library to synchronize Jupyter notebooks and Markdown documents, enabling seamless integration and dynamic content execution"
 readme = "README.md"
 license = { file = "LICENSE" }

{nbsync-0.3.3 → nbsync-0.3.5}/src/nbsync/cell.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import html
 import textwrap
 import uuid
 from dataclasses import dataclass
@@ -26,7 +27,7 @@ class Cell:
     content: bytes | str
     """The content of the image."""
 
-    def convert(self) -> str:
+    def convert(self, *, escape: bool = False) -> str:
         kind = self.image.attributes.pop("source", "")
         tabs = self.image.attributes.pop("tabs", "")
         identifier = self.image.attributes.pop("identifier", "")
@@ -49,8 +50,8 @@ class Cell:
                 include_attrs=True,
                 include_identifier=bool(identifier),
             )
-            result, self.image.url = self.content, ""
-            result = result.rstrip()
+            self.image.url = ""
+            result = get_text_markdown(self, escape=escape)
 
         else:
             source = get_source(
@@ -58,7 +59,7 @@ class Cell:
                 include_attrs=False,
                 include_identifier=bool(identifier),
             )
-            result = get_result(self)
+            result = get_image_markdown(self)
 
         if markdown := get_markdown(kind, source, result, tabs):
             return textwrap.indent(markdown, self.image.indent)
@@ -84,7 +85,19 @@ def get_source(
     return f"```{attr}\n{source}\n```"
 
 
-def get_result(cell: Cell) -> str:
+def get_text_markdown(cell: Cell, *, escape: bool = False) -> str:
+    text = str(cell.content.rstrip())
+
+    if lang := cell.image.attributes.get("result", ""):
+        return f"```{lang}\n{text}\n```"
+
+    if escape and cell.mime == "text/plain":
+        return html.escape(text)
+
+    return text
+
+
+def get_image_markdown(cell: Cell) -> str:
     msg = f"{cell.image.url}#{cell.image.identifier} [{cell.mime}]"
     logger.debug(f"Converting image: {msg}")
 

{nbsync-0.3.3 → nbsync-0.3.5}/tests/test_cell.py

@@ -1,3 +1,5 @@
+import textwrap
+
 import nbformat
 import nbstore.notebook
 import pytest
@@ -38,7 +40,7 @@ def convert(sync: Synchronizer):
     def convert(text: str) -> str:
         cell = next(sync.convert(text))
         assert isinstance(cell, Cell)
-        return cell.convert()
+        return cell.convert(escape=True)
 
     return convert
 
@@ -106,3 +108,36 @@ def test_unknown(convert):
 def test_code_block_exec(convert):
     x = convert('```python exec="1" source="1"\nprint(1+1)\n```')
     assert x == "```python\nprint(1+1)\n```\n\n2"
+
+
+def test_code_block_exec_escape_print(convert):
+    x = convert('```python exec="1" source="1"\nprint("<1>")\n```')
+    assert x == '```python\nprint("<1>")\n```\n\n&lt;1&gt;'
+
+
+def test_code_block_exec_escape_stream(convert):
+    x = convert('```python exec="1" source="1"\n"<1>"\n```')
+    assert x == '```python\n"<1>"\n```\n\n&#x27;&lt;1&gt;&#x27;'
+
+
+def test_code_block_exec_result(convert):
+    x = convert('```python exec="1" result="text"\nprint(1+1)\nprint("<1>")\n```')
+    assert x == "```text\n2\n<1>\n```"
+
+
+def test_code_block_html(convert):
+    src = textwrap.dedent("""\
+    from IPython.display import HTML
+    HTML("<div>a</div>")
+    """)
+    x = convert(f'```python exec="1"\n{src}```')
+    assert x == "<div>a</div>"
+
+
+def test_code_block_html_result(convert):
+    src = textwrap.dedent("""\
+    from IPython.display import HTML
+    HTML("<div>a</div>")
+    """)
+    x = convert(f'```python exec="1" result="html"\n{src}```')
+    assert x == "```html\n<div>a</div>\n```"