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

{pytest_codeblock-0.5.5/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.5
+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
 
@@ -146,8 +147,8 @@ Prerequisites
 Documentation
 =============
 - Documentation is available on `Read the Docs`_.
-- For `reStructuredText`_, see a dedicated `reStructuredText docs`_.
-- For `Markdown`_, see a dedicated `Markdown docs`_.
+- For `reStructuredText`, see a dedicated `reStructuredText docs`_.
+- For `Markdown`, see a dedicated `Markdown docs`_.
 - Both `reStructuredText docs`_ and `Markdown docs`_ have extensive
   documentation on `pytest`_ markers and corresponding ``conftest.py`` hooks.
 - For guidelines on contributing check the `Contributor guidelines`_.
@@ -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.5 → 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
 
@@ -83,8 +84,8 @@ Prerequisites
 Documentation
 =============
 - Documentation is available on `Read the Docs`_.
-- For `reStructuredText`_, see a dedicated `reStructuredText docs`_.
-- For `Markdown`_, see a dedicated `Markdown docs`_.
+- For `reStructuredText`, see a dedicated `reStructuredText docs`_.
+- For `Markdown`, see a dedicated `Markdown docs`_.
 - Both `reStructuredText docs`_ and `Markdown docs`_ have extensive
   documentation on `pytest`_ markers and corresponding ``conftest.py`` hooks.
 - For guidelines on contributing check the `Contributor guidelines`_.
@@ -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.5 → 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.5"
+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.5 → 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.5"
+__version__ = "0.5.7"
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
 __copyright__ = "2025-2026 Artur Barseghyan"
 __license__ = "MIT"

pytest_codeblock-0.5.7/src/pytest_codeblock/collector.py

@@ -0,0 +1,104 @@
+from dataclasses import dataclass, field
+from typing import Optional
+
+__author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
+__copyright__ = "2025-2026 Artur Barseghyan"
+__license__ = "MIT"
+__all__ = (
+    "CodeSnippet",
+    "group_snippets",
+)
+
+
+@dataclass
+class CodeSnippet:
+    """Data container for an extracted code snippet."""
+    code: str  # The code content
+    line: int  # Starting line number in the source
+    name: Optional[str] = None  # Identifier for grouping (None if anonymous)
+    marks: list[str] = field(default_factory=list)
+    # Collected pytest marks (e.g. ['django_db']), parsed from doc comments
+    fixtures: list[str] = field(default_factory=list)
+    # Collected pytest fixtures (e.g. ['tmp_path']), parsed from doc comments
+    group: Optional[str] = None
+    # Set by ``continue:`` directives; names the group this snippet belongs to
+
+
+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``
+      set, or nameless/same-name continuations) are concatenated into a single
+      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
+    buckets: dict[str, list[CodeSnippet]] = {}
+    order: list[str] = []
+    anon_count = 0
+
+    for sn in snippets:
+        if sn.group:
+            key = sn.group
+        elif sn.name:
+            key = sn.name
+        else:
+            anon_count += 1
+            key = f"codeblock{anon_count}"
+
+        if key not in buckets:
+            buckets[key] = []
+            order.append(key)
+        buckets[key].append(sn)
+
+    # 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 = continuations and all(
+            sn.name and sn.name != key for sn in continuations
+        )
+
+        if incremental:
+            acc_code = ""
+            acc_marks: list[str] = []
+            acc_fixtures: list[str] = []
+            for sn in members:
+                acc_code = acc_code + "\n" + sn.code if acc_code else sn.code
+                acc_marks.extend(sn.marks)
+                acc_fixtures.extend(sn.fixtures)
+                combined.append(CodeSnippet(
+                    name=sn.name,
+                    code=acc_code,
+                    line=sn.line,
+                    marks=list(acc_marks),
+                    fixtures=list(acc_fixtures),
+                ))
+        else:
+            # Merge mode (default behaviour)
+            first = members[0]
+            merged_marks = list(first.marks)
+            merged_fixtures = list(first.fixtures)
+            merged_code = first.code
+            for sn in members[1:]:
+                merged_code += "\n" + sn.code
+                merged_marks.extend(sn.marks)
+                merged_fixtures.extend(sn.fixtures)
+            combined.append(CodeSnippet(
+                name=first.name,
+                code=merged_code,
+                line=first.line,
+                marks=merged_marks,
+                fixtures=merged_fixtures,
+            ))
+
+    return combined

{pytest_codeblock-0.5.5 → 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,35 +118,34 @@ 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)
-                # continue overrides snippet_name for grouping
+                snippet_group = None
+                # Continue overrides snippet_name for grouping
                 if pending_continue:
-                    final_name = pending_continue
+                    snippet_group = pending_continue
                     pending_continue = None
-                else:
-                    final_name = snippet_name
                 snippets.append(CodeSnippet(
-                    name=final_name,
+                    name=snippet_name,
                     code=code_text,
                     line=start_line,
                     marks=pending_marks.copy(),
                     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.5 → 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
@@ -204,12 +206,12 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
                         k += 1
                     else:
                         break
+                sn_group = None
                 # Decide snippet name: continue overrides name_val/pending_name
                 if pending_continue:
-                    sn_name = pending_continue
+                    sn_group = pending_continue
                     pending_continue = None
-                else:
-                    sn_name = name_val or pending_name
+                sn_name = name_val or pending_name
                 sn_marks = pending_marks.copy()
                 sn_fixtures = pending_fixtures.copy()
                 pending_name = None
@@ -222,6 +224,7 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
                     line=j + 1,
                     marks=sn_marks,
                     fixtures=sn_fixtures,
+                    group=sn_group,
                 ))
 
                 i = k
@@ -235,11 +238,11 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
         # --------------------------------------------------------------------
         if line.rstrip().endswith("::") and pending_name:
             # Similar override logic
+            sn_group = None
             if pending_continue:
-                sn_name = pending_continue
+                sn_group = pending_continue
                 pending_continue = None
-            else:
-                sn_name = pending_name
+            sn_name = pending_name
             sn_marks = pending_marks.copy()
             sn_fixtures = pending_fixtures.copy()
             pending_name = None
@@ -273,6 +276,7 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
                 line=j + 1,
                 marks=sn_marks,
                 fixtures=sn_fixtures,
+                group=sn_group,
             ))
             i = k
             continue

{pytest_codeblock-0.5.5 → 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."""