Merge pull request #11133 from bluetech/removed-in-8-error

Change PytestRemovedIn8Warning to error by default, add PytestRemovedIn9Warning

Author: bluetech

changelog/7363.breaking.rst

@@ -0,0 +1,22 @@
+**PytestRemovedIn8Warning deprecation warnings are now errors by default.**
+
+Following our plan to remove deprecated features with as little disruption as
+possible, all warnings of type ``PytestRemovedIn8Warning`` now generate errors
+instead of warning messages by default.
+
+**The affected features will be effectively removed in pytest 8.1**, so please consult the
+:ref:`deprecations` section in the docs for directions on how to update existing code.
+
+In the pytest ``8.0.X`` series, it is possible to change the errors back into warnings as a
+stopgap measure by adding this to your ``pytest.ini`` file:
+
+.. code-block:: ini
+
+    [pytest]
+    filterwarnings =
+        ignore::pytest.PytestRemovedIn8Warning
+
+But this will stop working when pytest ``8.1`` is released.
+
+**If you have concerns** about the removal of a specific feature, please add a
+comment to :issue:`7363`.

doc/en/reference/reference.rst

@@ -1153,6 +1153,9 @@ Custom warnings generated in some situations such as improper usage or deprecate
 .. autoclass:: pytest.PytestRemovedIn8Warning
   :show-inheritance:
 
+.. autoclass:: pytest.PytestRemovedIn9Warning
+  :show-inheritance:
+
 .. autoclass:: pytest.PytestUnhandledCoroutineWarning
    :show-inheritance:
 

src/_pytest/warning_types.py

@@ -56,6 +56,12 @@ class PytestRemovedIn8Warning(PytestDeprecationWarning):
     __module__ = "pytest"
 
 
+class PytestRemovedIn9Warning(PytestDeprecationWarning):
+    """Warning class for features that will be removed in pytest 9."""
+
+    __module__ = "pytest"
+
+
 class PytestReturnNotNoneWarning(PytestRemovedIn8Warning):
     """Warning emitted when a test function is returning value other than None."""
 

src/_pytest/warnings.py

@@ -49,6 +49,8 @@ def catch_warnings_for_item(
             warnings.filterwarnings("always", category=DeprecationWarning)
             warnings.filterwarnings("always", category=PendingDeprecationWarning)
 
+        warnings.filterwarnings("error", category=pytest.PytestRemovedIn8Warning)
+
         apply_warning_filters(config_filters, cmdline_filters)
 
         # apply filters from "filterwarnings" marks

src/pytest/__init__.py

@@ -71,6 +71,7 @@
 from _pytest.warning_types import PytestDeprecationWarning
 from _pytest.warning_types import PytestExperimentalApiWarning
 from _pytest.warning_types import PytestRemovedIn8Warning
+from _pytest.warning_types import PytestRemovedIn9Warning
 from _pytest.warning_types import PytestReturnNotNoneWarning
 from _pytest.warning_types import PytestUnhandledCoroutineWarning
 from _pytest.warning_types import PytestUnhandledThreadExceptionWarning
@@ -131,6 +132,7 @@
     "PytestDeprecationWarning",
     "PytestExperimentalApiWarning",
     "PytestRemovedIn8Warning",
+    "PytestRemovedIn9Warning",
     "PytestReturnNotNoneWarning",
     "Pytester",
     "PytestPluginManager",

testing/acceptance_test.py

@@ -1164,7 +1164,6 @@ def test_usage_error_code(pytester: Pytester) -> None:
     assert result.ret == ExitCode.USAGE_ERROR
 
 
-@pytest.mark.filterwarnings("default::pytest.PytestUnhandledCoroutineWarning")
 def test_warn_on_async_function(pytester: Pytester) -> None:
     # In the below we .close() the coroutine only to avoid
     # "RuntimeWarning: coroutine 'test_2' was never awaited"
@@ -1181,7 +1180,7 @@ def test_3():
             return coro
     """
     )
-    result = pytester.runpytest()
+    result = pytester.runpytest("-Wdefault")
     result.stdout.fnmatch_lines(
         [
             "test_async.py::test_1",
@@ -1197,7 +1196,6 @@ def test_3():
     )
 
 
-@pytest.mark.filterwarnings("default::pytest.PytestUnhandledCoroutineWarning")
 def test_warn_on_async_gen_function(pytester: Pytester) -> None:
     pytester.makepyfile(
         test_async="""
@@ -1209,7 +1207,7 @@ def test_3():
             return test_2()
     """
     )
-    result = pytester.runpytest()
+    result = pytester.runpytest("-Wdefault")
     result.stdout.fnmatch_lines(
         [
             "test_async.py::test_1",

testing/deprecated_test.py

@@ -103,7 +103,7 @@ def test_strict_option_is_deprecated(pytester: Pytester) -> None:
         def test_foo(): pass
         """
     )
-    result = pytester.runpytest("--strict")
+    result = pytester.runpytest("--strict", "-Wdefault::pytest.PytestRemovedIn8Warning")
     result.stdout.fnmatch_lines(
         [
             "'unknown' not found in `markers` configuration option",
@@ -189,7 +189,7 @@ def test_skipping_msg():
                 pytest.skip(msg="skippedmsg")
             """
         )
-        result = pytester.runpytest(p)
+        result = pytester.runpytest(p, "-Wdefault::pytest.PytestRemovedIn8Warning")
         result.stdout.fnmatch_lines(
             [
                 "*PytestRemovedIn8Warning: pytest.skip(msg=...) is now deprecated, "
@@ -208,7 +208,7 @@ def test_failing_msg():
                 pytest.fail(msg="failedmsg")
             """
         )
-        result = pytester.runpytest(p)
+        result = pytester.runpytest(p, "-Wdefault::pytest.PytestRemovedIn8Warning")
         result.stdout.fnmatch_lines(
             [
                 "*PytestRemovedIn8Warning: pytest.fail(msg=...) is now deprecated, "
@@ -227,7 +227,7 @@ def test_exit_msg():
                 pytest.exit(msg="exitmsg")
             """
         )
-        result = pytester.runpytest(p)
+        result = pytester.runpytest(p, "-Wdefault::pytest.PytestRemovedIn8Warning")
         result.stdout.fnmatch_lines(
             [
                 "*PytestRemovedIn8Warning: pytest.exit(msg=...) is now deprecated, "
@@ -245,7 +245,7 @@ def pytest_cmdline_preparse(config, args):
 
         """
     )
-    result = pytester.runpytest()
+    result = pytester.runpytest("-Wdefault::pytest.PytestRemovedIn8Warning")
     result.stdout.fnmatch_lines(
         [
             "*PytestRemovedIn8Warning: The pytest_cmdline_preparse hook is deprecated*",
@@ -299,7 +299,7 @@ def test_omits_warnings():
             ...
         """
     )
-    output = pytester.runpytest()
+    output = pytester.runpytest("-Wdefault::pytest.PytestRemovedIn8Warning")
     message = [
         "*PytestRemovedIn8Warning: Support for nose tests is deprecated and will be removed in a future release.",
         "*test_nose_deprecated_with_setup.py::test_omits_warnings is using nose method: `setup_fn_no_op` (setup)",
@@ -327,7 +327,7 @@ def test(self):
                 ...
         """
     )
-    output = pytester.runpytest()
+    output = pytester.runpytest("-Wdefault::pytest.PytestRemovedIn8Warning")
     message = [
         "*PytestRemovedIn8Warning: Support for nose tests is deprecated and will be removed in a future release.",
         "*test_nose_deprecated_setup_teardown.py::Test::test is using nose-specific method: `setup(self)`",

testing/test_config.py

@@ -1184,7 +1184,7 @@ def pytest_cmdline_preparse(args):
             args.append("-h")
     """
     )
-    result = pytester.runpytest()
+    result = pytester.runpytest("-Wignore::pytest.PytestRemovedIn8Warning")
     result.stdout.fnmatch_lines(["*pytest*", "*-h*"])
 
 

testing/test_nose.py

@@ -23,7 +23,9 @@ def test_world():
         test_hello.teardown = lambda: values.append(2)
     """
     )
-    result = pytester.runpytest(p, "-p", "nose")
+    result = pytester.runpytest(
+        p, "-p", "nose", "-Wignore::pytest.PytestRemovedIn8Warning"
+    )
     result.assert_outcomes(passed=2)
 
 
@@ -76,7 +78,9 @@ def test_world():
 
     """
     )
-    result = pytester.runpytest(p, "-p", "nose")
+    result = pytester.runpytest(
+        p, "-p", "nose", "-Wignore::pytest.PytestRemovedIn8Warning"
+    )
     result.assert_outcomes(passed=2)
 
 
@@ -100,7 +104,9 @@ def test_world():
 
     """
     )
-    result = pytester.runpytest(p, "-p", "nose")
+    result = pytester.runpytest(
+        p, "-p", "nose", "-Wignore::pytest.PytestRemovedIn8Warning"
+    )
     result.stdout.fnmatch_lines(["*TypeError: <lambda>()*"])
 
 
@@ -154,7 +160,9 @@ def test_world():
         test_hello.teardown = my_teardown_partial
     """
     )
-    result = pytester.runpytest(p, "-p", "nose")
+    result = pytester.runpytest(
+        p, "-p", "nose", "-Wignore::pytest.PytestRemovedIn8Warning"
+    )
     result.stdout.fnmatch_lines(["*2 passed*"])
 
 
@@ -193,7 +201,9 @@ def test_local_setup_again():
             assert items["setup2"] == ["up", "down", "up"]
     """
     )
-    result = pytester.runpytest("-p", "nose")
+    result = pytester.runpytest(
+        "-p", "nose", "-Wignore::pytest.PytestRemovedIn8Warning"
+    )
     result.stdout.fnmatch_lines(["*4 passed*"])
 
 
@@ -278,7 +288,7 @@ def test_first(self):
                 assert self.visited_cls
         """
     )
-    result = pytester.runpytest()
+    result = pytester.runpytest("-Wignore::pytest.PytestRemovedIn8Warning")
     result.stdout.fnmatch_lines(["*1 passed*"])
 
 

testing/test_warnings.py

@@ -518,7 +518,8 @@ def test_hidden_by_system(self, pytester: Pytester, monkeypatch) -> None:
         assert WARNINGS_SUMMARY_HEADER not in result.stdout.str()
 
 
-@pytest.mark.skip("not relevant until pytest 8.0")
+# In 8.1, uncomment below and change RemovedIn8 -> RemovedIn9.
+# @pytest.mark.skip("not relevant until pytest 9.0")
 @pytest.mark.parametrize("change_default", [None, "ini", "cmdline"])
 def test_removed_in_x_warning_as_error(pytester: Pytester, change_default) -> None:
     """This ensures that PytestRemovedInXWarnings raised by pytest are turned into errors.