Group deprecation tests by the helper they cover

Author: takayoshi-makabe

tests/utils/test_deprecated.py

@@ -40,18 +40,6 @@ def deprecated_method() -> None:
     )
 
 
-@patch("warnings.warn")
-def test_deprecation_message(warn: Mock) -> None:
-    deprecation_message(
-        deprecated_in="0.1.0",
-        removed_in="0.2.0",
-        help_message="Please use something_else instead",
-    )
-
-    assert warn.called
-    assert warn.call_args[0] == ("Deprecated in 0.1.0, will be removed in 0.2.0. Please use something_else instead",)
-
-
 @patch("warnings.warn")
 def test_deprecated_without_help_message(warn: Mock) -> None:
     @deprecated(
@@ -67,21 +55,19 @@ def deprecated_method() -> None:
     assert warn.call_args[0] == ("Call to deprecated_method, deprecated in 0.1.0, will be removed in 0.2.0.",)
 
 
-@patch("warnings.warn")
-def test_deprecation_message_without_help_message(warn: Mock) -> None:
-    deprecation_message(
-        deprecated_in="0.1.0",
-        removed_in="0.2.0",
-        help_message=None,
-    )
+def test_deprecated_warning_points_at_the_caller() -> None:
+    """The warning is attributed to the code using the deprecated API, not to the helper."""
 
-    assert warn.called
-    assert warn.call_args[0] == ("Deprecated in 0.1.0, will be removed in 0.2.0.",)
+    @deprecated(deprecated_in="0.1.0", removed_in="0.2.0")
+    def deprecated_method() -> None:
+        pass
 
+    with warnings.catch_warnings(record=True) as caught:
+        warnings.simplefilter("always")
+        deprecated_method()
 
-@pytest.mark.parametrize("help_message", [None, ""])
-def test_deprecation_notice_without_help_message(help_message: str | None) -> None:
-    assert deprecation_notice("0.1.0", "0.2.0", help_message) == "Deprecated in 0.1.0, will be removed in 0.2.0."
+    assert len(caught) == 1
+    assert caught[0].filename == __file__
 
 
 def test_deprecation_notice_with_help_message() -> None:
@@ -91,19 +77,33 @@ def test_deprecation_notice_with_help_message() -> None:
     )
 
 
-def test_deprecated_warning_points_at_the_caller() -> None:
-    """The warning is attributed to the code using the deprecated API, not to the helper."""
+@pytest.mark.parametrize("help_message", [None, ""])
+def test_deprecation_notice_without_help_message(help_message: str | None) -> None:
+    assert deprecation_notice("0.1.0", "0.2.0", help_message) == "Deprecated in 0.1.0, will be removed in 0.2.0."
 
-    @deprecated(deprecated_in="0.1.0", removed_in="0.2.0")
-    def deprecated_method() -> None:
-        pass
 
-    with warnings.catch_warnings(record=True) as caught:
-        warnings.simplefilter("always")
-        deprecated_method()
+@patch("warnings.warn")
+def test_deprecation_message(warn: Mock) -> None:
+    deprecation_message(
+        deprecated_in="0.1.0",
+        removed_in="0.2.0",
+        help_message="Please use something_else instead",
+    )
 
-    assert len(caught) == 1
-    assert caught[0].filename == __file__
+    assert warn.called
+    assert warn.call_args[0] == ("Deprecated in 0.1.0, will be removed in 0.2.0. Please use something_else instead",)
+
+
+@patch("warnings.warn")
+def test_deprecation_message_without_help_message(warn: Mock) -> None:
+    deprecation_message(
+        deprecated_in="0.1.0",
+        removed_in="0.2.0",
+        help_message=None,
+    )
+
+    assert warn.called
+    assert warn.call_args[0] == ("Deprecated in 0.1.0, will be removed in 0.2.0.",)
 
 
 def test_deprecation_message_points_at_the_caller() -> None: