Skip to main content

pytest plugin to test codeblocks in your documentation.

Project description

pytest_docfiles

Build Status PyPI Downloads License

pytest plugin to test code sections in your documentation.

Installation

pip install pytest_docfiles

Usage

Define code sections in your markdown files.

<!-- doc.md -->
# Hello World
```python
print("hello world!")
```

run pytest on your markdown files with the --docfiles flag.

pytest --docfiles doc.md

Features

Section Names

Define names for your code sections so they can be better identified in your pytest output

<!-- doc.md -->
```python {"name": "my-section"}
print("hello world")
```
$ pytest --docfiles doc.md
...
doc.md::my-section PASSED
...

Fixtures

Define your fixtures in conftest.py as usual

# conftest.py

import pytest

@pytest.fixture
def custom_fixture() -> str:
    return "fixture value"

@pytest.fixture(autouse=True)
def autouse() -> None:
    """autouse fixtures are used in each code section"""

use the fixtures in your code sections

<!-- doc.md -->
```python {"fixtures": ["custom_fixture"]}
assert custom_fixture == "fixture value"
```

Scopes

Code section depending on other code section can be executed in scopes.

```python {"scope": "my-scope"}
value = True
```
```python {"scope": "my-scope"}
assert value is True
```

Skip Sections

```python {"skip": true}
raise Exception("this section should not run")
```

Exception Handling

```python {"raises": "RuntimeError"}
raise RuntimeError("this section should pass")
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distribution

pytest_docfiles-0.2.0-py3-none-any.whl (5.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page