fix deprecation notice

Author: zariiii9003

can/interfaces/ixxat/canlib.py

@@ -398,15 +398,16 @@ class IXXATBus(BusABC):
     @deprecated_args_alias(
         deprecation_start="4.3.0",
         deprecation_end="5.0.0",
-        fd="timing",
-        data_bitrate="timing",
-        sjw_abr="timing",
-        tseg1_abr="timing",
-        tseg2_abr="timing",
-        sjw_dbr="timing",
-        tseg1_dbr="timing",
-        tseg2_dbr="timing",
-        ssp_dbr="timing",
+        deprecation_info="Use the `can.BitTimingFd` class and the `timing` parameter instead.",
+        fd=None,
+        data_bitrate=None,
+        sjw_abr=None,
+        tseg1_abr=None,
+        tseg2_abr=None,
+        sjw_dbr=None,
+        tseg1_dbr=None,
+        tseg2_dbr=None,
+        ssp_dbr=None,
     )
     @deprecated_args_alias(
         deprecation_start="4.0.0",

can/util.py

@@ -334,6 +334,7 @@ def channel2int(channel: Optional[typechecking.Channel]) -> Optional[int]:
 def deprecated_args_alias(
     deprecation_start: str,
     deprecation_end: Optional[str] = None,
+    deprecation_info: Optional[str] = None,
     **aliases: Optional[str],
 ) -> Callable[[Callable[P1, T1]], Callable[P1, T1]]:
     """Allows to rename/deprecate a function kwarg(s) and optionally
@@ -358,6 +359,8 @@ def library_function(new_arg):
         The *python-can* version, that introduced the :class:`DeprecationWarning`.
     :param deprecation_end:
         The *python-can* version, that marks the end of the deprecation period.
+    :param deprecation_info:
+        Additional information, which will be added to the deprecation warning..
     :param aliases:
         keyword arguments, that map the deprecated argument names
         to the new argument names or ``None``.
@@ -371,6 +374,7 @@ def wrapper(*args: P1.args, **kwargs: P1.kwargs) -> T1:
                 func_name=f.__name__,
                 start=deprecation_start,
                 end=deprecation_end,
+                info=deprecation_info,
                 kwargs=kwargs,
                 aliases=aliases,
             )
@@ -385,6 +389,7 @@ def _rename_kwargs(
     func_name: str,
     start: str,
     end: Optional[str],
+    info: Optional[str],
     kwargs: P1.kwargs,
     aliases: Dict[str, Optional[str]],
 ) -> None:
@@ -410,6 +415,9 @@ def _rename_kwargs(
                     )
                 kwargs[new] = value
 
+            if info:
+                deprecation_notice += " " + info.strip()
+
             warnings.warn(deprecation_notice, DeprecationWarning)
 
 

test/test_util.py

@@ -2,6 +2,7 @@
 
 import unittest
 import warnings
+from typing import Optional
 
 import pytest
 
@@ -20,12 +21,14 @@
 class RenameKwargsTest(unittest.TestCase):
     expected_kwargs = dict(a=1, b=2, c=3, d=4)
 
-    def _test(self, start: str, end: str, kwargs, aliases):
+    def _test(
+        self, start: str, end: Optional[str], note: Optional[str], kwargs, aliases
+    ):
         # Test that we do get the DeprecationWarning when called with deprecated kwargs
         with self.assertWarnsRegex(
             DeprecationWarning, "is deprecated.*?" + start + ".*?" + end
         ):
-            _rename_kwargs("unit_test", start, end, kwargs, aliases)
+            _rename_kwargs("unit_test", start, end, note, kwargs, aliases)
 
         # Test that the aliases contains the deprecated values and
         # the obsolete kwargs have been removed
@@ -37,30 +40,30 @@ def _test(self, start: str, end: str, kwargs, aliases):
         # Cause all warnings to always be triggered.
         warnings.simplefilter("error", DeprecationWarning)
         try:
-            _rename_kwargs("unit_test", start, end, kwargs, aliases)
+            _rename_kwargs("unit_test", start, end, note, kwargs, aliases)
         finally:
             warnings.resetwarnings()
 
     def test_rename(self):
         kwargs = dict(old_a=1, old_b=2, c=3, d=4)
         aliases = {"old_a": "a", "old_b": "b"}
-        self._test("1.0", "2.0", kwargs, aliases)
+        self._test("1.0", "2.0", None, kwargs, aliases)
 
     def test_obsolete(self):
         kwargs = dict(a=1, b=2, c=3, d=4, z=10)
         aliases = {"z": None}
-        self._test("1.0", "2.0", kwargs, aliases)
+        self._test("1.0", "2.0", None, kwargs, aliases)
 
     def test_rename_and_obsolete(self):
         kwargs = dict(old_a=1, old_b=2, c=3, d=4, z=10)
         aliases = {"old_a": "a", "old_b": "b", "z": None}
-        self._test("1.0", "2.0", kwargs, aliases)
+        self._test("1.0", "2.0", None, kwargs, aliases)
 
     def test_with_new_and_alias_present(self):
         kwargs = dict(old_a=1, a=1, b=2, c=3, d=4, z=10)
         aliases = {"old_a": "a", "old_b": "b", "z": None}
         with self.assertRaises(TypeError):
-            self._test("1.0", "2.0", kwargs, aliases)
+            self._test("1.0", "2.0", "Random note.", kwargs, aliases)
 
 
 class DeprecatedArgsAliasTest(unittest.TestCase):
@@ -130,6 +133,20 @@ def _test_func3(a):
             warnings.simplefilter("error")
             _test_func3(a=1)
 
+            @deprecated_args_alias(
+                "1.0.0", deprecation_info="Because why not?", old_a="a"
+            )
+            def _test_func4(a):
+                pass
+
+            with pytest.warns(DeprecationWarning) as record:
+                _test_func4(old_a=1)
+                assert len(record) == 1
+                assert (
+                    record[0].message.args[0]
+                    == "The 'old_a' argument is deprecated since python-can v1.0.0. Use 'a' instead. Because why not?"
+                )
+
 
 class TestBusConfig(unittest.TestCase):
     base_config = dict(interface="socketcan", bitrate=500_000)