Merge pull request #1223 from zariiii9003/fix_ascii

Improve ASCReader robustness

Author: zariiii9003

can/io/asc.py

@@ -6,7 +6,8 @@
     - under `test/data/logfile.asc`
 """
 import gzip
-from typing import cast, Any, Generator, IO, List, Optional, Dict, Union, TextIO
+import re
+from typing import Any, Generator, List, Optional, Dict, Union, TextIO
 
 from datetime import datetime
 import time
@@ -85,8 +86,8 @@ def _extract_header(self):
                 self.timestamps_format = timestamp_format
             elif lower_case.endswith("internal events logged"):
                 self.internal_events_logged = not lower_case.startswith("no")
-            elif lower_case.startswith("// version"):
-                # the test files include `// version 9.0.0` - not sure what this is
+            elif lower_case.startswith("//"):
+                # ignore comments
                 continue
             # grab absolute timestamp
             elif lower_case.startswith("begin triggerblock"):
@@ -210,14 +211,20 @@ def __iter__(self) -> Generator[Message, None, None]:
         self._extract_header()
 
         for line in self.file:
-            temp = line.strip()
-            if not temp or not temp[0].isdigit():
-                # Could be a comment
+            line = line.strip()
+
+            if not re.match(
+                r"\d+\.\d+\s+(\d+\s+(\w+\s+(Tx|Rx)|ErrorFrame)|CANFD)",
+                line,
+                re.ASCII | re.IGNORECASE,
+            ):
+                # line might be a comment, chip status,
+                # J1939 message or some other unsupported event
                 continue
 
             msg_kwargs: Dict[str, Union[float, bool, int]] = {}
             try:
-                _timestamp, channel, rest_of_message = temp.split(None, 2)
+                _timestamp, channel, rest_of_message = line.split(None, 2)
                 timestamp = float(_timestamp) + self.start_time
                 msg_kwargs["timestamp"] = timestamp
                 if channel == "CANFD":

test/data/logfile.asc

@@ -2,6 +2,7 @@ date Sam Sep 30 15:06:13.191 2017
 base hex  timestamps absolute
 internal events logged
 // version 9.0.0
+//0.000000 previous log file: logfile_errorframes.asc
 Begin Triggerblock Sam Sep 30 15:06:13.191 2017
    0.000000 Start of measurement
    0.015991 CAN 1 Status:chip status error passive - TxErr: 132 RxErr: 0

test/logformats_test.py

@@ -554,6 +554,9 @@ def test_can_and_canfd_error_frames(self):
         actual = self._read_log_file("test_CanErrorFrames.asc")
         self.assertMessagesEqual(actual, expected_messages)
 
+    def test_ignore_comments(self):
+        _msg_list = self._read_log_file("logfile.asc")
+
 
 class TestGzipASCFileFormat(ReaderWriterTest):
     """Tests can.GzipASCWriter and can.GzipASCReader"""