Merge branch 'main' into slcanFD

Author: ssj71

.github/workflows/ci.yml

@@ -18,7 +18,6 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
         experimental: [false]
         python-version: [
-          "3.8",
           "3.9",
           "3.10",
           "3.11",
@@ -42,6 +41,7 @@ jobs:
     - name: Setup SocketCAN
       if: ${{ matrix.os == 'ubuntu-latest' }}
       run: |
+        sudo apt-get update
         sudo apt-get -y install linux-modules-extra-$(uname -r)
         sudo ./test/open_vcan.sh
     - name: Test with pytest via tox
@@ -80,10 +80,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .[lint]
-    - name: mypy 3.8
-      run: |
-        mypy --python-version 3.8 .
+        pip install --group lint -e .
     - name: mypy 3.9
       run: |
         mypy --python-version 3.9 .
@@ -96,6 +93,9 @@ jobs:
     - name: mypy 3.12
       run: |
         mypy --python-version 3.12 .
+    - name: mypy 3.13
+      run: |
+        mypy --python-version 3.13 .
     - name: ruff
       run: |
         ruff check can
@@ -119,7 +119,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .[lint]
+        pip install --group lint
     - name: Code Format Check with Black
       run: |
         black --check --verbose .

.readthedocs.yml

@@ -10,6 +10,9 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
+  jobs:
+    post_install:
+      - pip install --group docs
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -23,10 +26,11 @@ formats:
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-    - requirements: doc/doc-requirements.txt
     - method: pip
       path: .
       extra_requirements:
         - canalystii
-        - gs_usb
+        - gs-usb
         - mf4
+        - remote
+        - serial

README.rst

@@ -3,7 +3,7 @@ python-can
 
 |pypi| |conda| |python_implementation| |downloads| |downloads_monthly|
 
-|docs| |github-actions| |coverage| |mergify| |formatter|
+|docs| |github-actions| |coverage| |formatter|
 
 .. |pypi| image:: https://img.shields.io/pypi/v/python-can.svg
    :target: https://pypi.python.org/pypi/python-can/
@@ -41,10 +41,6 @@ python-can
    :target: https://coveralls.io/github/hardbyte/python-can?branch=develop
    :alt: Test coverage reports on Coveralls.io
 
-.. |mergify| image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/hardbyte/python-can&style=flat
-   :target: https://mergify.io
-   :alt: Mergify Status
-
 The **C**\ ontroller **A**\ rea **N**\ etwork is a bus standard designed
 to allow microcontrollers and devices to communicate with each other. It
 has priority based bus arbitration and reliable deterministic
@@ -64,6 +60,7 @@ Library Version                 Python
   3.x                           2.7+, 3.5+
   4.0+                          3.7+
   4.3+                          3.8+
+  4.6+                          3.9+
 ==============================  ===========
 
 

can/__init__.py

@@ -8,20 +8,23 @@
 import contextlib
 import logging
 from importlib.metadata import PackageNotFoundError, version
-from typing import Any, Dict
+from typing import Any
 
 __all__ = [
+    "VALID_INTERFACES",
     "ASCReader",
     "ASCWriter",
     "AsyncBufferedReader",
-    "BitTiming",
-    "BitTimingFd",
     "BLFReader",
     "BLFWriter",
+    "BitTiming",
+    "BitTimingFd",
     "BufferedReader",
     "Bus",
     "BusABC",
     "BusState",
+    "CSVReader",
+    "CSVWriter",
     "CanError",
     "CanInitializationError",
     "CanInterfaceNotImplementedError",
@@ -30,30 +33,27 @@
     "CanTimeoutError",
     "CanutilsLogReader",
     "CanutilsLogWriter",
-    "CSVReader",
-    "CSVWriter",
     "CyclicSendTaskABC",
     "LimitedDurationCyclicSendTaskABC",
     "Listener",
-    "Logger",
     "LogReader",
-    "ModifiableCyclicTaskABC",
-    "Message",
-    "MessageSync",
+    "Logger",
     "MF4Reader",
     "MF4Writer",
+    "Message",
+    "MessageSync",
+    "ModifiableCyclicTaskABC",
     "Notifier",
     "Printer",
     "RedirectReader",
     "RestartableCyclicTaskABC",
     "SizedRotatingLogger",
     "SqliteReader",
     "SqliteWriter",
-    "ThreadSafeBus",
     "TRCFileVersion",
     "TRCReader",
     "TRCWriter",
-    "VALID_INTERFACES",
+    "ThreadSafeBus",
     "bit_timing",
     "broadcastmanager",
     "bus",
@@ -64,8 +64,8 @@
     "interfaces",
     "io",
     "listener",
-    "logconvert",
     "log",
+    "logconvert",
     "logger",
     "message",
     "notifier",
@@ -130,4 +130,4 @@
 
 log = logging.getLogger("can")
 
-rc: Dict[str, Any] = {}
+rc: dict[str, Any] = {}

can/_entry_points.py

@@ -2,7 +2,7 @@
 import sys
 from dataclasses import dataclass
 from importlib.metadata import entry_points
-from typing import Any, List
+from typing import Any
 
 
 @dataclass
@@ -20,14 +20,14 @@ def load(self) -> Any:
 # "Compatibility Note".
 if sys.version_info >= (3, 10):
 
-    def read_entry_points(group: str) -> List[_EntryPoint]:
+    def read_entry_points(group: str) -> list[_EntryPoint]:
         return [
             _EntryPoint(ep.name, ep.module, ep.attr) for ep in entry_points(group=group)
         ]
 
 else:
 
-    def read_entry_points(group: str) -> List[_EntryPoint]:
+    def read_entry_points(group: str) -> list[_EntryPoint]:
         return [
             _EntryPoint(ep.name, *ep.value.split(":", maxsplit=1))
             for ep in entry_points().get(group, [])

can/bit_timing.py

@@ -1,6 +1,7 @@
 # pylint: disable=too-many-lines
 import math
-from typing import TYPE_CHECKING, Iterator, List, Mapping, cast
+from collections.abc import Iterator, Mapping
+from typing import TYPE_CHECKING, cast
 
 if TYPE_CHECKING:
     from can.typechecking import BitTimingDict, BitTimingFdDict
@@ -155,7 +156,7 @@ def from_bitrate_and_segments(
             if the arguments are invalid.
         """
         try:
-            brp = int(round(f_clock / (bitrate * (1 + tseg1 + tseg2))))
+            brp = round(f_clock / (bitrate * (1 + tseg1 + tseg2)))
         except ZeroDivisionError:
             raise ValueError("Invalid inputs") from None
 
@@ -232,15 +233,15 @@ def iterate_from_sample_point(
             raise ValueError(f"sample_point (={sample_point}) must not be below 50%.")
 
         for brp in range(1, 65):
-            nbt = round(int(f_clock / (bitrate * brp)))
+            nbt = int(f_clock / (bitrate * brp))
             if nbt < 8:
                 break
 
             effective_bitrate = f_clock / (nbt * brp)
             if abs(effective_bitrate - bitrate) > bitrate / 256:
                 continue
 
-            tseg1 = int(round(sample_point / 100 * nbt)) - 1
+            tseg1 = round(sample_point / 100 * nbt) - 1
             # limit tseg1, so tseg2 is at least 1 TQ
             tseg1 = min(tseg1, nbt - 2)
 
@@ -286,7 +287,7 @@ def from_sample_point(
         if sample_point < 50.0:
             raise ValueError(f"sample_point (={sample_point}) must not be below 50%.")
 
-        possible_solutions: List[BitTiming] = list(
+        possible_solutions: list[BitTiming] = list(
             cls.iterate_from_sample_point(f_clock, bitrate, sample_point)
         )
 
@@ -312,7 +313,7 @@ def f_clock(self) -> int:
     @property
     def bitrate(self) -> int:
         """Bitrate in bits/s."""
-        return int(round(self.f_clock / (self.nbt * self.brp)))
+        return round(self.f_clock / (self.nbt * self.brp))
 
     @property
     def brp(self) -> int:
@@ -322,7 +323,7 @@ def brp(self) -> int:
     @property
     def tq(self) -> int:
         """Time quantum in nanoseconds"""
-        return int(round(self.brp / self.f_clock * 1e9))
+        return round(self.brp / self.f_clock * 1e9)
 
     @property
     def nbt(self) -> int:
@@ -433,7 +434,7 @@ def recreate_with_f_clock(self, f_clock: int) -> "BitTiming":
                 "f_clock change failed because of sample point discrepancy."
             )
         # adapt synchronization jump width, so it has the same size relative to bit time as self
-        sjw = int(round(self.sjw / self.nbt * bt.nbt))
+        sjw = round(self.sjw / self.nbt * bt.nbt)
         sjw = max(1, min(4, bt.tseg2, sjw))
         bt._data["sjw"] = sjw  # pylint: disable=protected-access
         bt._data["nof_samples"] = self.nof_samples  # pylint: disable=protected-access
@@ -458,7 +459,7 @@ def __repr__(self) -> str:
         return f"can.{self.__class__.__name__}({args})"
 
     def __getitem__(self, key: str) -> int:
-        return cast(int, self._data.__getitem__(key))
+        return cast("int", self._data.__getitem__(key))
 
     def __len__(self) -> int:
         return self._data.__len__()
@@ -716,10 +717,8 @@ def from_bitrate_and_segments(  # pylint: disable=too-many-arguments
             if the arguments are invalid.
         """
         try:
-            nom_brp = int(round(f_clock / (nom_bitrate * (1 + nom_tseg1 + nom_tseg2))))
-            data_brp = int(
-                round(f_clock / (data_bitrate * (1 + data_tseg1 + data_tseg2)))
-            )
+            nom_brp = round(f_clock / (nom_bitrate * (1 + nom_tseg1 + nom_tseg2)))
+            data_brp = round(f_clock / (data_bitrate * (1 + data_tseg1 + data_tseg2)))
         except ZeroDivisionError:
             raise ValueError("Invalid inputs.") from None
 
@@ -787,15 +786,15 @@ def iterate_from_sample_point(
         sync_seg = 1
 
         for nom_brp in range(1, 257):
-            nbt = round(int(f_clock / (nom_bitrate * nom_brp)))
+            nbt = int(f_clock / (nom_bitrate * nom_brp))
             if nbt < 1:
                 break
 
             effective_nom_bitrate = f_clock / (nbt * nom_brp)
             if abs(effective_nom_bitrate - nom_bitrate) > nom_bitrate / 256:
                 continue
 
-            nom_tseg1 = int(round(nom_sample_point / 100 * nbt)) - 1
+            nom_tseg1 = round(nom_sample_point / 100 * nbt) - 1
             # limit tseg1, so tseg2 is at least 2 TQ
             nom_tseg1 = min(nom_tseg1, nbt - sync_seg - 2)
             nom_tseg2 = nbt - nom_tseg1 - 1
@@ -811,7 +810,7 @@ def iterate_from_sample_point(
                 if abs(effective_data_bitrate - data_bitrate) > data_bitrate / 256:
                     continue
 
-                data_tseg1 = int(round(data_sample_point / 100 * dbt)) - 1
+                data_tseg1 = round(data_sample_point / 100 * dbt) - 1
                 # limit tseg1, so tseg2 is at least 2 TQ
                 data_tseg1 = min(data_tseg1, dbt - sync_seg - 2)
                 data_tseg2 = dbt - data_tseg1 - 1
@@ -876,7 +875,7 @@ def from_sample_point(
                 f"data_sample_point (={data_sample_point}) must not be below 50%."
             )
 
-        possible_solutions: List[BitTimingFd] = list(
+        possible_solutions: list[BitTimingFd] = list(
             cls.iterate_from_sample_point(
                 f_clock,
                 nom_bitrate,
@@ -923,7 +922,7 @@ def f_clock(self) -> int:
     @property
     def nom_bitrate(self) -> int:
         """Nominal (arbitration phase) bitrate."""
-        return int(round(self.f_clock / (self.nbt * self.nom_brp)))
+        return round(self.f_clock / (self.nbt * self.nom_brp))
 
     @property
     def nom_brp(self) -> int:
@@ -933,7 +932,7 @@ def nom_brp(self) -> int:
     @property
     def nom_tq(self) -> int:
         """Nominal time quantum in nanoseconds"""
-        return int(round(self.nom_brp / self.f_clock * 1e9))
+        return round(self.nom_brp / self.f_clock * 1e9)
 
     @property
     def nbt(self) -> int:
@@ -969,7 +968,7 @@ def nom_sample_point(self) -> float:
     @property
     def data_bitrate(self) -> int:
         """Bitrate of the data phase in bit/s."""
-        return int(round(self.f_clock / (self.dbt * self.data_brp)))
+        return round(self.f_clock / (self.dbt * self.data_brp))
 
     @property
     def data_brp(self) -> int:
@@ -979,7 +978,7 @@ def data_brp(self) -> int:
     @property
     def data_tq(self) -> int:
         """Data time quantum in nanoseconds"""
-        return int(round(self.data_brp / self.f_clock * 1e9))
+        return round(self.data_brp / self.f_clock * 1e9)
 
     @property
     def dbt(self) -> int:
@@ -1106,10 +1105,10 @@ def recreate_with_f_clock(self, f_clock: int) -> "BitTimingFd":
                 "f_clock change failed because of sample point discrepancy."
             )
         # adapt synchronization jump width, so it has the same size relative to bit time as self
-        nom_sjw = int(round(self.nom_sjw / self.nbt * bt.nbt))
+        nom_sjw = round(self.nom_sjw / self.nbt * bt.nbt)
         nom_sjw = max(1, min(bt.nom_tseg2, nom_sjw))
         bt._data["nom_sjw"] = nom_sjw  # pylint: disable=protected-access
-        data_sjw = int(round(self.data_sjw / self.dbt * bt.dbt))
+        data_sjw = round(self.data_sjw / self.dbt * bt.dbt)
         data_sjw = max(1, min(bt.data_tseg2, data_sjw))
         bt._data["data_sjw"] = data_sjw  # pylint: disable=protected-access
         bt._validate()  # pylint: disable=protected-access
@@ -1138,7 +1137,7 @@ def __repr__(self) -> str:
         return f"can.{self.__class__.__name__}({args})"
 
     def __getitem__(self, key: str) -> int:
-        return cast(int, self._data.__getitem__(key))
+        return cast("int", self._data.__getitem__(key))
 
     def __len__(self) -> int:
         return self._data.__len__()