Skip to main content

A pytest plugin to list unused fixtures after a test run.

Project description

pytest-unused-fixtures

A pytest plugin to list unused fixtures after a test run.

The plugin watches all fixtures which are used in a test run, and then compares it to all the fixtures available in the same test collection. It then prints out all the fixtures which were not used, groupped by where they were defined.

Running the tests is required to accurately record which fixtures are used, as pytest provides ways of dynamically requesting fixtures, and pure static analysis will not catch those.

Installation

$ pip install pytest-unused-fixtures

Usage

After installing the package, the plugin is enabled by adding the switch --unused-fixtures.

Paths of fixtures can be ignored with one or multiple --unused-fixtures-ignore-path arguments. For example --unused-fixtures-ignore-path=venv will ignore all fixtures defined in the venv folder.

Ignoring specific fixtures from report

Sometimes there will be fixture which are unused on purpose, for example when used in tests which are skipped by default. A decorator is provided for ignoring fixtures from the unused report. See the example for usage:

import pytest
from pytest_unused_fixtures import ignore_unused_fixture

@pytest.fixture
@ignore_unused_fixture
def ignored_fixture():
    pass

Development

Poetry (dependencies) and pre-commit (coding standards) are required for development. Ther are some tests, obviously written in pytest.

$ poetry install
$ pre-commit install
$ pytest tests

Thanks

Many thanks to

Changelog

0.1.0 (Jun 14, 2023)

  • First Release

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

pytest_unused_fixtures-0.1.1.tar.gz (5.4 kB view hashes)

Uploaded Source

Built Distribution

pytest_unused_fixtures-0.1.1-py3-none-any.whl (7.3 kB view hashes)

Uploaded Python 3

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