Move extract header text method to NlxHeader static.

Author: Peter N. Steinmetz

neo/rawio/neuralynxrawio/nlxheader.py

@@ -1,4 +1,3 @@
-import datetime
 import dateutil
 from packaging.version import Version
 import os
@@ -176,9 +175,8 @@ def __init__(self, filename, props_only=False):
         :param props_only: if true, will not try and read time and date or check start
         """
         super(OrderedDict, self).__init__()
-        with open(filename, "rb") as f:
-            txt_header = f.read(NlxHeader.HEADER_SIZE)
-        txt_header = txt_header.strip(b"\x00").decode("latin-1")
+
+        txt_header = NlxHeader.get_text_header(filename)
 
         # must start with 8 # characters
         if not props_only and not txt_header.startswith("########"):
@@ -194,6 +192,16 @@ def __init__(self, filename, props_only=False):
         if not props_only:
             self.readTimeDate(txt_header)
 
+    @staticmethod
+    def get_text_header(filename):
+        """
+        Accessory method to extract text in header. Useful for subclasses.
+        :param filename: name of Neuralynx file
+        """
+        with open(filename, "rb") as f:
+            txt_header = f.read(NlxHeader.HEADER_SIZE)
+        return txt_header.strip(b"\x00").decode("latin-1")
+
     def read_properties(self, filename, txt_header):
         """
         Read properties from header and place in OrderedDictionary which this object is.

neo/test/rawiotest/test_neuralynxrawio.py

@@ -386,10 +386,6 @@ def test_neuraview2(self):
         self.assertEqual(datetime.datetime(2015,12,14, 15,58,32), hdr['recording_closed'])
 
     # left in for possible future header tests
-    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")
 
     # left in for possible future header tests
     def check_dateutil_parse(self, hdrTxt, openPat, closePat, openDate, closeDate):
@@ -408,7 +404,7 @@ def check_dateutil_parse(self, hdrTxt, openPat, closePat, openDate, closeDate):
     def test_datetime_parsing(self):
         # neuraview2
         filename = self.get_local_path("neuralynx/Neuraview_v2/original_data/NeuraviewEventMarkers-sample.nev")
-        txt_header = self.get_text_header(filename)
+        txt_header = NlxHeader.get_text_header(filename)
         self.check_dateutil_parse(txt_header, NlxHeader.openDatetime1_pat, NlxHeader.closeDatetime1_pat,
                                   datetime.datetime(2015,12,14, 15,58,32),
                                   datetime.datetime(2015,12,14, 15,58,32))
@@ -420,7 +416,7 @@ def test_datetime_parsing(self):
 
         # 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)
+        txt_header = NlxHeader.get_text_header(filename)
         self.check_dateutil_parse(txt_header, NlxHeader.openDatetime2_pat, NlxHeader.closeDatetime2_pat,
                                   datetime.datetime(2017,2,16, 17,56,4),
                                   datetime.datetime(2017,2,16, 18,1,18))
@@ -432,7 +428,7 @@ def test_datetime_parsing(self):
 
         # Cheetah 4.0.2
         filename = self.get_local_path("neuralynx/Cheetah_v4.0.2/original_data/CSC14_trunc.Ncs")
-        txt_header = self.get_text_header(filename)
+        txt_header = NlxHeader.get_text_header(filename)
         self.check_dateutil_parse(txt_header, NlxHeader.openDatetime1_pat, None,
                                   datetime.datetime(2003,10,4, 10,3,0, 578000),
                                   None)
@@ -443,7 +439,7 @@ def test_datetime_parsing(self):
 
         # 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)
+        txt_header = NlxHeader.get_text_header(filename)
         self.check_dateutil_parse(txt_header, NlxHeader.openDatetime1_pat, NlxHeader.closeDatetime1_pat,
                                   datetime.datetime(2001,1,1, 0,0,0, 0),
                                   datetime.datetime(2001,1,1, 0,0,0, 0))