Mark private members and methods. Use camelCase for private methods.

Author: Peter N. Steinmetz

neo/rawio/neuralynxrawio/nlxheader.py

@@ -85,12 +85,12 @@ def _to_bool(txt):
     #
     # There are now separate patterns for the in header line and in properties cases which cover
     # the known variations in each case. They are compiled here once for efficiency.
-    openDatetime1_pat = re.compile(r"## (Time|Date) Opened:* \((m/d/y|mm/dd/yyy)\): (?P<date>\S+)"\
+    _openDatetime1_pat = re.compile(r"## (Time|Date) Opened:* \((m/d/y|mm/dd/yyy)\): (?P<date>\S+)"\
                                       r"\s+(\(h:m:s\.ms\)|At Time:) (?P<time>\S+)")
-    openDatetime2_pat = re.compile(r"-TimeCreated (?P<date>\S+) (?P<time>\S+)")
-    closeDatetime1_pat = re.compile(r"## (Time|Date) Closed:* \((m/d/y|mm/dd/yyy)\): " \
+    _openDatetime2_pat = re.compile(r"-TimeCreated (?P<date>\S+) (?P<time>\S+)")
+    _closeDatetime1_pat = re.compile(r"## (Time|Date) Closed:* \((m/d/y|mm/dd/yyy)\): " \
                                         r"(?P<date>\S+)\s+(\(h:m:s\.ms\)|At Time:) (?P<time>\S+)")
-    closeDatetime2_pat = re.compile(r"-TimeClosed (?P<date>\S+) (?P<time>\S+)")
+    _closeDatetime2_pat = re.compile(r"-TimeClosed (?P<date>\S+) (?P<time>\S+)")
 
     # Precompiled filename pattern
     _filename_pat = re.compile(r"## File Name:* (?P<filename>.*)")
@@ -182,15 +182,15 @@ def __init__(self, filename, props_only=False):
         if not props_only and not txt_header.startswith("########"):
             ValueError("Neuralynx files must start with 8 # characters.")
 
-        self.read_properties(filename, txt_header)
-        self.setApplicationAndVersion()
-        numChidEntries = self.convert_channel_ids_names(filename)
-        self.setBitToMicroVolt()
-        self.setInputRanges(numChidEntries)
+        self._readProperties(filename, txt_header)
+        self._setApplicationAndVersion()
+        numChidEntries = self._convertChannelIdsNames(filename)
+        self._setBitToMicroVolt()
+        self._setInputRanges(numChidEntries)
         self._setFilenameProp(txt_header)
 
         if not props_only:
-            self.readTimeDate(txt_header)
+            self._setTimeDate(txt_header)
 
     @staticmethod
     def get_text_header(filename):
@@ -202,7 +202,7 @@ def get_text_header(filename):
             txt_header = f.read(NlxHeader.HEADER_SIZE)
         return txt_header.strip(b"\x00").decode("latin-1")
 
-    def read_properties(self, filename, txt_header):
+    def _readProperties(self, filename, txt_header):
         """
         Read properties from header and place in OrderedDictionary which this object is.
         :param filename: name of ncs file, used for extracting channel number
@@ -222,7 +222,7 @@ def read_properties(self, filename, txt_header):
                     value = type_(value)
                 self[name] = value
 
-    def setApplicationAndVersion(self):
+    def _setApplicationAndVersion(self):
         """
         Set "ApplicationName" property and app_version attribute based on existing properties
         """
@@ -251,7 +251,7 @@ def setApplicationAndVersion(self):
 
         self["ApplicationVersion"] = Version(app_version)
 
-    def convert_channel_ids_names(self, filename):
+    def _convertChannelIdsNames(self, filename):
         """
         Convert channel ids and channel name properties, if present.
 
@@ -281,7 +281,7 @@ def convert_channel_ids_names(self, filename):
 
         return len(chid_entries)
 
-    def setBitToMicroVolt(self):
+    def _setBitToMicroVolt(self):
         # convert bit_to_microvolt
         if "bit_to_microVolt" in self:
             btm_entries = re.findall(r"\S+", self["bit_to_microVolt"])
@@ -291,7 +291,7 @@ def setBitToMicroVolt(self):
             assert len(self["bit_to_microVolt"]) == len( self["channel_ids"]), \
                 "Number of channel ids does not match bit_to_microVolt conversion factors."
 
-    def setInputRanges(self, numChidEntries):
+    def _setInputRanges(self, numChidEntries):
         if "InputRange" in self:
             ir_entries = re.findall(r"\w+", self["InputRange"])
             if len(ir_entries) == 1:
@@ -313,14 +313,14 @@ def _setFilenameProp(self, txt_header):
             # some file types quote the property so strip that also
             self['OriginalFileName'] = self['OriginalFileName'].strip(' "\t\r\n')
 
-    def readTimeDate(self, txt_header):
+    def _setTimeDate(self, txt_header):
         """
         Read time and date from text of header
         """
 
         # opening time
-        sr = NlxHeader.openDatetime1_pat.search(txt_header)
-        if not sr: sr=NlxHeader.openDatetime2_pat.search(txt_header)
+        sr = NlxHeader._openDatetime1_pat.search(txt_header)
+        if not sr: sr=NlxHeader._openDatetime2_pat.search(txt_header)
         if not sr:
             raise IOError(
                 f"No matching header open date/time for application {self['ApplicationName']} " +
@@ -331,8 +331,8 @@ def readTimeDate(self, txt_header):
             self['recording_opened'] = dateutil.parser.parse(f"{dt1['date']} {dt1['time']}")
 
         # close time, if available
-        sr = NlxHeader.closeDatetime1_pat.search(txt_header)
-        if not sr: sr=NlxHeader.closeDatetime2_pat.search(txt_header)
+        sr = NlxHeader._closeDatetime1_pat.search(txt_header)
+        if not sr: sr=NlxHeader._closeDatetime2_pat.search(txt_header)
         if sr:
             dt2 = sr.groupdict()
             self['recording_closed'] = dateutil.parser.parse(f"{dt2['date']} {dt2['time']}")

neo/test/rawiotest/test_neuralynxrawio.py

@@ -405,7 +405,7 @@ def test_datetime_parsing(self):
         # neuraview2
         filename = self.get_local_path("neuralynx/Neuraview_v2/original_data/NeuraviewEventMarkers-sample.nev")
         txt_header = NlxHeader.get_text_header(filename)
-        self.check_dateutil_parse(txt_header, NlxHeader.openDatetime1_pat, NlxHeader.closeDatetime1_pat,
+        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))
         hdr = NlxHeader(filename)
@@ -417,7 +417,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 = NlxHeader.get_text_header(filename)
-        self.check_dateutil_parse(txt_header, NlxHeader.openDatetime2_pat, NlxHeader.closeDatetime2_pat,
+        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))
         hdr = NlxHeader(filename)
@@ -429,7 +429,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 = NlxHeader.get_text_header(filename)
-        self.check_dateutil_parse(txt_header, NlxHeader.openDatetime1_pat, None,
+        self.check_dateutil_parse(txt_header, NlxHeader._openDatetime1_pat, None,
                                   datetime.datetime(2003,10,4, 10,3,0, 578000),
                                   None)
         hdr = NlxHeader(filename)
@@ -440,7 +440,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 = NlxHeader.get_text_header(filename)
-        self.check_dateutil_parse(txt_header, NlxHeader.openDatetime1_pat, NlxHeader.closeDatetime1_pat,
+        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))
         hdr = NlxHeader(filename)