diff --git a/monai/utils/deprecate_utils.py b/monai/utils/deprecate_utils.py index 64e678e2bd6..42ca71893e3 100644 --- a/monai/utils/deprecate_utils.py +++ b/monai/utils/deprecate_utils.py @@ -92,7 +92,8 @@ def _decorator(obj): msg_prefix = f"{'Function' if is_func else 'Class'} `{obj.__qualname__}`" if is_removed: - msg_infix = f"was removed in version {removed}." + in_version = f" in version {removed}" if removed is not None else "" + msg_infix = f"was removed{in_version}." elif is_deprecated: msg_infix = f"has been deprecated since version {since}." if removed is not None: @@ -181,7 +182,8 @@ def _decorator(func): msg_prefix = f"Argument `{name}`" if is_removed: - msg_infix = f"was removed in version {removed}." + in_version = f" in version {removed}" if removed is not None else "" + msg_infix = f"was removed{in_version}." elif is_deprecated: msg_infix = f"has been deprecated since version {since}." if removed is not None: diff --git a/tests/utils/test_deprecated.py b/tests/utils/test_deprecated.py index 3171a67e2c3..fac66af0061 100644 --- a/tests/utils/test_deprecated.py +++ b/tests/utils/test_deprecated.py @@ -95,6 +95,26 @@ def foo3(): self.assertRaises(DeprecatedError, foo3) + def test_except1_message(self): + """Bare `@deprecated()` must not claim a version in the error message.""" + + @deprecated(version_val=self.test_version) + def foo3(): + pass + + with self.assertRaises(DeprecatedError) as cm: + foo3() + self.assertIn("was removed.", str(cm.exception)) + self.assertNotIn("version None", str(cm.exception)) + + @deprecated(removed=self.prev_version, version_val=self.test_version) + def foo4(): + pass + + with self.assertRaises(DeprecatedError) as cm: + foo4() + self.assertIn(f"was removed in version {self.prev_version}.", str(cm.exception)) + def test_except2(self): """Test deprecated decorator raises exception with `removed` set in the past.""" @@ -193,6 +213,26 @@ def afoo3(a, b=None): self.assertRaises(DeprecatedError, lambda: afoo3(1, b=2)) + def test_arg_except1_message(self): + """Bare `@deprecated_arg()` must not claim a version in the error message.""" + + @deprecated_arg("b", version_val=self.test_version) + def afoo3(a, b=None): + pass + + with self.assertRaises(DeprecatedError) as cm: + afoo3(1, b=2) + self.assertIn("was removed.", str(cm.exception)) + self.assertNotIn("version None", str(cm.exception)) + + @deprecated_arg("b", removed=self.prev_version, version_val=self.test_version) + def afoo4(a, b=None): + pass + + with self.assertRaises(DeprecatedError) as cm: + afoo4(1, b=2) + self.assertIn(f"was removed in version {self.prev_version}.", str(cm.exception)) + def test_arg_except2(self): """Test deprecated_arg decorator raises exception with `removed` set in the past."""