Skip to content

docs: clarify the purpose of reporting hooks #15175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
otosmane wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify the purpose of reporting hooks #15175

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/en/reference/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,9 +721,14 @@ Initialization hooks called for plugins and ``conftest.py`` files.
.. hook:: pytest_plugin_registered
.. autofunction:: pytest_plugin_registered

.. _`collection-hooks`:

Collection hooks
~~~~~~~~~~~~~~~~

Hooks that report collection events, such as :hook:`pytest_collectstart` and
:hook:`pytest_itemcollected`, are listed under :ref:`reporting-hooks`.

``pytest`` calls the following hooks for collecting files and directories:

.. hook:: pytest_collection
Expand Down Expand Up @@ -800,9 +805,17 @@ into interactive debugging when a test failure occurs.
.. hook:: pytest_pyfunc_call
.. autofunction:: pytest_pyfunc_call

.. _`reporting-hooks`:

Reporting hooks
~~~~~~~~~~~~~~~

Reporting hooks let plugins observe events and reports from pytest, including
events during collection and test execution. A plugin can use these notifications
to produce output, but implementing a reporting hook does not require displaying
anything to the user. Hooks that perform or modify collection are listed under
:ref:`collection-hooks`.

Session related reporting hooks:

.. hook:: pytest_collectstart
Expand Down
Loading