Skip to main content

Flake8 plugin to disallow the use of the pytest.mark.only decorator.

Project description

flake8-no-pytest-mark-only

A Flake8 plugin to check for the usage of the @pytest.mark.only decorator.

Rationale

The @pytest.mark.only decorator, coming from the pytest-only plugin, is great. It's super useful when developing your tests, so that you can run just the test (or set of tests) that you're working on, without having to run your whole test suite.

The only problem with it is that when you forget to remove it after you've finished developing your tests, and you accidentally commit it to your repository, it's hard to notice that only a subset of tests are running in CI instead of the whole test suite.

This Flake8 plugin prevents that, by raising a lint error on usages of the @pytest.mark.only decorator, so that you notice that you've committed changes with the decorator in them.

Usage

Just install the flake8-no-pytest-mark-only package, and when you run Flake8, it will automatically find the plugin and use it.

If you want to override the reporting from this plugin, you can filter for the error code PNO001:

# Turn on the errors from this plugin
flake8 --select PNO001 ...

# Turn off the errors from this plugin
flake8 --extend-ignore PNO001 ...

Project details


Download files

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

Source Distribution

flake8-no-pytest-mark-only-1.0.0.tar.gz (4.9 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page