"Add support for the mf4 io format" (Adapted version of #554)

.appveyor.yml

@@ -15,7 +15,7 @@ install:
   - set PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%
 
   # We need to install the python-can library itself including the dependencies
-  - "python -m pip install .[test,neovi]"
+  - "python -m pip install .[test,neovi,mf4]"
 
 build: off
 

.travis.yml

@@ -74,6 +74,7 @@ jobs:
         #   -a Write all files
         #   -n nitpicky
         - python -m sphinx -an doc build
+
     - stage: linter
       name: "Linter Checks"
       python: "3.7"
@@ -85,6 +86,8 @@ jobs:
         # Slowly enable all pylint warnings by adding addressed classes of
         # warnings to the .pylintrc-wip file to prevent them from being
         # re-introduced
+
+
         # check the entire main codebase
         - pylint --rcfile=.pylintrc-wip can/**.py
         # check setup.py
@@ -116,13 +119,15 @@ jobs:
           can/io/**.py
           scripts/**.py
           examples/**.py
+
     - stage: linter
       name: "Formatting Checks"
       python: "3.7"
       before_install:
         - travis_retry pip install -r requirements-lint.txt
       script:
         - black --check --verbose .
+
     - stage: deploy
       name: "PyPi Deployment"
       python: "3.7"

README.rst

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

can/__init__.py

@@ -28,6 +28,11 @@ class CanError(IOError):
 from .io import CSVWriter, CSVReader
 from .io import SqliteWriter, SqliteReader
 
+try:
+    from .io import MF4Writer, MF4Reader
+except ImportError:
+    pass
+
 from .util import set_logging_level
 
 from .message import Message

can/io/__init__.py

@@ -14,3 +14,8 @@
 from .csv import CSVWriter, CSVReader
 from .sqlite import SqliteReader, SqliteWriter
 from .printer import Printer
+
+try:
+    from .mf4 import MF4Writer, MF4Reader
+except ImportError:
+    pass

can/io/logger.py

@@ -1,7 +1,10 @@
+# coding: utf-8
+
 """
 See the :class:`Logger` class.
 """
 
+import logging
 import pathlib
 import typing
 
@@ -16,6 +19,12 @@
 from .sqlite import SqliteWriter
 from .printer import Printer
 
+try:
+    from .mf4 import MF4Writer
+except ImportError:
+    # be careful when using MF4Writer, it might NameError
+    pass
+
 
 class Logger(BaseIOHandler, Listener):  # pylint: disable=abstract-method
     """
@@ -27,6 +36,7 @@ class Logger(BaseIOHandler, Listener):  # pylint: disable=abstract-method
       * .csv: :class:`can.CSVWriter`
       * .db: :class:`can.SqliteWriter`
       * .log :class:`can.CanutilsLogWriter`
+      * .mf4 :class:`can.MF4Writer`
       * .txt :class:`can.Printer`
 
     The **filename** may also be *None*, to fall back to :class:`can.Printer`.
@@ -59,6 +69,11 @@ def __new__(
             ".log": CanutilsLogWriter,
             ".txt": Printer,
         }
+        try:
+            lookup[".mf4"] = MF4Writer
+        except NameError:
+            pass
+
         suffix = pathlib.PurePath(filename).suffix
         try:
             return lookup[suffix](filename, *args, **kwargs)