pytest-routes
Property-based smoke testing for ASGI application routes.
Overview
pytest-routes automatically discovers routes from your ASGI application and performs randomized smoke testing using Hypothesis. It works with any ASGI framework, with first-class support for Litestar.
Key Features
- Automatic Route Discovery - Extracts routes directly from your ASGI app
- Property-Based Testing - Uses Hypothesis to generate diverse test inputs
- Framework Agnostic - Works with Litestar, FastAPI, Starlette, and any ASGI app
- Configurable - Filter routes, set examples per route, customize validation
- Zero Config - Works out of the box with sensible defaults
Installation
# With pip
pip install pytest-routes
# With uv
uv add pytest-routes
# With framework extras
uv add "pytest-routes[litestar]"
uv add "pytest-routes[fastapi]"
Quick Start
# Run smoke tests on your ASGI app
pytest --routes --routes-app myapp:app
# With options
pytest --routes --routes-app myapp:app --routes-max-examples 50
Or define your app as a fixture:
# conftest.py
import pytest
from myapp import create_app
@pytest.fixture(scope="session")
def app():
return create_app()
pytest --routes
Configuration
CLI Options
| Option | Description | Default |
|---|---|---|
--routes |
Enable route smoke testing | False |
--routes-app |
Import path to ASGI app | - |
--routes-max-examples |
Max Hypothesis examples per route | 100 |
--routes-exclude |
Comma-separated patterns to exclude | /health,/metrics,... |
--routes-include |
Comma-separated patterns to include | - |
--routes-methods |
HTTP methods to test | GET,POST,PUT,PATCH,DELETE |
--routes-seed |
Random seed for reproducibility | - |
pyproject.toml
[tool.pytest-routes]
app = "myapp:app"
max_examples = 100
exclude = ["/health", "/metrics", "/docs"]
methods = ["GET", "POST"]
Supported Frameworks
| Framework | Status | Notes |
|---|---|---|
| Litestar | First-class | Full type extraction |
| FastAPI | Supported | Via Starlette |
| Starlette | Supported | Base ASGI support |
How It Works
- Discovery - Extracts routes from your ASGI app using framework-specific extractors
- Generation - Creates Hypothesis strategies based on route parameter types
- Execution - Runs property-based tests against each route
- Validation - Checks responses meet smoke test criteria (no 5xx, etc.)
Documentation
Full documentation available at jacobcoffee.github.io/pytest-routes
License
MIT License - see LICENSE
1 maintainer
Metadata
1 maintainer
Release files for pytest-routes 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pytest_routes-0.4.1.tar.gz | 86.8 kB | With provenance | Details for pytest_routes-0.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pytest_routes-0.4.1-py3-none-any.whl | Python 3 | none | any | Details for pytest_routes-0.4.1-py3-none-any.whl |
Total release size: 188.9 kB
Release files / pytest_routes-0.4.1.tar.gz
| Download URL | pytest_routes-0.4.1.tar.gz |
|---|---|
| Size | 86.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
baccf8b15b0cfd290c62a9c3ca25f97ddf1376fd2367dedc568276ab87d1e316
|
|
BLAKE2b-256 checksum How to use checksums |
9e459be8ce7247ed7076790d800744878638a3ac6e64649fedaf2f2826bef629
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency logRelease files / pytest_routes-0.4.1-py3-none-any.whl
| Download URL | pytest_routes-0.4.1-py3-none-any.whl |
|---|---|
| Size | 102.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2c13bfd5363ebfc73bd2133d60f8642e5e1bf438f57723e2782be868f7f01834
|
|
BLAKE2b-256 checksum How to use checksums |
f843dd5df4b6656b46b5520dabed20737586c4c58500ce4e335d2b4ac7ce8d71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency logSecurity for pytest-routes 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for pytest_routes-0.4.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
