Add logconvert script (#1072)

Co-authored-by: Felix Divo <[email protected]>

Author: simontegelid

can/logconvert.py

@@ -0,0 +1,66 @@
+"""
+Convert a log file from one format to another.
+"""
+
+import sys
+import argparse
+import errno
+
+from can import LogReader, Logger, SizedRotatingLogger
+
+
+class ArgumentParser(argparse.ArgumentParser):
+    def error(self, message):
+        self.print_help(sys.stderr)
+        self.exit(errno.EINVAL, "%s: error: %s\n" % (self.prog, message))
+
+
+def main():
+    parser = ArgumentParser(
+        description="Convert a log file from one format to another.",
+    )
+
+    parser.add_argument(
+        "-s",
+        "--file_size",
+        dest="file_size",
+        type=int,
+        help="Maximum file size in bytes. Rotate log file when size threshold is reached.",
+        default=None,
+    )
+
+    parser.add_argument(
+        "input",
+        metavar="INFILE",
+        type=str,
+        help="Input filename. The type is dependent on the suffix, see can.LogReader.",
+    )
+
+    parser.add_argument(
+        "output",
+        metavar="OUTFILE",
+        type=str,
+        help="Output filename. The type is dependent on the suffix, see can.Logger.",
+    )
+
+    args = parser.parse_args()
+
+    with LogReader(args.input) as reader:
+
+        if args.file_size:
+            logger = SizedRotatingLogger(
+                base_filename=args.output, max_bytes=args.file_size
+            )
+        else:
+            logger = Logger(filename=args.output)
+
+        with logger:
+            try:
+                for m in reader:  # pylint: disable=not-an-iterable
+                    logger(m)
+            except KeyboardInterrupt:
+                sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

scripts/can_logconvert.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+
+"""
+See :mod:`can.logconvert`.
+"""
+
+from can.logconvert import main
+
+
+if __name__ == "__main__":
+    main()

test/test_scripts.py

@@ -103,6 +103,22 @@ def _import(self):
         return module
 
 
+class TestLogconvertScript(CanScriptTest):
+    def _commands(self):
+        commands = [
+            "python -m can.logconvert --help",
+            "python scripts/can_logconvert.py --help",
+        ]
+        if IS_UNIX:
+            commands += ["can_logconvert.py --help"]
+        return commands
+
+    def _import(self):
+        import can.logconvert as module
+
+        return module
+
+
 # TODO add #390