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

Clarify pytest_ignore_collect docs #12385

Merged
merged 2 commits into from
May 28, 2024
Merged

Clarify pytest_ignore_collect docs #12385

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df2fccd
Clarify pytest_ignore_collect docs
nicoddemus May 28, 2024
ac1d99e
Apply suggestions from code review
nicoddemus May 28, 2024
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 @@ -311,7 +311,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 prevent considering this path for collection.

Return ``None`` to let other plugins ignore the path for collection.

Returning ``False`` will forcefully consider this path to be considered
for collection, without giving a chance of other plugins to ignore this file.

This hook is consulted for all files and directories prior to calling
more specific hooks.
Expand Down
Loading