markdown-exec 1.8.1__tar.gz → 1.8.3__tar.gz

{markdown_exec-1.8.1 → markdown_exec-1.8.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-exec
-Version: 1.8.1
+Version: 1.8.3
 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>

{markdown_exec-1.8.1 → markdown_exec-1.8.3}/pyproject.toml

@@ -40,7 +40,7 @@ classifiers = [
 dependencies = [
     "pymdown-extensions>=9",
 ]
-version = "1.8.1"
+version = "1.8.3"
 
 [project.license]
 text = "ISC"

markdown_exec-1.8.3/src/markdown_exec/formatters/_exec_python.py

@@ -0,0 +1,8 @@
+"""Special module without future annotations for executing Python code."""
+
+from typing import Any, Dict, Optional
+
+
+def exec_python(code: str, filename: str, exec_globals: Optional[Dict[str, Any]] = None) -> None:
+    compiled = compile(code, filename=filename, mode="exec")
+    exec(compiled, exec_globals)  # noqa: S102

{markdown_exec-1.8.1 → markdown_exec-1.8.3}/src/markdown_exec/formatters/python.py

@@ -2,12 +2,16 @@
 
 from __future__ import annotations
 
+import re
+import sys
 import traceback
 from collections import defaultdict
 from functools import partial
 from io import StringIO
+from types import ModuleType
 from typing import Any
 
+from markdown_exec.formatters._exec_python import exec_python
 from markdown_exec.formatters.base import ExecutionError, base_format
 from markdown_exec.rendering import code_block
 
@@ -51,12 +55,20 @@ def _run_python(
     _code_blocks[code_block_id] = code.split("\n")
     exec_globals = _sessions_globals[session] if session else {}
 
+    # Other libraries expect functions to have a valid `__module__` attribute.
+    # To achieve this, we need to add a `__name__` attribute to the globals.
+    # We compute the name from the code block ID, replacing invalid characters with `_`.
+    # We also create a module object with the same name and add it to `sys.modules`,
+    # because that's what yet other libraries expect (`dataclasses` for example).
+    module_name = re.sub(r"[^a-zA-Z\d]+", "_", code_block_id)
+    exec_globals["__name__"] = module_name
+    sys.modules[module_name] = ModuleType(module_name)
+
     buffer = StringIO()
     exec_globals["print"] = partial(_buffer_print, buffer)
 
     try:
-        compiled = compile(code, filename=code_block_id, mode="exec")
-        exec(compiled, exec_globals)  # noqa: S102
+        exec_python(code, code_block_id, exec_globals)
     except Exception as error:  # noqa: BLE001
         trace = traceback.TracebackException.from_exception(error)
         for frame in trace.stack:

{markdown_exec-1.8.1 → markdown_exec-1.8.3}/tests/test_python.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import re
 from textwrap import dedent
 from typing import TYPE_CHECKING
 
@@ -182,3 +183,49 @@ def test_removing_output_from_pycon_code(md: Markdown) -> None:
     )
     assert "ok" in html
     assert "ko" not in html
+
+
+def test_functions_have_a_module_attribute(md: Markdown) -> None:
+    """Assert functions have a `__module__` attribute.
+
+    Parameters:
+        md: A Markdown instance (fixture).
+    """
+    html = md.convert(
+        dedent(
+            """
+            ```python exec="1"
+            def func():
+                pass
+
+            print(f"`{func.__module__}`")
+            ```
+            """,
+        ),
+    )
+    assert "_code_block_n" in html
+
+
+def test_future_annotations_do_not_leak_into_user_code(md: Markdown) -> None:
+    """Assert future annotations do not leak into user code.
+
+    Parameters:
+        md: A Markdown instance (fixture).
+    """
+    html = md.convert(
+        dedent(
+            """
+            ```python exec="1"
+            class Int:
+                ...
+
+            def f(x: Int) -> None:
+                return x + 1.0
+
+            print(f"`{f.__annotations__['x']}`")
+            ```
+            """,
+        ),
+    )
+    assert "<code>Int</code>" not in html
+    assert re.search(r"class '_code_block_n\d+_\.Int'", html)