setupplan.py 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. from __future__ import annotations
  2. from _pytest.config import Config
  3. from _pytest.config import ExitCode
  4. from _pytest.config.argparsing import Parser
  5. from _pytest.fixtures import FixtureDef
  6. from _pytest.fixtures import SubRequest
  7. import pytest
  8. def pytest_addoption(parser: Parser) -> None:
  9. group = parser.getgroup("debugconfig")
  10. group.addoption(
  11. "--setupplan",
  12. "--setup-plan",
  13. action="store_true",
  14. help="Show what fixtures and tests would be executed but "
  15. "don't execute anything",
  16. )
  17. @pytest.hookimpl(tryfirst=True)
  18. def pytest_fixture_setup(
  19. fixturedef: FixtureDef[object], request: SubRequest
  20. ) -> object | None:
  21. # Will return a dummy fixture if the setuponly option is provided.
  22. if request.config.option.setupplan:
  23. my_cache_key = fixturedef.cache_key(request)
  24. fixturedef.cached_result = (None, my_cache_key, None)
  25. return fixturedef.cached_result
  26. return None
  27. @pytest.hookimpl(tryfirst=True)
  28. def pytest_cmdline_main(config: Config) -> int | ExitCode | None:
  29. if config.option.setupplan:
  30. config.option.setuponly = True
  31. config.option.setupshow = True
  32. return None