Rename CANProtocol to CanProtocol

Author: lumagi

can/__init__.py

@@ -27,7 +27,7 @@
 from .util import set_logging_level
 
 from .message import Message
-from .bus import BusABC, BusState, CANProtocol
+from .bus import BusABC, BusState, CanProtocol
 from .thread_safe_bus import ThreadSafeBus
 from .notifier import Notifier
 from .interfaces import VALID_INTERFACES

can/bus.py

@@ -27,7 +27,7 @@ class BusState(Enum):
     ERROR = auto()
 
 
-class CANProtocol(Enum):
+class CanProtocol(Enum):
     """The CAN protocol type supported by a :class:`can.BusABC` instance"""
 
     CAN_20 = auto()
@@ -56,7 +56,7 @@ class BusABC(metaclass=ABCMeta):
     def __init__(
         self,
         channel: Any,
-        protocol: CANProtocol = CANProtocol.CAN_20,
+        protocol: CanProtocol = CanProtocol.CAN_20,
         can_filters: Optional[can.typechecking.CanFilters] = None,
         **kwargs: object
     ):
@@ -460,7 +460,7 @@ def state(self, new_state: BusState) -> None:
         raise NotImplementedError("Property is not implemented.")
 
     @property
-    def protocol(self) -> CANProtocol:
+    def protocol(self) -> CanProtocol:
         """Return the CAN protocol used by this bus instance.
 
         This value is set at initialization time and does not change

can/interfaces/canalystii.py

@@ -6,7 +6,7 @@
 
 import canalystii as driver
 
-from can import BitTiming, BusABC, Message, BitTimingFd, CANProtocol
+from can import BitTiming, BusABC, Message, BitTimingFd, CanProtocol
 from can.exceptions import CanTimeoutError
 from can.typechecking import CanFilters
 from can.util import deprecated_args_alias, check_or_adjust_timing_clock
@@ -53,7 +53,7 @@ def __init__(
         super().__init__(
             channel=channel,
             can_filters=can_filters,
-            protocol=CANProtocol.CAN_20,
+            protocol=CanProtocol.CAN_20,
             **kwargs,
         )
 

can/interfaces/pcan/pcan.py

@@ -12,7 +12,7 @@
 from can import (
     BusABC,
     BusState,
-    CANProtocol,
+    CanProtocol,
     BitTiming,
     BitTimingFd,
     Message,
@@ -341,7 +341,7 @@ def __init__(
 
         super().__init__(
             channel=channel,
-            protocol=CANProtocol.CAN_FD if is_fd else CANProtocol.CAN_20,
+            protocol=CanProtocol.CAN_FD if is_fd else CanProtocol.CAN_20,
             state=state,
             bitrate=bitrate,
             **kwargs,
@@ -491,7 +491,7 @@ def _recv_internal(
         end_time = time.time() + timeout if timeout is not None else None
 
         while True:
-            if self.protocol == CANProtocol.CAN_FD:
+            if self.protocol == CanProtocol.CAN_FD:
                 result, pcan_msg, pcan_timestamp = self.m_objPCANBasic.ReadFD(
                     self.m_PcanHandle
                 )
@@ -553,7 +553,7 @@ def _recv_internal(
         error_state_indicator = bool(pcan_msg.MSGTYPE & PCAN_MESSAGE_ESI.value)
         is_error_frame = bool(pcan_msg.MSGTYPE & PCAN_MESSAGE_ERRFRAME.value)
 
-        if self.protocol == CANProtocol.CAN_FD:
+        if self.protocol == CanProtocol.CAN_FD:
             dlc = dlc2len(pcan_msg.DLC)
             timestamp = boottimeEpoch + (pcan_timestamp.value / (1000.0 * 1000.0))
         else:
@@ -599,7 +599,7 @@ def send(self, msg, timeout=None):
         if msg.error_state_indicator:
             msgType |= PCAN_MESSAGE_ESI.value
 
-        if self.protocol == CANProtocol.CAN_FD:
+        if self.protocol == CanProtocol.CAN_FD:
             # create a TPCANMsg message structure
             CANMsg = TPCANMsgFD()
 

can/interfaces/slcan.py

@@ -7,7 +7,7 @@
 import time
 from typing import Any, Optional, Tuple
 
-from can import BusABC, Message, CANProtocol
+from can import BusABC, Message, CanProtocol
 from can import typechecking
 from ..exceptions import (
     CanInterfaceNotImplementedError,
@@ -122,7 +122,7 @@ def __init__(
             ttyBaudrate=115200,
             bitrate=None,
             rtscts=False,
-            protocol=CANProtocol.CAN_20,
+            protocol=CanProtocol.CAN_20,
             **kwargs,
         )
 

can/interfaces/udp_multicast/bus.py

@@ -6,7 +6,7 @@
 from typing import List, Optional, Tuple, Union
 
 import can
-from can import BusABC, CANProtocol
+from can import BusABC, CanProtocol
 from can.typechecking import AutoDetectedConfig
 from .utils import pack_message, unpack_message, check_msgpack_installed
 
@@ -103,7 +103,7 @@ def __init__(
             )
 
         super().__init__(
-            channel, **kwargs, protocol=CANProtocol.CAN_FD if fd else CANProtocol.CAN_20
+            channel, **kwargs, protocol=CanProtocol.CAN_FD if fd else CanProtocol.CAN_20
         )
 
         self.is_fd = fd

can/interfaces/virtual.py

@@ -16,7 +16,7 @@
 from random import randint
 
 from can import CanOperationError
-from can.bus import BusABC, CANProtocol
+from can.bus import BusABC, CanProtocol
 from can.message import Message
 from can.typechecking import AutoDetectedConfig
 
@@ -63,7 +63,7 @@ def __init__(
         receive_own_messages: bool = False,
         rx_queue_size: int = 0,
         preserve_timestamps: bool = False,
-        protocol: CANProtocol = CANProtocol.CAN_20,
+        protocol: CanProtocol = CanProtocol.CAN_20,
         **kwargs: Any,
     ) -> None:
         """

test/test_interface_canalystii.py

@@ -23,7 +23,7 @@ def test_initialize_from_constructor(self):
             instance = mock_device.return_value
             bus = CANalystIIBus(bitrate=1000000)
 
-            self.assertEqual(bus.protocol, can.CANProtocol.CAN_20)
+            self.assertEqual(bus.protocol, can.CanProtocol.CAN_20)
 
             instance.init.assert_has_calls(
                 [
@@ -38,7 +38,7 @@ def test_initialize_single_channel_only(self):
                 instance = mock_device.return_value
                 bus = CANalystIIBus(channel, bitrate=1000000)
 
-                self.assertEqual(bus.protocol, can.CANProtocol.CAN_20)
+                self.assertEqual(bus.protocol, can.CanProtocol.CAN_20)
                 instance.init.assert_called_once_with(channel, bitrate=1000000)
 
     def test_initialize_with_timing_registers(self):
@@ -48,7 +48,7 @@ def test_initialize_with_timing_registers(self):
                 f_clock=8_000_000, btr0=0x03, btr1=0x6F
             )
             bus = CANalystIIBus(bitrate=None, timing=timing)
-            self.assertEqual(bus.protocol, can.CANProtocol.CAN_20)
+            self.assertEqual(bus.protocol, can.CanProtocol.CAN_20)
 
             instance.init.assert_has_calls(
                 [

test/test_pcan.py

@@ -11,7 +11,7 @@
 from parameterized import parameterized
 
 import can
-from can import BusState, CANProtocol
+from can import BusState, CanProtocol
 from can.exceptions import CanInitializationError
 from can.interfaces.pcan import PcanBus, PcanError
 from can.interfaces.pcan.basic import *
@@ -53,7 +53,7 @@ def test_bus_creation(self) -> None:
         self.bus = can.Bus(interface="pcan")
 
         self.assertIsInstance(self.bus, PcanBus)
-        self.assertEqual(self.bus.protocol, CANProtocol.CAN_20)
+        self.assertEqual(self.bus.protocol, CanProtocol.CAN_20)
 
         self.MockPCANBasic.assert_called_once()
         self.mock_pcan.Initialize.assert_called_once()
@@ -81,7 +81,7 @@ def test_bus_creation_fd(self, clock_param: str, clock_val: int) -> None:
         )
 
         self.assertIsInstance(self.bus, PcanBus)
-        self.assertEqual(self.bus.protocol, CANProtocol.CAN_FD)
+        self.assertEqual(self.bus.protocol, CanProtocol.CAN_FD)
 
         self.MockPCANBasic.assert_called_once()
         self.mock_pcan.Initialize.assert_not_called()
@@ -459,7 +459,7 @@ def test_constructor_bit_timing(self):
 
         bitrate_arg = self.mock_pcan.Initialize.call_args[0][1]
         self.assertEqual(bitrate_arg.value, 0x472F)
-        self.assertEqual(bus.protocol, CANProtocol.CAN_20)
+        self.assertEqual(bus.protocol, CanProtocol.CAN_20)
 
     def test_constructor_bit_timing_fd(self):
         timing = can.BitTimingFd(
@@ -474,7 +474,7 @@ def test_constructor_bit_timing_fd(self):
             data_sjw=1,
         )
         bus = can.Bus(interface="pcan", channel="PCAN_USBBUS1", timing=timing)
-        self.assertEqual(bus.protocol, CANProtocol.CAN_FD)
+        self.assertEqual(bus.protocol, CanProtocol.CAN_FD)
 
         bitrate_arg = self.mock_pcan.InitializeFD.call_args[0][-1]