nbsync 0.3.10__tar.gz → 0.4.0__tar.gz

{nbsync-0.3.10 → nbsync-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nbsync
-Version: 0.3.10
+Version: 0.4.0
 Summary: A core library to synchronize Jupyter notebooks and Markdown documents, enabling seamless integration and dynamic content execution
 Keywords: jupyter,notebook,documentation,markdown,python,visualization,dynamic-execution,real-time-sync
 Author: daizutabi
@@ -38,7 +38,9 @@ Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Text Processing :: Markup :: Markdown
 Requires-Dist: nbstore>=0.5.2
 Requires-Python: >=3.10
+Project-URL: Changelog, https://github.com/daizutabi/nbsync/releases
 Project-URL: Documentation, https://daizutabi.github.io/nbsync/
+Project-URL: Homepage, https://daizutabi.github.io/nbsync/
 Project-URL: Issues, https://github.com/daizutabi/nbsync/issues
 Project-URL: Source, https://github.com/daizutabi/nbsync
 Description-Content-Type: text/markdown

{nbsync-0.3.10 → nbsync-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "nbsync"
-version = "0.3.10"
+version = "0.4.0"
 description = "A core library to synchronize Jupyter notebooks and Markdown documents, enabling seamless integration and dynamic content execution"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -35,19 +35,26 @@ requires-python = ">=3.10"
 dependencies = ["nbstore>=0.5.2"]
 
 [project.urls]
+Changelog = "https://github.com/daizutabi/nbsync/releases"
 Documentation = "https://daizutabi.github.io/nbsync/"
-Source = "https://github.com/daizutabi/nbsync"
+Homepage = "https://daizutabi.github.io/nbsync/"
 Issues = "https://github.com/daizutabi/nbsync/issues"
+Source = "https://github.com/daizutabi/nbsync"
 
 [dependency-groups]
 dev = [
+  "basedpyright>=1.31.7",
   "ipykernel>=6",
   "matplotlib>=3",
   "nbconvert>=7",
+  "prek>=0.2.12",
   "pytest-cov>=6",
+  "pytest-mock>=3.15.1",
   "pytest-randomly>=3",
+  "ruff>=0.14.0",
+  "ty>=0.0.1a22",
 ]
-docs = ["mkapi", "mkdocs-material"]
+docs = ["mkapi", "mkdocs-material", "mkdocs-nbsync>=0.1.5"]
 
 [tool.pytest.ini_options]
 testpaths = ["src", "tests"]
@@ -82,3 +89,10 @@ ignore = [
 
 [tool.ruff.lint.per-file-ignores]
 "**/tests/*" = ["ANN", "ARG", "D", "FBT", "PGH003", "PLR", "RUF", "S", "SLF"]
+
+[tool.basedpyright]
+include = ["src", "tests"]
+reportAny = false
+reportExplicitAny = false
+reportImportCycles = false
+reportUnusedCallResult = false

{nbsync-0.3.10 → nbsync-0.4.0}/src/nbsync/cell.py

@@ -105,7 +105,7 @@ def get_source(
 
 
 def _add_prompt(source: str) -> str:
-    lines = []
+    lines: list[str] = []
     for line in source.splitlines():
         if not line:
             lines.append("")

{nbsync-0.3.10 → nbsync-0.4.0}/src/nbsync/logger.py

@@ -7,7 +7,9 @@ from typing import Any
 _logger = logging.getLogger("nbsync")
 
 
-def set_logger(logger: Logger | LoggerAdapter | None = None) -> Logger | LoggerAdapter:
+def set_logger(
+    logger: Logger | LoggerAdapter[Logger] | None = None,
+) -> Logger | LoggerAdapter[Logger]:
     global _logger  # noqa: PLW0603
 
     if logger:

{nbsync-0.3.10 → nbsync-0.4.0}/src/nbsync/markdown.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import shlex
 import textwrap
 from typing import TYPE_CHECKING, TypeAlias
 
@@ -40,14 +41,19 @@ def _convert_code_block_attrs(code_block: CodeBlock) -> CodeBlock | Image:
     if exec_ != "1" or not code_block.classes:
         return code_block
 
-    if code_block.classes[0] != "python":
+    if code_block.classes[0] == "python":
+        classes = code_block.classes[1:]
+    elif code_block.classes[0] == "console":
+        classes = code_block.classes
+    else:
         return code_block
 
     del code_block.attributes["exec"]
+
     return Image(
         code_block.indent,
         "",
-        code_block.classes[1:],
+        classes,
         code_block.attributes,
         code_block.source,
         url=".md",
@@ -62,7 +68,7 @@ def convert_image(image: Image, index: int | None = None) -> Iterator[Element]:
             raise ValueError(msg)
 
         image.identifier = image.identifier or f"image-nbsync-{index}"
-        yield CodeBlock("", image.identifier, [], {}, image.source, image.url)
+        yield create_code_block(image)
         yield image
 
     elif image.identifier:
@@ -72,6 +78,29 @@ def convert_image(image: Image, index: int | None = None) -> Iterator[Element]:
         yield image.text
 
 
+def create_code_block(image: Image) -> CodeBlock:
+    if "console" in image.classes:
+        source = create_subprocess_source(image.source)
+    else:
+        source = image.source
+
+    return CodeBlock("", image.identifier, [], {}, source, image.url)
+
+
+def create_subprocess_source(source: str) -> str:
+    """Create a Python source that runs the command in subprocess."""
+    args = shlex.split(source)
+    if not args:
+        return ""
+
+    if args[0] in ["$", "#", ">"]:
+        args = args[1:]
+
+    return textwrap.dedent(f"""\
+    import subprocess
+    print(subprocess.check_output({args}, text=True).rstrip())""")
+
+
 SUPPORTED_EXTENSIONS = (".ipynb", ".md", ".py")
 
 

{nbsync-0.3.10 → nbsync-0.4.0}/src/nbsync/sync.py

@@ -72,7 +72,7 @@ def update_notebooks(
 
     if url not in notebooks:
         if url == ".md":
-            notebooks[url] = Notebook(nbformat.v4.new_notebook())
+            notebooks[url] = Notebook(nbformat.v4.new_notebook())  # pyright: ignore[reportUnknownMemberType]
         else:
             try:
                 notebooks[url] = Notebook(store.read(url))
@@ -101,6 +101,10 @@ def convert(
                 return ""
 
             nb = notebooks[elem.url].nb
+
+            if "console" in elem.classes:
+                return convert_console(elem, nb)
+
             return convert_image(elem, nb)
 
         return convert_code_block(elem)
@@ -121,6 +125,24 @@ def convert_image(image: Image, nb: NotebookNode) -> Cell:
     return Cell(image, get_language(nb), *mime_content)
 
 
+def remove_ansi(text: str) -> str:
+    return re.sub(r"\x1B\[[0-?]*[ -/]*[@-~]", "", text)
+
+
+def convert_console(image: Image, nb: NotebookNode) -> str:
+    result = image.attributes.get("result", "bash")
+    if result == "1":
+        result = "bash"
+
+    source = image.attributes.get("source", None)
+    source = f"{image.source}\n" if is_truelike(source) else ""
+
+    _, content = get_mime_content(nb, image.identifier)
+    if isinstance(content, str):
+        content = remove_ansi(content)
+    return f"```{result}\n{source}{content}```"
+
+
 def convert_code_block(code_block: CodeBlock) -> str:
     source = code_block.attributes.pop("source", None)
     if not is_truelike(source):