Skip to content

docs: group collection reporting hooks #15000

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

docs: group collection reporting hooks #15000

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
53e1ddf
docs: group collection reporting hooks
LouisDeconinck Sep 10, 2026
ec2213a
docs: add changelog entry for hook grouping
LouisDeconinck Sep 10, 2026
adc0967
docs: preserve the existing hook changelog
LouisDeconinck Sep 10, 2026
4fde9a5
docs: add a new history fragment
LouisDeconinck Sep 10, 2026
0d4bfd7
docs: fold the collection-hooks fragment into 12658.doc.rst
LouisDeconinck Sep 13, 2026
2f74733
docs: add changelog entry for hook grouping
LouisDeconinck Sep 14, 2026
06fd86a
docs: name the changelog fragment after issue 12658
LouisDeconinck Sep 15, 2026
ba5eb67
Merge branch 'main' into docs/collection-hooks-12658
LouisDeconinck Sep 16, 2026
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/15000.doc.rst
View file
Open in desktop
Comment thread
LouisDeconinck marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Grouped collection reporting hooks with the other collection hooks in the reference documentation.
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 @@ -765,6 +765,19 @@ items, delete or otherwise amend the test items:
.. hook:: pytest_collection_finish
.. autofunction:: pytest_collection_finish

Collection 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

Test running (runtest) hooks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -805,16 +818,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