Update linters and gh actions (#1794)

zariiii9003 · web-flow · commit 1ce550c8bf75 · 2024-06-12T23:17:26.000+02:00
* update black

* update ruff

* update mypy and pylint

* make pylint happy

* update actions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -64,7 +64,7 @@ jobs:
         # See: https://foss.heptapod.net/pypy/pypy/-/issues/3809
         TEST_SOCKETCAN: "${{ matrix.os == 'ubuntu-latest' && ! startsWith(matrix.python-version, 'pypy' ) }}"
     - name: Coveralls Parallel
-      uses: coverallsapp/github-action@master
+      uses: coverallsapp/github-action@v2
       with:
         github-token: ${{ secrets.github_token }}
         flag-name: Unittests-${{ matrix.os }}-${{ matrix.python-version }}
@@ -76,17 +76,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Coveralls Finished
-      uses: coverallsapp/github-action@master
+      uses: coverallsapp/github-action@v2
       with:
         github-token: ${{ secrets.github_token }}
         parallel-finished: true
 
   static-code-analysis:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
     - name: Install dependencies
@@ -123,9 +123,9 @@ jobs:
   format:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
     - name: Install dependencies
diff --git a/can/ctypesutil.py b/can/ctypesutil.py
@@ -1,6 +1,7 @@
 """
 This module contains common `ctypes` utils.
 """
+
 import ctypes
 import logging
 import sys
diff --git a/can/interfaces/ixxat/structures.py b/can/interfaces/ixxat/structures.py
@@ -51,17 +51,17 @@ class UniqueHardwareId(ctypes.Union):
     ]
 
     def __str__(self):
-        return "Mfg: {}, Dev: {} HW: {}.{}.{}.{} Drv: {}.{}.{}.{}".format(
-            self.Manufacturer,
-            self.Description,
-            self.HardwareBranchVersion,
-            self.HardwareMajorVersion,
-            self.HardwareMinorVersion,
-            self.HardwareBuildVersion,
-            self.DriverReleaseVersion,
-            self.DriverMajorVersion,
-            self.DriverMinorVersion,
-            self.DriverBuildVersion,
+        return (
+            f"Mfg: {self.Manufacturer}, "
+            f"Dev: {self.Description} "
+            f"HW: {self.HardwareBranchVersion}"
+            f".{self.HardwareMajorVersion}"
+            f".{self.HardwareMinorVersion}"
+            f".{self.HardwareBuildVersion} "
+            f"Drv: {self.DriverReleaseVersion}"
+            f".{self.DriverMajorVersion}"
+            f".{self.DriverMinorVersion}"
+            f".{self.DriverBuildVersion}"
         )
 
 
diff --git a/can/interfaces/kvaser/canlib.py b/can/interfaces/kvaser/canlib.py
@@ -64,7 +64,6 @@ def __get_canlib_function(func_name, argtypes=None, restype=None, errcheck=None)
 
 
 class CANLIBError(CanError):
-
     """
     Try to display errors that occur within the wrapped C library nicely.
     """
diff --git a/can/interfaces/kvaser/structures.py b/can/interfaces/kvaser/structures.py
@@ -23,16 +23,13 @@ class BusStatistics(ctypes.Structure):
 
     def __str__(self):
         return (
-            "std_data: {}, std_remote: {}, ext_data: {}, ext_remote: {}, "
-            "err_frame: {}, bus_load: {:.1f}%, overruns: {}"
-        ).format(
-            self.std_data,
-            self.std_remote,
-            self.ext_data,
-            self.ext_remote,
-            self.err_frame,
-            self.bus_load / 100.0,
-            self.overruns,
+            f"std_data: {self.std_data}, "
+            f"std_remote: {self.std_remote}, "
+            f"ext_data: {self.ext_data}, "
+            f"ext_remote: {self.ext_remote}, "
+            f"err_frame: {self.err_frame}, "
+            f"bus_load: {self.bus_load / 100.0:.1f}%, "
+            f"overruns: {self.overruns}"
         )
 
     @property
diff --git a/can/interfaces/pcan/pcan.py b/can/interfaces/pcan/pcan.py
@@ -1,6 +1,7 @@
 """
 Enable basic CAN over a PCAN USB device.
 """
+
 import logging
 import platform
 import time
diff --git a/can/interfaces/socketcan/socketcan.py b/can/interfaces/socketcan/socketcan.py
@@ -41,6 +41,13 @@
     log.error("socket.CMSG_SPACE not available on this platform")
 
 
+# Constants needed for precise handling of timestamps
+RECEIVED_TIMESTAMP_STRUCT = struct.Struct("@ll")
+RECEIVED_ANCILLARY_BUFFER_SIZE = (
+    CMSG_SPACE(RECEIVED_TIMESTAMP_STRUCT.size) if CMSG_SPACE_available else 0
+)
+
+
 # Setup BCM struct
 def bcm_header_factory(
     fields: List[Tuple[str, Union[Type[ctypes.c_uint32], Type[ctypes.c_long]]]],
@@ -597,12 +604,6 @@ def capture_message(
     return msg
 
 
-# Constants needed for precise handling of timestamps
-if CMSG_SPACE_available:
-    RECEIVED_TIMESTAMP_STRUCT = struct.Struct("@ll")
-    RECEIVED_ANCILLARY_BUFFER_SIZE = CMSG_SPACE(RECEIVED_TIMESTAMP_STRUCT.size)
-
-
 class SocketcanBus(BusABC):  # pylint: disable=abstract-method
     """A SocketCAN interface to CAN.
 
diff --git a/can/interfaces/socketcand/socketcand.py b/can/interfaces/socketcand/socketcand.py
@@ -7,6 +7,7 @@
 Copyright (C) 2021  DOMOLOGIC GmbH
 http://www.domologic.de
 """
+
 import logging
 import os
 import select
diff --git a/can/interfaces/systec/exceptions.py b/can/interfaces/systec/exceptions.py
@@ -22,8 +22,7 @@ def __init__(self, result, func, arguments):
 
     @property
     @abstractmethod
-    def _error_message_mapping(self) -> Dict[ReturnCode, str]:
-        ...
+    def _error_message_mapping(self) -> Dict[ReturnCode, str]: ...
 
 
 class UcanError(UcanException):
diff --git a/can/interfaces/systec/ucanbus.py b/can/interfaces/systec/ucanbus.py
@@ -143,11 +143,11 @@ def __init__(self, channel, can_filters=None, **kwargs):
             self._ucan.init_hardware(device_number=device_number)
             self._ucan.init_can(self.channel, **self._params)
             hw_info_ex, _, _ = self._ucan.get_hardware_info()
-            self.channel_info = "{}, S/N {}, CH {}, BTR {}".format(
-                self._ucan.get_product_code_message(hw_info_ex.product_code),
-                hw_info_ex.serial,
-                self.channel,
-                self._ucan.get_baudrate_message(self.BITRATES[bitrate]),
+            self.channel_info = (
+                f"{self._ucan.get_product_code_message(hw_info_ex.product_code)}, "
+                f"S/N {hw_info_ex.serial}, "
+                f"CH {self.channel}, "
+                f"BTR {self._ucan.get_baudrate_message(self.BITRATES[bitrate])}"
             )
         except UcanException as exception:
             raise CanInitializationError() from exception
diff --git a/can/io/asc.py b/can/io/asc.py
@@ -5,6 +5,7 @@
     - https://bitbucket.org/tobylorenz/vector_asc/src/master/src/Vector/ASC/tests/unittests/data/
     - under `test/data/logfile.asc`
 """
+
 import logging
 import re
 from datetime import datetime
diff --git a/can/io/generic.py b/can/io/generic.py
@@ -1,4 +1,5 @@
 """Contains generic base classes for file IO."""
+
 import gzip
 import locale
 from abc import ABCMeta
diff --git a/can/io/mf4.py b/can/io/mf4.py
@@ -4,6 +4,7 @@
 MF4 files represent Measurement Data Format (MDF) version 4 as specified by
 the ASAM MDF standard (see https://www.asam.net/standards/detail/mdf/)
 """
+
 import logging
 from datetime import datetime
 from hashlib import md5
diff --git a/can/io/player.py b/can/io/player.py
@@ -3,6 +3,7 @@
 well as :class:`MessageSync` which plays back messages
 in the recorded order and time intervals.
 """
+
 import gzip
 import pathlib
 import time
diff --git a/can/listener.py b/can/listener.py
@@ -136,7 +136,7 @@ class AsyncBufferedReader(
     """
 
     def __init__(self, **kwargs: Any) -> None:
-        self.buffer: "asyncio.Queue[Message]"
+        self.buffer: asyncio.Queue[Message]
 
         if "loop" in kwargs:
             warnings.warn(
diff --git a/can/notifier.py b/can/notifier.py
@@ -112,10 +112,12 @@ def _rx_thread(self, bus: BusABC) -> None:
         # determine message handling callable early, not inside while loop
         handle_message = cast(
             Callable[[Message], None],
-            self._on_message_received
-            if self._loop is None
-            else functools.partial(
-                self._loop.call_soon_threadsafe, self._on_message_received
+            (
+                self._on_message_received
+                if self._loop is None
+                else functools.partial(
+                    self._loop.call_soon_threadsafe, self._on_message_received
+                )
             ),
         )
 
diff --git a/can/typechecking.py b/can/typechecking.py
@@ -1,5 +1,6 @@
 """Types for mypy type-checking
 """
+
 import gzip
 import typing
 
diff --git a/can/util.py b/can/util.py
@@ -1,6 +1,7 @@
 """
 Utilities and configuration file parsing.
 """
+
 import copy
 import functools
 import json
diff --git a/pyproject.toml b/pyproject.toml
@@ -60,10 +60,10 @@ changelog = "https://github.com/hardbyte/python-can/blob/develop/CHANGELOG.md"
 
 [project.optional-dependencies]
 lint = [
-    "pylint==3.0.*",
-    "ruff==0.1.13",
-    "black==23.12.*",
-    "mypy==1.8.*",
+    "pylint==3.2.*",
+    "ruff==0.4.8",
+    "black==24.4.*",
+    "mypy==1.10.*",
 ]
 seeedstudio = ["pyserial>=3.0"]
 serial = ["pyserial~=3.0"]
@@ -128,6 +128,9 @@ exclude = [
 ]
 
 [tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
 select = [
     "A",  # flake8-builtins
     "B",  # flake8-bugbear
@@ -149,9 +152,8 @@ ignore = [
     "B026",  # star-arg-unpacking-after-keyword-arg
     "PLR",  # pylint refactor
 ]
-line-length = 100
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "can/interfaces/*" = [
     "E501",  # Line too long
     "F403",  # undefined-local-with-import-star
@@ -163,7 +165,7 @@ line-length = 100
 "can/logger.py" = ["T20"]  # flake8-print
 "can/player.py" = ["T20"]  # flake8-print
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 known-first-party = ["can"]
 
 [tool.pylint]
diff --git a/test/test_rotating_loggers.py b/test/test_rotating_loggers.py
@@ -38,8 +38,7 @@ def writer(self) -> FileIOMessageWriter:
             def should_rollover(self, msg: can.Message) -> bool:
                 return False
 
-            def do_rollover(self):
-                ...
+            def do_rollover(self): ...
 
         return SubClass(file=file)
 
