code refactor

related to #8 (closed):

• I kept changes per commit small, so the number of commits got kind of numerous...

src/icartt/dataset.py

@@ -125,7 +125,7 @@ class DataStore2110(collections.UserDict):
         self.add(**newdata)
 
     def addBulkDep(self, ivar, raw):
-        nlines, nvars = raw.shape
+        nlines, nvars = raw.shape # nvars not used
         self._addDeplines(ivar, raw, nlines)
 
     def _addDeplines(self, ivar, raw, n):
@@ -422,6 +422,8 @@ class Dataset:
         :rtype: list
         """
         return [
+            # TODO see commit f5208db0 - this will do unexpected things if
+            #      self.dateOfCollection is a naive datetime object (think DST transitions...)
             self.dateOfCollection + datetime.timedelta(seconds=x)
             for x in self.independentVariable
         ]
@@ -489,6 +491,10 @@ class Dataset:
             self.format = Formats(int(dmp[1]))
         except:
             raise ValueError("ICARTT format {:d} not implemented".format(dmp[1]))
+            # TODO except clause could be re-written like
+            # except ValueError as ve:
+            #     raise ValueError(f"ICARTT format {dmp[1]:d} not implemented") from ve
+            # to show the error trace
 
         if len(dmp) > 2:
             self.version = dmp[2]
@@ -689,7 +695,7 @@ class Dataset:
     def read(self, splitChar=","):
         """Read ICARTT data and header"""
         self.readHeader(splitChar)
-        self.endDefineMode(splitChar)
+        self.endDefineMode(splitChar) # TODO: endDefineMode does not take arg splitChar
         self.readData(splitChar)
 
     def makeFileName(self, dateFormat="%Y%m%d"):
@@ -894,6 +900,9 @@ class Dataset:
         self.PIAffiliation = "Musterinstitut"
         self.dataSourceDescription = "Musterdatenprodukt"
         self.missionName = "MUSTEREX"
+
+        # TODO: not 100%  sure if this is relevant here, but those dates should refer to UTC
+        # - if you leave the datetime objects naive (no tzinfo set), they represent local time.
         self.dateOfCollection = datetime.datetime.today()
         self.dateOfRevision = datetime.datetime.today()
         self.dataIntervalCode = [0.0]
@@ -921,6 +930,8 @@ class Dataset:
             else:
                 self.inputFhandle = f
 
+        # TODO should we add a filename characters check, as we have it for the variable names?
+
             self.readHeader(splitChar)
             if loadData:
                 self.endDefineMode()