Skip to content

jasongi/pytest-uncollect-if

Repository files navigation

pytest-uncollect-if

PyPI version Python versions See Build Status on GitHub Actions

A pytest plugin to uncollect tests based on a condition without the tests being included in the skipped for deselected report counts. This makes it easier use the Cartesian product of two different usages of pytest.mark.parametrize where you want to disable a specific combination.

This pytest plugin was generated with Cookiecutter along with @hackebrot's cookiecutter-pytest-plugin template.

Requirements

  • pytest > 6.2.0

For development requirements, run

pip install -r requirements-dev.txt

Installation

You can install "pytest-uncollect-if" via pip from PyPI

pip install pytest-uncollect-if

If you do not have autoload enabled, add the plugin to your top-level conftest.py

pytest_plugins = ("pytest_uncollect_if.plugin",)

Usage

The marker takes a single argument func which accepts parameters as **kwargs and returns a boolean value. If the return value is True, the test will be uncollected. To avoid fragile statements that fail on extra parameters, be sure to add **kwargs to your function signature.

param1_decorator = pytest.mark.parametrize("param1", [1, 2, 3, 4])
param2_decorator = pytest.mark.parametrize("param2", [1, 2, 3, 4])


# uncollect if param and param2 are equal
@pytest.mark.uncollect_if(func=lambda param1, param2, **kwargs: param1 == param2)
def test_uncollect_if(param1, param2):
    assert param != param2

A typed alias for pytest.mark.uncollect_if is available as uncollect_if

from pytest_uncollect_if import uncollect_if

param1_decorator = pytest.mark.parametrize("param1", [1, 2, 3, 4])
param2_decorator = pytest.mark.parametrize("param2", [1, 2, 3, 4])


# uncollect if param and param2 are equal
@uncollect_if(func=lambda param1, param2, **kwargs: param1 == param2)
def test_uncollect_if(param1, param2):
    assert param != param2

Contributing

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.

License

Distributed under the terms of the MIT license, "pytest-uncollect-if" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.