pytest-snail

Plugin for adding a marker to slow running tests. 🐌


Keywords
pytest, pytest-plugin, python
License
MIT
Install
pip install pytest-snail==0.1.0

Documentation

pytest-snail

Plugin for adding a marker to slow running tests. 🐌

Installation

You can install pytest-snail via pip from PyPI:

pip install pytest-snail==0.1.0

Usage

When you run your tests, pytest-snail keeps track of test durations for each test item by test phase: setup, call, and teardown.

The next time you run your tests, pytest-snail adds a snail marker to all test items with a recorded, accumulated duration that is equal or longer than the value for the --snail CLI option (defaults to 5.0 seconds).

You can then use pytest's marker expressions to select or deselect tests.

Examples

First run your tests to measure test durations:

pytest

Then deselect all tests that take longer than 5.0 seconds to complete:

pytest -m "not snail"

Select only tests that take longer than 10.0 seconds to complete:

pytest --snail 10.0 -m snail

Community

Please check out the good first issue label for tasks, that are good candidates for your first contribution to pytest-snail. Your contributions are greatly appreciated! Every little bit helps, and credit will always be given!

You can also support the development of this project by volunteering to become a maintainer, which means you will be able to triage issues, merge pull-requests, and publish new releases. If you're interested, please submit a pull-request to add yourself to the list of maintainers and we'll get you started! 🚀

Please note that pytest-snail is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Distributed under the terms of the MIT license, pytest-snail is free and open source software.