A Python package for managing test dependencies in pytest.
Project description
pytest-depends-on
An advanced pytest plugin designed for Python projects, offering robust dependency management utilities to enhance the testing workflow.
It allows tests to be skipped based on the execution status of other tests, ensuring that dependent tests do not run if their prerequisites fail or are skipped, resulting in a cleaner and more efficient testing experience.
🚀 Features
- ✅ depends-on: A powerful marker to declare test dependencies. If a parent test fails or hasn't run, the dependent test is automatically skipped.
- Marker:
@pytest.mark.depends_on - Arguments:
tests(list): A list of parent test names (node IDs) that the current test depends on.status(optional): The expected status of the parent test. Defaults toPASSED. The dependent test will skip if the parent status does not match this value.allowed_not_run(optional): Boolean. IfTrue, the test will not skip if the parent test has not run yet. Defaults toFalse(skips if parent is missing).
- ✅ Automatic Status Tracking: Automatically tracks the result (
passed,failed,skipped,xfailed,xpassed) of every test during thecallphase to resolve dependencies dynamically.
- Marker:
📦 Installation
pip install pytest-depends-on
🔧 Usage
1. Register the marker
Add the marker to your pytest.ini file to avoid warnings (optional, as the plugin programmatically registers it, but good practice):
[pytest]
markers =
depends_on: mark test as dependent on another test
2. Implement in your tests
Use the marker decorator on your test functions.
Basic Dependency:
test_child will only run if test_parent passes.
import pytest
def test_parent():
assert True
@pytest.mark.depends_on(tests=["test_parent"])
def test_child():
assert True
Custom Status Dependency:
test_child will run only if test_parent fails (useful for testing error handling or recovery).
import pytest
from pytest_depends_on.consts.status import Status
@pytest.mark.depends_on(tests=["test_parent"], status=Status.FAILED)
def test_child():
pass
Soft Dependency:
test_child will run even if test_parent hasn't executed yet (e.g., due to ordering).
import pytest
@pytest.mark.depends_on(tests=["test_parent"], allowed_not_run=True)
def test_child():
pass
🤝 Contributing
If you have a helpful tool, pattern, or improvement to suggest:
Fork the repo
Create a new branch
Submit a pull request
I welcome additions that promote clean, productive, and maintainable development.
🙏 Thanks
Thanks for exploring this repository!
Happy coding!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pytest_depends_on-1.0.0.tar.gz.
File metadata
- Download URL: pytest_depends_on-1.0.0.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
41452282d44fcb37cb987bd3957f30586e69520ea96a26b58fbce1e2c22ef694
|
|
| MD5 |
7b4cb06c753cb88ac36d6d79804b7a22
|
|
| BLAKE2b-256 |
94a793e8e79f4e247fd1124f6d101f2cd1ceb3a99323fcb7d98a697fc024cbbf
|
File details
Details for the file pytest_depends_on-1.0.0-py3-none-any.whl.
File metadata
- Download URL: pytest_depends_on-1.0.0-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d876b4c34c440f910efeed91e99eab6510d4b6f90164bfcd38ab881952066381
|
|
| MD5 |
9daa74e09fa4bbd838f77c7f1e7fea76
|
|
| BLAKE2b-256 |
1e6d211025e84f8c9cb4c34e3f8ed4c37c59c75d8a9b9d9439b68bdbd4519297
|