feat: Add ability to render using tabs

Author: pawamoy

src/markdown_exec/__init__.py

@@ -42,8 +42,10 @@ def validator(
     if not exec_value:
         return False
     isolate_value = _to_bool(inputs.pop("isolate", "no"))
+    show_source_value = inputs.pop("show_source", "")
     options["exec"] = exec_value
     options["isolate"] = isolate_value
+    options["show_source"] = show_source_value
     return True
 
 
@@ -56,7 +58,7 @@ def formatter(
     classes: list[str] | None = None,
     id_value: str = "",
     attrs: dict[str, Any] | None = None,
-    **kwargs,
+    **kwargs: Any,
 ) -> str:
     """Execute code and return HTML.
 
@@ -76,8 +78,20 @@ def formatter(
         HTML contents.
     """
     fmt = _formatters.get(language, lambda source, *args, **kwargs: source)
-    return fmt(source, md)
+    return fmt(source, md, **options)
 
 
-def _to_bool(value):
-    return value.lower() not in {"", "no", "off", "false", "0"}
+falsy_values = {"", "no", "off", "false", "0"}
+truthy_values = {"yes", "on", "true", "1"}
+
+
+def _to_bool(value: str) -> bool:
+    return value.lower() not in falsy_values
+
+
+def _to_bool_or_value(value: str) -> bool | str:
+    if value.lower() in falsy_values:
+        return False
+    if value.lower() in truthy_values:
+        return True
+    return value

src/markdown_exec/python.py

@@ -1,11 +1,15 @@
 """Formatter and utils for executing Python code."""
 
 import traceback
-from copy import deepcopy
+from textwrap import indent
 
 from markdown.core import Markdown
 from markupsafe import Markup
 
+from markdown_exec.utils import code_block, tabbed
+
+md_copy = None
+
 
 class MarkdownOutput(Exception):  # noqa: N818
     """Exception to return Markdown."""
@@ -39,22 +43,42 @@ def output_html(text: str) -> None:
     raise HTMLOutput(text)
 
 
-def exec_python(source: str, md: Markdown) -> str:
+def exec_python(source: str, md: Markdown, isolate: bool = False, show_source: str = "", **options) -> str:
     """Execute code and return HTML.
 
     Parameters:
         source: The code to execute.
         md: The Markdown instance.
+        isolate: Whether to run the code in isolation.
+        show_source: Whether to show source as well, and where.
 
     Returns:
         HTML contents.
     """
+    global md_copy
+    if md_copy is None:
+        md_copy = Markdown()
+        md_copy.registerExtensions(md.registeredExtensions, {})
+    if isolate:
+        exec_source = f"def _function():\n{indent(source, prefix=' ' * 4)}\n_function()\n"
+    else:
+        exec_source = source
     try:
-        exec(source)  # noqa: S102
-    except MarkdownOutput as output:
-        return Markup(deepcopy(md).convert(str(output)))
-    except HTMLOutput as output:
-        return str(output)
+        exec(exec_source)  # noqa: S102
+    except MarkdownOutput as raised_output:
+        output = str(raised_output)
+    except HTMLOutput as raised_output:
+        output = f'<div markdown="0">{str(raised_output)}</div>'
     except Exception:
-        return Markup(deepcopy(md).convert(f"```python\n{traceback.format_exc()}\n```"))
-    return ""
+        output = code_block("python", traceback.format_exc())
+    if show_source:
+        source_block = code_block("python", source)
+    if show_source == "above":
+        output = source_block + "\n\n" + output
+    elif show_source == "below":
+        output = output + "\n\n" + source_block
+    elif show_source == "tabbed-left":
+        output = tabbed(("Source", source_block), ("Result", output))
+    elif show_source == "tabbed-right":
+        output = tabbed(("Result", output), ("Source", source_block))
+    return Markup(md_copy.convert(output))

src/markdown_exec/utils.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+from textwrap import indent
+
+
+def code_block(language: str, source: str) -> str:
+    """Format source as a code block.
+
+    Parameters:
+        language: The code block language.
+        source: The source code to format.
+
+    Returns:
+        The formatted code block.
+    """
+    return f"```{language}\n{source}\n```"
+
+
+def tabbed(*tabs: tuple[str, str]) -> str:
+    """Format tabs using `pymdownx.tabbed` extension.
+
+    Parameters:
+        *tabs: Tuples of strings: title and text.
+
+    Returns:
+        The formatted tabs.
+    """
+    parts = []
+    for title, text in tabs:
+        parts.append(f'=== "{title}"')
+        parts.append(indent(text, prefix=" " * 4))
+        parts.append("")
+    return "\n".join(parts)

tests/test_python.py

@@ -38,4 +38,4 @@ def test_output_html(md: Markdown) -> None:
             """
         )
     )
-    assert html == "<p>**Bold!**</p>"
+    assert html == '<div markdown="0">**Bold!**</div>'