pytest-restrict 4.7.0

Features

This plugin allows you to restrict the test types allowed to ensure they inherit from one of a given list of classes. Useful on projects where you have custom test classes that developers may forget about.

Installation

Install with:

python -m pip install pytest-restrict

Python 3.9 to 3.13 supported.

Usage

Pytest will automatically find the plugin and use it when you run pytest, however by default there are no restrictions. To restrict the test types, provide --restrict-types as a comma-separated list of import paths to allowed test base classes. The import paths are passed to pkgutil.resolve_name(), for which you should prefer the form <module.path>:<classname>. It’s best to set --restrict-types within addopts in your pytest configuration file.

For example, to restrict tests to Django’s test case classes within pytest.ini:

[pytest]
addopts = --restrict-types django.test:SimpleTestCase

To allow function tests and other non-class test types (such as doctests), provide the special string “None”:

[pytest]
addopts = --restrict-types None,django.test:SimpleTestCase

History

I developed this feature in a closed source Nose plugin whilst working on the big Django project at YPlan. We had some custom enhancements and fixes on top of the Django test classes, but developers sometimes forgot about using them and instead used the built-in unittest classes, or the plain Django ones. Our solution was to just make the test runner error if it encountered non-whitelisted test types.

This package is a pytest port of that plugin.