Skip to content

docs: be more explicit about module level skip preventing collection #10753

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

Merged
merged 5 commits into from
Feb 28, 2023
Merged

docs: be more explicit about module level skip preventing collection #10753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5f83069
docs: be more explicit about module level skip preventing collection
RonnyPfannschmidt Feb 19, 2023
2a832f0
fixup: even more explicit about module skip preventing collect
RonnyPfannschmidt Feb 20, 2023
ebad614
Update src/_pytest/outcomes.py
RonnyPfannschmidt Feb 28, 2023
8c92a36
Update src/_pytest/outcomes.py
nicoddemus Feb 28, 2023
299902e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 28, 2023
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
2 changes: 2 additions & 0 deletions changelog/10753.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Change wording of the module level skip to be very explicit
about not collecting and not executing the rest of the module.
8 changes: 6 additions & 2 deletions src/_pytest/outcomes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,12 @@ def skip(
The message to show the user as reason for the skip.

:param allow_module_level:
Allows this function to be called at module level, skipping the rest
of the module. Defaults to False.
Allows this function to be called at module level.
Raising the skip exception at module level will stop
the execution of the module and prevent the collection of all tests in the module,
even those defined before the `skip` call.

Defaults to False.

:param msg:
Same as ``reason``, but deprecated. Will be removed in a future version, use ``reason`` instead.
Expand Down