pytest-codeblock 0.3.1__tar.gz → 0.3.2__tar.gz

{pytest_codeblock-0.3.1/src/pytest_codeblock.egg-info → pytest_codeblock-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-codeblock
-Version: 0.3.1
+Version: 0.3.2
 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>
@@ -126,7 +126,8 @@ Features
 - **reStructuredText and Markdown support**: Automatically find and test code
   blocks in `reStructuredText`_ (``.rst``) and `Markdown`_ (``.md``) files.
   The only requirement here is that your code blocks shall
-  have a name starting with ``test_``.
+  have a name starting with ``test_``. Async code snippets are supported as
+  well.
 - **Grouping by name**: Split a single example across multiple code blocks;
   the plugin concatenates them into one test.
 - **Pytest markers support**: Add existing or custom `pytest`_ markers

{pytest_codeblock-0.3.1 → pytest_codeblock-0.3.2}/README.rst

@@ -65,7 +65,8 @@ Features
 - **reStructuredText and Markdown support**: Automatically find and test code
   blocks in `reStructuredText`_ (``.rst``) and `Markdown`_ (``.md``) files.
   The only requirement here is that your code blocks shall
-  have a name starting with ``test_``.
+  have a name starting with ``test_``. Async code snippets are supported as
+  well.
 - **Grouping by name**: Split a single example across multiple code blocks;
   the plugin concatenates them into one test.
 - **Pytest markers support**: Add existing or custom `pytest`_ markers

{pytest_codeblock-0.3.1 → pytest_codeblock-0.3.2}/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.3.1"
+version = "0.3.2"
 requires-python = ">=3.9"
 dependencies = [
     "pytest",

{pytest_codeblock-0.3.1 → pytest_codeblock-0.3.2}/src/pytest_codeblock/__init__.py

@@ -4,9 +4,9 @@ from .md import MarkdownFile
 from .rst import RSTFile
 
 __title__ = "pytest-codeblock"
-__version__ = "0.3.1"
+__version__ = "0.3.2"
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
-__copyright__ = "2025 Artur Barseghyan"
+__copyright__ = "2025-2026 Artur Barseghyan"
 __license__ = "MIT"
 __all__ = (
     "pytest_collect_file",

pytest_codeblock-0.3.2/src/pytest_codeblock/helpers.py

@@ -0,0 +1,38 @@
+import ast
+import textwrap
+
+__author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
+__copyright__ = "2025-2026 Artur Barseghyan"
+__license__ = "MIT"
+__all__ = (
+    "contains_top_level_await",
+    "wrap_async_code",
+)
+
+
+def contains_top_level_await(code: str) -> bool:
+    """Analyzes code to detect presence of async patterns."""
+    try:
+        tree = ast.parse(code)
+    except SyntaxError:
+        # If the code is invalid, it technically doesn't
+        # contain valid async patterns.
+        return False
+
+    # Define the AST nodes that represent async constructs
+    async_nodes = (
+        ast.AsyncFunctionDef,  # async def ...
+        ast.Await,  # await ...
+        ast.AsyncWith,  # async with ...
+        ast.AsyncFor,  # async for ...
+    )
+
+    return any(isinstance(node, async_nodes) for node in ast.walk(tree))
+
+
+def wrap_async_code(code: str) -> str:
+    """Wrap code containing top-level await in an async function."""
+    ind = textwrap.indent(code, "    ")
+    return (
+        f"async def __async_main__():\n{ind}\n\nasyncio.run(__async_main__())"
+    )

{pytest_codeblock-0.3.1 → pytest_codeblock-0.3.2}/src/pytest_codeblock/md.py

@@ -1,3 +1,4 @@
+import asyncio
 import inspect
 import re
 import textwrap
@@ -8,9 +9,10 @@ import pytest
 
 from .collector import CodeSnippet, group_snippets
 from .constants import CODEBLOCK_MARK, DJANGO_DB_MARKS, TEST_PREFIX
+from .helpers import contains_top_level_await, wrap_async_code
 
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
-__copyright__ = "2025 Artur Barseghyan"
+__copyright__ = "2025-2026 Artur Barseghyan"
 __license__ = "MIT"
 __all__ = (
     "MarkdownFile",
@@ -176,16 +178,30 @@ class MarkdownFile(pytest.File):
                 # but we override __signature__ so pytest passes the right
                 # fixtures and names.
                 def test_block(**fixtures):
-                    compiled = compile(code, fpath, "exec")
+                    # Auto-wrap async code
+                    ex_code = code
+                    if contains_top_level_await(code):
+                        ex_code = wrap_async_code(code)
+
+                    try:
+                        compiled = compile(ex_code, fpath, "exec")
+                    except SyntaxError as err:
+                        raise SyntaxError(
+                            f"Syntax error in "
+                            f"codeblock `{sn_name}` in {fpath}:\n"
+                            f"\n{textwrap.indent(ex_code, prefix='    ')}\n\n"
+                            f"{traceback.format_exc()}"
+                        ) from err
+
                     try:
                         # Make fixtures available as top-level names
                         # inside the executed snippet.
-                        exec(compiled, dict(fixtures))
+                        exec(compiled, {"asyncio": asyncio, **dict(fixtures)})
                     except Exception as err:
                         raise Exception(
                             f"Error in "
                             f"codeblock `{sn_name}` in {fpath}:\n"
-                            f"\n{textwrap.indent(code, prefix='    ')}\n\n"
+                            f"\n{textwrap.indent(ex_code, prefix='    ')}\n\n"
                             f"{traceback.format_exc()}"
                         ) from err
 

{pytest_codeblock-0.3.1 → pytest_codeblock-0.3.2}/src/pytest_codeblock/rst.py

@@ -1,3 +1,4 @@
+import asyncio
 import inspect
 import re
 import textwrap
@@ -9,9 +10,10 @@ import pytest
 
 from .collector import CodeSnippet, group_snippets
 from .constants import CODEBLOCK_MARK, DJANGO_DB_MARKS, TEST_PREFIX
+from .helpers import contains_top_level_await, wrap_async_code
 
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
-__copyright__ = "2025 Artur Barseghyan"
+__copyright__ = "2025-2026 Artur Barseghyan"
 __license__ = "MIT"
 __all__ = (
     "RSTFile",
@@ -314,16 +316,29 @@ class RSTFile(pytest.File):
                 # but we override __signature__ so pytest passes the right
                 # fixtures and names.
                 def test_block(**fixtures):
-                    compiled = compile(code, fpath, "exec")
+                    ex_code = code
+                    if contains_top_level_await(code):
+                        ex_code = wrap_async_code(code)
+
+                    try:
+                        compiled = compile(ex_code, fpath, "exec")
+                    except SyntaxError as err:
+                        raise SyntaxError(
+                            f"Syntax error in "
+                            f"codeblock `{sn_name}` in {fpath}:\n"
+                            f"\n{textwrap.indent(ex_code, prefix='    ')}\n\n"
+                            f"{traceback.format_exc()}"
+                        ) from err
+
                     try:
                         # Make fixtures available as top-level names
                         # inside the executed snippet.
-                        exec(compiled, dict(fixtures))
+                        exec(compiled, {"asyncio": asyncio, **dict(fixtures)})
                     except Exception as err:
                         raise Exception(
                             f"Error in "
                             f"codeblock `{sn_name}` in {fpath}:\n"
-                            f"\n{textwrap.indent(code, prefix='    ')}\n\n"
+                            f"\n{textwrap.indent(ex_code, prefix='    ')}\n\n"
                             f"{traceback.format_exc()}"
                         ) from err
 

{pytest_codeblock-0.3.1 → pytest_codeblock-0.3.2}/src/pytest_codeblock/tests/test_pytest_codeblock.py

@@ -1,4 +1,5 @@
 from pytest_codeblock.collector import CodeSnippet, group_snippets
+from pytest_codeblock.helpers import contains_top_level_await, wrap_async_code
 from pytest_codeblock.md import parse_markdown
 from pytest_codeblock.rst import (
     get_literalinclude_content,
@@ -7,7 +8,7 @@ from pytest_codeblock.rst import (
 )
 
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
-__copyright__ = "2025 Artur Barseghyan"
+__copyright__ = "2025-2026 Artur Barseghyan"
 __license__ = "MIT"
 __all__ = (
     "test_group_snippets_different_names",
@@ -119,3 +120,55 @@ def test_parse_rst_literalinclude(tmp_path):
     sn = snippets[0]
     assert sn.name == "test_li"
     assert "z=3" in sn.code
+
+
+def test_contains_top_level_await_positive():
+    """Verify detection of various async constructs."""
+    # Direct await
+    assert contains_top_level_await("await asyncio.sleep(0)") is True
+    # Async function definition
+    assert contains_top_level_await("async def foo(): pass") is True
+    # Async with
+    assert contains_top_level_await("async with lock: pass") is True
+    # Async for
+    assert contains_top_level_await("async for i in range(1): pass") is True
+
+
+def test_contains_top_level_await_negative():
+    """Verify that sync code or strings containing keywords are ignored."""
+    # Standard sync code
+    assert contains_top_level_await("import time; time.sleep(1)") is False
+    # Keywords inside strings
+    assert contains_top_level_await("print('this is an await')") is False
+    # Comments should be ignored
+    assert contains_top_level_await("# await inside comment") is False
+
+
+def test_contains_top_level_await_invalid_syntax():
+    """Verify that invalid syntax returns False rather than crashing."""
+    assert contains_top_level_await("def main(:") is False
+
+
+def test_wrap_async_code_structure():
+    """Verify the transformation logic and indentation."""
+    code = "await asyncio.sleep(1)\nreturn 42"
+    wrapped = wrap_async_code(code)
+
+    # Check for the boilerplate components
+    assert "async def __async_main__():" in wrapped
+    assert "asyncio.run(__async_main__())" in wrapped
+
+    # Check that the original code is indented correctly (4 spaces)
+    assert "    await asyncio.sleep(1)" in wrapped
+    assert "    return 42" in wrapped
+
+
+def test_wrap_async_code_execution_integrity():
+    """
+    Verify that the wrapped code is still valid Python and can be compiled.
+    This ensures wrap_async_code doesn't break the AST.
+    """
+    code = "val = 1 + 1"
+    wrapped = wrap_async_code(code)
+    # If compile fails, the test fails
+    assert compile(wrapped, "<string>", "exec")

{pytest_codeblock-0.3.1 → pytest_codeblock-0.3.2/src/pytest_codeblock.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-codeblock
-Version: 0.3.1
+Version: 0.3.2
 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>
@@ -126,7 +126,8 @@ Features
 - **reStructuredText and Markdown support**: Automatically find and test code
   blocks in `reStructuredText`_ (``.rst``) and `Markdown`_ (``.md``) files.
   The only requirement here is that your code blocks shall
-  have a name starting with ``test_``.
+  have a name starting with ``test_``. Async code snippets are supported as
+  well.
 - **Grouping by name**: Split a single example across multiple code blocks;
   the plugin concatenates them into one test.
 - **Pytest markers support**: Add existing or custom `pytest`_ markers

{pytest_codeblock-0.3.1 → pytest_codeblock-0.3.2}/src/pytest_codeblock.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ pyproject.toml
 src/pytest_codeblock/__init__.py
 src/pytest_codeblock/collector.py
 src/pytest_codeblock/constants.py
+src/pytest_codeblock/helpers.py
 src/pytest_codeblock/md.py
 src/pytest_codeblock/rst.py
 src/pytest_codeblock.egg-info/PKG-INFO