4.1.0

[hardbyte]

I'm happy to announce version 4.1.0 of python-can has been released to PyPi.

Installation

pip install python-can==4.1.0

Changelog

Breaking Changes

• windows-curses was moved to optional dependencies (Move windows-curses dependency to an optional extra #1395).
  Use pip install python-can[viewer] if you are using the can.viewer
  script on Windows.
• The attributes of can.interfaces.vector.VectorChannelConfig were renamed
  from camelCase to snake_case (Add bus_params and use snake case for VectorChannelConfig #1422).

Features

IO

• The canutils logger preserves message direction ([IO][canutils]: add direction support #1244)
  and uses common interface names (e.g. can0) instead of just
  channel numbers ([IO][canutils]: use common CAN interface names in generated logfile #1271).
• The can.logger script accepts the -a, --append option
  to add new data to an existing log file (Enhance the can.logger to check to see if the log file exists and append if there rather than overwrite #1326, Enhance can.logger to consider the append option #1327, Raise appropriate error message when append is not possible #1361).
  Currently only the blf-, canutils- and csv-formats are supported.
• All CLI extra_args are passed to the bus, logger
  and player initialisation (Pass CLI extra_args to Logger initialisation #1366).
• Initial support for TRC files (Trc file support #1217)

Type Annotations

• python-can now includes the py.typed marker to support type checking
  according to PEP 561 (Add py.typed file and distribute it upon installation #1344).

Interface Improvements

• The gs_usb interface can be selected by device index instead
  of USB bus/address. Loopback frames are now correctly marked
  with the is_rx flag (Improve gs_usb usability and fix loopback frames #1270).
• The PCAN interface can be selected by its device ID instead
  of just the channel name (Add device_id parameter to PcanBus constructor #1346).
• The PCAN Bus implementation supports auto bus-off reset (Add Parameter for Enabling PCAN Auto Bus-Off Reset #1345).
• SocketCAN: Make find_available_interfaces() find slcanX interfaces (socketcan: Make find_available_interfaces() find slcanX interfaces #1369).
• Vector: Add xlGetReceiveQueueLevel, xlGenerateSyncPulse and
  xlFlushReceiveQueue to xldriver (Extend XL api wrapper #1387).
• Vector: Raise a CanInitializationError, if the CAN settings can not
  be applied according to the arguments of VectorBus.__init__ (VectorBus: check whether CAN settings were correctly applied #1426).
• Ixxat bus now implements BusState api and detects errors (Ixxat bus state and hardware errors detection #1141)

Bug Fixes

• Improve robustness of USB2CAN serial number detection (Finds USB2CAN Serial Number by USB Name #1129).
• Fix channel2int conversion (channel2int() defect in Vector ASC conversion (from SocketCAN log format) ?? #1268, Fix channel2int conversion #1269).
• Fix BLF timestamp conversion (Error with timestamp when write a blf file with BLFWriter and read with BLFReader #1266, Fix BLF timestamp conversion #1273).
• Fix timestamp handling in udp_multicast on macOS (Error with Multicast IP Interface #1275, Fix timestamp handling in udp_multicast on macOS #1278).
• Fix failure to initiate the Neousys DLL (%d format is for a number, not str #1281).
• Fix AttributeError in IscanError (Error when trying to initialize isCAN dongle #1292, Fix AttributeError in IscanError #1293).
• Add missing vector devices (add missing vector devices #1296).
• Fix error for DLC > 8 in ASCReader (asc file parse failed #1299, ASCReader: Fix error for DLC > 8 #1301).
• Set default mode for FileIOMessageWriter to wt instead of rt (Default mode for FileIOMessageWriter should be wt #1303).
• Fix conversion for port number from config file (fix: conversion for port number #1309).
• Fix fileno error on Windows (Notifier bug on Windows #1312, Fix fileno error on Windows (robotell bus) #1313, Fix fileno error on Windows (Serial bus) #1333).
• Remove redundant writer.stop() call that throws error (Bug in can.logger during rollover when file format .blf is defined #1316, Remove redundant writer.stop call that throws error #1317).
• Detect and cast types of CLI extra_args (CAN player script fails when using extra_args #1280, Detect types in _parse_additonal_config #1328).
• Fix ASC/CANoe incompatibility due to timestamp format (Logged .asc file can't open in CANoe 14 #1315, Write 3 ms digits to ascii to resolve CANoe bug #1362).
• Fix MessageSync timings (The actual playback time is much larger than the timestamp #1372, Improve MessageSync timings #1374).
• Fix file name for compressed files in SizedRotatingLogger (Compressed SizedRotatingLogger creates files LogReader deems an unknown format #1382, Configure TCP socket to reduce latency #1683).
• Fix memory leak in neoVI bus where message_receipts grows with no limit (Fixing memory leak in neoVI bus where message_receipts grows with no limit #1427).
• Raise ValueError if gzip is used with incompatible log formats (Add gzip check to compress method #1429).
• Allow restarting of transmission tasks for socketcan (Allow restarting of transmission tasks for socketcan #1440)

Miscellaneous

• Allow ICSApiError to be pickled and un-pickled (Allow ICSApiError to be pickled and un-pickled #1341)
• Sort interface names in CLI API to make documentation reproducible (Sort interface names, to make documentation reproducible #1342)
• Exclude repository-configuration from git-archive (Exclude repository-configuration from git-archive #1343)
• Improve documentation (Update BufferedReader.get_message docstring #1397, Modify file_size help doc string #1401, Fix Sphinx warnings #1405, Improve vector documentation #1420, Update docs and examples #1421, Documentation update for 4.1.0 #1434)
• Officially support Python 3.11 (Add python 3.11 to supported versions #1423)
• Migrate code coverage reporting from Codecov to Coveralls (Switch from codecov to coveralls #1430)
• Migrate building docs and publishing releases to PyPi from Travis-CI to GitHub Actions (Release 4.1.0 #1433)

---

This discussion was created from the release 4.1.0.