markdown-exec 1.8.3__py3-none-any.whl → 1.9.0__py3-none-any.whl

markdown_exec/__init__.py

@@ -8,6 +8,7 @@ Utilities to execute code blocks in Markdown files.
 
 from __future__ import annotations
 
+import os
 import re
 from typing import TYPE_CHECKING, Any
 
@@ -26,6 +27,7 @@ from markdown_exec.formatters.tree import _format_tree
 
 __all__: list[str] = ["formatter", "validator"]
 
+MARKDOWN_EXEC_AUTO = [lang.strip() for lang in os.getenv("MARKDOWN_EXEC_AUTO", "").split(",")]
 
 formatters = {
     "bash": _format_bash,
@@ -63,7 +65,7 @@ def validator(
     Returns:
         Success or not.
     """
-    exec_value = _to_bool(inputs.pop("exec", "no"))
+    exec_value = language in MARKDOWN_EXEC_AUTO or _to_bool(inputs.pop("exec", "no"))
     if language not in {"tree", "pyodide"} and not exec_value:
         return False
     id_value = inputs.pop("id", "")
@@ -76,6 +78,8 @@ def validator(
     update_toc_value = _to_bool(inputs.pop("updatetoc", "yes"))
     tabs_value = inputs.pop("tabs", "|".join(default_tabs))
     tabs = tuple(_tabs_re.split(tabs_value, maxsplit=1))
+    workdir_value = inputs.pop("workdir", None)
+    width_value = int(inputs.pop("width", "0"))
     options["id"] = id_value
     options["id_prefix"] = id_prefix_value
     options["html"] = html_value
@@ -85,6 +89,8 @@ def validator(
     options["session"] = session_value
     options["update_toc"] = update_toc_value
     options["tabs"] = tabs
+    options["workdir"] = workdir_value
+    options["width"] = width_value
     options["extra"] = inputs
     return True
 

markdown_exec/formatters/base.py

@@ -2,8 +2,10 @@
 
 from __future__ import annotations
 
+import os
+from contextlib import contextmanager
 from textwrap import indent
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Callable, Iterator
 from uuid import uuid4
 
 from markupsafe import Markup
@@ -18,6 +20,47 @@ logger = get_logger(__name__)
 default_tabs = ("Source", "Result")
 
 
+@contextmanager
+def working_directory(path: str | None = None) -> Iterator[None]:
+    """Change the working directory for the duration of the context.
+
+    Parameters:
+        path: The path to change the working directory to.
+    """
+    if path:
+        old_cwd = os.getcwd()
+        os.chdir(path)
+        try:
+            yield
+        finally:
+            os.chdir(old_cwd)
+    else:
+        yield
+
+
+@contextmanager
+def console_width(width: int | None = None) -> Iterator[None]:
+    """Set the console width for the duration of the context.
+
+    The console width is set using the `COLUMNS` environment variable.
+
+    Parameters:
+        width: The width to set the console to.
+    """
+    if width:
+        old_width = os.environ.get("COLUMNS", None)
+        os.environ["COLUMNS"] = str(width)
+        try:
+            yield
+        finally:
+            if old_width is None:
+                del os.environ["COLUMNS"]
+            else:
+                os.environ["COLUMNS"] = old_width
+    else:
+        yield
+
+
 class ExecutionError(Exception):
     """Exception raised for errors during execution of a code block.
 
@@ -55,6 +98,8 @@ def base_format(
     transform_source: Callable[[str], tuple[str, str]] | None = None,
     session: str | None = None,
     update_toc: bool = True,
+    workdir: str | None = None,
+    width: int | None = None,
     **options: Any,
 ) -> Markup:
     """Execute code and return HTML.
@@ -77,6 +122,7 @@ def base_format(
         session: A session name, to persist state between executed code blocks.
         update_toc: Whether to include generated headings
             into the Markdown table of contents (toc extension).
+        workdir: The working directory to use for the execution.
         **options: Additional options passed from the formatter.
 
     Returns:
@@ -92,7 +138,8 @@ def base_format(
         source_output = code
 
     try:
-        output = run(source_input, returncode=returncode, session=session, id=id, **extra)
+        with working_directory(workdir), console_width(width):
+            output = run(source_input, returncode=returncode, session=session, id=id, **extra)
     except ExecutionError as error:
         identifier = id or extra.get("title", "")
         identifier = identifier and f"'{identifier}' "
@@ -105,9 +152,12 @@ def base_format(
         logger.warning(log_message)
         return markdown.convert(str(error))
 
+    if not output:
+        return Markup()
+
     if html:
         if source:
-            placeholder = str(uuid4())
+            placeholder = f'<div class="{uuid4()}"></div>'
             wrapped_output = add_source(
                 source=source_output,
                 location=source,

markdown_exec/formatters/pyodide.py

@@ -7,16 +7,21 @@ from typing import TYPE_CHECKING, Any
 if TYPE_CHECKING:
     from markdown import Markdown
 
+# All Ace.js themes listed here:
+# https://github.com/ajaxorg/ace/tree/master/src/theme
+
 play_emoji = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8 5.14v14l11-7-11-7Z"></path></svg>'
 clear_emoji = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.14 3c-.51 0-1.02.2-1.41.59L2.59 14.73c-.78.77-.78 2.04 0 2.83L5.03 20h7.66l8.72-8.73c.79-.77.79-2.04 0-2.83l-4.85-4.85c-.39-.39-.91-.59-1.42-.59M17 18l-2 2h7v-2"></path></svg>'
 
-template = """
+assets = """
 <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.16.0/ace.js"></script>
 <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
 <script type="text/javascript" src="https://cdn.jsdelivr.net/pyodide/v0.23.0/full/pyodide.js"></script>
 <link title="light" rel="alternate stylesheet" href="https://cdn.jsdelivr.net/npm/highlightjs-themes@1.0.0/tomorrow.min.css" disabled="disabled">
 <link title="dark" rel="alternate stylesheet" href="https://cdn.jsdelivr.net/npm/highlightjs-themes@1.0.0/tomorrow-night-blue.min.css" disabled="disabled">
+"""
 
+template = """
 <div class="pyodide">
 <div class="pyodide-editor-bar">
 <span class="pyodide-bar-item">Editor (session: %(session)s)</span><span id="%(id_prefix)srun" title="Run: press Ctrl-Enter" class="pyodide-bar-item pyodide-clickable"><span class="twemoji">%(play_emoji)s</span> Run</span>
@@ -43,6 +48,7 @@ def _format_pyodide(code: str, md: Markdown, session: str, extra: dict, **option
     _counter += 1
     install = extra.pop("install", "")
     install = install.split(",") if install else []
+    exclude_assets = extra.pop("assets", "1").lower() in {"0", "false", "no", "off"}
     theme = extra.pop("theme", "tomorrow,tomorrow_night")
     if "," not in theme:
         theme = f"{theme},{theme}"
@@ -57,4 +63,7 @@ def _format_pyodide(code: str, md: Markdown, session: str, extra: dict, **option
         "play_emoji": play_emoji,
         "clear_emoji": clear_emoji,
     }
-    return template % data
+    rendered = template % data
+    if exclude_assets:
+        return rendered
+    return assets + rendered

markdown_exec/formatters/python.py

@@ -69,7 +69,7 @@ def _run_python(
 
     try:
         exec_python(code, code_block_id, exec_globals)
-    except Exception as error:  # noqa: BLE001
+    except Exception as error:
         trace = traceback.TracebackException.from_exception(error)
         for frame in trace.stack:
             if frame.filename.startswith("<code block: "):

markdown_exec/logger.py

@@ -39,22 +39,35 @@ class _Logger:
     _default_logger: Any = logging.getLogger
     _instances: ClassVar[dict[str, _Logger]] = {}
 
+    # See same code in Griffe project.
     def __init__(self, name: str) -> None:
-        # default logger that can be patched by third-party
+        # Default logger that can be patched by third-party.
         self._logger = self.__class__._default_logger(name)
-        # register instance
-        self._instances[name] = self
 
     def __getattr__(self, name: str) -> Any:
-        # forward everything to the logger
+        # Forward everything to the logger.
         return getattr(self._logger, name)
 
+    @classmethod
+    def get(cls, name: str) -> _Logger:
+        """Get a logger instance.
+
+        Parameters:
+            name: The logger name.
+
+        Returns:
+            The logger instance.
+        """
+        if name not in cls._instances:
+            cls._instances[name] = cls(name)
+        return cls._instances[name]
+
     @classmethod
     def _patch_loggers(cls, get_logger_func: Callable) -> None:
-        # patch current instances
+        # Patch current instances.
         for name, instance in cls._instances.items():
             instance._logger = get_logger_func(name)
-        # future instances will be patched as well
+        # Future instances will be patched as well.
         cls._default_logger = get_logger_func
 
 
@@ -67,7 +80,7 @@ def get_logger(name: str) -> _Logger:
     Returns:
         The logger.
     """
-    return _Logger(name)
+    return _Logger.get(name)
 
 
 def patch_loggers(get_logger_func: Callable[[str], Any]) -> None:

markdown_exec/mkdocs_plugin.py

@@ -9,6 +9,7 @@ from typing import TYPE_CHECKING, Any, MutableMapping
 
 from mkdocs.config import config_options
 from mkdocs.config.base import Config
+from mkdocs.exceptions import PluginError
 from mkdocs.plugins import BasePlugin
 from mkdocs.utils import write_file
 
@@ -76,6 +77,15 @@ class MarkdownExecPlugin(BasePlugin[MarkdownExecPluginConfig]):
         Returns:
             The modified config.
         """
+        if "pymdownx.superfences" not in config["markdown_extensions"]:
+            message = "The 'markdown-exec' plugin requires the 'pymdownx.superfences' Markdown extension to work."
+            raise PluginError(message)
+        if self.config.ansi in ("required", True) and not ansi_ok:
+            raise PluginError(
+                "The configuration for the 'markdown-exec' plugin requires "
+                "that it is installed with the 'ansi' extra. "
+                "Install it with 'pip install markdown-exec[ansi]'.",
+            )
         self.mkdocs_config_dir = os.getenv("MKDOCS_CONFIG_DIR")
         os.environ["MKDOCS_CONFIG_DIR"] = os.path.dirname(config["config_file_path"])
         self.languages = self.config.languages

markdown_exec/processors.py

@@ -92,9 +92,9 @@ class InsertHeadings(Treeprocessor):
             if match:
                 counter = int(match.group(1))
                 markup: Markup = self.md.htmlStash.rawHtmlBlocks[counter]  # type: ignore[assignment]
-                if markup in self.headings:
+                if headings := self.headings.get(markup):
                     div = Element("div", {"class": "markdown-exec"})
-                    div.extend(self.headings[markup])
+                    div.extend(headings)
                     el.append(div)
 
 
@@ -104,15 +104,20 @@ class RemoveHeadings(Treeprocessor):
     name = "markdown_exec_remove_headings"
 
     def run(self, root: Element) -> None:  # noqa: D102
+        self._remove_duplicated_headings(root)
+
+    def _remove_duplicated_headings(self, parent: Element) -> None:
         carry_text = ""
-        for el in reversed(root):  # Reversed mainly for the ability to mutate during iteration.
-            for subel in reversed(el):
-                if subel.tag == "div" and subel.get("class") == "markdown-exec":
-                    # Delete the duplicated headings along with their container, but keep the text (i.e. the actual HTML).
-                    carry_text = (subel.text or "") + carry_text
-                    el.remove(subel)
-                elif carry_text:
-                    subel.tail = (subel.tail or "") + carry_text
+        for el in reversed(parent):  # Reversed mainly for the ability to mutate during iteration.
+            if el.tag == "div" and el.get("class") == "markdown-exec":
+                # Delete the duplicated headings along with their container, but keep the text (i.e. the actual HTML).
+                carry_text = (el.text or "") + carry_text
+                parent.remove(el)
+            else:
+                if carry_text:
+                    el.tail = (el.tail or "") + carry_text
                     carry_text = ""
-            if carry_text:
-                el.text = (el.text or "") + carry_text
+                self._remove_duplicated_headings(el)
+
+        if carry_text:
+            parent.text = (parent.text or "") + carry_text

markdown_exec/pyodide.css

@@ -40,6 +40,7 @@ html[data-theme="dark"] {
 .pyodide-output {
     width: 100%;
     margin-bottom: -15px;
+    min-height: 46px;
     max-height: 400px
 }
 

{markdown_exec-1.8.3.dist-info → markdown_exec-1.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-exec
-Version: 1.8.3
+Version: 1.9.0
 Summary: Utilities to execute code blocks in Markdown files.
 Keywords: markdown,python,exec,shell,bash,mkdocs
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development
 Classifier: Topic :: Utilities
@@ -36,9 +37,9 @@ Description-Content-Type: text/markdown
 # Markdown Exec
 
 [![ci](https://github.com/pawamoy/markdown-exec/workflows/ci/badge.svg)](https://github.com/pawamoy/markdown-exec/actions?query=workflow%3Aci)
-[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://pawamoy.github.io/markdown-exec/)
+[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/markdown-exec/)
 [![pypi version](https://img.shields.io/pypi/v/markdown-exec.svg)](https://pypi.org/project/markdown-exec/)
-[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/markdown-exec)
+[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/markdown-exec)
 [![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#markdown-exec:gitter.im)
 
 Utilities to execute code blocks in Markdown files.
@@ -113,6 +114,10 @@ markdown_extensions:
 plugins:
 - search
 - markdown-exec
+
+# SuperFences must still be enabled!
+markdown_extensions:
+- pymdownx.superfences
 ```
 
 We do recommend enabling Markdown Exec with the MkDocs plugin

{markdown_exec-1.8.3.dist-info → markdown_exec-1.9.0.dist-info}/RECORD

@@ -1,26 +1,26 @@
-markdown_exec-1.8.3.dist-info/METADATA,sha256=Zb4ucOswqJdnlb39c6CjEuzb-J-9TssLja6SpsRKcz8,4954
-markdown_exec-1.8.3.dist-info/WHEEL,sha256=vnE8JVcI2Wz7GRKorsPArnBdnW2SWKWGow5gu5tHlRU,90
-markdown_exec-1.8.3.dist-info/entry_points.txt,sha256=W-JWRoZzS5TXRcyVnxYmsaVBV4HSl7B_7uTgtaZ-Pms,81
-markdown_exec-1.8.3.dist-info/licenses/LICENSE,sha256=eZQBcJKqlN0QepmOi0u09hlqKMPFdzWjY6NUWYeJGZs,754
-markdown_exec/__init__.py,sha256=cdQDNiSeWnQ8NK3hqNOfyxKT8uoxLkKm4VI_8E7ztcM,4366
+markdown_exec-1.9.0.dist-info/METADATA,sha256=cDM9KEMiLpxPMIYvTd9GxN_YrTeJqN1mOMqdYlTkeqE,5080
+markdown_exec-1.9.0.dist-info/WHEEL,sha256=vnE8JVcI2Wz7GRKorsPArnBdnW2SWKWGow5gu5tHlRU,90
+markdown_exec-1.9.0.dist-info/entry_points.txt,sha256=W-JWRoZzS5TXRcyVnxYmsaVBV4HSl7B_7uTgtaZ-Pms,81
+markdown_exec-1.9.0.dist-info/licenses/LICENSE,sha256=eZQBcJKqlN0QepmOi0u09hlqKMPFdzWjY6NUWYeJGZs,754
+markdown_exec/__init__.py,sha256=imnxEGJ4SCay2aeK-IMv5lnSwi7NurpPaoETXJZRsIk,4675
 markdown_exec/ansi.css,sha256=6PTJxTSsExVgPbMySCuKjih0gr-fdfx2aZ9--u7zWf0,8090
 markdown_exec/debug.py,sha256=dy0bTd9mTTyTaWuUGNkH0UUdMp2ZThsmGh5q9wt9O0c,2840
 markdown_exec/formatters/__init__.py,sha256=w8ui1JaGUA5SCyWd2pPAAopQ5y6QYtDvOUHUa7KW2Wg,51
 markdown_exec/formatters/_exec_python.py,sha256=eVomRZQQl2DySCZIrtqipmBme3kgwIjjRIu8dl22JdE,323
-markdown_exec/formatters/base.py,sha256=frtAFV1mxi0JMmgESrbmLk5XD-MMAgc6SrmpwLcS3gQ,4761
+markdown_exec/formatters/base.py,sha256=zrkC2XTRGcU2jF2kIWbk0igZMhkQ--9TfMu1ORKp__I,6095
 markdown_exec/formatters/bash.py,sha256=qVn6nPqitUuFX72ll00w_x343zl_bMuXrr-Xyox4dJY,886
 markdown_exec/formatters/console.py,sha256=D2JBIC4MU0ct2MiRCkBO-qo4MiH6Hjy6LXjYAsRmuRA,815
 markdown_exec/formatters/markdown.py,sha256=pd0akvFGUXrc41NABcHUTTkKFA3k5Ju8im-b3kzOvIw,276
 markdown_exec/formatters/pycon.py,sha256=F9xpSRKFWsVpGu5XXybtCkMMJ_PAfyd48Qqo1SWl6RA,854
-markdown_exec/formatters/pyodide.py,sha256=fsAkEq9cgI_-AipV4tS4iXbaOcqQVi-HjJ-VcfMv6aE,2898
-markdown_exec/formatters/python.py,sha256=RMNOPBpTbcF6esxpQ6aW1hpU6YH5OAKq7dcsanUAhiw,3025
+markdown_exec/formatters/pyodide.py,sha256=fxjYM4Ev2FAiANtGhb7ih9D70Qz3kNH4yJvwz8v7Adw,3169
+markdown_exec/formatters/python.py,sha256=RmJtPMTJKb-haFsqSZ2nlx0t7Ref63ZhzGVHlteH0Qg,3009
 markdown_exec/formatters/sh.py,sha256=41kmwFjkyisWYmfJeBMC40kqhEe7sI2E0vvbO9ixjCg,876
 markdown_exec/formatters/tree.py,sha256=4XU1KaNqChkkNxMYanwy6glTE2uwcY8Mz9jBZiIf3zY,2046
-markdown_exec/logger.py,sha256=e06Ih9EonG3KCAPbwraCEYmS0Nt9yRytyMjVJMAREIQ,2109
-markdown_exec/mkdocs_plugin.py,sha256=Bc18zHDQ3b4Q6gvIk2JMTHHebfXQF9z8v5Ox0xt6ReM,4701
-markdown_exec/processors.py,sha256=oRZ6QGEm9V2UfqQij5W4Ygp2vZE8MuY-5nDwoPKrE1w,4291
+markdown_exec/logger.py,sha256=V8b_D19B0NkZuLr6cBQJnQgHAlz6NyqeENqHKWvTk5M,2422
+markdown_exec/mkdocs_plugin.py,sha256=2PdhdDceGjgpHrfRuDcvSJHXZGdPKEKtedAbWTmrCu8,5291
+markdown_exec/processors.py,sha256=sE7ZWz_NisdcOdzQStqzPgvz7qnPkzNy4mqHLy6bugM,4411
 markdown_exec/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-markdown_exec/pyodide.css,sha256=rJ-HW-ymcgUfrZ9Mm6QB1qo6eE-I3YQcqSxTmG1NhvM,849
+markdown_exec/pyodide.css,sha256=7jToXYySNVdX4x9jANwRfjRjYvM6robHibGPWCFzeBQ,871
 markdown_exec/pyodide.js,sha256=6iL-9xA4b9UeZgsxVYq_BiCE-Bwu58NfYwYCzz9C9j0,3845
 markdown_exec/rendering.py,sha256=ssWg6U-7Ez45N6sLak-oGD2e55qtEkPY8T8l7h1RbDM,9459
-markdown_exec-1.8.3.dist-info/RECORD,,
+markdown_exec-1.9.0.dist-info/RECORD,,