Adding support for gzipped ASC logging file

Author: pierreluctg

can/__init__.py

@@ -25,7 +25,7 @@
 )
 
 from .io import Logger, SizedRotatingLogger, Printer, LogReader, MessageSync
-from .io import ASCWriter, ASCReader
+from .io import ASCWriter, ASCReader, CompressedASCWriter, CompressedASCReader
 from .io import BLFReader, BLFWriter
 from .io import CanutilsLogReader, CanutilsLogWriter
 from .io import CSVWriter, CSVReader

can/io/__init__.py

@@ -8,7 +8,7 @@
 from .player import LogReader, MessageSync
 
 # Format specific
-from .asc import ASCWriter, ASCReader
+from .asc import ASCWriter, ASCReader, CompressedASCWriter, CompressedASCReader
 from .blf import BLFReader, BLFWriter
 from .canutils import CanutilsLogReader, CanutilsLogWriter
 from .csv import CSVWriter, CSVReader

can/io/asc.py

@@ -5,7 +5,7 @@
     - https://bitbucket.org/tobylorenz/vector_asc/src/47556e1a6d32c859224ca62d075e1efcc67fa690/src/Vector/ASC/tests/unittests/data/CAN_Log_Trigger_3_2.asc?at=master&fileviewer=file-view-default
     - under `test/data/logfile.asc`
 """
-
+import gzip
 from typing import cast, Any, Generator, IO, List, Optional, Dict
 
 from datetime import datetime
@@ -396,3 +396,51 @@ def on_message_received(self, msg: Message) -> None:
                 data=" ".join(data),
             )
         self.log_event(serialized, msg.timestamp)
+
+
+class CompressedASCReader(ASCReader):
+    """Gzipped version of :class:`~can.ASCReader`"""
+
+    def __init__(
+        self,
+        file: Union[typechecking.FileLike, typechecking.StringPathLike],
+        base: str = "hex",
+        relative_timestamp: bool = True,
+    ):
+        """
+        :param file: a path-like object or as file-like object to read from
+                     If this is a file-like object, is has to opened in text
+                     read mode, not binary read mode.
+        :param base: Select the base(hex or dec) of id and data.
+                     If the header of the asc file contains base information,
+                     this value will be overwritten. Default "hex".
+        :param relative_timestamp: Select whether the timestamps are
+                     `relative` (starting at 0.0) or `absolute` (starting at
+                     the system time). Default `True = relative`.
+        """
+        super(CompressedASCReader, self).__init__(
+            gzip.open(file, mode="rt"), base, relative_timestamp
+        )
+
+
+class CompressedASCWriter(ASCWriter):
+    """Gzipped version of :class:`~can.ASCWriter`"""
+
+    def __init__(
+        self,
+        file: Union[typechecking.FileLike, typechecking.StringPathLike],
+        channel: int = 1,
+        compresslevel: int = 6,
+    ):
+        """
+        :param file: a path-like object or as file-like object to write to
+                     If this is a file-like object, is has to opened in text
+                     write mode, not binary write mode.
+        :param channel: a default channel to use when the message does not
+                        have a channel set
+        :param compresslevel: Gzip compresslevel, see
+                              :class:`~gzip.GzipFile` for details. The default is 6.
+        """
+        super(CompressedASCWriter, self).__init__(
+            gzip.open(file, mode="wt", compresslevel=compresslevel), channel
+        )

can/io/logger.py

@@ -21,7 +21,7 @@
 from ..message import Message
 from ..listener import Listener
 from .generic import BaseIOHandler, FileIOMessageWriter
-from .asc import ASCWriter
+from .asc import ASCWriter, CompressedASCWriter
 from .blf import BLFWriter
 from .canutils import CanutilsLogWriter
 from .csv import CSVWriter
@@ -36,6 +36,7 @@ class Logger(BaseIOHandler, Listener):  # pylint: disable=abstract-method
 
     The format is determined from the file format which can be one of:
       * .asc: :class:`can.ASCWriter`
+      * .asc.gz: :class:`can.CompressedASCWriter`
       * .blf :class:`can.BLFWriter`
       * .csv: :class:`can.CSVWriter`
       * .db: :class:`can.SqliteWriter`
@@ -54,6 +55,7 @@ class Logger(BaseIOHandler, Listener):  # pylint: disable=abstract-method
     fetched_plugins = False
     message_writers = {
         ".asc": ASCWriter,
+        ".asc,gz": CompressedASCWriter,
         ".blf": BLFWriter,
         ".csv": CSVWriter,
         ".db": SqliteWriter,

can/io/player.py

@@ -14,7 +14,7 @@
     import can
 
 from .generic import BaseIOHandler, MessageReader
-from .asc import ASCReader
+from .asc import ASCReader, CompressedASCReader
 from .blf import BLFReader
 from .canutils import CanutilsLogReader
 from .csv import CSVReader
@@ -27,6 +27,7 @@ class LogReader(BaseIOHandler):
 
     The format is determined from the file format which can be one of:
       * .asc
+      * .asc.gz
       * .blf
       * .csv
       * .db
@@ -49,6 +50,7 @@ class LogReader(BaseIOHandler):
     fetched_plugins = False
     message_readers = {
         ".asc": ASCReader,
+        ".asc.gz": CompressedASCReader,
         ".blf": BLFReader,
         ".csv": CSVReader,
         ".db": SqliteReader,