Update documentation example of pytest.skip(allow_module_level=True)

This commit is contained in:
George Y. Kussumoto 2017-10-02 21:26:00 -03:00
parent c1aa63c0bb
commit 59f66933cd
1 changed files with 4 additions and 3 deletions

View File

@ -57,11 +57,12 @@ by calling the ``pytest.skip(reason)`` function:
It is also possible to skip the whole module using It is also possible to skip the whole module using
``pytest.skip(reason, allow_module_level=True)`` at the module level: ``pytest.skip(reason, allow_module_level=True)`` at the module level:
.. code-block:: python .. code-block:: python
if not enabled_platform_edge_cases(): import pytest
pytest.skip("unsupported platform", allow_module_level=True)
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 The imperative method is useful when it is not possible to evaluate the skip condition
during import time. during import time.