Eliminating datetimeformats and tests of header processing.

Author: Peter N. Steinmetz

neo/rawio/neuralynxrawio/nlxheader.py

@@ -1,4 +1,5 @@
 import datetime
+import dateutil
 from packaging.version import Version
 import os
 import re
@@ -281,7 +282,6 @@ def convert_channel_ids_names(self, filename):
                              r" At Time: (?P<time>\S+)",
             datetime2_regex=r"## (Time|Date) Closed:* \((m/d/y|mm/dd/yyy)\): (?P<date>\S+)" \
                              r" At Time: (?P<time>\S+)",
-            datetimeformat="%m/%d/%Y %H:%M:%S",
         ),
         # pegasus version 2.1.1 and Cheetah beyond version 5.6.4 - example
         # ######## Neuralynx Data File Header
@@ -292,21 +292,17 @@ def convert_channel_ids_names(self, filename):
         "inProps": dict(
             datetime1_regex=r"-TimeCreated (?P<date>\S+) (?P<time>\S+)",
             datetime2_regex=r"-TimeClosed (?P<date>\S+) (?P<time>\S+)",
-            datetimeformat=r"%Y/%m/%d %H:%M:%S",
-            datetime2format=r"%Y/%m/%d %H:%M:%S.%f",
         ),
         # general version for date and time in ## header lines
         "inHeader": dict(
             datetime1_regex=r"## Time Opened: \(m/d/y\): (?P<date>\S+)" r"  At Time: (?P<time>\S+)",
-            datetimeformat="%m/%d/%y %H:%M:%S.%f",
         ),
         # version with time open and closed in ## header lines
         "openClosedInHeader": dict(
            datetime1_regex=r"## (Time|Date) Opened:* \(m/d/y\): (?P<date>\S+)" \
                             r"  (\(h:m:s\.ms\)|At Time:) (?P<time>\S+)",
            datetime2_regex=r"## (Time|Date) Closed:* \(m/d/y\): (?P<date>\S+)" \
                             r"  (\(h:m:s\.ms\)|At Time:) (?P<time>\S+)",
-           datetimeformat="%m/%d/%Y %H:%M:%S.%f",
         )
     }
 
@@ -351,27 +347,14 @@ def readTimeDate(self, txt_header):
             hpd = NlxHeader.header_pattern_dicts["inProps"]
 
         # opening time
-        # :TODO: Processing for this and close time should be changed to not depend on storing
-        # in a particular formatted string by header type, but rather always should be
-        # formatted in one standard way. 
         sr = re.search(hpd["datetime1_regex"], txt_header)
         if not sr:
             raise IOError(
                 f"No matching header open date/time for application {an} " + f"version {av}. Please contact developers."
             )
         else:
             dt1 = sr.groupdict()
-            try:  # allow two possible formats for date and time
-                self["recording_opened"] = datetime.datetime.strptime(
-                    dt1["date"] + " " + dt1["time"], hpd["datetimeformat"]
-                )
-            except:
-                try:
-                    self["recording_opened"] = datetime.datetime.strptime(
-                        dt1["date"] + " " + dt1["time"], hpd["datetime2format"]
-                    )
-                except:
-                    self["recording_opened"] = None
+            self['recording_opened'] = dateutil.parser.parse(f"{dt1['date']} {dt1['time']}")
 
         # close time, if available
         if "datetime2_regex" in hpd:
@@ -382,13 +365,8 @@ def readTimeDate(self, txt_header):
                     + f"version {av}. Please contact developers."
                 )
             else:
-                try:
-                    dt2 = sr.groupdict()
-                    self["recording_closed"] = datetime.datetime.strptime(
-                        dt2["date"] + " " + dt2["time"], hpd["datetimeformat"]
-                    )
-                except:
-                    self["recording_closed"] = None
+                dt2 = sr.groupdict()
+                self['recording_closed'] = dateutil.parser.parse(f"{dt2['date']} {dt2['time']}")
 
     def type_of_recording(self):
         """

neo/test/rawiotest/test_neuralynxrawio.py

@@ -1,8 +1,10 @@
 import datetime
+import dateutil
 import unittest
 
 import os
 import numpy as np
+import re
 
 from neo.rawio.neuralynxrawio.neuralynxrawio import NeuralynxRawIO
 from neo.rawio.neuralynxrawio.nlxheader import NlxHeader
@@ -383,5 +385,75 @@ def test_neuraview2(self):
         self.assertEqual(datetime.datetime(2015,12,14, 15,58,32), hdr['recording_opened'])
         self.assertEqual(datetime.datetime(2015,12,14, 15,58,32), hdr['recording_closed'])
 
+    def get_text_header(self, filename):
+        with open(filename, "rb") as f:
+            txt_header = f.read(NlxHeader.HEADER_SIZE)
+        return txt_header.strip(b"\x00").decode("latin-1")
+
+    def check_dateutil_parse(self, hdrTxt, hdrPatternName, openDate, closeDate):
+        hpd = NlxHeader.header_pattern_dicts[hdrPatternName]
+        mtch = re.search(hpd["datetime1_regex"], hdrTxt)
+        self.assertIsNotNone(mtch)
+        dt = mtch.groupdict()
+        date = dateutil.parser.parse(f"{dt['date']} {dt['time']}")
+        self.assertEqual(openDate, date)
+        if closeDate is not None:
+            mtch = re.search(hpd["datetime2_regex"], hdrTxt)
+            self.assertIsNotNone(mtch)
+            dt = mtch.groupdict()
+            date = dateutil.parser.parse(f"{dt['date']} {dt['time']}")
+            self.assertEqual(closeDate, date)
+
+    def test_datetime_parsing(self):
+
+        # neuraview2 'neuraview2'
+        filename = self.get_local_path("neuralynx/Neuraview_v2/original_data/NeuraviewEventMarkers-sample.nev")
+        txt_header = self.get_text_header(filename)
+        self.check_dateutil_parse(txt_header, 'neuraview2',
+                                  datetime.datetime(2015,12,14, 15,58,32),
+                                  datetime.datetime(2015,12,14, 15,58,32))
+        hdr = NlxHeader(filename)
+        self.assertEqual(datetime.datetime(2015,12,14, 15,58,32),
+                          hdr['recording_opened'])
+        self.assertEqual(datetime.datetime(2015,12,14, 15,58,32),
+                          hdr['recording_closed'])
+
+        # Cheetah 5.7.4 'inProps'
+        filename = self.get_local_path("neuralynx/Cheetah_v5.7.4/original_data/CSC1.ncs")
+        txt_header = self.get_text_header(filename)
+        self.check_dateutil_parse(txt_header, 'inProps',
+                                  datetime.datetime(2017,2,16, 17,56,4),
+                                  datetime.datetime(2017,2,16, 18,1,18))
+        hdr = NlxHeader(filename)
+        self.assertEqual(datetime.datetime(2017,2,16, 17,56,4),
+                          hdr['recording_opened'])
+        self.assertEqual(datetime.datetime(2017,2,16, 18,1,18),
+                         hdr['recording_closed'])
+
+        # Cheetah 4.0.2 'inHeader'
+        filename = self.get_local_path("neuralynx/Cheetah_v4.0.2/original_data/CSC14_trunc.Ncs")
+        txt_header = self.get_text_header(filename)
+        self.check_dateutil_parse(txt_header, 'inHeader',
+                                  datetime.datetime(2003,10,4, 10,3,0, 578000),
+                                  None)
+        hdr = NlxHeader(filename)
+        self.assertEqual(datetime.datetime(2003,10,4, 10,3,0, 578000),
+                         hdr['recording_opened'])
+        self.assertIsNone(hdr.get('recording_closed'))
+
+        # Cheetah 5.4.0 'openClosedInHeader'
+        filename = self.get_local_path("neuralynx/Cheetah_v5.4.0/original_data/CSC5_trunc.Ncs")
+        txt_header = self.get_text_header(filename)
+        self.check_dateutil_parse(txt_header, 'openClosedInHeader',
+                                  datetime.datetime(2001,1,1, 0,0,0, 0),
+                                  datetime.datetime(2001,1,1, 0,0,0, 0))
+        hdr = NlxHeader(filename)
+        self.assertEqual(datetime.datetime(2001,1,1, 0,0,0, 0),
+                         hdr['recording_opened'])
+        self.assertEqual(datetime.datetime(2001,1,1, 0,0,0, 0),
+                         hdr['recording_closed'])
+
+
+
 if __name__ == "__main__":
     unittest.main()