pytest-deadfixtures 3.1.0

Important

The –dead-fixtures option will not run your tests and it’s also sensible for errors in the pytest collection step. If you are using as part of you CI process the recommended way is to run it after the default test run. For example:

script:
  - pytest
  - pytest --dead-fixtures

Listing unused fixtures

Just run ‘pytest’ with an extra option ‘–dead-fixtures’:

$ pytest --dead-fixtures
============================= test session starts ==============================
(hidden for brevity)

Hey there, I believe the following fixture(s) are not being used:
Fixture name: some_fixture, location: test_write_docs_when_verbose.py:5

========================= no tests ran in 0.00 seconds =========================

Using some level of verbosity will also print the docstring of each fixture:

$ pytest --dead-fixtures -v
============================= test session starts ==============================
(hidden for brevity)

Hey there, I believe the following fixture(s) are not being used:
Fixture name: some_fixture, location: test_write_docs_when_verbose.py:5
    Blabla fixture docs

========================= no tests ran in 0.00 seconds =========================

Listing repeated fixtures

Now that you removed every unused fixture of your test suite, what if you want to go an extra mile?

An important note about this is that it uses the fixture return value to verify if two or more fixtures are equal.

This means fixtures without a truthy return value will be skipped.

You should use this as a hint only, verify that the functionality provided by both fixtures are really repeated before deleting one of them.

Just run ‘pytest’ with an extra option ‘–dup-fixtures’, unlike the ‘–dead-fixtures’ option, it’ll normally run you tests:

$ pytest --dup-fixtures
======================================================================================================================== test session starts ========================================================================================================================
(hidden for brevity)

tests/test_deadfixtures.py ........

You may have some duplicate fixtures:
Fixture name: someclass_fixture, location: test_repeated_fixtures.py:12
Fixture name: someclass_samefixture, location: test_repeated_fixtures.py:17

Ignoring specific fixtures

You can use the @deadfixtures_ignore decorator to exclude specific fixtures from the analysis:

from pytest_deadfixtures import deadfixtures_ignore

@pytest.fixture
@deadfixtures_ignore
def intentionally_unused_fixture():
    """This fixture won't be reported as unused."""
    return "something"

To see which fixtures are being ignored, use the –show-ignored-fixtures option:

$ pytest --dead-fixtures --show-ignored-fixtures
============================= test session starts ==============================
(hidden for brevity)

No unused fixtures found. Great job!

Ignored fixtures (1):
Fixture name: intentionally_unused_fixture, location: conftest.py:10

========================= no tests ran in 0.00 seconds =========================