Skip to content

Allow module level skip #2808

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
RonnyPfannschmidt merged 8 commits into from
Oct 12, 2017
Merged

Allow module level skip #2808

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
79d3353
Add allow_module_level kwarg to skip helper
georgeyk Oct 1, 2017
06307be
Add initial tests using skip with allow_module_level kwarg
georgeyk Oct 1, 2017
e4a6e52
Update skipping documentation to include usage of allow_module_level …
georgeyk Oct 1, 2017
c1aa63c
Fix docstring alignment and typos
georgeyk Oct 3, 2017
59f6693
Update documentation example of pytest.skip(allow_module_level=True)
georgeyk Oct 3, 2017
9824499
Add 2808.feature changelog entry
georgeyk Oct 3, 2017
03ce0ad
Fix: handle CollectReport in folded_skips function
georgeyk Oct 4, 2017
0668a6c
Add myself to authors file
georgeyk Oct 5, 2017
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
Prev Previous commit
Next Next commit
Update documentation example of pytest.skip(allow_module_level=True)
  • Loading branch information
@georgeyk
georgeyk committed Oct 3, 2017
commit 59f66933cd9468eec3dc67714f1b686f8dfb1c39
7 changes: 4 additions & 3 deletions doc/en/skipping.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,12 @@ by calling the ``pytest.skip(reason)`` function:
It is also possible to skip the whole module using
``pytest.skip(reason, allow_module_level=True)`` at the module level:


.. code-block:: python

Copy link
Copy Markdown
Member

@RonnyPfannschmidt RonnyPfannschmidt Oct 2, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i do wonder if there is a better example for this (thats not looking like a skipif marker or a importorskip would already solve

Copy link
Copy Markdown
Contributor Author

@georgeyk georgeyk Oct 2, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe using the use case from previous discussion ? Something like:

if not pytest.config.getoption('--custom-flag'):
    pytest.skip('--custom-flag is missing, skipping tests', allow_module_level=True)

if not enabled_platform_edge_cases():
pytest.skip("unsupported platform", allow_module_level=True)
import pytest

if not pytest.config.getoption("--custom-flag"):
pytest.skip("--custom-flag is missing, skipping tests", allow_module_level=True)

The imperative method is useful when it is not possible to evaluate the skip condition
during import time.
Expand Down