Skip to content

Commit

Permalink
Fix argument handling in pytest.mark.skip
Browse files Browse the repository at this point in the history
  • Loading branch information
The-Compiler committed Mar 3, 2021
1 parent 19fc04f commit 70e967f
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 9 deletions.
1 change: 1 addition & 0 deletions changelog/8384.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The ``@pytest.mark.skip`` decorator now correctly handles its arguments. When the ``reason`` argument is accidentally given both positional and as a keyword (e.g. because it was confused with ``skipif``), a ``TypeError`` now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, ``reason`` is now documented correctly as positional or keyword (rather than keyword-only).
2 changes: 1 addition & 1 deletion doc/en/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ pytest.mark.skip

Unconditionally skip a test function.

.. py:function:: pytest.mark.skip(*, reason=None)
.. py:function:: pytest.mark.skip(reason=None)
:keyword str reason: Reason why the test function is being skipped.

Expand Down
13 changes: 5 additions & 8 deletions src/_pytest/skipping.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ def evaluate_condition(item: Item, mark: Mark, condition: object) -> Tuple[bool,
class Skip:
"""The result of evaluate_skip_marks()."""

reason = attr.ib(type=str)
reason = attr.ib(type=str, default="unconditional skip")


def evaluate_skip_marks(item: Item) -> Optional[Skip]:
Expand All @@ -184,13 +184,10 @@ def evaluate_skip_marks(item: Item) -> Optional[Skip]:
return Skip(reason)

for mark in item.iter_markers(name="skip"):
if "reason" in mark.kwargs:
reason = mark.kwargs["reason"]
elif mark.args:
reason = mark.args[0]
else:
reason = "unconditional skip"
return Skip(reason)
try:
return Skip(*mark.args, **mark.kwargs)
except TypeError as e:
raise TypeError(str(e) + " - maybe you meant pytest.mark.skipif?")

return None

Expand Down
16 changes: 16 additions & 0 deletions testing/test_skipping.py
Original file line number Diff line number Diff line change
Expand Up @@ -864,6 +864,22 @@ def test_hello():
result = pytester.runpytest("-rs", "--strict-markers")
result.stdout.fnmatch_lines(["*unconditional skip*", "*1 skipped*"])

def test_wrong_strict_usage(self, pytester: Pytester) -> None:
pytester.makepyfile(
"""
import pytest
@pytest.mark.skip(False, reason="I thought this was skipif")
def test_hello():
pass
"""
)
result = pytester.runpytest()
result.stdout.fnmatch_lines(
[
"*TypeError: __init__() got multiple values for argument 'reason' - maybe you meant pytest.mark.skipif?"
]
)


class TestSkipif:
def test_skipif_conditional(self, pytester: Pytester) -> None:
Expand Down

0 comments on commit 70e967f

Please sign in to comment.