pytest-codeblock 0.3.4__tar.gz → 0.4__tar.gz

{pytest_codeblock-0.3.4/src/pytest_codeblock.egg-info → pytest_codeblock-0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-codeblock
-Version: 0.3.4
+Version: 0.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>
@@ -15,7 +15,6 @@ Classifier: Framework :: Pytest
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -24,10 +23,11 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Software Development
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: pytest
+Requires-Dist: tomli; python_version < "3.11"
 Provides-Extra: all
 Requires-Dist: pytest-codeblock[build,dev,docs,test]; extra == "all"
 Provides-Extra: dev
@@ -75,12 +75,14 @@ pytest-codeblock
 .. _moto: https://github.com/getmoto/moto
 .. _openai: https://github.com/openai/openai-python
 .. _Ollama: https://github.com/ollama/ollama
+.. _tomli: https://pypi.org/project/tomli/
 
 .. Internal references
 
 .. _pytest-codeblock: https://github.com/barseghyanartur/pytest-codeblock/
 .. _Read the Docs: http://pytest-codeblock.readthedocs.io/
 .. _Examples: https://github.com/barseghyanartur/pytest-codeblock/tree/main/examples
+.. _Customisation docs: https://pytest-codeblock.readthedocs.io/en/latest/customisation.html
 .. _Contributor guidelines: https://pytest-codeblock.readthedocs.io/en/latest/contributor_guidelines.html
 .. _reStructuredText docs: https://pytest-codeblock.readthedocs.io/en/latest/restructured_text.html
 .. _Markdown docs: https://pytest-codeblock.readthedocs.io/en/latest/markdown.html
@@ -128,7 +130,7 @@ Features
   The only requirement here is that your code blocks shall
   have a name starting with ``test_``. Async code snippets are supported as
   well.
-- **Grouping by name**: Split a single example across multiple code blocks;
+- **Grouping**: Split a single example across multiple code blocks;
   the plugin concatenates them into one test.
 - **Pytest markers support**: Add existing or custom `pytest`_ markers
   to the code blocks and hook into the tests life-cycle using ``conftest.py``.
@@ -137,8 +139,9 @@ Features
 
 Prerequisites
 =============
-- Python 3.9+
-- `pytest`_ is the only required dependency
+- Python 3.10+
+- `pytest`_ is the only required dependency (on Python 3.11+; for Python 3.10
+  `tomli`_ is also required).
 
 Documentation
 =============
@@ -168,8 +171,25 @@ Or install with `uv`_:
 
 Configuration
 =============
-No configuration needed. All your `.rst` and `.md` files shall be picked
-automatically.
+For most use cases, no configuration needed. All your `.rst` and `.md` files
+shall be picked automatically.
+
+However, if you need to add another file extension or use or another language
+identifier for python in codeblock, you could configure that.
+
+See the following example of `pyproject.toml` configuration:
+
+*Filename: pyproject.toml*
+
+.. code-block:: toml
+
+    [tool.pytest-codeblock]
+    rst_user_codeblocks = ["c_py"]
+    rst_user_extensions = [".rst.txt"]
+    md_user_codeblocks = ["c_py"]
+    md_user_extensions = [".md.txt"]
+
+See `customisation docs`_ for more.
 
 Usage
 =====

{pytest_codeblock-0.3.4 → pytest_codeblock-0.4}/README.rst

@@ -14,12 +14,14 @@ pytest-codeblock
 .. _moto: https://github.com/getmoto/moto
 .. _openai: https://github.com/openai/openai-python
 .. _Ollama: https://github.com/ollama/ollama
+.. _tomli: https://pypi.org/project/tomli/
 
 .. Internal references
 
 .. _pytest-codeblock: https://github.com/barseghyanartur/pytest-codeblock/
 .. _Read the Docs: http://pytest-codeblock.readthedocs.io/
 .. _Examples: https://github.com/barseghyanartur/pytest-codeblock/tree/main/examples
+.. _Customisation docs: https://pytest-codeblock.readthedocs.io/en/latest/customisation.html
 .. _Contributor guidelines: https://pytest-codeblock.readthedocs.io/en/latest/contributor_guidelines.html
 .. _reStructuredText docs: https://pytest-codeblock.readthedocs.io/en/latest/restructured_text.html
 .. _Markdown docs: https://pytest-codeblock.readthedocs.io/en/latest/markdown.html
@@ -67,7 +69,7 @@ Features
   The only requirement here is that your code blocks shall
   have a name starting with ``test_``. Async code snippets are supported as
   well.
-- **Grouping by name**: Split a single example across multiple code blocks;
+- **Grouping**: Split a single example across multiple code blocks;
   the plugin concatenates them into one test.
 - **Pytest markers support**: Add existing or custom `pytest`_ markers
   to the code blocks and hook into the tests life-cycle using ``conftest.py``.
@@ -76,8 +78,9 @@ Features
 
 Prerequisites
 =============
-- Python 3.9+
-- `pytest`_ is the only required dependency
+- Python 3.10+
+- `pytest`_ is the only required dependency (on Python 3.11+; for Python 3.10
+  `tomli`_ is also required).
 
 Documentation
 =============
@@ -107,8 +110,25 @@ Or install with `uv`_:
 
 Configuration
 =============
-No configuration needed. All your `.rst` and `.md` files shall be picked
-automatically.
+For most use cases, no configuration needed. All your `.rst` and `.md` files
+shall be picked automatically.
+
+However, if you need to add another file extension or use or another language
+identifier for python in codeblock, you could configure that.
+
+See the following example of `pyproject.toml` configuration:
+
+*Filename: pyproject.toml*
+
+.. code-block:: toml
+
+    [tool.pytest-codeblock]
+    rst_user_codeblocks = ["c_py"]
+    rst_user_extensions = [".rst.txt"]
+    md_user_codeblocks = ["c_py"]
+    md_user_extensions = [".md.txt"]
+
+See `customisation docs`_ for more.
 
 Usage
 =====

{pytest_codeblock-0.3.4 → pytest_codeblock-0.4}/pyproject.toml

@@ -2,10 +2,11 @@
 name = "pytest-codeblock"
 description = "Pytest plugin to collect and test code blocks in reStructuredText and Markdown files."
 readme = "README.rst"
-version = "0.3.4"
-requires-python = ">=3.9"
+version = "0.4"
+requires-python = ">=3.10"
 dependencies = [
     "pytest",
+    "tomli; python_version < '3.11'",
 ]
 authors = [
     { name = "Artur Barseghyan", email = "artur.barseghyan@gmail.com" },
@@ -19,7 +20,6 @@ classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -156,6 +156,10 @@ known-third-party = []
 ignore-path = [
     "docs/requirements.txt",
     "src/pytest-codeblock.egg-info/SOURCES.txt",
+    "examples/customisation_example/*.rst",
+    "examples/customisation_example/*.rst.txt",
+    "examples/customisation_example/*.md",
+    "examples/customisation_example/*.md.txt",
 ]
 
 [tool.pytest.ini_options]

{pytest_codeblock-0.3.4 → pytest_codeblock-0.4}/src/pytest_codeblock/__init__.py

@@ -1,10 +1,11 @@
 from pathlib import Path
 
+from .config import get_config
 from .md import MarkdownFile
 from .rst import RSTFile
 
 __title__ = "pytest-codeblock"
-__version__ = "0.3.4"
+__version__ = "0.4"
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
 __copyright__ = "2025-2026 Artur Barseghyan"
 __license__ = "MIT"
@@ -15,12 +16,13 @@ __all__ = (
 
 def pytest_collect_file(parent, path):
     """Collect .md and .rst files for codeblock tests."""
+    config = get_config()
     # Determine file extension (works for py.path or pathlib.Path)
     file_name = str(path).lower()
-    if file_name.endswith((".md", ".markdown")):
+    if any(file_name.endswith(ext) for ext in config.all_md_extensions):
         # Use the MarkdownFile collector for Markdown files
         return MarkdownFile.from_parent(parent=parent, path=Path(path))
-    if file_name.endswith(".rst"):
+    if any(file_name.endswith(ext) for ext in config.all_rst_extensions):
         # Use the RSTFile collector for reStructuredText files
         return RSTFile.from_parent(parent=parent, path=Path(path))
     return None

pytest_codeblock-0.4/src/pytest_codeblock/config.py

@@ -0,0 +1,133 @@
+"""Configuration loading from pyproject.toml."""
+import sys
+from pathlib import Path
+from typing import Optional
+
+if sys.version_info >= (3, 11):
+    import tomllib
+else:
+    try:
+        import tomli as tomllib
+    except ImportError:
+        tomllib = None  # type: ignore[assignment]
+
+__author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
+__copyright__ = "2025-2026 Artur Barseghyan"
+__license__ = "MIT"
+__all__ = (
+    "get_config",
+    "Config",
+)
+
+# Default values
+DEFAULT_RST_CODEBLOCKS = ("py", "python", "python3")
+DEFAULT_MD_CODEBLOCKS = ("py", "python", "python3")
+DEFAULT_RST_EXTENSIONS = (".rst",)
+DEFAULT_MD_EXTENSIONS = (".md", ".markdown")
+
+
+class Config:
+    """Configuration container for pytest-codeblock."""
+
+    def __init__(
+        self,
+        rst_codeblocks: tuple[str, ...] = DEFAULT_RST_CODEBLOCKS,
+        rst_user_codeblocks: tuple[str, ...] = (),
+        md_codeblocks: tuple[str, ...] = DEFAULT_MD_CODEBLOCKS,
+        md_user_codeblocks: tuple[str, ...] = (),
+        rst_extensions: tuple[str, ...] = DEFAULT_RST_EXTENSIONS,
+        rst_user_extensions: tuple[str, ...] = (),
+        md_extensions: tuple[str, ...] = DEFAULT_MD_EXTENSIONS,
+        md_user_extensions: tuple[str, ...] = (),
+    ):
+        self.rst_codeblocks = rst_codeblocks
+        self.rst_user_codeblocks = rst_user_codeblocks
+        self.md_codeblocks = md_codeblocks
+        self.md_user_codeblocks = md_user_codeblocks
+        self.rst_extensions = rst_extensions
+        self.rst_user_extensions = rst_user_extensions
+        self.md_extensions = md_extensions
+        self.md_user_extensions = md_user_extensions
+
+    @property
+    def all_rst_codeblocks(self) -> tuple[str, ...]:
+        """Combined RST codeblocks (system + user)."""
+        return self.rst_codeblocks + self.rst_user_codeblocks
+
+    @property
+    def all_md_codeblocks(self) -> tuple[str, ...]:
+        """Combined MD codeblocks (system + user)."""
+        return self.md_codeblocks + self.md_user_codeblocks
+
+    @property
+    def all_rst_extensions(self) -> tuple[str, ...]:
+        """Combined RST extensions (system + user)."""
+        return self.rst_extensions + self.rst_user_extensions
+
+    @property
+    def all_md_extensions(self) -> tuple[str, ...]:
+        """Combined MD extensions (system + user)."""
+        return self.md_extensions + self.md_user_extensions
+
+
+_cached_config: Optional[Config] = None
+
+
+def _find_pyproject_toml() -> Optional[Path]:
+    """Find pyproject.toml starting from cwd and going up."""
+    cwd = Path.cwd()
+    for parent in [cwd, *cwd.parents]:
+        candidate = parent / "pyproject.toml"
+        if candidate.is_file():
+            return candidate
+    return None
+
+
+def _load_config_from_pyproject(path: Path) -> dict:
+    """Load [tool.pytest-codeblock] section from pyproject.toml."""
+    if tomllib is None:
+        return {}
+    try:
+        with open(path, "rb") as f:
+            data = tomllib.load(f)
+        return data.get("tool", {}).get("pytest-codeblock", {})
+    except Exception:
+        return {}
+
+
+def get_config(*, force_reload: bool = False) -> Config:
+    """Get the configuration, loading from pyproject.toml if available."""
+    global _cached_config
+
+    if _cached_config is not None and not force_reload:
+        return _cached_config
+
+    pyproject_path = _find_pyproject_toml()
+    if pyproject_path is None:
+        _cached_config = Config()
+        return _cached_config
+
+    raw = _load_config_from_pyproject(pyproject_path)
+
+    def to_tuple(val, default: tuple[str, ...]) -> tuple[str, ...]:
+        if val is None:
+            return default
+        if isinstance(val, (list, tuple)):
+            return tuple(val)
+        return default
+
+    _cached_config = Config(
+        rst_codeblocks=to_tuple(
+            raw.get("rst_codeblocks"), DEFAULT_RST_CODEBLOCKS
+        ),
+        rst_user_codeblocks=to_tuple(raw.get("rst_user_codeblocks"), ()),
+        md_codeblocks=to_tuple(raw.get("md_codeblocks"), DEFAULT_MD_CODEBLOCKS),
+        md_user_codeblocks=to_tuple(raw.get("md_user_codeblocks"), ()),
+        rst_extensions=to_tuple(
+            raw.get("rst_extensions"), DEFAULT_RST_EXTENSIONS
+        ),
+        rst_user_extensions=to_tuple(raw.get("rst_user_extensions"), ()),
+        md_extensions=to_tuple(raw.get("md_extensions"), DEFAULT_MD_EXTENSIONS),
+        md_user_extensions=to_tuple(raw.get("md_user_extensions"), ()),
+    )
+    return _cached_config

{pytest_codeblock-0.3.4 → pytest_codeblock-0.4}/src/pytest_codeblock/md.py

@@ -8,6 +8,7 @@ from typing import Optional
 import pytest
 
 from .collector import CodeSnippet, group_snippets
+from .config import get_config
 from .constants import CODEBLOCK_MARK, DJANGO_DB_MARKS, TEST_PREFIX
 from .helpers import contains_top_level_await, wrap_async_code
 
@@ -28,22 +29,23 @@ def parse_markdown(text: str) -> list[CodeSnippet]:
     Supports:
       - <!-- pytestmark: <mark> --> comments immediately before a code fence
       - <!-- codeblock-name: <name> --> comments for naming
-      - <!-- continue:  <name> --> comments for grouping with a named snippet
+      - <!-- 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.
     """
-    snippets:  list[CodeSnippet] = []
+    config = get_config()
+    snippets: list[CodeSnippet] = []
     lines = text.splitlines()
-    pending_name:  Optional[str] = None
+    pending_name: Optional[str] = None
     pending_continue: Optional[str] = None
     pending_marks: list[str] = [CODEBLOCK_MARK]
     pending_fixtures: list[str] = []
     in_block = False
     fence = ""
     block_indent = 0
-    code_buffer:  list[str] = []
+    code_buffer: list[str] = []
     snippet_name: Optional[str] = None
     start_line = 0
 
@@ -92,7 +94,7 @@ def parse_markdown(text: str) -> list[CodeSnippet]:
                 parts = info.split(None, 1)
                 lang = parts[0].lower() if parts else ""
                 extra = parts[1] if len(parts) > 1 else ""
-                if lang in ("python", "py", "python3"):
+                if lang in config.all_md_codeblocks:
                     in_block = True
                     block_indent = indent
                     start_line = idx + 1
@@ -173,7 +175,7 @@ class MarkdownFile(pytest.File):
             _fpath = str(self.path)
 
             # Build list of fixture names requested by this snippet
-            _fixture_names:  list[str] = list(sn.fixtures)
+            _fixture_names: list[str] = list(sn.fixtures)
 
             # If snippet is marked as needing DB, also request the `db`
             # fixture, unless user already added it explicitly.

{pytest_codeblock-0.3.4 → pytest_codeblock-0.4}/src/pytest_codeblock/rst.py

@@ -9,6 +9,7 @@ from typing import Optional, Union
 import pytest
 
 from .collector import CodeSnippet, group_snippets
+from .config import get_config
 from .constants import CODEBLOCK_MARK, DJANGO_DB_MARKS, TEST_PREFIX
 from .helpers import contains_top_level_await, wrap_async_code
 
@@ -69,6 +70,7 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
       - .. codeblock-name: <name>
       - .. code-block:: python
     """
+    config = get_config()
     snippets: list[CodeSnippet] = []
     lines = text.splitlines()
     n = len(lines)
@@ -159,7 +161,7 @@ def parse_rst(text: str, base_dir: Path) -> list[CodeSnippet]:
         if m:
             base_indent = len(m.group(1))
             lang = m.group(2).lower()
-            if lang in ("python", "py", "python3"):
+            if lang in config.all_rst_codeblocks:
                 # Parse :name: option
                 name_val: Optional[str] = None
                 j = i + 1

{pytest_codeblock-0.3.4 → pytest_codeblock-0.4}/src/pytest_codeblock/tests/conftest.py

@@ -13,6 +13,9 @@ __all__ = (
 )
 
 
+pytest_plugins = ["pytester"]
+
+
 @pytest.fixture
 def http_request_factory():
     """
@@ -47,3 +50,13 @@ def markdown_with_pytest_mark():
 ```python name=test_db
 from django.db import models
 ```"""
+
+
+@pytest.fixture
+def pytester_subprocess(pytester):
+    """
+    Wrapper that forces subprocess mode to avoid deprecation warning conflicts
+    when the plugin uses the old `path` argument signature.
+    """
+    pytester.runpytest = pytester.runpytest_subprocess
+    return pytester

pytest_codeblock-0.4/src/pytest_codeblock/tests/test_customisation.py

@@ -0,0 +1,96 @@
+"""Tests for customisation of languages and extensions."""
+from unittest.mock import patch
+
+from ..config import get_config
+from ..md import parse_markdown
+
+
+class TestCustomLanguages:
+    """Test custom language support in markdown."""
+
+    def test_custom_md_language_recognized(self):
+        """Test that custom markdown language is recognised when configured."""
+        # Mock config to include custom language
+        mock_config = {
+            "all_md_codeblocks": ["python", "djc_py"],  # djc_py is custom
+            "all_rst_codeblocks": ["python"],
+            "all_md_extensions": [".md"],
+            "all_rst_extensions": [".rst"],
+        }
+
+        text = """
+```djc_py name=custom_lang
+x = 1
+```
+"""
+        with patch("pytest_codeblock.md.get_config") as mock_get_config:
+            mock_config_obj = type("Config", (), mock_config)()
+            mock_get_config.return_value = mock_config_obj
+
+            snippets = parse_markdown(text)
+            assert len(snippets) == 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."""
+        text = """
+```unknown_lang
+x = 1
+```
+"""
+        snippets = parse_markdown(text)
+        assert len(snippets) == 0
+
+
+class TestCustomExtensions:
+    """Test custom file extension support."""
+
+    def test_config_includes_custom_extensions(self):
+        """Test that config can include custom extensions."""
+        config = get_config()
+        # By default should include .md and .rst
+        assert ".md" in config.all_md_extensions
+        assert ".rst" in config.all_rst_extensions
+
+    def test_python_as_custom_md_extension(self):
+        """Test that .py files can be configured as markdown sources."""
+        # This test verifies the config structure supports it
+        mock_config = {
+            "all_md_codeblocks": ["python"],
+            "all_rst_codeblocks": ["python"],
+            "all_md_extensions": [".md", ".txt"],  # .txt added
+            "all_rst_extensions": [".rst"],
+        }
+
+        mock_config_obj = type("Config", (), mock_config)()
+        # Verify .txt extension is in the list
+        assert ".txt" in mock_config_obj.all_md_extensions
+
+
+class TestDefaults:
+    """Test that defaults are preserved."""
+
+    def test_default_python_language_works(self):
+        """Test that default Python language is always available."""
+        text = """
+```python
+x = 1
+```
+"""
+        snippets = parse_markdown(text)
+        assert len(snippets) == 1
+
+    # -------------------------------------------------------------------------
+
+    def test_default_md_extension(self):
+        """Test that .md is always a supported extension."""
+        config = get_config()
+        assert ".md" in config.all_md_extensions
+
+    def test_default_rst_extension(self):
+        """Test that .rst is always a supported extension."""
+        config = get_config()
+        assert ".rst" in config.all_rst_extensions