Add MF4 support (#1289)

* add extra dependency

* add mf4 io writer

* update asammdf requirement

* changes after initial review

* simplify append call

* add MF4Reader class

* start testing

* passes tests

* update documentation

* update docs and CI scripts

* retrigger build

* update setup.py according to review

* remove debug save file

* changes after review

* updates after review

* add cython requirement

* fixes after review:
* fix documentation
* fix item access on FD_DLC2LEN dict
* add compression argument to MF4Writer stop method

* add MF4Writer and MF4Reader to logger and player modules

* reformat and change setup.py accordingly

* cleanup test file

* cleanup docs

* cleanups and fix linter problems

* re-add change to can.io.Logger; it somehow went lost while rebasing

* remove leftover __future__ import

* fix typing error in can.io's player.py and logger.py

* remove diff noise, remove deprecated appveyor CI

* run black

* Fix import errors

* add acquisition source needed by asammdf to extract bus logging

* use correct source type, add md5 digest required by asammdf

* refactor test_extension_matching tests to use explicit extensions

* satiate mypy

* update mf4 implementation

* fix AttributeError

* format black

* refactoring

* fix bugs and add direction support

* add timestamps to avoid ambiguity

* set allowed_timestamp_delta to 1e-4

* read into BytesIO

* Add restriction to docstring

* implement file_size

* constrain mf4 dependencies to pass CI tests

* format docstring

* add mf4 extra

* Update doc/listeners.rst

* Remove platform specifiers for asammdf

* Format code with black

* remove unnecessary parenthesis

* install asammdf only for CPython <= 3.12

* fix NameError

---------

Co-authored-by: danielhrisca <[email protected]>
Co-authored-by: Felix Divo <[email protected]>
Co-authored-by: zariiii9003 <[email protected]>
Co-authored-by: Brian Thorne <[email protected]>
Co-authored-by: Brian Thorne <[email protected]>
Co-authored-by: hardbyte <[email protected]>

Author: 5 people

.github/workflows/ci.yml

@@ -141,7 +141,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .[canalystii,gs_usb]
+        pip install -e .[canalystii,gs_usb,mf4]
         pip install -r doc/doc-requirements.txt
     - name: Build documentation
       run: |

.readthedocs.yml

@@ -29,3 +29,4 @@ python:
       extra_requirements:
         - canalystii
         - gs_usb
+        - mf4

README.rst

@@ -78,7 +78,7 @@ Features
 - receiving, sending, and periodically sending messages
 - normal and extended arbitration IDs
 - `CAN FD <https://en.wikipedia.org/wiki/CAN_FD>`__ support
-- many different loggers and readers supporting playback: ASC (CANalyzer format), BLF (Binary Logging Format by Vector), TRC, CSV, SQLite, and Canutils log
+- many different loggers and readers supporting playback: ASC (CANalyzer format), BLF (Binary Logging Format by Vector), MF4 (Measurement Data Format v4 by ASAM), TRC, CSV, SQLite, and Canutils log
 - efficient in-kernel or in-hardware filtering of messages on supported interfaces
 - bus configuration reading from a file or from environment variables
 - command line tools for working with CAN buses (see the `docs <https://python-can.readthedocs.io/en/stable/scripts.html>`__)

can/__init__.py

@@ -41,6 +41,8 @@
     "ModifiableCyclicTaskABC",
     "Message",
     "MessageSync",
+    "MF4Reader",
+    "MF4Writer",
     "Notifier",
     "Printer",
     "RedirectReader",
@@ -94,6 +96,8 @@
     Logger,
     LogReader,
     MessageSync,
+    MF4Reader,
+    MF4Writer,
     Printer,
     SizedRotatingLogger,
     SqliteReader,

can/io/__init__.py

@@ -16,6 +16,8 @@
     "Logger",
     "LogReader",
     "MessageSync",
+    "MF4Reader",
+    "MF4Writer",
     "Printer",
     "SizedRotatingLogger",
     "SqliteReader",
@@ -36,6 +38,7 @@
 from .blf import BLFReader, BLFWriter
 from .canutils import CanutilsLogReader, CanutilsLogWriter
 from .csv import CSVReader, CSVWriter
+from .mf4 import MF4Reader, MF4Writer
 from .printer import Printer
 from .sqlite import SqliteReader, SqliteWriter
 from .trc import TRCFileVersion, TRCReader, TRCWriter

can/io/logger.py

@@ -21,6 +21,7 @@
 from .canutils import CanutilsLogWriter
 from .csv import CSVWriter
 from .generic import BaseIOHandler, FileIOMessageWriter, MessageWriter
+from .mf4 import MF4Writer
 from .printer import Printer
 from .sqlite import SqliteWriter
 from .trc import TRCWriter
@@ -38,6 +39,7 @@ class Logger(MessageWriter):
       * .log :class:`can.CanutilsLogWriter`
       * .trc :class:`can.TRCWriter`
       * .txt :class:`can.Printer`
+      * .mf4 :class:`can.MF4Writer` (optional, depends on asammdf)
 
     Any of these formats can be used with gzip compression by appending
     the suffix .gz (e.g. filename.asc.gz). However, third-party tools might not
@@ -59,6 +61,7 @@ class Logger(MessageWriter):
         ".csv": CSVWriter,
         ".db": SqliteWriter,
         ".log": CanutilsLogWriter,
+        ".mf4": MF4Writer,
         ".trc": TRCWriter,
         ".txt": Printer,
     }
@@ -68,10 +71,12 @@ def __new__(  # type: ignore
         cls: Any, filename: Optional[StringPathLike], **kwargs: Any
     ) -> MessageWriter:
         """
-        :param filename: the filename/path of the file to write to,
-                         may be a path-like object or None to
-                         instantiate a :class:`~can.Printer`
-        :raises ValueError: if the filename's suffix is of an unknown file type
+        :param filename:
+            the filename/path of the file to write to,
+            may be a path-like object or None to
+            instantiate a :class:`~can.Printer`
+        :raises ValueError:
+            if the filename's suffix is of an unknown file type
         """
         if filename is None:
             return Printer(**kwargs)
@@ -92,7 +97,10 @@ def __new__(  # type: ignore
             suffix, file_or_filename = Logger.compress(filename, **kwargs)
 
         try:
-            return Logger.message_writers[suffix](file=file_or_filename, **kwargs)
+            LoggerType = Logger.message_writers[suffix]
+            if LoggerType is None:
+                raise ValueError(f'failed to import logger for extension "{suffix}"')
+            return LoggerType(file=file_or_filename, **kwargs)
         except KeyError:
             raise ValueError(
                 f'No write support for this unknown log format "{suffix}"'