|
|
|
|
@@ -237,7 +237,7 @@ pytest.mark.xfail
|
|
|
|
|
|
|
|
|
|
Marks a test function as *expected to fail*.
|
|
|
|
|
|
|
|
|
|
.. py:function:: pytest.mark.xfail(condition=None, *, reason=None, raises=None, run=True, strict=False)
|
|
|
|
|
.. py:function:: pytest.mark.xfail(condition=None, *, reason=None, raises=None, run=True, strict=xfail_strict)
|
|
|
|
|
|
|
|
|
|
:type condition: bool or str
|
|
|
|
|
:param condition:
|
|
|
|
|
@@ -249,10 +249,10 @@ Marks a test function as *expected to fail*.
|
|
|
|
|
:keyword Type[Exception] raises:
|
|
|
|
|
Exception subclass (or tuple of subclasses) expected to be raised by the test function; other exceptions will fail the test.
|
|
|
|
|
:keyword bool run:
|
|
|
|
|
If the test function should actually be executed. If ``False``, the function will always xfail and will
|
|
|
|
|
Whether the test function should actually be executed. If ``False``, the function will always xfail and will
|
|
|
|
|
not be executed (useful if a function is segfaulting).
|
|
|
|
|
:keyword bool strict:
|
|
|
|
|
* If ``False`` (the default) the function will be shown in the terminal output as ``xfailed`` if it fails
|
|
|
|
|
* If ``False`` the function will be shown in the terminal output as ``xfailed`` if it fails
|
|
|
|
|
and as ``xpass`` if it passes. In both cases this will not cause the test suite to fail as a whole. This
|
|
|
|
|
is particularly useful to mark *flaky* tests (tests that fail at random) to be tackled later.
|
|
|
|
|
* If ``True``, the function will be shown in the terminal output as ``xfailed`` if it fails, but if it
|
|
|
|
|
@@ -260,6 +260,8 @@ Marks a test function as *expected to fail*.
|
|
|
|
|
that are always failing and there should be a clear indication if they unexpectedly start to pass (for example
|
|
|
|
|
a new release of a library fixes a known bug).
|
|
|
|
|
|
|
|
|
|
Defaults to :confval:`xfail_strict`, which is ``False`` by default.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Custom marks
|
|
|
|
|
~~~~~~~~~~~~
|
|
|
|
|
|