p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #6993 from blueyed/doc-pytest_collection-upstream 

[WIP] doc: pytest_collection: has to set `session.items`
This commit is contained in:
Ran Benita 2020-05-05 21:05:56 +03:00 committed by GitHub
parent b4c46da278 a98a62723e
commit 85732e2b08
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/_pytest/hookspec.py
View File

@ -176,6 +176,21 @@ def pytest_collection(session: "Session") -> Optional[Any]:
"""Perform the collection protocol for the given session.
Stops at first non-None result, see :ref:`firstresult`.
The return value is not used, but only stops further processing.
The hook is meant to set `session.items` to a sequence of items at least,
but normally should follow this procedure:
1. Call the pytest_collectstart hook.
2. Call the pytest_collectreport hook.
3. Call the pytest_collection_modifyitems hook.
4. Call the pytest_collection_finish hook.
5. Set session.testscollected to the amount of collect items.
6. Set `session.items` to a list of items.
You can implement this hook to only perform some action before collection,
for example the terminal plugin uses it to start displaying the collection
counter (and returns `None`).
:param _pytest.main.Session session: the pytest session object
"""