A conftest implementing every hook

Showing pytest 9.1.1 pytest 9.1.0 pytest 9.0.3 pytest 9.0.2 pytest 9.0.1 pytest 9.0.0 pytest 8.4.2 pytest 8.4.1 pytest 8.4.0 pytest 8.3.5 pytest 8.3.4 pytest 8.3.3 pytest 8.3.2 pytest 8.3.1 pytest 8.3.0 pytest 8.2.2 pytest 8.2.1 pytest 8.2.0 pytest 8.1.2 pytest 8.1.1 pytest 8.0.2 pytest 8.0.1 pytest 8.0.0 pytest 7.4.4 pytest 7.4.3 pytest 7.4.2 pytest 7.4.1 pytest 7.4.0 pytest 7.3.2 pytest 7.3.1 pytest 7.3.0 pytest 7.2.2 pytest 7.2.1 pytest 7.2.0 pytest 7.1.3 pytest 7.1.2 pytest 7.1.1 pytest 7.1.0 pytest 7.0.1 pytest 7.0.0 pytest 6.2.5 pytest 6.2.4 pytest 6.2.3 pytest 6.2.2 pytest 6.2.1 pytest 6.2.0 pytest 6.1.2 pytest 6.1.1 pytest 6.1.0 pytest 6.0.2 pytest 6.0.1 pytest 6.0.0

pytest 7.3.2 - 7.4.4 - What actually happens when a conftest.py implements all 52 declared hooks.

These 6 releases produced an identical flow, so they share one page. Identical as far as this scenario can measure - a scenario exercising more hooks may tell them apart.

The conftest.py here is generated: it implements every hook pytest declares.

Deprecated hooks are implemented too, which pytest would normally refuse - the run suppresses its own removal warnings so that the conftest really does cover everything the version declares.

This is the scenario that shows which hooks a conftest.py can and cannot serve. Some hooks have already fired by the time a conftest is imported, so implementing them there does nothing at all - the implementation is registered, and never called.

How this was produced

• Source: scenarios/every-hook-conftest/ - the project this diagram was traced from
• Invocation: pytest . -q -W ignore::pytest.PytestDeprecationWarning
• Traced against: pytest 7.4.4, pluggy 1.6.0, Python 3.12.3
• Covers: 6 releases - pytest 7.3.2 - 7.4.4, which produced an identical flow
• Observed: 326 hook calls, 40 distinct hooks

The project is test_dummy.py. Browse it in the repository rather than inline here - scenarios grow directory trees, and GitHub renders them better than a collapsed block can.

The whole run

Phases left to right, steps top to bottom. Colour says which phase a hook belongs to; how dark a step is says how often it was called. Click a column heading to jump to that phase in full detail, or any hook to open its pytest documentation. Why it looks like this

Startup and configuration

Everything before collection begins: initial conftests are loaded, plugins register, and the session is configured.

Collection

Finding tests. Note that pytest_make_collect_report recurses - directories contain directories contain files.

The run-test protocol

pytest_runtestloop runs this once per collected test. Note the rhythm: setup, call and teardown are each followed by their own makereport and logreport pair - three reports per test, not one.

The path 5 of 8 took.

The others differed:

• 1 test also called pytest_exception_interact
• 1 test skipped pytest_fixture_post_finalizer, pytest_fixture_setup, pytest_pyfunc_call, pytest_runtest_call
• 1 test also called pytest_warning_recorded and skipped pytest_fixture_post_finalizer, pytest_fixture_setup

Session finish

Summary reporting and teardown of the session.

Hooks a conftest cannot serve

This scenario's conftest.py implements every hook pytest declares. The hooks below still fired without it: the implementation was registered and never invoked, because the conftest had not been imported yet when the hook ran, or sits below the level the hook applies to.

• pytest_cmdline_preparse
• pytest_load_initial_conftests

Every hook observed

Hook	Calls	Semantics	Implemented by, in call order
pytest_addhooks	1	historic	conftest.py
pytest_addoption	1	historic	conftest.py
pytest_cmdline_main	1	firstresult	_pytest.setupplan [tryfirst] _pytest.setuponly [tryfirst] _pytest.mark [tryfirst] conftest.py _pytest.python _pytest.helpconfig _pytest.main
pytest_cmdline_preparse	1		-
pytest_collect_file	5		conftest.py _pytest.doctest _pytest.python
pytest_collection	1	firstresult	_pytest.logging.LoggingPlugin (logging-plugin) [hookwrapper, tryfirst] _pytest.warnings [hookwrapper, tryfirst] _pytest.config.Config (pytestconfig) [hookwrapper] _pytest.terminal.TerminalReporter conftest.py _pytest.assertion _pytest.main
pytest_collection_finish	1		_pytest.terminal.TerminalReporter conftest.py
pytest_collection_modifyitems	1		_pytest.fixtures.FixtureManager (funcmanage) conftest.py _pytest.main _pytest.mark
pytest_collectreport	2		_pytest.main.Session.pytest_runtest_logreport (session) [tryfirst] _pytest.terminal.TerminalReporter conftest.py
pytest_collectstart	2		_pytest.main.Session [tryfirst] conftest.py
pytest_configure	1	historic	conftest.py _pytest.faulthandler _pytest.warnings _pytest.junitxml _pytest.tmpdir _pytest.legacypath _pytest.skipping _pytest.debugging _pytest.terminal _pytest.python _pytest.mark _pytest.config.PytestPluginManager (<anonymous>) _pytest.pastebin [trylast] _pytest.logging [trylast]
pytest_exception_interact	1		_pytest.faulthandler [tryfirst] conftest.py
pytest_fixture_post_finalizer	11		conftest.py _pytest.setuponly
pytest_fixture_setup	11	firstresult	_pytest.setuponly [hookwrapper] _pytest.setupplan [tryfirst] conftest.py _pytest.fixtures
pytest_generate_tests	4		_pytest.fixtures.FixtureManager (funcmanage) conftest.py _pytest.python
pytest_ignore_collect	5	firstresult	conftest.py _pytest.main
pytest_itemcollected	8		conftest.py
pytest_load_initial_conftests	1		_pytest.warnings [hookwrapper] _pytest.capture [hookwrapper] _pytest.python_path [tryfirst] _pytest.legacypath [tryfirst] _pytest.config.Config (pytestconfig) [trylast]
pytest_make_collect_report	2	firstresult	_pytest.capture.CaptureManager [hookwrapper] conftest.py _pytest.runner
pytest_make_parametrize_id	5	firstresult	conftest.py
pytest_plugin_registered	118	historic	_pytest.legacypath conftest.py _pytest.terminal.TerminalReporter _pytest.fixtures.FixtureManager (funcmanage)
pytest_pycollect_makeitem	10	firstresult	conftest.py _pytest.unittest _pytest.python [trylast]
pytest_pycollect_makemodule	1	firstresult	conftest.py _pytest.python
pytest_pyfunc_call	7	firstresult	conftest.py _pytest.python [trylast]
pytest_report_collectionfinish	1		conftest.py
pytest_report_teststatus	24	firstresult	conftest.py _pytest.skipping _pytest.runner _pytest.terminal [trylast]
pytest_runtest_call	7		_pytest.threadexception [hookwrapper, tryfirst] _pytest.unraisableexception [hookwrapper, tryfirst] _pytest.logging.LoggingPlugin (logging-plugin) [hookwrapper] _pytest.capture.CaptureManager [hookwrapper] _pytest.skipping [hookwrapper] conftest.py _pytest.runner
pytest_runtest_logfinish	8		_pytest.logging.LoggingPlugin (logging-plugin) _pytest.terminal.TerminalReporter conftest.py
pytest_runtest_logreport	23		_pytest.main.Session [tryfirst] _pytest.logging.LoggingPlugin (logging-plugin) _pytest.terminal.TerminalReporter conftest.py
pytest_runtest_logstart	8		_pytest.logging.LoggingPlugin (logging-plugin) _pytest.terminal.TerminalReporter conftest.py
pytest_runtest_makereport	23	firstresult	_pytest.tmpdir [hookwrapper, tryfirst] _pytest.skipping [hookwrapper] _pytest.unittest [tryfirst] conftest.py _pytest.runner
pytest_runtest_protocol	8	firstresult	_pytest.warnings [hookwrapper, tryfirst] _pytest.assertion [hookwrapper, tryfirst] _pytest.unittest [hookwrapper] _pytest.faulthandler [hookwrapper, trylast] conftest.py _pytest.runner
pytest_runtest_setup	8		_pytest.unraisableexception [hookwrapper, tryfirst] _pytest.logging.LoggingPlugin (logging-plugin) [hookwrapper] _pytest.capture.CaptureManager [hookwrapper] _pytest.threadexception [hookwrapper, trylast] _pytest.skipping [tryfirst] conftest.py _pytest.runner _pytest.nose [trylast]
pytest_runtest_teardown	8		_pytest.threadexception [hookwrapper, tryfirst] _pytest.unraisableexception [hookwrapper, tryfirst] _pytest.logging.LoggingPlugin (logging-plugin) [hookwrapper] _pytest.capture.CaptureManager [hookwrapper] conftest.py _pytest.runner
pytest_runtestloop	1	firstresult	_pytest.logging.LoggingPlugin (logging-plugin) [hookwrapper] conftest.py _pytest.main
pytest_sessionfinish	1		_pytest.logging.LoggingPlugin (logging-plugin) [hookwrapper, tryfirst] _pytest.terminal.TerminalReporter [hookwrapper] _pytest.warnings [hookwrapper] conftest.py _pytest.assertion _pytest.tmpdir _pytest.runner
pytest_sessionstart	1		_pytest.logging.LoggingPlugin (logging-plugin) [hookwrapper, tryfirst] conftest.py _pytest.fixtures _pytest.runner _pytest.terminal.TerminalReporter [trylast]
pytest_terminal_summary	1		_pytest.terminal.TerminalReporter [hookwrapper] _pytest.warnings [hookwrapper] conftest.py _pytest.pastebin _pytest.runner
pytest_unconfigure	1		_pytest.logging.LoggingPlugin (logging-plugin) _pytest.terminal.TerminalReporter conftest.py _pytest.faulthandler _pytest.doctest _pytest.junitxml _pytest.pastebin _pytest.mark _pytest.python_path [trylast]
pytest_warning_recorded	2	historic	_pytest.terminal.TerminalReporter conftest.py