pytest-codeblock 0.5.6__tar.gz → 0.5.7__tar.gz

{pytest_codeblock-0.5.6/src/pytest_codeblock.egg-info → pytest_codeblock-0.5.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-codeblock
-Version: 0.5.6
+Version: 0.5.7
 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>
@@ -78,6 +78,7 @@ pytest-codeblock
 .. _openai: https://github.com/openai/openai-python
 .. _Ollama: https://github.com/ollama/ollama
 .. _tomli: https://pypi.org/project/tomli/
+.. _doc8: https://doc8.readthedocs.io/
 
 .. Internal references
 
@@ -219,6 +220,11 @@ See `customisation docs`_ for more.
 
 Usage
 =====
+.. note::
+
+    It's highly recommended to use `doc8`_ for catching possible markup errors,
+    that otherwise would be difficult to spot.
+
 reStructruredText usage
 -----------------------
 Any code directive, such as ``.. code-block:: python``, ``.. code:: python``,

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7}/README.rst

@@ -15,6 +15,7 @@ pytest-codeblock
 .. _openai: https://github.com/openai/openai-python
 .. _Ollama: https://github.com/ollama/ollama
 .. _tomli: https://pypi.org/project/tomli/
+.. _doc8: https://doc8.readthedocs.io/
 
 .. Internal references
 
@@ -156,6 +157,11 @@ See `customisation docs`_ for more.
 
 Usage
 =====
+.. note::
+
+    It's highly recommended to use `doc8`_ for catching possible markup errors,
+    that otherwise would be difficult to spot.
+
 reStructruredText usage
 -----------------------
 Any code directive, such as ``.. code-block:: python``, ``.. code:: python``,

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7}/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.6"
+version = "0.5.7"
 requires-python = ">=3.10"
 dependencies = [
     "pytest",
@@ -264,14 +264,30 @@ ignore = [
     "CODE_OF_CONDUCT.rst",
     "LICENSE",
     "SECURITY.rst",
+    "docs/_implement_pytest_hooks.rst",
     "docs/changelog.rst",
     "docs/code_of_conduct.rst",
+    "docs/documentation.rst",
+    "docs/full-llms.rst",
+    "docs/index.rst",
+    "docs/llms.rst",
+    "docs/package.rst",
     "docs/security.rst",
     "docs/source_tree.rst",
     "docs/source_tree_full.rst",
     "docs/make.bat",
     "docs/Makefile",
 ]
+order = [
+    "README.rst",
+    "CONTRIBUTING.rst",
+    "docs/quick_start_ref.rst",
+    "docs/restructured_text.rst",
+    "docs/markdown.rst",
+    "docs/cheatsheet_restructured_text.rst",
+    "docs/cheatsheet_markdown.rst",
+    "docs/customisation.rst",
+]
 
 [[tool.sphinx-source-tree.files]]
 output = "docs/source_tree_full.rst"
@@ -315,13 +331,18 @@ ignore = [
     "CODE_OF_CONDUCT.rst",
     "LICENSE",
     "SECURITY.rst",
+    "docs/_implement_pytest_hooks.rst",
     "docs/changelog.rst",
     "docs/code_of_conduct.rst",
+    "docs/documentation.rst",
+    "docs/full-llms.rst",
+    "docs/index.rst",
+    "docs/llms.rst",
+    "docs/package.rst",
     "docs/security.rst",
     "docs/source_tree.rst",
     "docs/source_tree_full.rst",
     "docs/make.bat",
     "docs/Makefile",
     "examples",
-    "docs",
 ]

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7}/src/pytest_codeblock/__init__.py

@@ -6,7 +6,7 @@ from .md import MarkdownFile
 from .rst import RSTFile
 
 __title__ = "pytest-codeblock"
-__version__ = "0.5.6"
+__version__ = "0.5.7"
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
 __copyright__ = "2025-2026 Artur Barseghyan"
 __license__ = "MIT"

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7}/src/pytest_codeblock/collector.py

@@ -28,17 +28,17 @@ def group_snippets(snippets: list[CodeSnippet]) -> list[CodeSnippet]:
     """
     Combine snippets that share a group key, using one of two modes:
 
-    - **Merge mode** (default): snippets sharing the same name (no ``group``
+    - Merge mode (default): snippets sharing the same name (no ``group``
       set, or nameless/same-name continuations) are concatenated into a single
-      test, accumulating marks and fixtures. This is the original behaviour.
-    - **Incremental mode**: when every continuation snippet (``group`` set) in
+      test, accumulating marks and fixtures. This is the default behaviour.
+    - Incremental mode: when every continuation snippet (``group`` set) in
       a group also carries its own distinct name, emit one test per snippet.
       Each test's code is the cumulative concatenation of all preceding
       snippets plus itself, so each step is exercised in isolation.
 
     Unnamed snippets receive unique auto-keys so they are never merged.
     """
-    # Pass 1: bucket each snippet by its group key, preserving insertion order.
+    # Pass 1: bucket each snippet by its group key, preserving insertion order
     buckets: dict[str, list[CodeSnippet]] = {}
     order: list[str] = []
     anon_count = 0
@@ -57,13 +57,13 @@ def group_snippets(snippets: list[CodeSnippet]) -> list[CodeSnippet]:
             order.append(key)
         buckets[key].append(sn)
 
-    # Pass 2: emit merged or incremental snippets per bucket.
+    # Pass 2: emit merged or incremental snippets per bucket
     combined: list[CodeSnippet] = []
 
     for key in order:
         members = buckets[key]
         continuations = [sn for sn in members if sn.group]
-        # Incremental only when every continuation has a distinct own name.
+        # Incremental only when every continuation has a distinct own name
         incremental = continuations and all(
             sn.name and sn.name != key for sn in continuations
         )
@@ -84,7 +84,7 @@ def group_snippets(snippets: list[CodeSnippet]) -> list[CodeSnippet]:
                     fixtures=list(acc_fixtures),
                 ))
         else:
-            # Merge mode (original behaviour).
+            # Merge mode (default behaviour)
             first = members[0]
             merged_marks = list(first.marks)
             merged_fixtures = list(first.fixtures)

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7}/src/pytest_codeblock/md.py

@@ -103,7 +103,7 @@ def parse_markdown(text: str) -> list[CodeSnippet]:
                     block_indent = indent
                     start_line = idx + 1
                     code_buffer = []
-                    # determine name from info string or pending comment
+                    # Determine name from info string or pending comment
                     snippet_name = None
                     for token in extra.split():
                         if (
@@ -118,18 +118,17 @@ def parse_markdown(text: str) -> list[CodeSnippet]:
                             break
                     if snippet_name is None:
                         snippet_name = pending_name
-                    # reset pending_name; marks stay until block closes
+                    # Reset pending_name; marks stay until block closes
                     pending_name = None
-                continue
 
         else:
-            # inside a fenced code block
+            # Inside a fenced code block
             if line.lstrip().startswith(fence):
-                # end of block
+                # End of block
                 in_block = False
                 code_text = "\n".join(code_buffer)
                 snippet_group = None
-                # continue overrides snippet_name for grouping
+                # Continue overrides snippet_name for grouping
                 if pending_continue:
                     snippet_group = pending_continue
                     pending_continue = None
@@ -141,12 +140,12 @@ def parse_markdown(text: str) -> list[CodeSnippet]:
                     fixtures=pending_fixtures.copy(),
                     group=snippet_group,
                 ))
-                # reset pending marks after collecting
+                # Reset pending marks after collecting
                 pending_marks = [CODEBLOCK_MARK]  # Reset to default
                 snippet_name = None
                 pending_fixtures.clear()  # Clear pending fixtures
             else:
-                # collect code lines (dedent by block_indent)
+                # Collect code lines (dedent by block_indent)
                 if line.strip() == "":
                     code_buffer.append("")
                 else:
@@ -154,7 +153,6 @@ def parse_markdown(text: str) -> list[CodeSnippet]:
                         code_buffer.append(line[block_indent:])
                     else:
                         code_buffer.append(line.lstrip())
-            continue
 
     return snippets
 
@@ -278,7 +276,7 @@ class MarkdownFile(pytest.File):
                 name=sn.name,
                 callobj=callobj,
             )
-            # apply any marks (e.g. django_db)
+            # Apply any marks (e.g. django_db)
             for m in sn.marks:
                 fn.add_marker(getattr(pytest.mark, m))
             yield fn

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7}/src/pytest_codeblock/rst.py

@@ -134,6 +134,8 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
                         fixtures=pending_fixtures.copy(),
                     )
                     snippets.append(snippet)
+                    pending_marks = [CODEBLOCK_MARK]
+                    pending_fixtures.clear()
 
             i = j + 1
             continue

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7}/src/pytest_codeblock/tests/test_customisation.py

@@ -32,7 +32,7 @@ x = 1
             assert snippets[0].name == "custom_lang"
             assert "x = 1" in snippets[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_unknown_language_ignored(self):
         """Test that unknown language fence is ignored."""
@@ -83,7 +83,7 @@ x = 1
         snippets = parse_markdown(text)
         assert len(snippets) == 1
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_default_md_extension(self):
         """Test that .md is always a supported extension."""

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7}/src/pytest_codeblock/tests/test_integration.py

@@ -38,9 +38,9 @@ from ..rst import (
 )
 
 
-# =============================================================================
+# ============================================================================
 # Test constants.py
-# =============================================================================
+# ============================================================================
 class TestConstants:
     """Test constants module values."""
 
@@ -57,9 +57,9 @@ class TestConstants:
         assert TEST_PREFIX == "test_"
 
 
-# =============================================================================
+# ============================================================================
 # Test collector.py - CodeSnippet dataclass
-# =============================================================================
+# ============================================================================
 class TestCodeSnippet:
     """Test CodeSnippet dataclass."""
 
@@ -95,9 +95,9 @@ class TestCodeSnippet:
         assert "fixtures" in field_names
 
 
-# =============================================================================
+# ============================================================================
 # Test collector.py - group_snippets function
-# =============================================================================
+# ============================================================================
 class TestGroupSnippets:
     """Test group_snippets function."""
 
@@ -165,9 +165,9 @@ class TestGroupSnippets:
         assert "y=2" in combined[0].code
 
 
-# =============================================================================
+# ============================================================================
 # Test helpers.py - contains_top_level_await
-# =============================================================================
+# ============================================================================
 class TestContainsTopLevelAwait:
     """Test contains_top_level_await function."""
 
@@ -194,9 +194,9 @@ class TestContainsTopLevelAwait:
         assert contains_top_level_await("def broken(:") is False
 
 
-# =============================================================================
+# ============================================================================
 # Test helpers.py - wrap_async_code
-# =============================================================================
+# ============================================================================
 class TestWrapAsyncCode:
     """Test wrap_async_code function."""
 
@@ -222,9 +222,9 @@ class TestWrapAsyncCode:
         compile(wrapped, "<test>", "exec")
 
 
-# =============================================================================
+# ============================================================================
 # Test __init__.py - pytest_collect_file hook
-# =============================================================================
+# ============================================================================
 class TestPytestCollectFile:
     """Test pytest_collect_file hook function."""
 
@@ -292,9 +292,9 @@ class TestPytestCollectFile:
         assert isinstance(result, MarkdownFile)
 
 
-# =============================================================================
+# ============================================================================
 # Test md.py - parse_markdown function
-# =============================================================================
+# ============================================================================
 class TestParseMarkdown:
     """Test parse_markdown function."""
 
@@ -310,7 +310,7 @@ x = 1
         assert snippets[0].name == "test_simple"
         assert "x = 1" in snippets[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_with_pytestmark(self):
         """Test the <!-- pytestmark: mark --> directive."""
@@ -323,7 +323,7 @@ pass
         snippets = parse_markdown(text)
         assert "django_db" in snippets[0].marks
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_with_pytestfixture(self):
         """Test the <!-- pytestfixture: name --> directive."""
@@ -340,7 +340,7 @@ print("hello")
         assert "tmp_path" in snippets[0].fixtures
         assert "capsys" in snippets[0].fixtures
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_continue_directive(self):
         """Test the <!-- continue: name --> directive for grouping snippets."""
@@ -366,7 +366,7 @@ assert y == 2
         assert "x = 1" in test_snippets[0].code
         assert "y = x + 1" in test_snippets[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_incremental_continuation(self):
         """Named continuation blocks produce N cumulative tests."""
@@ -398,7 +398,7 @@ something = Exception("")
         assert 'something = "a"' in grouped[2].code
         assert 'something = Exception("")' in grouped[2].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_codeblock_name_directive(self):
         """Test the <!-- codeblock-name: name --> directive."""
@@ -414,7 +414,7 @@ assert z == 42
         assert len(snippets) == 1
         assert snippets[0].name == "test_named"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_py_language(self):
         """Test markdown with 'py' as language identifier."""
@@ -427,7 +427,7 @@ x = 1
         assert len(snippets) == 1
         assert snippets[0].name == "test_py_lang"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_python3_language(self):
         """Test markdown with 'python3' as language identifier."""
@@ -440,7 +440,7 @@ x = 1
         assert len(snippets) == 1
         assert snippets[0].name == "test_python3"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_non_python_codeblock_ignored(self):
         """Test that non-Python code blocks are skipped."""
@@ -458,7 +458,7 @@ x = 1
         assert len(snippets) == 1
         assert snippets[0].name == "test_py"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_name_colon_syntax(self):
         """Test name= vs name: syntax in fence info string."""
@@ -470,7 +470,7 @@ x = 1
         snippets = parse_markdown(text)
         assert snippets[0].name == "test_colon"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_empty_codeblock(self):
         """Test parse empty code block."""
@@ -482,7 +482,7 @@ x = 1
         assert len(snippets) == 1
         assert snippets[0].code == ""
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_indented_fence(self):
         """Test fence with indentation."""
@@ -494,7 +494,7 @@ x = 1
         snippets = parse_markdown(text)
         assert len(snippets) == 1
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     # TODO: Remove?
     def test_parse_fence_regex_edge_case(self):
@@ -508,7 +508,7 @@ x = 1
         snippets = parse_markdown(text)
         assert len(snippets) == 1
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_markdown_mixed_indentation(self):
         """Test parsing codeblock with mixed indentation levels."""
@@ -524,7 +524,7 @@ x = 1
         # Code should be dedented based on fence indentation
         assert "x = 1" in snippets[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_short_line_in_block(self):
         """Test code block with line shorter than indent."""
@@ -541,9 +541,9 @@ y
         # The short line 'y' should still be captured
         assert "y" in snippets[0].code or "x = 1" in snippets[0].code
 
-# =============================================================================
+# ============================================================================
 # Test rst.py - resolve_literalinclude_path
-# =============================================================================
+# ============================================================================
 class TestResolveLiteralincludePath:
     """Test resolve_literalinclude_path function."""
 
@@ -584,9 +584,9 @@ class TestResolveLiteralincludePath:
         assert result is None
 
 
-# =============================================================================
+# ============================================================================
 # Test rst.py - get_literalinclude_content
-# =============================================================================
+# ============================================================================
 class TestGetLiteralincludeContent:
     """Test get_literalinclude_content function."""
 
@@ -605,9 +605,9 @@ class TestGetLiteralincludeContent:
             get_literalinclude_content(str(tmp_path / "missing.py"))
 
 
-# =============================================================================
+# ============================================================================
 # Test rst.py - parse_rst function
-# =============================================================================
+# ============================================================================
 class TestParseRst:
     """Test parse_rst function."""
 
@@ -623,7 +623,7 @@ class TestParseRst:
         assert len(snippets) == 1
         assert snippets[0].name == "test_rst"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_code_directive(self, tmp_path):
         """Test .. code:: python (alternative to code-block)."""
@@ -637,7 +637,7 @@ class TestParseRst:
         assert len(snippets) == 1
         assert snippets[0].name == "test_code"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_pytestmark(self, tmp_path):
         rst = """
@@ -651,7 +651,7 @@ class TestParseRst:
         snippets = parse_rst(rst, tmp_path)
         assert "django_db" in snippets[0].marks
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_pytestfixture(self, tmp_path):
         """Test the .. pytestfixture: directive."""
@@ -668,7 +668,7 @@ class TestParseRst:
         assert len(snippets) == 1
         assert "tmp_path" in snippets[0].fixtures
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_continue_directive(self, tmp_path):
         """Test the .. continue: directive for grouping RST snippets."""
@@ -695,7 +695,7 @@ Some text.
         assert "a = 10" in test_snippets[0].code
         assert "b = a + 5" in test_snippets[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_codeblock_name(self, tmp_path):
         rst = """
@@ -708,7 +708,7 @@ Some text.
         snippets = parse_rst(rst, tmp_path)
         assert snippets[0].name == "test_named"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_literal_block(self, tmp_path):
         """Test parsing of literal blocks via :: syntax."""
@@ -726,7 +726,7 @@ assert result == 3
         assert snippets[0].name == "test_literal"
         assert "result = 1 + 2" in snippets[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_rst_continue_in_literal_block(self, tmp_path):
         """Test continue directive with literal block syntax."""
@@ -751,7 +751,7 @@ b = 2
         matching = [s for s in grouped if s.name == "test_lit_continue"]
         assert len(matching) >= 1
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_literalinclude(self, tmp_path):
         """Test literalinclude directive with test_ name."""
@@ -766,7 +766,7 @@ b = 2
         assert len(snippets) == 1
         assert "def hello():" in snippets[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_literalinclude_no_test_prefix(self, tmp_path):
         """Test literalinclude without test_ prefix is skipped."""
@@ -780,7 +780,7 @@ b = 2
         # Should be empty because name doesn't start with test_
         assert len(snippets) == 0
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_non_python_code_block(self, tmp_path):
         """Non-python code blocks are skipped."""
@@ -792,7 +792,7 @@ b = 2
         snippets = parse_rst(rst, tmp_path)
         assert len(snippets) == 0
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_wrong_indent(self, tmp_path):
         """Code at wrong indent level."""
@@ -807,7 +807,7 @@ x = 1
         # Should not collect this as a valid snippet
         assert len(snippets) == 0
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_literal_codeblock_eof(self, tmp_path):
         """Test literal block at end of file."""
@@ -820,7 +820,7 @@ Block::"""
         # Should handle gracefully
         assert len(snippets) == 0
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_empty_codeblock(self, tmp_path):
         """Test parsing an empty code block."""
@@ -833,7 +833,7 @@ Block::"""
         # Empty blocks are collected but have no snippets
         assert len(snippets) == 0
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_literal_block_empty_line_after(self, tmp_path):
         """Test literal block with just empty line after (edge case)."""
@@ -848,13 +848,13 @@ Block::
         assert len(snippets) == 0
 
 
-# =============================================================================
+# ============================================================================
 # Integration tests using pytester - exercises collectors and hook
-# =============================================================================
+# ============================================================================
 
-# -----------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
 # Test RSTFile.collect() method
-# -----------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
 
 class TestMarkdownCollector:
     """Integration tests for MarkdownFile collector."""
@@ -876,7 +876,7 @@ assert x == 1
         result.assert_outcomes(passed=1)
         assert "test_basic" in result.stdout.str()
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_collect_with_fixture(self, pytester_subprocess):
         """Test that fixtures are properly injected."""
@@ -892,7 +892,7 @@ assert tmp_path.exists()
         result = pytester_subprocess.runpytest("-v", "-p", "no:django")
         result.assert_outcomes(passed=1)
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_collect_async_code(self, pytester_subprocess):
         """Test that async code is automatically wrapped."""
@@ -908,7 +908,7 @@ await asyncio.sleep(0)
         result = pytester_subprocess.runpytest("-v", "-p", "no:django")
         result.assert_outcomes(passed=1)
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_syntax_error_reporting(self, pytester_subprocess):
         """Test that syntax errors in snippets are properly reported."""
@@ -928,7 +928,7 @@ def broken(:
             or "syntax" in result.stdout.str().lower()
         )
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_runtime_error_reporting(self, pytester_subprocess):
         """Test that runtime errors in snippets are properly reported."""
@@ -944,7 +944,7 @@ raise ValueError("intentional error")
         result.assert_outcomes(failed=1)
         assert "ValueError" in result.stdout.str()
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_incremental_continue_collects_separate_tests(
         self, pytester_subprocess
@@ -979,9 +979,9 @@ assert isinstance(something, Exception)
         assert "test_step_three" in stdout
 
 
-# -----------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
 # Test RSTFile.collect() method
-# -----------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
 
 class TestRSTCollector:
     """Integration tests for RSTFile collector."""
@@ -1005,7 +1005,7 @@ Test File
         result.assert_outcomes(passed=1)
         assert "test_rst_basic" in result.stdout.str()
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_collect_with_fixture(self, pytester_subprocess):
         """Test that RST fixtures are properly injected."""
@@ -1023,7 +1023,7 @@ Test File
         result = pytester_subprocess.runpytest("-v", "-p", "no:django")
         result.assert_outcomes(passed=1)
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_collect_async_code(self, pytester_subprocess):
         """Test that RST async code is automatically wrapped."""
@@ -1040,7 +1040,7 @@ Test File
         result = pytester_subprocess.runpytest("-v", "-p", "no:django")
         result.assert_outcomes(passed=1)
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_syntax_error_reporting(self, pytester_subprocess):
         """Test that syntax errors in RST snippets are reported."""
@@ -1058,9 +1058,9 @@ Test File
         result.assert_outcomes(failed=1)
 
 
-# ---------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
 # Tests for pytest_collect_file hook dispatch
-# ---------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
 
 
 class TestPytestCollectFileHook:
@@ -1081,7 +1081,7 @@ assert True
         )
         assert "test_md_hook" in result.stdout.str()
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_hook_dispatches_rst(self, pytester_subprocess):
         """Test that .rst files are dispatched to RSTFile."""
@@ -1099,7 +1099,7 @@ assert True
         )
         assert "test_rst_hook" in result.stdout.str()
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_hook_ignores_other_files(self, pytester_subprocess):
         """Test that non-.md/.rst files are ignored."""

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7}/src/pytest_codeblock/tests/test_nameless_codeblocks.py

@@ -33,9 +33,9 @@ __all__ = (
 )
 
 
-# =============================================================================
+# ============================================================================
 # Test Configuration Loading
-# =============================================================================
+# ============================================================================
 class TestConfigLoading:
     """Test that test_nameless_codeblocks config loads correctly."""
 
@@ -72,9 +72,9 @@ class TestConfigLoading:
         assert config.test_nameless_codeblocks is False
 
 
-# =============================================================================
+# ============================================================================
 # Test Auto-naming Logic
-# =============================================================================
+# ============================================================================
 class TestAutoNaming:
     """Test the auto-naming scheme for nameless code blocks."""
 
@@ -107,9 +107,9 @@ class TestAutoNaming:
         assert module_name == "my.doc"
 
 
-# =============================================================================
+# ============================================================================
 # Test Markdown Collector with Nameless Blocks
-# =============================================================================
+# ============================================================================
 class TestMarkdownNameless:
     """Test MarkdownFile collector with test_nameless_codeblocks."""
 
@@ -132,7 +132,7 @@ y = 2
         assert "x = 1" in snippets[0].code
         assert "y = 2" in snippets[1].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_markdown_mixed_named_and_nameless(self):
         """Test parsing mix of named and nameless blocks."""
@@ -160,7 +160,7 @@ d = 4
         assert snippets[2].name == "test_two"
         assert snippets[3].name is None
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_collect_nameless_disabled_default(self):
         """Test that nameless blocks are ignored by default."""
@@ -208,7 +208,7 @@ y = 2
             assert len(tests) == 1
             assert tests[0].name == "test_explicit"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_collect_nameless_enabled(self):
         """Test that nameless blocks are collected when enabled."""
@@ -251,7 +251,7 @@ z = 3
             assert tests[1].name == "test_test_1"
             assert tests[2].name == "test_test_2"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_auto_naming_preserves_code(self):
         """Test that auto-naming doesn't modify the code content."""
@@ -281,7 +281,7 @@ assert original_code == "unchanged"
             assert "original_code" in tests[0].code
             assert "unchanged" in tests[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_auto_naming_preserves_marks(self):
         """Test that auto-naming preserves pytest marks."""
@@ -310,7 +310,7 @@ user = User.objects.first()
             assert len(tests) == 1
             assert "django_db" in tests[0].marks
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_codeblock_marks_on_all_blocks(self):
         """Test that all blocks have default codeblock marks."""
@@ -331,7 +331,7 @@ assert True
             for sn in raw:
                 assert CODEBLOCK_MARK in sn.marks
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_auto_naming_preserves_fixtures(self):
         """Test that auto-naming preserves pytest fixtures."""
@@ -363,9 +363,9 @@ d.mkdir()
             assert "capsys" in tests[0].fixtures
 
 
-# =============================================================================
+# ============================================================================
 # Test RST Collector with Nameless Blocks
-# =============================================================================
+# ============================================================================
 class TestRSTNameless:
     """Test RSTFile collector with test_nameless_codeblocks."""
 
@@ -388,7 +388,7 @@ class TestRSTNameless:
         assert "x = 1" in snippets[0].code
         assert "y = 2" in snippets[1].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_parse_rst_mixed_named_and_nameless(self, tmp_path):
         """Test parsing mix of named and nameless blocks."""
@@ -418,7 +418,7 @@ class TestRSTNameless:
         assert snippets[2].name == "test_two"
         assert snippets[3].name is None
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_collect_nameless_disabled_default(self, tmp_path):
         """Test that nameless blocks are ignored by default in RST."""
@@ -462,7 +462,7 @@ class TestRSTNameless:
             assert len(tests) == 1
             assert tests[0].name == "test_explicit"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_collect_nameless_enabled(self, tmp_path):
         """Test that nameless blocks are collected when enabled in RST."""
@@ -507,7 +507,7 @@ class TestRSTNameless:
             assert tests[1].name == "test_test_1"
             assert tests[2].name == "test_test_2"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_auto_naming_preserves_code_rst(self, tmp_path):
         """Test that auto-naming doesn't modify the code content in RST."""
@@ -539,7 +539,7 @@ class TestRSTNameless:
             assert "original_code" in tests[0].code
             assert "unchanged" in tests[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_auto_naming_preserves_marks_rst(self, tmp_path):
         """Test that auto-naming preserves pytest marks in RST."""
@@ -571,7 +571,7 @@ class TestRSTNameless:
             assert len(tests) == 1
             assert "django_db" in tests[0].marks
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_codeblock_marks_on_all_blocks_rst(self, tmp_path):
         """Test that all blocks in RST file have default codeblock mark."""
@@ -594,7 +594,7 @@ class TestRSTNameless:
             for sn in raw:
                 assert CODEBLOCK_MARK in sn.marks
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_auto_naming_preserves_fixtures_rst(self, tmp_path):
         """Test that auto-naming preserves pytest fixtures in RST."""
@@ -629,9 +629,9 @@ class TestRSTNameless:
             assert "capsys" in tests[0].fixtures
 
 
-# =============================================================================
+# ============================================================================
 # Test Integration Scenarios
-# =============================================================================
+# ============================================================================
 @pytest.mark.skip(
     reason="Skip due to pytest 9 py.path.local deprecation issue in hooks"
 )
@@ -670,7 +670,7 @@ assert z == 3
         assert "test_integration_1" in result.stdout.str()
         assert "test_integration_2" in result.stdout.str()
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_rst_nameless_integration(self, pytester):
         """Test nameless blocks work end-to-end in RST."""
@@ -706,7 +706,7 @@ Test File
         assert "test_integration_1" in result.stdout.str()
         assert "test_integration_2" in result.stdout.str()
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_nameless_disabled_integration(self, pytester):
         """Test that nameless blocks are ignored when disabled."""
@@ -730,7 +730,7 @@ assert y == 2
         assert "test_explicit" in result.stdout.str()
         assert "test_default_1" not in result.stdout.str()
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_multiple_files_separate_counters(self, pytester):
         """Test that each file has its own counter."""
@@ -768,9 +768,9 @@ b = 2
         assert "test_file2_2" in result.stdout.str()
 
 
-# =============================================================================
+# ============================================================================
 # Test Edge Cases
-# =============================================================================
+# ============================================================================
 class TestEdgeCases:
     """Test edge cases and corner scenarios."""
 
@@ -801,7 +801,7 @@ z = 3
         result = pytester.runpytest("-v", "-p", "no:django")
         result.assert_outcomes(passed=3)
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     @pytest.mark.skip(
         reason="Skip due to pytest 9 py.path.local deprecation issue in hooks"
@@ -830,7 +830,7 @@ y = 2
         # No auto-generated names
         assert "test_only_named_1" not in result.stdout.str()
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     @pytest.mark.skip(
         reason="Skip due to pytest 9 py.path.local deprecation issue in hooks"
@@ -857,7 +857,7 @@ assert x == 1
         # Should have at least the non-empty one
         assert result.ret == 0
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     @pytest.mark.skip(
         reason="Skip due to pytest 9 py.path.local deprecation issue in hooks"
@@ -887,7 +887,7 @@ y = 2
         result.assert_outcomes(passed=2)
         # Only Python blocks should be collected
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_nameless_with_continue_directive_md(self):
         """Test nameless blocks with continue directive in Markdown."""
@@ -916,7 +916,7 @@ assert y == 2
             assert "x = 1" in combined[0].code
             assert "y = x + 1" in combined[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_nameless_with_continue_directive_rst(self, tmp_path):
         """Test nameless blocks with continue directive in RST."""
@@ -949,7 +949,7 @@ assert y == 2
             assert "x = 1" in combined[0].code
             assert "y = x + 1" in combined[0].code
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_counter_only_increments_for_nameless(self):
         """Test that counter only increments for nameless blocks."""
@@ -1008,7 +1008,7 @@ f = 6
             assert tests[3].name == "test_test_2"
             assert tests[5].name == "test_test_3"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     def test_filename_with_special_characters(self):
         """Test auto-naming with special characters in filename."""
@@ -1018,7 +1018,7 @@ f = 6
         auto_name = f"test_{module_name}_1"
         assert auto_name == "test_my-test_file_1"
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     @pytest.mark.skip(
         reason="Skip due to pytest 9 py.path.local deprecation issue in hooks"
@@ -1041,7 +1041,7 @@ x = 1
         # No tests should be collected
         assert result.ret == 5  # Exit code 5 = no tests collected
 
-    # -------------------------------------------------------------------------
+    # ------------------------------------------------------------------------
 
     @pytest.mark.skip(
         reason="Skip due to pytest 9 py.path.local deprecation issue in hooks"

{pytest_codeblock-0.5.6 → pytest_codeblock-0.5.7/src/pytest_codeblock.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-codeblock
-Version: 0.5.6
+Version: 0.5.7
 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>
@@ -78,6 +78,7 @@ pytest-codeblock
 .. _openai: https://github.com/openai/openai-python
 .. _Ollama: https://github.com/ollama/ollama
 .. _tomli: https://pypi.org/project/tomli/
+.. _doc8: https://doc8.readthedocs.io/
 
 .. Internal references
 
@@ -219,6 +220,11 @@ See `customisation docs`_ for more.
 
 Usage
 =====
+.. note::
+
+    It's highly recommended to use `doc8`_ for catching possible markup errors,
+    that otherwise would be difficult to spot.
+
 reStructruredText usage
 -----------------------
 Any code directive, such as ``.. code-block:: python``, ``.. code:: python``,