pytest-codeblock 0.1.5__tar.gz → 0.1.6__tar.gz

pytest_codeblock-0.1.6/PKG-INFO

@@ -0,0 +1,293 @@
+Metadata-Version: 2.4
+Name: pytest-codeblock
+Version: 0.1.6
+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>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/barseghyanartur/pytest-codeblock/
+Project-URL: Repository, https://github.com/barseghyanartur/pytest-codeblock/
+Project-URL: Issues, https://github.com/barseghyanartur/pytest-codeblock/issues
+Project-URL: Documentation, https://pytest-codeblock.readthedocs.io/
+Project-URL: Changelog, https://pytest-codeblock.readthedocs.io/en/latest/changelog.html
+Keywords: pytest,plugin,documentation,code blocks,markdown,rst
+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
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pytest
+Provides-Extra: all
+Requires-Dist: pytest-codeblock[build,dev,docs,test]; extra == "all"
+Provides-Extra: dev
+Requires-Dist: detect-secrets; extra == "dev"
+Requires-Dist: doc8; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pydoclint; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: uv; extra == "dev"
+Provides-Extra: test
+Requires-Dist: django; extra == "test"
+Requires-Dist: fake.py; extra == "test"
+Requires-Dist: moto[s3]; extra == "test"
+Requires-Dist: openai; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-django; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx<6.0; extra == "docs"
+Requires-Dist: sphinx-autobuild; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.3.0; extra == "docs"
+Requires-Dist: sphinx-no-pragma; extra == "docs"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
+Requires-Dist: wheel; extra == "build"
+Dynamic: license-file
+
+================
+pytest-codeblock
+================
+
+.. External references
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
+.. _Markdown: https://daringfireball.net/projects/markdown/
+.. _pytest: https://docs.pytest.org
+.. _Django: https://www.djangoproject.com
+.. _pip: https://pypi.org/project/pip/
+.. _uv: https://pypi.org/project/uv/
+.. _fake.py: https://github.com/barseghyanartur/fake.py
+.. _boto3: https://github.com/boto/boto3
+.. _moto: https://github.com/getmoto/moto
+.. _openai: https://github.com/openai/openai-python
+.. _Ollama: https://github.com/ollama/ollama
+
+.. 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
+.. _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
+.. _llms.txt: https://barseghyanartur.github.io/pytest-codeblock/llms.txt
+
+Test your documentation code blocks.
+
+.. image:: https://img.shields.io/pypi/v/pytest-codeblock.svg
+   :target: https://pypi.python.org/pypi/pytest-codeblock
+   :alt: PyPI Version
+
+.. image:: https://img.shields.io/pypi/pyversions/pytest-codeblock.svg
+    :target: https://pypi.python.org/pypi/pytest-codeblock/
+    :alt: Supported Python versions
+
+.. image:: https://github.com/barseghyanartur/pytest-codeblock/actions/workflows/test.yml/badge.svg?branch=main
+   :target: https://github.com/barseghyanartur/pytest-codeblock/actions
+   :alt: Build Status
+
+.. image:: https://readthedocs.org/projects/pytest-codeblock/badge/?version=latest
+    :target: http://pytest-codeblock.readthedocs.io
+    :alt: Documentation Status
+
+.. image:: https://img.shields.io/badge/docs-llms.txt-blue
+    :target: https://barseghyanartur.github.io/pytest-codeblock/llms.txt
+    :alt: llms.txt - documentation for LLMs
+
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
+   :target: https://github.com/barseghyanartur/pytest-codeblock/#License
+   :alt: MIT
+
+.. image:: https://coveralls.io/repos/github/barseghyanartur/pytest-codeblock/badge.svg?branch=main&service=github
+    :target: https://coveralls.io/github/barseghyanartur/pytest-codeblock?branch=main
+    :alt: Coverage
+
+`pytest-codeblock`_ is a `Pytest`_ plugin that discovers Python code examples
+in your `reStructuredText`_ and `Markdown`_ documentation files and runs them
+as part of your test suite. This ensures your docs stay correct and up-to-date.
+
+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_``.
+- **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
+  to the code blocks and add hook into the tests life-cycle
+  using ``conftest.py``.
+
+Prerequisites
+=============
+- Python 3.9+
+- `pytest`_ is the only required dependency
+
+Documentation
+=============
+- Documentation is available on `Read the 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`_.
+
+Installation
+============
+
+Install with `pip`_:
+
+.. code-block:: sh
+
+    pip install pytest-codeblock
+
+Or install with `uv`_:
+
+.. code-block:: sh
+
+    uv pip install pytest-codeblock
+
+.. _configuration:
+
+Configuration
+=============
+*Filename: pyproject.toml*
+
+.. code-block:: text
+
+    [tool.pytest.ini_options]
+    testpaths = [
+        "**/*.rst",
+        "**/*.md",
+    ]
+
+Usage
+=====
+reStructruredText usage
+-----------------------
+Any code directive, such as ``.. code-block:: python``, ``.. code:: python``,
+or literal blocks with a preceding ``.. codeblock-name: <name>``, will be
+collected and executed automatically, if your `pytest`_ `configuration`_
+allows that.
+
+``code-block`` directive example
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. note:: Note that ``:name:`` value has a ``test_`` prefix.
+
+*Filename: README.rst*
+
+.. code-block:: rst
+
+    .. code-block:: python
+       :name: test_basic_example
+
+       import math
+
+       result = math.pow(3, 2)
+       assert result == 9
+
+
+``literalinclude`` directive example
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. note:: Note that ``:name:`` value has a ``test_`` prefix.
+
+*Filename: README.rst*
+
+.. code-block:: rst
+
+    .. literalinclude:: examples/python/basic_example.py
+        :name: test_li_basic_example
+
+See a dedicated `reStructuredText docs`_ for more.
+
+Markdown usage
+--------------
+
+Any fenced code block with a recognized Python language tag (e.g., ``python``,
+``py``) will be collected and executed automatically, if your `pytest`_
+`configuration`_ allows that.
+
+.. note:: Note that ``name`` value has a ``test_`` prefix.
+
+*Filename: README.md*
+
+.. code-block:: markdown
+
+    ```python name=test_basic_example
+    import math
+
+    result = math.pow(3, 2)
+    assert result == 9
+    ```
+
+See a dedicated `Markdown docs`_ for more.
+
+Tests
+=====
+
+Run the tests with `pytest`_:
+
+.. code-block:: sh
+
+    pytest
+
+Writing documentation
+=====================
+
+Keep the following hierarchy.
+
+.. code-block:: text
+
+    =====
+    title
+    =====
+
+    header
+    ======
+
+    sub-header
+    ----------
+
+    sub-sub-header
+    ~~~~~~~~~~~~~~
+
+    sub-sub-sub-header
+    ^^^^^^^^^^^^^^^^^^
+
+    sub-sub-sub-sub-header
+    ++++++++++++++++++++++
+
+    sub-sub-sub-sub-sub-header
+    **************************
+
+License
+=======
+
+MIT
+
+Support
+=======
+For security issues contact me at the e-mail given in the `Author`_ section.
+
+For overall issues, go
+to `GitHub <https://github.com/barseghyanartur/pytest-codeblock/issues>`_.
+
+Author
+======
+
+Artur Barseghyan <artur.barseghyan@gmail.com>

pytest_codeblock-0.1.6/README.rst

@@ -0,0 +1,234 @@
+================
+pytest-codeblock
+================
+
+.. External references
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
+.. _Markdown: https://daringfireball.net/projects/markdown/
+.. _pytest: https://docs.pytest.org
+.. _Django: https://www.djangoproject.com
+.. _pip: https://pypi.org/project/pip/
+.. _uv: https://pypi.org/project/uv/
+.. _fake.py: https://github.com/barseghyanartur/fake.py
+.. _boto3: https://github.com/boto/boto3
+.. _moto: https://github.com/getmoto/moto
+.. _openai: https://github.com/openai/openai-python
+.. _Ollama: https://github.com/ollama/ollama
+
+.. 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
+.. _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
+.. _llms.txt: https://barseghyanartur.github.io/pytest-codeblock/llms.txt
+
+Test your documentation code blocks.
+
+.. image:: https://img.shields.io/pypi/v/pytest-codeblock.svg
+   :target: https://pypi.python.org/pypi/pytest-codeblock
+   :alt: PyPI Version
+
+.. image:: https://img.shields.io/pypi/pyversions/pytest-codeblock.svg
+    :target: https://pypi.python.org/pypi/pytest-codeblock/
+    :alt: Supported Python versions
+
+.. image:: https://github.com/barseghyanartur/pytest-codeblock/actions/workflows/test.yml/badge.svg?branch=main
+   :target: https://github.com/barseghyanartur/pytest-codeblock/actions
+   :alt: Build Status
+
+.. image:: https://readthedocs.org/projects/pytest-codeblock/badge/?version=latest
+    :target: http://pytest-codeblock.readthedocs.io
+    :alt: Documentation Status
+
+.. image:: https://img.shields.io/badge/docs-llms.txt-blue
+    :target: https://barseghyanartur.github.io/pytest-codeblock/llms.txt
+    :alt: llms.txt - documentation for LLMs
+
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
+   :target: https://github.com/barseghyanartur/pytest-codeblock/#License
+   :alt: MIT
+
+.. image:: https://coveralls.io/repos/github/barseghyanartur/pytest-codeblock/badge.svg?branch=main&service=github
+    :target: https://coveralls.io/github/barseghyanartur/pytest-codeblock?branch=main
+    :alt: Coverage
+
+`pytest-codeblock`_ is a `Pytest`_ plugin that discovers Python code examples
+in your `reStructuredText`_ and `Markdown`_ documentation files and runs them
+as part of your test suite. This ensures your docs stay correct and up-to-date.
+
+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_``.
+- **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
+  to the code blocks and add hook into the tests life-cycle
+  using ``conftest.py``.
+
+Prerequisites
+=============
+- Python 3.9+
+- `pytest`_ is the only required dependency
+
+Documentation
+=============
+- Documentation is available on `Read the 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`_.
+
+Installation
+============
+
+Install with `pip`_:
+
+.. code-block:: sh
+
+    pip install pytest-codeblock
+
+Or install with `uv`_:
+
+.. code-block:: sh
+
+    uv pip install pytest-codeblock
+
+.. _configuration:
+
+Configuration
+=============
+*Filename: pyproject.toml*
+
+.. code-block:: text
+
+    [tool.pytest.ini_options]
+    testpaths = [
+        "**/*.rst",
+        "**/*.md",
+    ]
+
+Usage
+=====
+reStructruredText usage
+-----------------------
+Any code directive, such as ``.. code-block:: python``, ``.. code:: python``,
+or literal blocks with a preceding ``.. codeblock-name: <name>``, will be
+collected and executed automatically, if your `pytest`_ `configuration`_
+allows that.
+
+``code-block`` directive example
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. note:: Note that ``:name:`` value has a ``test_`` prefix.
+
+*Filename: README.rst*
+
+.. code-block:: rst
+
+    .. code-block:: python
+       :name: test_basic_example
+
+       import math
+
+       result = math.pow(3, 2)
+       assert result == 9
+
+
+``literalinclude`` directive example
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. note:: Note that ``:name:`` value has a ``test_`` prefix.
+
+*Filename: README.rst*
+
+.. code-block:: rst
+
+    .. literalinclude:: examples/python/basic_example.py
+        :name: test_li_basic_example
+
+See a dedicated `reStructuredText docs`_ for more.
+
+Markdown usage
+--------------
+
+Any fenced code block with a recognized Python language tag (e.g., ``python``,
+``py``) will be collected and executed automatically, if your `pytest`_
+`configuration`_ allows that.
+
+.. note:: Note that ``name`` value has a ``test_`` prefix.
+
+*Filename: README.md*
+
+.. code-block:: markdown
+
+    ```python name=test_basic_example
+    import math
+
+    result = math.pow(3, 2)
+    assert result == 9
+    ```
+
+See a dedicated `Markdown docs`_ for more.
+
+Tests
+=====
+
+Run the tests with `pytest`_:
+
+.. code-block:: sh
+
+    pytest
+
+Writing documentation
+=====================
+
+Keep the following hierarchy.
+
+.. code-block:: text
+
+    =====
+    title
+    =====
+
+    header
+    ======
+
+    sub-header
+    ----------
+
+    sub-sub-header
+    ~~~~~~~~~~~~~~
+
+    sub-sub-sub-header
+    ^^^^^^^^^^^^^^^^^^
+
+    sub-sub-sub-sub-header
+    ++++++++++++++++++++++
+
+    sub-sub-sub-sub-sub-header
+    **************************
+
+License
+=======
+
+MIT
+
+Support
+=======
+For security issues contact me at the e-mail given in the `Author`_ section.
+
+For overall issues, go
+to `GitHub <https://github.com/barseghyanartur/pytest-codeblock/issues>`_.
+
+Author
+======
+
+Artur Barseghyan <artur.barseghyan@gmail.com>

{pytest_codeblock-0.1.5 → pytest_codeblock-0.1.6}/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.1.5"
+version = "0.1.6"
 requires-python = ">=3.9"
 dependencies = [
     "pytest",
@@ -167,7 +167,6 @@ addopts = [
     "--ignore=.tox",
     "--ignore=requirements",
     "--ignore=release",
-    "--ignore=examples",
     "--ignore=tmp",
     "--cov-report=html",
     "--cov-report=term",
@@ -187,7 +186,7 @@ pythonpath = [
     "examples/md_example",
     "examples/rst_example",
 ]
-norecursedirs = [".git", "examples"]
+norecursedirs = [".git"]
 DJANGO_SETTINGS_MODULE = "django_settings"
 
 markers = [

{pytest_codeblock-0.1.5 → pytest_codeblock-0.1.6}/pytest_codeblock/__init__.py

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

{pytest_codeblock-0.1.5 → pytest_codeblock-0.1.6}/pytest_codeblock/rst.py

@@ -15,9 +15,11 @@ __license__ = "MIT"
 __all__ = (
     "RSTFile",
     "parse_rst",
+    "resolve_literalinclude_path",
+    "get_literalinclude_content",
 )
 
-# Highlight: Added helper function for literalinclude path resolution
+
 def resolve_literalinclude_path(
     base_dir: Path,
     include_path: str,
@@ -30,7 +32,7 @@ def resolve_literalinclude_path(
     if _include_path.exists():
         return str(_include_path.resolve())
 
-    _base_dir = Path(base_dir.dirname) if base_dir.isfile() else base_dir
+    _base_dir = Path(base_dir.dirname) if base_dir.is_file() else base_dir
     try:
         full_path = _base_dir / include_path
         if full_path.exists():