kyfx
/
pytest
mirror of https://github.com/pytest-dev/pytest.git
4
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[8.2.x] Clarify pytest_ignore_collect docs (#12386) 

Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
This commit is contained in:
github-actions[bot] 2024-05-28 17:41:35 +00:00 committed by GitHub
parent 240a252d34
commit 1d103e5cdc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/_pytest/hookspec.py
View File

@ -310,7 +310,12 @@ def pytest_collection_finish(session: "Session") -> None:
def pytest_ignore_collect(
collection_path: Path, path: "LEGACY_PATH", config: "Config"
) -> Optional[bool]:
"""Return True to prevent considering this path for collection.
"""Return ``True`` to ignore this path for collection.
Return ``None`` to let other plugins ignore the path for collection.
Returning ``False`` will forcefully *not* ignore this path for collection,
without giving a chance for other plugins to ignore this path.
This hook is consulted for all files and directories prior to calling
more specific hooks.