Exposes variable CDF type

Signed-off-by: Alexis Jeandet <[email protected]>

Author: jeandet

pyistp/_impl.py

@@ -39,11 +39,13 @@ def _get_axis(master_cdf: Driver, cdf: Driver, axis_var: str, data_var: str):
             if 'sig_digits' in master_cdf.variable_attributes(axis_var):  # cluster CSA trick :/
                 return SupportDataVariable(name=axis_var, values=np.asarray(cdf.values(axis_var), dtype=float),
                                            attributes=_get_attributes(master_cdf, cdf, axis_var),
-                                           is_nrv=cdf.is_nrv(axis_var)
+                                           is_nrv=cdf.is_nrv(axis_var),
+                                           cdf_type=cdf.cdf_type(axis_var)
                                            )
         return SupportDataVariable(name=axis_var, values=cdf.values(axis_var),
                                    attributes=_get_attributes(master_cdf, cdf, axis_var),
-                                   is_nrv=cdf.is_nrv(axis_var)
+                                   is_nrv=cdf.is_nrv(axis_var),
+                                   cdf_type=cdf.cdf_type(axis_var)
                                    )
     else:
         log.warning(
@@ -78,13 +80,14 @@ def _load_data_var(master_cdf: Driver, cdf: Driver, var: str) -> DataVariable or
     shape = cdf.shape(var)
     axes = _get_axes(master_cdf, cdf, var, shape)
     attributes = _get_attributes(master_cdf, cdf, var)
+    cdf_type = cdf.cdf_type(var)
     labels = _get_labels(attributes)
     if len(axes) == 0:
         log.warning(f"{ISTP_NOT_COMPLIANT_W}: {var} was marked as data variable but it has 0 support variable")
         return None
     if None in axes or axes[0].values.shape[0] != shape[0]:
         return None
-    return DataVariable(name=var, values=values, attributes=attributes, axes=axes, labels=labels)
+    return DataVariable(name=var, values=values, attributes=attributes, axes=axes, cdf_type=cdf_type, labels=labels)
 
 
 class ISTPLoaderImpl:

pyistp/data_variable.py

@@ -2,14 +2,15 @@
 
 
 class DataVariable:
-    __slots__ = ("name", "_values", 'attributes', 'axes', 'labels')
+    __slots__ = ("name", "_values", 'attributes', 'axes', 'labels', 'cdf_type')
 
-    def __init__(self, name: str, values: Union[Collection[Any], Callable], attributes, axes, labels=None):
+    def __init__(self, name: str, values: Union[Collection[Any], Callable], attributes, axes, cdf_type, labels=None):
         self.name = name
         self._values = values
         self.attributes = attributes
         self.axes = axes or []
         self.labels = labels
+        self.cdf_type = cdf_type
 
     @property
     def values(self):

pyistp/drivers/_driver.py

@@ -15,6 +15,9 @@ def data_variables(self) -> List[AnyStr]:
     def data_variable(self, var_name: AnyStr):
         ...
 
+    def cdf_type(self, var_name: AnyStr) -> AnyStr:
+        ...
+
     def variable_attribute_value(self, var: AnyStr, attr: AnyStr) -> Any:
         ...
 

pyistp/drivers/pycdfpp.py

@@ -31,6 +31,9 @@ def variables(self):
             return list(self.cdf)
         return []
 
+    def cdf_type(self, var_name):
+        return self.cdf[var_name].type.name
+
     def has_variable(self, name):
         return name in self.cdf
 

pyistp/drivers/spacepy.py

@@ -28,6 +28,9 @@ def variables(self):
             return self.cdf.keys()
         return []
 
+    def cdf_type(self, var_name):
+        return pycdf.lib.cdftypenames[self.cdf[var_name].type()]
+
     def has_variable(self, name):
         return name in self.cdf
 

pyistp/support_data_variable.py

@@ -2,15 +2,16 @@
 
 
 class SupportDataVariable:
-    __slots__ = ("name", "values", 'attributes', 'is_nrv')
+    __slots__ = ("name", "values", 'attributes', 'is_nrv', 'cdf_type')
 
-    def __init__(self, name, values, attributes, is_nrv):
+    def __init__(self, name, values, attributes, is_nrv, cdf_type):
         self.name = name
         self.values = values
         if type(self.values) is list:
             self.values = np.array(self.values)
         self.attributes = attributes
         self.is_nrv = is_nrv
+        self.cdf_type = cdf_type
 
     def __len__(self):
         return len(self.values)

tests/test_pyistp.py

@@ -111,6 +111,14 @@ def test_non_compliant_cdf_with_master(self):
         self.assertIsNotNone(istp_file)
         self.assertIsNotNone(istp_file.data_variable('MOM.P.AVGTEMP'))
 
+    def test_get_data_variable_type(self):
+        istp_file = pyistp.load(file=f"{current_path}/resources/solo_l3_rpw-bia-density-10-seconds_00000000_v01.cdf")
+        self.assertEqual(istp_file.data_variable('DENSITY').cdf_type, 'CDF_FLOAT')
+
+    def test_get_support_variable_type(self):
+        istp_file = pyistp.load(file=f"{current_path}/resources/solo_l3_rpw-bia-density-10-seconds_00000000_v01.cdf")
+        self.assertEqual(istp_file.data_variable('DENSITY').axes[0].cdf_type, 'CDF_TIME_TT2000')  
+
     def test_is_nrv(self):
         istp_file = pyistp.load(file=f"{current_path}/resources/solo_l3_rpw-bia-density-10-seconds_00000000_v01.cdf")
         self.assertFalse(istp_file.data_variable('DENSITY').axes[0].is_nrv)