Merge pull request #520 from JuliaSprenger/enh/set_dim

Allow for list-like labels of SetDimension

Author: jgrewe

nixio/data_array.py

@@ -82,12 +82,15 @@ def append_set_dimension(self, labels=None):
         Append a new SetDimension to the list of existing dimension
         descriptors.
 
+        :param labels: The set of sample labels
+        :type labels: list or convertible to list
+
         :returns: The newly created SetDimension.
         :rtype: nixio.SetDimension
         """
         index = len(self.dimensions) + 1
         setdim = SetDimension.create_new(self, index)
-        if labels:
+        if labels is not None:
             setdim.labels = labels
         if self.file.auto_update_timestamps:
             self.force_updated_at()
@@ -101,6 +104,12 @@ def append_sampled_dimension(self, sampling_interval, label=None,
 
         :param sampling_interval: The sampling interval of the SetDimension to create.
         :type sampling_interval: float
+        :param label: The label of the dimension
+        :type label: str
+        :param unit: The physical unit of the dimension
+        :type unit: str
+        :param offset: The offset between 0 and the first sample
+        :type offset: float
 
         :returns: The newly created SampledDimension.
         :rtype: nixio.SampledDimension
@@ -124,6 +133,10 @@ def append_range_dimension(self, ticks=None, label=None, unit=None):
 
         :param ticks: The ticks of the RangeDimension to create.
         :type ticks: list of float
+        :param label: The label of the dimension
+        :type label: str
+        :param unit: The physical unit of the dimension
+        :type unit: str
 
         :returns: The newly created RangeDimension.
         :rtype: nixio.RangeDimension

nixio/dimensions.py

@@ -684,6 +684,13 @@ def labels(self, labels):
             raise RuntimeError("The labels of a SetDimension linked to a "
                                "data object cannot be modified")
         dt = util.vlen_str_dtype
+        if not hasattr(labels, '__iter__') or isinstance(labels, str):
+            raise ValueError('`labels` has to be a list-like object.')
+        for label in labels:
+            if not isinstance(label, str):
+                raise ValueError(f'`labels` has to contain string objects, not {type(label)}')
+        if not isinstance(labels, list):
+            labels = list(labels)
         self._h5group.write_data("labels", labels, dtype=dt)
 
     def index_of(self, position, mode=IndexMode.LessOrEqual):

nixio/test/test_dimensions.py

@@ -153,6 +153,22 @@ def test_set_dim_label_resize(self):
         setdim.labels = newlabels
         assert tuple(newlabels) == setdim.labels
 
+    def test_set_dim_labels_array(self):
+        labels = np.array(["A", "B"])
+        setdim = self.array.append_set_dimension(labels)
+        assert tuple(labels) == setdim.labels
+
+    def test_set_dim_invalid_labels(self):
+        # don't accept non list-like labels
+        with self.assertRaises(ValueError):
+            self.array.append_set_dimension('Sample 1')
+        with self.assertRaises(ValueError):
+            self.array.append_set_dimension(1000)
+
+        # don't accept list of non-string objects
+        with self.assertRaises(ValueError):
+            self.array.append_set_dimension([1, 2, 3])
+
     def test_range_dim_ticks_resize(self):
         rangedim = self.array.append_range_dimension([1, 2, 100])
         ticks = [1, 1, 30]