Skip to content
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

Jump to bottom

[8.2.x] Clarify pytest_ignore_collect docs #12386

Merged
merged 1 commit into from
May 28, 2024
Merged

[8.2.x] Clarify pytest_ignore_collect docs #12386

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
7 changes: 6 additions & 1 deletion src/_pytest/hookspec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading