Skip to main content

Pytest plugin to restrict the test types allowed

Project description

https://img.shields.io/github/workflow/status/adamchainz/pytest-restrict/CI/main?style=for-the-badge https://img.shields.io/pypi/v/pytest-restrict.svg?style=for-the-badge https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge pre-commit

Pytest plugin to restrict the test types allowed.

Features

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

About

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 blow up if it encountered non-whitelisted test types. This is a Pytest port of that plugin.

Installation

Install from pip with:

python -m pip install pytest-restrict

Python 3.6 to 3.10 supported.


Testing a Django project? Check out my book Speed Up Your Django Tests which covers loads of best practices so you can write faster, more accurate tests.


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 allowable test case base classes, for example:

# Allow only test cases that inherit from Django
pytest --restrict-types django.test.TestCase,django.test.SimpleTestCase

If you wish to allow function tests and other non-class test types (e.g. doctests), provide the special string ‘None’, for example:

# Allow function tests and our custom tests
pytest --restrict-types None,myproject.test.TestCase

This is most useful as a default set with addopts in your pytest.ini (docs):

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-restrict, version 4.1.0
Filename, size File type Python version Upload date Hashes
Filename, size pytest_restrict-4.1.0-py3-none-any.whl (4.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pytest-restrict-4.1.0.tar.gz (5.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page