create is_str and move old str_bool to private function

Author: betaBison

gnss_lib_py/parsers/navdata.py

@@ -255,14 +255,14 @@ def _get_str_rows(self, rows):
         row_str : list
             List of boolean values indicating which rows contain strings
         """
-        str_bool = self.str_bool
+        _row_idx_str_bool = self._row_idx_str_bool
         if isinstance(rows, slice):
             slice_idx = rows.indices(self.shape[0])
             row_list = np.arange(slice_idx[0], slice_idx[1], slice_idx[2])
-            row_str = [str_bool[row] for row in row_list]
+            row_str = [_row_idx_str_bool[row] for row in row_list]
         else:
             row_list = list(rows)
-            row_str = [str_bool[row] for row in rows]
+            row_str = [_row_idx_str_bool[row] for row in rows]
         return row_list, row_str
 
     def __getitem__(self, key_idx):
@@ -633,19 +633,42 @@ def rows(self):
 
 
     @property
-    def str_bool(self):
+    def _row_idx_str_bool(self):
         """Dictionary of index : if data entry is string.
 
         Row has string values if the string map is nonempty for a
         given row.
 
         Returns
         -------
-        str_bool : Dict
+        _row_idx_str_bool : Dict
             Dictionary of whether data at row number key is string or not
         """
-        str_bool = {self.map[k]: bool(len(self.str_map[k])) for k in self.str_map.keys()}
-        return str_bool
+        _row_idx_str_bool = {self.map[k]: bool(len(self.str_map[k])) for k in self.str_map.keys()}
+        return _row_idx_str_bool
+
+    def is_str(self, row_name):
+        """Check whether a row contained string values.
+
+        Parameters
+        ----------
+        row_name : string
+            Name of the row to check whether it contains string values.
+
+        Returns
+        -------
+        contains_str : bool
+            True if the row contains string values, False otherwise.
+
+        """
+
+        if row_name not in self.map:
+            raise KeyError("'" + str(row_name) \
+                           + "' key doesn't exist in NavData class")
+
+        contains_str = self._row_idx_str_bool[self.map[row_name]]
+
+        return contains_str
 
     @property
     def inv_map(self):

tests/parsers/test_navdata.py

@@ -960,3 +960,27 @@ def test_col_looping(csv_simple):
         expected_df = compare_df.iloc[[idx], :].reset_index(drop=True)
         pd.testing.assert_frame_equal(col_df, expected_df,
                                       check_index_type=False)
+
+def test_is_str(df_simple):
+    """Test the is_str function.
+
+    Parameters
+    ----------
+    df_simple : pd.DataFrame
+        Simple pd.DataFrame with which to initialize NavData.
+
+    """
+    navdata = NavData(pandas_df=df_simple)
+
+    # check on simple dataframe rows
+    assert navdata.is_str("names")
+    assert not navdata.is_str("integers")
+    assert not navdata.is_str("floats")
+    assert navdata.is_str("strings")
+
+    # should raise error if key doesn't exist
+    with pytest.raises(KeyError):
+        navdata.is_str("bananas")
+
+    with pytest.raises(KeyError):
+        navdata.is_str(0)

tests/utils/test_visualizations.py

@@ -114,7 +114,7 @@ def test_plot_metrics(derived):
                  ]
 
     for row in derived.rows:
-        if not derived.str_bool[derived.map[row]]:
+        if not derived.is_str(row):
             if row in test_rows:
                 fig = viz.plot_metric(derived, row, save=False)
                 close_figures(fig)
@@ -130,7 +130,7 @@ def test_plot_metrics(derived):
     assert "Prefix" in str(excinfo.value)
 
     for row in derived.rows:
-        if not derived.str_bool[derived.map[row]]:
+        if not derived.is_str(row):
             if row in test_rows:
                 fig = viz.plot_metric(derived, "raw_pr_m", row, save=False)
                 close_figures(fig)
@@ -168,7 +168,7 @@ def test_plot_metrics_by_constellation(derived):
                  ]
 
     for row in derived.rows:
-        if not derived.str_bool[derived.map[row]]:
+        if not derived.is_str(row):
             if row in test_rows:
                 fig = viz.plot_metric_by_constellation(derived, row, save=False)
                 close_figures(fig)