Revert "Deprecate raising unittest.SkipTest to skip tests during collection" (#9710)
This reverts commit 25e657bfc1
.
Turns out that this *is* a working unittest feature, which pytest should
support, so undo the deprecation.
This commit is contained in:
parent
0c80a1c836
commit
7b6e477e2f
|
@ -0,0 +1,3 @@
|
||||||
|
The deprecation of raising :class:`unittest.SkipTest` to skip collection of
|
||||||
|
tests during the pytest collection phase is reverted - this is now a supported
|
||||||
|
feature again.
|
|
@ -211,6 +211,8 @@ Deprecations
|
||||||
:class:`unittest.SkipTest` / :meth:`unittest.TestCase.skipTest` /
|
:class:`unittest.SkipTest` / :meth:`unittest.TestCase.skipTest` /
|
||||||
:func:`unittest.skip` in unittest test cases is fully supported.
|
:func:`unittest.skip` in unittest test cases is fully supported.
|
||||||
|
|
||||||
|
.. note:: This deprecation has been reverted in pytest 7.1.0.
|
||||||
|
|
||||||
|
|
||||||
- `#8315 <https://github.com/pytest-dev/pytest/issues/8315>`_: Several behaviors of :meth:`Parser.addoption <pytest.Parser.addoption>` are now
|
- `#8315 <https://github.com/pytest-dev/pytest/issues/8315>`_: Several behaviors of :meth:`Parser.addoption <pytest.Parser.addoption>` are now
|
||||||
scheduled for removal in pytest 8 (deprecated since pytest 2.4.0):
|
scheduled for removal in pytest 8 (deprecated since pytest 2.4.0):
|
||||||
|
|
|
@ -241,19 +241,6 @@ scheduled for removal in pytest 8 (deprecated since pytest 2.4.0):
|
||||||
- ``parser.addoption(..., type="int/string/float/complex")`` - use ``type=int`` etc. instead.
|
- ``parser.addoption(..., type="int/string/float/complex")`` - use ``type=int`` etc. instead.
|
||||||
|
|
||||||
|
|
||||||
Raising ``unittest.SkipTest`` during collection
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. deprecated:: 7.0
|
|
||||||
|
|
||||||
Raising :class:`unittest.SkipTest` to skip collection of tests during the
|
|
||||||
pytest collection phase is deprecated. Use :func:`pytest.skip` instead.
|
|
||||||
|
|
||||||
Note: This deprecation only relates to using `unittest.SkipTest` during test
|
|
||||||
collection. You are probably not doing that. Ordinary usage of
|
|
||||||
:class:`unittest.SkipTest` / :meth:`unittest.TestCase.skipTest` /
|
|
||||||
:func:`unittest.skip` in unittest test cases is fully supported.
|
|
||||||
|
|
||||||
Using ``pytest.warns(None)``
|
Using ``pytest.warns(None)``
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
|
@ -47,11 +47,6 @@ STRICT_OPTION = PytestRemovedIn8Warning(
|
||||||
# This deprecation is never really meant to be removed.
|
# This deprecation is never really meant to be removed.
|
||||||
PRIVATE = PytestDeprecationWarning("A private pytest class or function was used.")
|
PRIVATE = PytestDeprecationWarning("A private pytest class or function was used.")
|
||||||
|
|
||||||
UNITTEST_SKIP_DURING_COLLECTION = PytestRemovedIn8Warning(
|
|
||||||
"Raising unittest.SkipTest to skip tests during collection is deprecated. "
|
|
||||||
"Use pytest.skip() instead."
|
|
||||||
)
|
|
||||||
|
|
||||||
ARGUMENT_PERCENT_DEFAULT = PytestRemovedIn8Warning(
|
ARGUMENT_PERCENT_DEFAULT = PytestRemovedIn8Warning(
|
||||||
'pytest now uses argparse. "%default" should be changed to "%(default)s"',
|
'pytest now uses argparse. "%default" should be changed to "%(default)s"',
|
||||||
)
|
)
|
||||||
|
|
|
@ -2,7 +2,6 @@
|
||||||
import bdb
|
import bdb
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import warnings
|
|
||||||
from typing import Callable
|
from typing import Callable
|
||||||
from typing import cast
|
from typing import cast
|
||||||
from typing import Dict
|
from typing import Dict
|
||||||
|
@ -28,7 +27,6 @@ from _pytest._code.code import TerminalRepr
|
||||||
from _pytest.compat import final
|
from _pytest.compat import final
|
||||||
from _pytest.config.argparsing import Parser
|
from _pytest.config.argparsing import Parser
|
||||||
from _pytest.deprecated import check_ispytest
|
from _pytest.deprecated import check_ispytest
|
||||||
from _pytest.deprecated import UNITTEST_SKIP_DURING_COLLECTION
|
|
||||||
from _pytest.nodes import Collector
|
from _pytest.nodes import Collector
|
||||||
from _pytest.nodes import Item
|
from _pytest.nodes import Item
|
||||||
from _pytest.nodes import Node
|
from _pytest.nodes import Node
|
||||||
|
@ -379,11 +377,6 @@ def pytest_make_collect_report(collector: Collector) -> CollectReport:
|
||||||
# Type ignored because unittest is loaded dynamically.
|
# Type ignored because unittest is loaded dynamically.
|
||||||
skip_exceptions.append(unittest.SkipTest) # type: ignore
|
skip_exceptions.append(unittest.SkipTest) # type: ignore
|
||||||
if isinstance(call.excinfo.value, tuple(skip_exceptions)):
|
if isinstance(call.excinfo.value, tuple(skip_exceptions)):
|
||||||
if unittest is not None and isinstance(
|
|
||||||
call.excinfo.value, unittest.SkipTest # type: ignore[attr-defined]
|
|
||||||
):
|
|
||||||
warnings.warn(UNITTEST_SKIP_DURING_COLLECTION, stacklevel=2)
|
|
||||||
|
|
||||||
outcome = "skipped"
|
outcome = "skipped"
|
||||||
r_ = collector._repr_failure_py(call.excinfo, "line")
|
r_ = collector._repr_failure_py(call.excinfo, "line")
|
||||||
assert isinstance(r_, ExceptionChainRepr), repr(r_)
|
assert isinstance(r_, ExceptionChainRepr), repr(r_)
|
||||||
|
|
|
@ -86,23 +86,6 @@ def test_private_is_deprecated() -> None:
|
||||||
PrivateInit(10, _ispytest=True)
|
PrivateInit(10, _ispytest=True)
|
||||||
|
|
||||||
|
|
||||||
def test_raising_unittest_skiptest_during_collection_is_deprecated(
|
|
||||||
pytester: Pytester,
|
|
||||||
) -> None:
|
|
||||||
pytester.makepyfile(
|
|
||||||
"""
|
|
||||||
import unittest
|
|
||||||
raise unittest.SkipTest()
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
result = pytester.runpytest()
|
|
||||||
result.stdout.fnmatch_lines(
|
|
||||||
[
|
|
||||||
"*PytestRemovedIn8Warning: Raising unittest.SkipTest*",
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("hooktype", ["hook", "ihook"])
|
@pytest.mark.parametrize("hooktype", ["hook", "ihook"])
|
||||||
def test_hookproxy_warnings_for_pathlib(tmp_path, hooktype, request):
|
def test_hookproxy_warnings_for_pathlib(tmp_path, hooktype, request):
|
||||||
path = legacy_path(tmp_path)
|
path = legacy_path(tmp_path)
|
||||||
|
|
|
@ -345,7 +345,7 @@ def test_SkipTest_during_collection(pytester: Pytester) -> None:
|
||||||
"""
|
"""
|
||||||
)
|
)
|
||||||
result = pytester.runpytest(p)
|
result = pytester.runpytest(p)
|
||||||
result.assert_outcomes(skipped=1, warnings=1)
|
result.assert_outcomes(skipped=1, warnings=0)
|
||||||
|
|
||||||
|
|
||||||
def test_SkipTest_in_test(pytester: Pytester) -> None:
|
def test_SkipTest_in_test(pytester: Pytester) -> None:
|
||||||
|
|
|
@ -1498,3 +1498,30 @@ def test_traceback_pruning(pytester: Pytester) -> None:
|
||||||
assert passed == 1
|
assert passed == 1
|
||||||
assert failed == 1
|
assert failed == 1
|
||||||
assert reprec.ret == 1
|
assert reprec.ret == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_raising_unittest_skiptest_during_collection(
|
||||||
|
pytester: Pytester,
|
||||||
|
) -> None:
|
||||||
|
pytester.makepyfile(
|
||||||
|
"""
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
class TestIt(unittest.TestCase):
|
||||||
|
def test_it(self): pass
|
||||||
|
def test_it2(self): pass
|
||||||
|
|
||||||
|
raise unittest.SkipTest()
|
||||||
|
|
||||||
|
class TestIt2(unittest.TestCase):
|
||||||
|
def test_it(self): pass
|
||||||
|
def test_it2(self): pass
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
reprec = pytester.inline_run()
|
||||||
|
passed, skipped, failed = reprec.countoutcomes()
|
||||||
|
assert passed == 0
|
||||||
|
# Unittest reports one fake test for a skipped module.
|
||||||
|
assert skipped == 1
|
||||||
|
assert failed == 0
|
||||||
|
assert reprec.ret == ExitCode.NO_TESTS_COLLECTED
|
||||||
|
|
Loading…
Reference in New Issue