{
  "$type": "site.standard.document",
  "canonicalUrl": "https://rednafi.com/python/inject-pytest-fixture/",
  "description": "Clean up pytest test signatures using @pytest.mark.usefixtures to inject implicit fixtures without autouse or unused parameter warnings.",
  "path": "/python/inject-pytest-fixture/",
  "publishedAt": "2024-12-02T00:00:00.000Z",
  "site": "at://did:plc:fgtm2c26vfcj74rfmeggbyqj/site.standard.publication/3mnl6f7ob462z",
  "tags": [
    "Python",
    "TIL",
    "Pytest",
    "Testing"
  ],
  "textContent": "Sometimes, when writing tests in Pytest, I find myself using fixtures that the test\nfunction/method doesn't directly reference. Instead, Pytest runs the fixture, and the test\nfunction implicitly leverages its side effects. For example:\n\nIn the test_stuff function above, we directly use the mock_svc fixture but not\nmock_env. Instead, we expect Pytest to run mock_env, which modifies the environment\nvariables. This works, but IDEs often mark mock_env as an unused parameter and dims it\nout.\n\nOne way to avoid this is by marking the mock_env fixture with\n@pytest.fixture(autouse=True) and omitting it from the test function's parameters.\nHowever, I prefer not to use autouse=True because it can make reasoning about tests\nharder.\n\nTIL that you can use [@pytest.mark.usefixtures] to inject these implicit fixtures without\ncluttering the test function signature or using autouse. Here's the same test marked with\nusefixtures:\n\nNow, the mock_env fixture is applied without cluttering the test function's signature, and\nno more greyed-out unused parameter warnings! The usefixtures marker also accepts multiple\nfixtures as variadic arguments: @pytest.mark.usefixtures(\"fixture_a\", \"fixture_b\").\n\nOne thing to keep in mind is that it won't work if you try to mark another fixture with the\nusefixtures decorator. The pytest documentation includes a [warning] about this.\n\nFin!\n\n\n\n\n[@pytest.mark.usefixtures]:\n    https://docs.pytest.org/en/7.1.x/how-to/fixtures.html#usefixtures\n\n[warning]:\n    https://docs.pytest.org/en/7.1.x/how-to/fixtures.html#usefixtures:~:text=usefixtures%20%3D%20cleandir-,Warning,-Note%20this%20mark",
  "title": "Injecting Pytest fixtures without cluttering test signatures"
}