pytest-codeblock 0.5.2__tar.gz → 0.5.4__tar.gz

{pytest_codeblock-0.5.2/src/pytest_codeblock.egg-info → pytest_codeblock-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-codeblock
-Version: 0.5.2
+Version: 0.5.4
 Summary: Pytest plugin to collect and test code blocks in reStructuredText and Markdown files.
 Author-email: Artur Barseghyan <artur.barseghyan@gmail.com>
 Maintainer-email: Artur Barseghyan <artur.barseghyan@gmail.com>

{pytest_codeblock-0.5.2 → pytest_codeblock-0.5.4}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "pytest-codeblock"
 description = "Pytest plugin to collect and test code blocks in reStructuredText and Markdown files."
 readme = "README.rst"
-version = "0.5.2"
+version = "0.5.4"
 requires-python = ">=3.10"
 dependencies = [
     "pytest",
@@ -268,6 +268,60 @@ ignore = [
     "docs/code_of_conduct.rst",
     "docs/security.rst",
     "docs/source_tree.rst",
+    "docs/source_tree_full.rst",
     "docs/make.bat",
     "docs/Makefile",
 ]
+
+[[tool.sphinx-source-tree.files]]
+output = "docs/source_tree_full.rst"
+title = "Full project source-tree"
+
+[[tool.sphinx-source-tree.files]]
+output = "docs/source_tree.rst"
+title = "Project source-tree"
+ignore = [
+    "__pycache__",
+    "*.pyc",
+    "*.pyo",
+    "*.py,cover",
+    ".git",
+    ".hg",
+    ".svn",
+    ".tox",
+    ".nox",
+    ".venv",
+    "venv",
+    "env",
+    "*.egg-info",
+    "dist",
+    "build",
+    "node_modules",
+    ".mypy_cache",
+    ".pytest_cache",
+    ".coverage",
+    "htmlcov",
+    ".idea",
+    ".vscode",
+    ".DS_Store",
+    "Thumbs.db",
+    ".ruff_cache",
+    ".coverage.*",
+    ".secrets.baseline",
+    ".pre-commit-config.yaml",
+    ".pre-commit-hooks.yaml",
+    ".readthedocs.yaml",
+    "CHANGELOG.rst",
+    "CODE_OF_CONDUCT.rst",
+    "LICENSE",
+    "SECURITY.rst",
+    "docs/changelog.rst",
+    "docs/code_of_conduct.rst",
+    "docs/security.rst",
+    "docs/source_tree.rst",
+    "docs/source_tree_full.rst",
+    "docs/make.bat",
+    "docs/Makefile",
+    "examples",
+    "docs",
+]

{pytest_codeblock-0.5.2 → pytest_codeblock-0.5.4}/src/pytest_codeblock/__init__.py

@@ -1,12 +1,12 @@
 from pathlib import Path
 
 from .config import get_config
-from .constants import CODEBLOCK_MARK
+from .constants import CODEBLOCK_MARK, PYTESTRUN_MARK
 from .md import MarkdownFile
 from .rst import RSTFile
 
 __title__ = "pytest-codeblock"
-__version__ = "0.5.2"
+__version__ = "0.5.4"
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
 __copyright__ = "2025-2026 Artur Barseghyan"
 __license__ = "MIT"
@@ -42,3 +42,9 @@ def pytest_configure(config):
             "markers",
             f"{CODEBLOCK_MARK}: pytest-codeblock markers (auto-registered)",
         )
+    # Only register if not already present
+    if PYTESTRUN_MARK not in marker_names:
+        config.addinivalue_line(
+            "markers",
+            f"{PYTESTRUN_MARK}: pytest-codeblock markers (auto-registered)",
+        )

{pytest_codeblock-0.5.2 → pytest_codeblock-0.5.4}/src/pytest_codeblock/constants.py

@@ -4,6 +4,7 @@ __license__ = "MIT"
 __all__ = (
     "CODEBLOCK_MARK",
     "DJANGO_DB_MARKS",
+    "PYTESTRUN_MARK",
     "TEST_PREFIX",
 )
 
@@ -16,3 +17,8 @@ DJANGO_DB_MARKS = {
 TEST_PREFIX = "test_"
 
 CODEBLOCK_MARK = "codeblock"
+
+# When this mark is present on a code block, the plugin will exec() the block
+# and then discover and run any Test* classes / test_* functions found in it,
+# rather than treating the whole block as a single test body.
+PYTESTRUN_MARK = "pytestrun"

{pytest_codeblock-0.5.2 → pytest_codeblock-0.5.4}/src/pytest_codeblock/md.py

@@ -9,8 +9,14 @@ import pytest
 
 from .collector import CodeSnippet, group_snippets
 from .config import get_config
-from .constants import CODEBLOCK_MARK, DJANGO_DB_MARKS, TEST_PREFIX
+from .constants import (
+    CODEBLOCK_MARK,
+    DJANGO_DB_MARKS,
+    PYTESTRUN_MARK,
+    TEST_PREFIX,
+)
 from .helpers import contains_top_level_await, wrap_async_code
+from .pytestrun import run_pytest_style_code
 
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
 __copyright__ = "2025-2026 Artur Barseghyan"
@@ -25,14 +31,12 @@ def parse_markdown(text: str) -> list[CodeSnippet]:
     """
     Parse Markdown text and extract Python code snippets as CodeSnippet
     objects.
-
     Supports:
       - <!-- pytestmark: <mark> --> comments immediately before a code fence
       - <!-- codeblock-name: <name> --> comments for naming
       - <!-- continue: <name> --> comments for grouping with a named snippet
       - Fenced code blocks with ```python (and optional name=<name> in the
         info string)
-
     Captures each snippet's name, code, starting line, and any pytest marks.
     """
     config = get_config()
@@ -195,6 +199,7 @@ class MarkdownFile(pytest.File):
             # Bind the values we need so we don't close over `sn` itself
             _sn_name = sn.name
             _fpath = str(self.path)
+            _is_pytestrun = PYTESTRUN_MARK in sn.marks
 
             # Build list of fixture names requested by this snippet
             _fixture_names: list[str] = list(sn.fixtures)
@@ -213,14 +218,24 @@ class MarkdownFile(pytest.File):
                 sn_name=_sn_name,
                 fpath=_fpath,
                 fixture_names=_fixture_names,
+                is_pytestrun=_is_pytestrun,
             ):
                 # This inner function *actually* has a **fixtures signature,
                 # but we override __signature__ so pytest passes the right
                 # fixtures and names.
                 def test_block(**fixtures):
-                    # Auto-wrap async code
+                    if is_pytestrun:
+                        run_pytest_style_code(
+                            code=code,
+                            snippet_name=sn_name,
+                            path=fpath,
+                        )
+                        return
+
+                    # Normal (non-pytestrun) execution path
                     ex_code = code
                     if contains_top_level_await(code):
+                        # Auto-wrap async code
                         ex_code = wrap_async_code(code)
 
                     try:

pytest_codeblock-0.5.4/src/pytest_codeblock/pytestrun.py

@@ -0,0 +1,63 @@
+"""
+Helper module for running pytest-style tests found inside executed code blocks.
+When a code block is marked with `pytestrun`, its code is written to a
+temporary file and executed by pytest as a subprocess, so that fixtures,
+markers, setup/teardown, and assertions all work correctly.
+"""
+import os
+import subprocess
+import sys
+import tempfile
+
+__author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
+__copyright__ = "2025-2026 Artur Barseghyan"
+__license__ = "MIT"
+__all__ = ("run_pytest_style_code",)
+
+
+def run_pytest_style_code(
+    code: str,
+    snippet_name: str,
+    path: str,
+) -> None:
+    """
+    Write the code block to a temporary file and run it with pytest.
+    Raises AssertionError on any test failures.
+    """
+    project_root = os.getcwd()
+    # Place the temp directory alongside the source file so that pytest walks
+    # up through its real directory hierarchy and discovers conftest.py files
+    # (including project-root ones that define fixtures).
+    source_dir = os.path.dirname(os.path.abspath(path))
+    pytest_cache_dir = os.path.join(source_dir, ".pytest_cache")
+    os.makedirs(pytest_cache_dir, exist_ok=True)
+    tmpdir = tempfile.mkdtemp(prefix="pytest_codeblock_", dir=pytest_cache_dir)
+    tmpfile = os.path.join(tmpdir, f"{snippet_name}.py")
+    try:
+        with open(tmpfile, "w") as f:
+            f.write(code)
+        env = os.environ.copy()
+        env["PYTHONPATH"] = os.pathsep.join(sys.path)
+        result = subprocess.run(
+            [
+                sys.executable, "-m", "pytest", tmpfile,
+                f"--rootdir={project_root}",
+                "--no-header", "-q",
+            ],
+            capture_output=True,
+            text=True,
+            cwd=project_root,
+            env=env,
+        )
+        if result.returncode != 0:
+            output = (result.stdout + result.stderr).strip()
+            raise AssertionError(
+                f"pytestrun block `{snippet_name}` in {path} failed:\n\n"
+                f"{output}"
+            )
+    finally:
+        try:
+            os.unlink(tmpfile)
+            os.rmdir(tmpdir)
+        except OSError:
+            pass

{pytest_codeblock-0.5.2 → pytest_codeblock-0.5.4}/src/pytest_codeblock/rst.py

@@ -10,8 +10,14 @@ import pytest
 
 from .collector import CodeSnippet, group_snippets
 from .config import get_config
-from .constants import CODEBLOCK_MARK, DJANGO_DB_MARKS, TEST_PREFIX
+from .constants import (
+    CODEBLOCK_MARK,
+    DJANGO_DB_MARKS,
+    PYTESTRUN_MARK,
+    TEST_PREFIX,
+)
 from .helpers import contains_top_level_await, wrap_async_code
+from .pytestrun import run_pytest_style_code
 
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
 __copyright__ = "2025-2026 Artur Barseghyan"
@@ -129,10 +135,6 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
                     )
                     snippets.append(snippet)
 
-                    # TODO: Is this needed?
-                    # pending_marks.clear()
-                    # pending_fixtures.clear()
-
             i = j + 1
             continue
 
@@ -211,7 +213,7 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
                 sn_marks = pending_marks.copy()
                 sn_fixtures = pending_fixtures.copy()
                 pending_name = None
-                pending_marks = [CODEBLOCK_MARK] # clear pending marks
+                pending_marks = [CODEBLOCK_MARK]  # clear pending marks
                 pending_fixtures.clear()
 
                 snippets.append(CodeSnippet(
@@ -241,7 +243,7 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
             sn_marks = pending_marks.copy()
             sn_fixtures = pending_fixtures.copy()
             pending_name = None
-            pending_marks = [CODEBLOCK_MARK] # clear pending marks
+            pending_marks = [CODEBLOCK_MARK]  # clear pending marks
             pending_fixtures.clear()
             j = i + 1
             if j < n and not lines[j].strip():
@@ -317,6 +319,7 @@ class RSTFile(pytest.File):
             # Bind the values we need so we don't close over `sn` itself
             _sn_name = sn.name
             _fpath = str(self.path)
+            _is_pytestrun = PYTESTRUN_MARK in sn.marks
 
             # Build list of fixture names requested by this snippet
             _fixture_names: list[str] = list(sn.fixtures)
@@ -334,11 +337,21 @@ class RSTFile(pytest.File):
                 sn_name=_sn_name,
                 fpath=_fpath,
                 fixture_names=_fixture_names,
+                is_pytestrun=_is_pytestrun,
             ):
                 # This inner function *actually* has a **fixtures signature,
                 # but we override __signature__ so pytest passes the right
                 # fixtures and names.
                 def test_block(**fixtures):
+                    if is_pytestrun:
+                        run_pytest_style_code(
+                            code=code,
+                            snippet_name=sn_name,
+                            path=fpath,
+                        )
+                        return
+
+                    # Normal (non-pytestrun) execution path
                     ex_code = code
                     if contains_top_level_await(code):
                         ex_code = wrap_async_code(code)

{pytest_codeblock-0.5.2 → pytest_codeblock-0.5.4/src/pytest_codeblock.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-codeblock
-Version: 0.5.2
+Version: 0.5.4
 Summary: Pytest plugin to collect and test code blocks in reStructuredText and Markdown files.
 Author-email: Artur Barseghyan <artur.barseghyan@gmail.com>
 Maintainer-email: Artur Barseghyan <artur.barseghyan@gmail.com>

{pytest_codeblock-0.5.2 → pytest_codeblock-0.5.4}/src/pytest_codeblock.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ src/pytest_codeblock/config.py
 src/pytest_codeblock/constants.py
 src/pytest_codeblock/helpers.py
 src/pytest_codeblock/md.py
+src/pytest_codeblock/pytestrun.py
 src/pytest_codeblock/rst.py
 src/pytest_codeblock.egg-info/PKG-INFO
 src/pytest_codeblock.egg-info/SOURCES.txt
@@ -18,4 +19,5 @@ src/pytest_codeblock/tests/__init__.py
 src/pytest_codeblock/tests/test_customisation.py
 src/pytest_codeblock/tests/test_integration.py
 src/pytest_codeblock/tests/test_nameless_codeblocks.py
-src/pytest_codeblock/tests/test_pytest_codeblock.py
+src/pytest_codeblock/tests/test_pytest_codeblock.py
+src/pytest_codeblock/tests/test_pytestrun_marker.py