Add deprecation warning for 'bustype' parameter (#1462)

zariiii9003 · felixdivo · web-flow · commit 66a5d2a1466b · 2022-12-21T17:43:05.000+01:00
* deprecate bustype parameter

* Add comment

Co-authored-by: Felix Divo &lt;4403130+felixdivo@users.noreply.github.com&gt;

Co-authored-by: Felix Divo &lt;4403130+felixdivo@users.noreply.github.com&gt;
diff --git a/can/interface.py b/can/interface.py
@@ -9,7 +9,7 @@
 from typing import Any, cast, Iterable, Type, Optional, Union, List
 
 from .bus import BusABC
-from .util import load_config
+from .util import load_config, deprecated_args_alias
 from .interfaces import BACKENDS
 from .exceptions import CanInterfaceNotImplementedError
 from .typechecking import AutoDetectedConfig, Channel
@@ -88,6 +88,7 @@ class Bus(BusABC):  # pylint: disable=abstract-method
     """
 
     @staticmethod
+    @deprecated_args_alias(bustype="interface")  # Deprecated since python-can 4.2
     def __new__(  # type: ignore  # pylint: disable=keyword-arg-before-vararg
         cls: Any,
         channel: Optional[Channel] = None,
diff --git a/doc/bus.rst b/doc/bus.rst
@@ -69,7 +69,7 @@ Example defining two filters, one to pass 11-bit ID ``0x451``, the other to pass
         {"can_id": 0x451, "can_mask": 0x7FF, "extended": False},
         {"can_id": 0xA0000, "can_mask": 0x1FFFFFFF, "extended": True},
     ]
-    bus = can.interface.Bus(channel="can0", bustype="socketcan", can_filters=filters)
+    bus = can.interface.Bus(channel="can0", interface="socketcan", can_filters=filters)
 
 
 See :meth:`~can.BusABC.set_filters` for the implementation.
diff --git a/doc/configuration.rst b/doc/configuration.rst
@@ -30,7 +30,7 @@ You can also specify the interface and channel for each Bus instance::
 
     import can
 
-    bus = can.interface.Bus(bustype='socketcan', channel='vcan0', bitrate=500000)
+    bus = can.interface.Bus(interface='socketcan', channel='vcan0', bitrate=500000)
 
 
 Configuration File
diff --git a/doc/interfaces/gs_usb.rst b/doc/interfaces/gs_usb.rst
@@ -14,7 +14,7 @@ Usage: pass device ``index`` (starting from 0) if using automatic device detecti
 
     import can
 
-    bus = can.Bus(bustype="gs_usb", channel=dev.product, index=0, bitrate=250000)
+    bus = can.Bus(interface="gs_usb", channel=dev.product, index=0, bitrate=250000)
 
 Alternatively, pass ``bus`` and ``address`` to open a specific device. The parameters can be got by ``pyusb`` as shown below:
 
@@ -25,7 +25,7 @@ Alternatively, pass ``bus`` and ``address`` to open a specific device. The param
 
     dev = usb.core.find(idVendor=0x1D50, idProduct=0x606F)
     bus = can.Bus(
-        bustype="gs_usb",
+        interface="gs_usb",
         channel=dev.product,
         bus=dev.bus,
         address=dev.address,
diff --git a/doc/interfaces/seeedstudio.rst b/doc/interfaces/seeedstudio.rst
@@ -31,7 +31,7 @@ Interface
 
 A bus example::
 
-    bus = can.interface.Bus(bustype='seeedstudio', channel='/dev/ttyUSB0', bitrate=500000)
+    bus = can.interface.Bus(interface='seeedstudio', channel='/dev/ttyUSB0', bitrate=500000)
 
 
 
diff --git a/doc/interfaces/socketcan.rst b/doc/interfaces/socketcan.rst
@@ -177,12 +177,12 @@ To spam a bus:
     import time
     import can
 
-    bustype = 'socketcan'
+    interface = 'socketcan'
     channel = 'vcan0'
 
     def producer(id):
         """:param id: Spam the bus with messages including the data id."""
-        bus = can.Bus(channel=channel, interface=bustype)
+        bus = can.Bus(channel=channel, interface=interface)
         for i in range(10):
             msg = can.Message(arbitration_id=0xc0ffee, data=[id, i, 0, 1, 3, 1, 4, 1], is_extended_id=False)
             bus.send(msg)
diff --git a/doc/interfaces/socketcand.rst b/doc/interfaces/socketcand.rst
@@ -18,7 +18,7 @@ daemon running on a remote Raspberry Pi:
 
     import can
 
-    bus = can.interface.Bus(bustype='socketcand', host="10.0.16.15", port=29536, channel="can0")
+    bus = can.interface.Bus(interface='socketcand', host="10.0.16.15", port=29536, channel="can0")
 
     # loop until Ctrl-C
     try:
diff --git a/doc/interfaces/udp_multicast.rst b/doc/interfaces/udp_multicast.rst
@@ -40,7 +40,7 @@ from ``bus_1`` to ``bus_2``:
         from can.interfaces.udp_multicast import UdpMulticastBus
 
         # The bus can be created using the can.Bus wrapper class or using UdpMulticastBus directly
-        with can.Bus(channel=UdpMulticastBus.DEFAULT_GROUP_IPv6, bustype='udp_multicast') as bus_1, \
+        with can.Bus(channel=UdpMulticastBus.DEFAULT_GROUP_IPv6, interface='udp_multicast') as bus_1, \
                 UdpMulticastBus(channel=UdpMulticastBus.DEFAULT_GROUP_IPv6) as bus_2:
 
             # register a callback on the second bus that prints messages to the standard out
diff --git a/doc/interfaces/virtual.rst b/doc/interfaces/virtual.rst
@@ -18,8 +18,8 @@ Example
 
     import can
 
-    bus1 = can.interface.Bus('test', bustype='virtual')
-    bus2 = can.interface.Bus('test', bustype='virtual')
+    bus1 = can.interface.Bus('test', interface='virtual')
+    bus2 = can.interface.Bus('test', interface='virtual')
 
     msg1 = can.Message(arbitration_id=0xabcde, data=[1,2,3])
     bus1.send(msg1)
@@ -34,8 +34,8 @@ Example
 
     import can
 
-    bus1 = can.interface.Bus('test', bustype='virtual', preserve_timestamps=True)
-    bus2 = can.interface.Bus('test', bustype='virtual')
+    bus1 = can.interface.Bus('test', interface='virtual', preserve_timestamps=True)
+    bus2 = can.interface.Bus('test', interface='virtual')
 
     msg1 = can.Message(timestamp=1639740470.051948, arbitration_id=0xabcde, data=[1,2,3])
 
diff --git a/examples/asyncio_demo.py b/examples/asyncio_demo.py
@@ -19,7 +19,7 @@ def print_message(msg: can.Message) -> None:
 async def main() -> None:
     """The main function that runs in the loop."""
 
-    with can.Bus(  # type: ignore
+    with can.Bus(
         interface="virtual", channel="my_channel_0", receive_own_messages=True
     ) as bus:
         reader = can.AsyncBufferedReader()
diff --git a/examples/crc.py b/examples/crc.py
@@ -76,9 +76,7 @@ def compute_xbr_checksum(message, counter):
     for interface, channel in [("socketcan", "vcan0")]:
         print(f"Carrying out crc test with {interface} interface")
 
-        with can.Bus(  # type: ignore
-            interface=interface, channel=channel, bitrate=500000
-        ) as BUS:
+        with can.Bus(interface=interface, channel=channel, bitrate=500000) as BUS:
             crc_send(BUS)
 
     time.sleep(2)
diff --git a/examples/cyclic_multiple.py b/examples/cyclic_multiple.py
@@ -133,9 +133,7 @@ def cyclic_multiple_send_modify(bus):
     for interface, channel in [("socketcan", "vcan0")]:
         print(f"Carrying out cyclic multiple tests with {interface} interface")
 
-        with can.Bus(  # type: ignore
-            interface=interface, channel=channel, bitrate=500000
-        ) as BUS:
+        with can.Bus(interface=interface, channel=channel, bitrate=500000) as BUS:
             cyclic_multiple_send(BUS)
             cyclic_multiple_send_modify(BUS)
 
diff --git a/examples/send_multiple.py b/examples/send_multiple.py
@@ -19,7 +19,7 @@ def producer(thread_id: int, message_count: int = 16) -> None:
 
     # this uses the default configuration (for example from environment variables, or a
     # config file) see https://python-can.readthedocs.io/en/stable/configuration.html
-    with can.Bus() as bus:  # type: ignore
+    with can.Bus() as bus:
         for i in range(message_count):
             msg = can.Message(
                 arbitration_id=0x0CF02200 + thread_id,
diff --git a/test/back2back_test.py b/test/back2back_test.py
@@ -43,14 +43,14 @@ class Back2BackTestCase(unittest.TestCase):
     def setUp(self):
         self.bus1 = can.Bus(
             channel=self.CHANNEL_1,
-            bustype=self.INTERFACE_1,
+            interface=self.INTERFACE_1,
             bitrate=self.BITRATE,
             fd=TEST_CAN_FD,
             single_handle=True,
         )
         self.bus2 = can.Bus(
             channel=self.CHANNEL_2,
-            bustype=self.INTERFACE_2,
+            interface=self.INTERFACE_2,
             bitrate=self.BITRATE,
             fd=TEST_CAN_FD,
             single_handle=True,
@@ -166,7 +166,7 @@ def test_message_is_rx_receive_own_messages(self):
         """The same as `test_message_direction` but testing with `receive_own_messages=True`."""
         bus3 = can.Bus(
             channel=self.CHANNEL_2,
-            bustype=self.INTERFACE_2,
+            interface=self.INTERFACE_2,
             bitrate=self.BITRATE,
             fd=TEST_CAN_FD,
             single_handle=True,
@@ -188,7 +188,7 @@ def test_unique_message_instances(self):
         """
         bus3 = can.Bus(
             channel=self.CHANNEL_2,
-            bustype=self.INTERFACE_2,
+            interface=self.INTERFACE_2,
             bitrate=self.BITRATE,
             fd=TEST_CAN_FD,
             single_handle=True,
@@ -347,8 +347,8 @@ def test_unique_message_instances(self):
 @unittest.skipUnless(TEST_INTERFACE_SOCKETCAN, "skip testing of socketcan")
 class SocketCanBroadcastChannel(unittest.TestCase):
     def setUp(self):
-        self.broadcast_bus = can.Bus(channel="", bustype="socketcan")
-        self.regular_bus = can.Bus(channel="vcan0", bustype="socketcan")
+        self.broadcast_bus = can.Bus(channel="", interface="socketcan")
+        self.regular_bus = can.Bus(channel="vcan0", interface="socketcan")
 
     def tearDown(self):
         self.broadcast_bus.shutdown()
@@ -370,14 +370,14 @@ class TestThreadSafeBus(Back2BackTestCase):
     def setUp(self):
         self.bus1 = can.ThreadSafeBus(
             channel=self.CHANNEL_1,
-            bustype=self.INTERFACE_1,
+            interface=self.INTERFACE_1,
             bitrate=self.BITRATE,
             fd=TEST_CAN_FD,
             single_handle=True,
         )
         self.bus2 = can.ThreadSafeBus(
             channel=self.CHANNEL_2,
-            bustype=self.INTERFACE_2,
+            interface=self.INTERFACE_2,
             bitrate=self.BITRATE,
             fd=TEST_CAN_FD,
             single_handle=True,
diff --git a/test/simplecyclic_test.py b/test/simplecyclic_test.py
@@ -31,8 +31,8 @@ def test_cycle_time(self):
             is_extended_id=False, arbitration_id=0x123, data=[0, 1, 2, 3, 4, 5, 6, 7]
         )
 
-        with can.interface.Bus(bustype="virtual") as bus1:
-            with can.interface.Bus(bustype="virtual") as bus2:
+        with can.interface.Bus(interface="virtual") as bus1:
+            with can.interface.Bus(interface="virtual") as bus2:
 
                 # disabling the garbage collector makes the time readings more reliable
                 gc.disable()
@@ -67,7 +67,7 @@ def test_cycle_time(self):
                 self.assertMessageEqual(msg, last_msg)
 
     def test_removing_bus_tasks(self):
-        bus = can.interface.Bus(bustype="virtual")
+        bus = can.interface.Bus(interface="virtual")
         tasks = []
         for task_i in range(10):
             msg = can.Message(
@@ -90,7 +90,7 @@ def test_removing_bus_tasks(self):
         bus.shutdown()
 
     def test_managed_tasks(self):
-        bus = can.interface.Bus(bustype="virtual", receive_own_messages=True)
+        bus = can.interface.Bus(interface="virtual", receive_own_messages=True)
         tasks = []
         for task_i in range(3):
             msg = can.Message(
@@ -120,7 +120,7 @@ def test_managed_tasks(self):
         bus.shutdown()
 
     def test_stopping_perodic_tasks(self):
-        bus = can.interface.Bus(bustype="virtual")
+        bus = can.interface.Bus(interface="virtual")
         tasks = []
         for task_i in range(10):
             msg = can.Message(
@@ -153,7 +153,7 @@ def test_stopping_perodic_tasks(self):
 
     @unittest.skipIf(IS_CI, "fails randomly when run on CI server")
     def test_thread_based_cyclic_send_task(self):
-        bus = can.ThreadSafeBus(bustype="virtual")
+        bus = can.ThreadSafeBus(interface="virtual")
         msg = can.Message(
             is_extended_id=False, arbitration_id=0x123, data=[0, 1, 2, 3, 4, 5, 6, 7]
         )
diff --git a/test/test_cantact.py b/test/test_cantact.py
@@ -12,7 +12,7 @@
 
 class CantactTest(unittest.TestCase):
     def test_bus_creation(self):
-        bus = can.Bus(channel=0, bustype="cantact", _testing=True)
+        bus = can.Bus(channel=0, interface="cantact", _testing=True)
         self.assertIsInstance(bus, cantact.CantactBus)
         cantact.MockInterface.set_bitrate.assert_called()
         cantact.MockInterface.set_bit_timing.assert_not_called()
@@ -24,7 +24,7 @@ def test_bus_creation_bittiming(self):
         cantact.MockInterface.set_bitrate.reset_mock()
 
         bt = can.BitTiming(tseg1=13, tseg2=2, brp=6, sjw=1)
-        bus = can.Bus(channel=0, bustype="cantact", bit_timing=bt, _testing=True)
+        bus = can.Bus(channel=0, interface="cantact", bit_timing=bt, _testing=True)
         self.assertIsInstance(bus, cantact.CantactBus)
         cantact.MockInterface.set_bitrate.assert_not_called()
         cantact.MockInterface.set_bit_timing.assert_called()
@@ -33,26 +33,26 @@ def test_bus_creation_bittiming(self):
         cantact.MockInterface.start.assert_called()
 
     def test_transmit(self):
-        bus = can.Bus(channel=0, bustype="cantact", _testing=True)
+        bus = can.Bus(channel=0, interface="cantact", _testing=True)
         msg = can.Message(
             arbitration_id=0xC0FFEF, data=[1, 2, 3, 4, 5, 6, 7, 8], is_extended_id=True
         )
         bus.send(msg)
         cantact.MockInterface.send.assert_called()
 
     def test_recv(self):
-        bus = can.Bus(channel=0, bustype="cantact", _testing=True)
+        bus = can.Bus(channel=0, interface="cantact", _testing=True)
         frame = bus.recv(timeout=0.5)
         cantact.MockInterface.recv.assert_called()
         self.assertIsInstance(frame, can.Message)
 
     def test_recv_timeout(self):
-        bus = can.Bus(channel=0, bustype="cantact", _testing=True)
+        bus = can.Bus(channel=0, interface="cantact", _testing=True)
         frame = bus.recv(timeout=0.0)
         cantact.MockInterface.recv.assert_called()
         self.assertIsNone(frame)
 
     def test_shutdown(self):
-        bus = can.Bus(channel=0, bustype="cantact", _testing=True)
+        bus = can.Bus(channel=0, interface="cantact", _testing=True)
         bus.shutdown()
         cantact.MockInterface.stop.assert_called()
diff --git a/test/test_interface_virtual.py b/test/test_interface_virtual.py
@@ -13,8 +13,8 @@
 
 class TestMessageFiltering(unittest.TestCase):
     def setUp(self):
-        self.node1 = Bus("test", bustype="virtual", preserve_timestamps=True)
-        self.node2 = Bus("test", bustype="virtual")
+        self.node1 = Bus("test", interface="virtual", preserve_timestamps=True)
+        self.node2 = Bus("test", interface="virtual")
 
     def tearDown(self):
         self.node1.shutdown()
diff --git a/test/test_kvaser.py b/test/test_kvaser.py
@@ -37,7 +37,7 @@ def setUp(self):
 
         self.msg = {}
         self.msg_in_cue = None
-        self.bus = can.Bus(channel=0, bustype="kvaser")
+        self.bus = can.Bus(channel=0, interface="kvaser")
 
     def tearDown(self):
         if self.bus:
@@ -149,7 +149,7 @@ def test_available_configs(self):
     def test_canfd_default_data_bitrate(self):
         canlib.canSetBusParams.reset_mock()
         canlib.canSetBusParamsFd.reset_mock()
-        can.Bus(channel=0, bustype="kvaser", fd=True)
+        can.Bus(channel=0, interface="kvaser", fd=True)
         canlib.canSetBusParams.assert_called_once_with(
             0, constants.canFD_BITRATE_500K_80P, 0, 0, 0, 0, 0
         )
@@ -161,7 +161,7 @@ def test_canfd_nondefault_data_bitrate(self):
         canlib.canSetBusParams.reset_mock()
         canlib.canSetBusParamsFd.reset_mock()
         data_bitrate = 2000000
-        can.Bus(channel=0, bustype="kvaser", fd=True, data_bitrate=data_bitrate)
+        can.Bus(channel=0, interface="kvaser", fd=True, data_bitrate=data_bitrate)
         bitrate_constant = canlib.BITRATE_FD[data_bitrate]
         canlib.canSetBusParams.assert_called_once_with(
             0, constants.canFD_BITRATE_500K_80P, 0, 0, 0, 0, 0
@@ -172,7 +172,7 @@ def test_canfd_custom_data_bitrate(self):
         canlib.canSetBusParams.reset_mock()
         canlib.canSetBusParamsFd.reset_mock()
         data_bitrate = 123456
-        can.Bus(channel=0, bustype="kvaser", fd=True, data_bitrate=data_bitrate)
+        can.Bus(channel=0, interface="kvaser", fd=True, data_bitrate=data_bitrate)
         canlib.canSetBusParams.assert_called_once_with(
             0, constants.canFD_BITRATE_500K_80P, 0, 0, 0, 0, 0
         )
diff --git a/test/test_message_filtering.py b/test/test_message_filtering.py
@@ -21,7 +21,7 @@
 
 class TestMessageFiltering(unittest.TestCase):
     def setUp(self):
-        self.bus = Bus(bustype="virtual", channel="testy")
+        self.bus = Bus(interface="virtual", channel="testy")
 
     def tearDown(self):
         self.bus.shutdown()
diff --git a/test/test_neousys.py b/test/test_neousys.py
@@ -33,7 +33,7 @@ def setUp(self) -> None:
         can.interfaces.neousys.neousys.NEOUSYS_CANLIB.CAN_Start = Mock(return_value=1)
         can.interfaces.neousys.neousys.NEOUSYS_CANLIB.CAN_Send = Mock(return_value=1)
         can.interfaces.neousys.neousys.NEOUSYS_CANLIB.CAN_Stop = Mock(return_value=1)
-        self.bus = can.Bus(channel=0, bustype="neousys")
+        self.bus = can.Bus(channel=0, interface="neousys")
 
     def tearDown(self) -> None:
         if self.bus:
@@ -66,7 +66,7 @@ def test_bus_creation(self) -> None:
         )
 
     def test_bus_creation_bitrate(self) -> None:
-        self.bus = can.Bus(channel=0, bustype="neousys", bitrate=200000)
+        self.bus = can.Bus(channel=0, interface="neousys", bitrate=200000)
         self.assertIsInstance(self.bus, neousys.NeousysBus)
         CAN_Start_args = (
             can.interfaces.neousys.neousys.NEOUSYS_CANLIB.CAN_Setup.call_args[0]
diff --git a/test/test_pcan.py b/test/test_pcan.py
diff --git a/test/test_robotell.py b/test/test_robotell.py
diff --git a/test/test_slcan.py b/test/test_slcan.py
diff --git a/test/test_systec.py b/test/test_systec.py
diff --git a/test/test_vector.py b/test/test_vector.py
diff --git a/test/zero_dlc_test.py b/test/zero_dlc_test.py

Original file line number	Diff line number	Diff line change
@@ -69,7 +69,7 @@ Example defining two filters, one to pass 11-bit ID ``0x451``, the other to pass
`69`	`69`	`{"can_id": 0x451, "can_mask": 0x7FF, "extended": False},`
`70`	`70`	`{"can_id": 0xA0000, "can_mask": 0x1FFFFFFF, "extended": True},`
`71`	`71`	`]`
`72`		`- bus = can.interface.Bus(channel="can0", bustype="socketcan", can_filters=filters)`
	`72`	`+ bus = can.interface.Bus(channel="can0", interface="socketcan", can_filters=filters)`
`73`	`73`
`74`	`74`
`75`	`75`	See :meth:`~can.BusABC.set_filters` for the implementation.
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ Interface`
`31`	`31`
`32`	`32`	`A bus example::`
`33`	`33`
`34`		`- bus = can.interface.Bus(bustype='seeedstudio', channel='/dev/ttyUSB0', bitrate=500000)`
	`34`	`+ bus = can.interface.Bus(interface='seeedstudio', channel='/dev/ttyUSB0', bitrate=500000)`
`35`	`35`
`36`	`36`
`37`	`37`