Trc file support (#1217)

* Added file for implementation of trc file read and write

* Added trc file header template

* Added link where to lookup the trc file format description

* Add trc reader and writer to backends

* Add example trace file as conversion from asc log

* Add TRCWriter and TRCReader to can package

* Basic header extraction in reader

* Implement read of file version

* Remove useless format string

* Implement basic message parsing

* Move message parsing to separate function

* Implement parse of first message

* Handle none rx messages

* Handle empty files

* Add test method for trc files

* Format code with black

* Implement stop at end of log file

* Implement basic write of header version 2.1

* Add newline after header

* Implement write of messages

* Enable test for trace file writing

* Add test files for different pcan trace file versions

* Use binary mode for write to ensure correct line ending on all platforms

* Add handler for file write

* Move some header lines to specific write function

* Move lines to function

* Move write of file header to class

* Use new function for better code readability

* Add enum for file versions

* Handle text io streams correctly

* send line ending setting to logger

* Add check for file version in writer

* Add TRCFileVersion as export

* Add test for wrong file version

* Add format and header for version 1 trace file format

* Use correct format according to selected version

* Introduce handler method _parse_line

* Skip empty lines

* Add check for type before eval message

* Print info on unsupported types

* Add test for new test data files trc format

* Implement file version reading

* More flexible implementation of line parsing for different versions

* Implement Version 1 trace file parsing

* Add test case for Version 1.0 trc file

* Implement parsing for version 1.1 trace files

* Add test for version 1.1 reading

* Add test case for version 1.0 trace files

* Avoid multi test runs with same input and output by separate generic tests from file version tests

* Correct first timestamp

* Add type information for file attribute

* Add type definitions for init function

* Add type for first_timestamp

* Add info for return types

* Drop type casting for file. Should already be done in init

* Add type info

* Always use text read write

* Update types for initialization

* Use text io mode by default

Author: pkess

can/__init__.py

@@ -41,6 +41,7 @@
 from .io import CanutilsLogReader, CanutilsLogWriter
 from .io import CSVWriter, CSVReader
 from .io import SqliteWriter, SqliteReader
+from .io import TRCReader, TRCWriter, TRCFileVersion
 
 from .broadcastmanager import (
     CyclicSendTaskABC,

can/io/__init__.py

@@ -14,3 +14,4 @@
 from .csv import CSVWriter, CSVReader
 from .sqlite import SqliteReader, SqliteWriter
 from .printer import Printer
+from .trc import TRCReader, TRCWriter, TRCFileVersion

can/io/logger.py

@@ -23,6 +23,7 @@
 from .csv import CSVWriter
 from .sqlite import SqliteWriter
 from .printer import Printer
+from .trc import TRCWriter
 from ..typechecking import StringPathLike, FileLike, AcceptedIOType
 
 
@@ -36,6 +37,7 @@ class Logger(MessageWriter):  # pylint: disable=abstract-method
       * .csv: :class:`can.CSVWriter`
       * .db: :class:`can.SqliteWriter`
       * .log :class:`can.CanutilsLogWriter`
+      * .trc :class:`can.TRCWriter`
       * .txt :class:`can.Printer`
 
     Any of these formats can be used with gzip compression by appending
@@ -58,6 +60,7 @@ class Logger(MessageWriter):  # pylint: disable=abstract-method
         ".csv": CSVWriter,
         ".db": SqliteWriter,
         ".log": CanutilsLogWriter,
+        ".trc": TRCWriter,
         ".txt": Printer,
     }
 

can/io/player.py

@@ -16,6 +16,7 @@
 from .canutils import CanutilsLogReader
 from .csv import CSVReader
 from .sqlite import SqliteReader
+from .trc import TRCReader
 from ..typechecking import StringPathLike, FileLike, AcceptedIOType
 from ..message import Message
 
@@ -30,6 +31,7 @@ class LogReader(MessageReader):
       * .csv
       * .db
       * .log
+      * .trc
 
     Gzip compressed files can be used as long as the original
     files suffix is one of the above (e.g. filename.asc.gz).
@@ -56,6 +58,7 @@ class LogReader(MessageReader):
         ".csv": CSVReader,
         ".db": SqliteReader,
         ".log": CanutilsLogReader,
+        ".trc": TRCReader,
     }
 
     @staticmethod