Merge branch 'main' into CC-2174_over8_adaptations

Author: rahagal

.github/workflows/ci.yml

@@ -131,18 +131,14 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.10"
+        python-version: "3.12"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .[canalystii,gs_usb,mf4]
-        pip install -r doc/doc-requirements.txt
+        pip install tox
     - name: Build documentation
       run: |
-        python -m sphinx -Wan --keep-going doc build
-    - name: Run doctest
-      run: |
-        python -m sphinx -b doctest -W --keep-going doc build
+        tox -e docs
 
   build:
     name: Packaging

.readthedocs.yml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.12"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

CHANGELOG.md

@@ -1,3 +1,48 @@
+Version 4.5.0
+=============
+
+Features
+--------
+
+* gs_usb command-line support (and documentation updates and stability fixes) by @BenGardiner in https://github.com/hardbyte/python-can/pull/1790
+* Faster and more general MF4 support by @cssedev in https://github.com/hardbyte/python-can/pull/1892
+* ASCWriter speed improvement by @pierreluctg in https://github.com/hardbyte/python-can/pull/1856
+* Faster Message string representation by @pierreluctg in https://github.com/hardbyte/python-can/pull/1858
+* Added Netronic's CANdo and CANdoISO adapters interface by @belliriccardo in https://github.com/hardbyte/python-can/pull/1887
+* Add autostart option to BusABC.send_periodic() to fix issue #1848 by @SWolfSchunk in https://github.com/hardbyte/python-can/pull/1853
+* Improve TestBusConfig by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1804
+* Improve speed of TRCReader by @lebuni in https://github.com/hardbyte/python-can/pull/1893
+
+Bug Fixes
+---------
+
+* Fix Kvaser timestamp by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1878
+* Set end_time in ThreadBasedCyclicSendTask.start() by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1871
+* Fix regex in _parse_additional_config() by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1868
+* Fix for #1849 (PCAN fails when PCAN_ERROR_ILLDATA is read via ReadFD) by @bures in https://github.com/hardbyte/python-can/pull/1850
+* Period must be >= 1ms for BCM using Win32 API by @pierreluctg in https://github.com/hardbyte/python-can/pull/1847
+* Fix ASCReader Crash on "Start of Measurement" Line by @RitheeshBaradwaj in https://github.com/hardbyte/python-can/pull/1811
+* Resolve AttributeError within NicanError by @vijaysubbiah20 in https://github.com/hardbyte/python-can/pull/1806
+
+
+Miscellaneous
+-------------
+
+* Fix CI by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1889
+* Update msgpack dependency by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1875
+* Add tox environment for doctest by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1870
+* Use typing_extensions.TypedDict on python < 3.12 for pydantic support by @NickCao in https://github.com/hardbyte/python-can/pull/1845
+* Replace PyPy3.8 with PyPy3.10 by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1838
+* Fix slcan tests by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1834
+* Test on Python 3.13 by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1833
+* Stop notifier in examples by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1814
+* Use setuptools_scm by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1810
+* Added extra info for Kvaser dongles by @FedericoSpada in https://github.com/hardbyte/python-can/pull/1797
+* Socketcand: show actual response as well as expected in error by @liamkinne in https://github.com/hardbyte/python-can/pull/1807
+* Refactor CLI filter parsing, add tests by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1805
+* Add zlgcan to docs by @zariiii9003 in https://github.com/hardbyte/python-can/pull/1839
+
+
 Version 4.4.2
 =============
 

CONTRIBUTORS.txt

@@ -83,3 +83,12 @@ Felix Nieuwenhuizen
 @felixn
 @Tbruno25
 @RitheeshBaradwaj
+@vijaysubbiah20
+@liamkinne
+@RitheeshBaradwaj
+@BenGardiner
+@bures
+@NickCao
+@SWolfSchunk
+@belliriccardo
+@cssedev

can/broadcastmanager.py

@@ -182,6 +182,7 @@ def __init__(
         """
         super().__init__(messages, period)
         self.duration = duration
+        self.end_time: Optional[float] = None
 
 
 class RestartableCyclicTaskABC(CyclicSendTaskABC, abc.ABC):
@@ -276,6 +277,7 @@ def __init__(
         period: float,
         duration: Optional[float] = None,
         on_error: Optional[Callable[[Exception], bool]] = None,
+        autostart: bool = True,
         modifier_callback: Optional[Callable[[Message], None]] = None,
     ) -> None:
         """Transmits `messages` with a `period` seconds for `duration` seconds on a `bus`.
@@ -298,9 +300,6 @@ def __init__(
         self.send_lock = lock
         self.stopped = True
         self.thread: Optional[threading.Thread] = None
-        self.end_time: Optional[float] = (
-            time.perf_counter() + duration if duration else None
-        )
         self.on_error = on_error
         self.modifier_callback = modifier_callback
 
@@ -324,7 +323,8 @@ def __init__(
                 stacklevel=1,
             )
 
-        self.start()
+        if autostart:
+            self.start()
 
     def stop(self) -> None:
         self.stopped = True
@@ -339,6 +339,10 @@ def start(self) -> None:
             self.thread = threading.Thread(target=self._run, name=name)
             self.thread.daemon = True
 
+            self.end_time: Optional[float] = (
+                time.perf_counter() + self.duration if self.duration else None
+            )
+
             if self.event and PYWIN32:
                 PYWIN32.set_timer(self.event, self.period_ms)
 
@@ -354,6 +358,7 @@ def _run(self) -> None:
 
         while not self.stopped:
             if self.end_time is not None and time.perf_counter() >= self.end_time:
+                self.stop()
                 break
 
             try:

can/bus.py

@@ -215,6 +215,7 @@ def send_periodic(
         period: float,
         duration: Optional[float] = None,
         store_task: bool = True,
+        autostart: bool = True,
         modifier_callback: Optional[Callable[[Message], None]] = None,
     ) -> can.broadcastmanager.CyclicSendTaskABC:
         """Start sending messages at a given period on this bus.
@@ -237,6 +238,10 @@ def send_periodic(
         :param store_task:
             If True (the default) the task will be attached to this Bus instance.
             Disable to instead manage tasks manually.
+        :param autostart:
+            If True (the default) the sending task will immediately start after creation.
+            Otherwise, the task has to be started by calling the
+            tasks :meth:`~can.RestartableCyclicTaskABC.start` method on it.
         :param modifier_callback:
             Function which should be used to modify each message's data before
             sending. The callback modifies the :attr:`~can.Message.data` of the
@@ -272,7 +277,9 @@ def send_periodic(
         # Create a backend specific task; will be patched to a _SelfRemovingCyclicTask later
         task = cast(
             _SelfRemovingCyclicTask,
-            self._send_periodic_internal(msgs, period, duration, modifier_callback),
+            self._send_periodic_internal(
+                msgs, period, duration, autostart, modifier_callback
+            ),
         )
         # we wrap the task's stop method to also remove it from the Bus's list of tasks
         periodic_tasks = self._periodic_tasks
@@ -299,6 +306,7 @@ def _send_periodic_internal(
         msgs: Union[Sequence[Message], Message],
         period: float,
         duration: Optional[float] = None,
+        autostart: bool = True,
         modifier_callback: Optional[Callable[[Message], None]] = None,
     ) -> can.broadcastmanager.CyclicSendTaskABC:
         """Default implementation of periodic message sending using threading.
@@ -312,6 +320,10 @@ def _send_periodic_internal(
         :param duration:
             The duration between sending each message at the given rate. If
             no duration is provided, the task will continue indefinitely.
+        :param autostart:
+            If True (the default) the sending task will immediately start after creation.
+            Otherwise, the task has to be started by calling the
+            tasks :meth:`~can.RestartableCyclicTaskABC.start` method on it.
         :return:
             A started task instance. Note the task can be stopped (and
             depending on the backend modified) by calling the
@@ -328,6 +340,7 @@ def _send_periodic_internal(
             messages=msgs,
             period=period,
             duration=duration,
+            autostart=autostart,
             modifier_callback=modifier_callback,
         )
         return task

can/interfaces/ixxat/canlib.py

@@ -155,10 +155,11 @@ def _send_periodic_internal(
         msgs: Union[Sequence[Message], Message],
         period: float,
         duration: Optional[float] = None,
+        autostart: bool = True,
         modifier_callback: Optional[Callable[[Message], None]] = None,
     ) -> CyclicSendTaskABC:
         return self.bus._send_periodic_internal(
-            msgs, period, duration, modifier_callback
+            msgs, period, duration, autostart, modifier_callback
         )
 
     def shutdown(self) -> None:

can/interfaces/ixxat/canlib_vcinpl.py

@@ -793,6 +793,7 @@ def _send_periodic_internal(
         msgs: Union[Sequence[Message], Message],
         period: float,
         duration: Optional[float] = None,
+        autostart: bool = True,
         modifier_callback: Optional[Callable[[Message], None]] = None,
     ) -> CyclicSendTaskABC:
         """Send a message using built-in cyclic transmit list functionality."""
@@ -807,7 +808,12 @@ def _send_periodic_internal(
                 self._scheduler_resolution = caps.dwClockFreq / caps.dwCmsDivisor
                 _canlib.canSchedulerActivate(self._scheduler, constants.TRUE)
             return CyclicSendTask(
-                self._scheduler, msgs, period, duration, self._scheduler_resolution
+                self._scheduler,
+                msgs,
+                period,
+                duration,
+                self._scheduler_resolution,
+                autostart=autostart,
             )
 
         # fallback to thread based cyclic task
@@ -821,6 +827,7 @@ def _send_periodic_internal(
             msgs=msgs,
             period=period,
             duration=duration,
+            autostart=autostart,
             modifier_callback=modifier_callback,
         )
 
@@ -863,7 +870,15 @@ def state(self) -> BusState:
 class CyclicSendTask(LimitedDurationCyclicSendTaskABC, RestartableCyclicTaskABC):
     """A message in the cyclic transmit list."""
 
-    def __init__(self, scheduler, msgs, period, duration, resolution):
+    def __init__(
+        self,
+        scheduler,
+        msgs,
+        period,
+        duration,
+        resolution,
+        autostart: bool = True,
+    ):
         super().__init__(msgs, period, duration)
         if len(self.messages) != 1:
             raise ValueError(
@@ -883,7 +898,8 @@ def __init__(self, scheduler, msgs, period, duration, resolution):
         self._msg.uMsgInfo.Bits.dlc = self.messages[0].dlc
         for i, b in enumerate(self.messages[0].data):
             self._msg.abData[i] = b
-        self.start()
+        if autostart:
+            self.start()
 
     def start(self):
         """Start transmitting message (add to list if needed)."""

can/interfaces/ixxat/canlib_vcinpl2.py

@@ -937,6 +937,7 @@ def _send_periodic_internal(
         msgs: Union[Sequence[Message], Message],
         period: float,
         duration: Optional[float] = None,
+        autostart: bool = True,
         modifier_callback: Optional[Callable[[Message], None]] = None,
     ) -> CyclicSendTaskABC:
         """Send a message using built-in cyclic transmit list functionality."""
@@ -953,7 +954,12 @@ def _send_periodic_internal(
                 )  # TODO: confirm
                 _canlib.canSchedulerActivate(self._scheduler, constants.TRUE)
             return CyclicSendTask(
-                self._scheduler, msgs, period, duration, self._scheduler_resolution
+                self._scheduler,
+                msgs,
+                period,
+                duration,
+                self._scheduler_resolution,
+                autostart=autostart,
             )
 
         # fallback to thread based cyclic task
@@ -967,6 +973,7 @@ def _send_periodic_internal(
             msgs=msgs,
             period=period,
             duration=duration,
+            autostart=autostart,
             modifier_callback=modifier_callback,
         )
 
@@ -983,7 +990,15 @@ def shutdown(self):
 class CyclicSendTask(LimitedDurationCyclicSendTaskABC, RestartableCyclicTaskABC):
     """A message in the cyclic transmit list."""
 
-    def __init__(self, scheduler, msgs, period, duration, resolution):
+    def __init__(
+        self,
+        scheduler,
+        msgs,
+        period,
+        duration,
+        resolution,
+        autostart: bool = True,
+    ):
         super().__init__(msgs, period, duration)
         if len(self.messages) != 1:
             raise ValueError(
@@ -1003,7 +1018,8 @@ def __init__(self, scheduler, msgs, period, duration, resolution):
         self._msg.uMsgInfo.Bits.dlc = self.messages[0].dlc
         for i, b in enumerate(self.messages[0].data):
             self._msg.abData[i] = b
-        self.start()
+        if autostart:
+            self.start()
 
     def start(self):
         """Start transmitting message (add to list if needed)."""