DEP: add deprecation warning for raise_if_err()

src/safetywrap/_impl.py

@@ -1,6 +1,7 @@
 """Implementations of Ok, Err, Some, and None."""
 
 import typing as t
+import warnings
 
 from ._interface import _Option, _Result
 
@@ -464,6 +465,11 @@ def raise_if_err(
 
         Alias of `Some.expect`.
         """
+        warnings.warn(
+            "Option.raise_if_err() is deprecated. "
+            "Use raise_if_nothing() or expect() instead",
+            DeprecationWarning,
+        )
         return self.expect(msg, exc_cls=exc_cls)
 
     def raise_if_nothing(
@@ -640,6 +646,11 @@ def raise_if_err(
 
         Alias of `Nothing.expect`.
         """
+        warnings.warn(
+            "Option.raise_if_err() is deprecated. "
+            "Use raise_if_nothing() or expect() instead",
+            DeprecationWarning,
+        )
         return self.expect(msg, exc_cls=exc_cls)
 
     def raise_if_nothing(

tests/test_option.py

@@ -150,9 +150,7 @@ def test_or_else(
         """Chains option-generating functions if results are `None`."""
         assert start.or_else(fn) == exp
 
-    @pytest.mark.parametrize(
-        "method", ("expect", "raise_if_err", "raise_if_nothing")
-    )
+    @pytest.mark.parametrize("method", ("expect", "raise_if_nothing"))
     @pytest.mark.parametrize("exc_cls", (None, IOError))
     def test_expect_and_aliases_raising(
         self, method: str, exc_cls: t.Type[Exception]
@@ -167,13 +165,19 @@ def test_expect_and_aliases_raising(
 
         assert msg in str(exc_info.value)
 
-    @pytest.mark.parametrize(
-        "method", ("expect", "raise_if_err", "raise_if_nothing")
-    )
+    @pytest.mark.parametrize("method", ("expect", "raise_if_nothing"))
     def test_expect_and_aliases_not_raising(self, method: str) -> None:
         """Expecting on a Some() returns the value."""
         assert getattr(Some("hello"), method)("not what I expected") == "hello"
 
+    def test_raise_if_err(self) -> None:
+        """This method is deprecated."""
+        with pytest.deprecated_call():
+            assert Some("hello").raise_if_err("error") == "hello"
+        with pytest.deprecated_call():
+            with pytest.raises(RuntimeError):
+                Nothing().raise_if_err("error")
+
     @pytest.mark.parametrize(
         "start, exp",
         ((Nothing(), Nothing()), (Some(3), Nothing()), (Some(4), Some(4))),