Skip to content

Docs: move collection-reporting hooks under collection hooks (fixes #… #14056

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
skprasadu wants to merge 4 commits into
base: main
Choose a base branch
from
+14 −10
Open

Docs: move collection-reporting hooks under collection hooks (fixes #… #14056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
10d169f
Docs: move collection-reporting hooks under collection hooks (fixes #…
krishna-prasad-tce Dec 21, 2025
e2fd41f
Add changelog entry for #12658
krishna-prasad-tce Dec 21, 2025
63ef06f
Add changelog entry for #12658
krishna-prasad-tce Dec 21, 2025
7a3557d
Docs: add changelog entry for #12658
krishna-prasad-tce Dec 21, 2025
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
1 change: 1 addition & 0 deletions changelog/12658.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Moved collection-reporting hooks in the API reference from “Reporting hooks” to the “Collection hooks” section.
23 changes: 13 additions & 10 deletions doc/en/reference/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,19 @@ items, delete or otherwise amend the test items:
If this hook is implemented in ``conftest.py`` files, it always receives all collected items, not only those
under the ``conftest.py`` where it is implemented.

Hooks for reporting about collection:

.. hook:: pytest_collectstart
.. autofunction:: pytest_collectstart
.. hook:: pytest_make_collect_report
.. autofunction:: pytest_make_collect_report
.. hook:: pytest_itemcollected
.. autofunction:: pytest_itemcollected
.. hook:: pytest_collectreport
.. autofunction:: pytest_collectreport
.. hook:: pytest_deselected
.. autofunction:: pytest_deselected

.. autofunction:: pytest_collection_finish

Test running (runtest) hooks
Expand Down Expand Up @@ -795,16 +808,6 @@ Reporting hooks

Session related reporting hooks:

.. hook:: pytest_collectstart
.. autofunction:: pytest_collectstart
.. hook:: pytest_make_collect_report
.. autofunction:: pytest_make_collect_report
.. hook:: pytest_itemcollected
.. autofunction:: pytest_itemcollected
.. hook:: pytest_collectreport
.. autofunction:: pytest_collectreport
.. hook:: pytest_deselected
.. autofunction:: pytest_deselected
.. hook:: pytest_report_header
.. autofunction:: pytest_report_header
.. hook:: pytest_report_collectionfinish
Expand Down