pytest-involve
is a pytest
plugin for running only tests which cover a given file
or set of files. It's called pytest-involve
because it lets you run only tests involving
modules or members from those modules.
Usually with pytest
the test set to run is specified and coverage collected based on that set. When pytest-involve
is used, instead you specify the file(s) you want to cover, and test files are selected based
on whether they import from those file(s) or not.
pytest-involve
adds one command line argument to pytest
, namely --involving
.
This can be provided a file path, a module import path (such as you would use in a
Python interpreter), or either of the above suffixed with ::
and the name of something defined in there:
pytest --involving ./path/to/file.py
pytest --involving importable.module.path
pytest --involving ./path/to/file.py::member
pytest --involving importable.module.path::member
This will have the effect of only collecting and running tests which are defined in modules
whose imports overlap with the file(s) and member(s) specified with the --involving
flag.
The plugin aims for recall over precision: It might run a few tests that aren't strictly necessary, but it shouldn't ignore any tests that are.
The ::member
syntax will only work for things with a __file__
attribute
(so, mostly classes and functions).
pytest-involve
should play nicely with most other pytest
plugins and command line tooling.
One useful example is as follows:
git status -s | cut -c4- | grep .py | sed "s/^/--involving /" | xargs pytest
This will take all *.py
files mentioned in the output of git status
and provide them
to pytest
prefixed with --involving
, which allows for quickly running unit tests
relevant to the current state of the repository.
This pytest plugin was generated with Cookiecutter along with @hackebrot's cookiecutter-pytest-plugin template.
- Run unit tests covering specific file(s) via the command line flag
--involving
pytest
- That's it.
You can install "pytest-involve" via pip from PyPI:
$ pip install pytest-involve
Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.
Distributed under the terms of the MIT license, "pytest-involve" is free and open source software.
If you encounter any problems, please file an issue along with a detailed description.