docstrings & tests

Author: JavierCladellas

src/feelpp/benchmarking/report/transformationFactory.py

@@ -13,7 +13,17 @@ def calculate(self,df):
         """ abstract method for transforming a dataframe depending on the strategy"""
         raise NotImplementedError("Not to be called directly.")
 
-    def chooseColumn(self,value,df):
+    @staticmethod
+    def chooseColumn(value,df):
+        """ Chooses a column from a list of possible columns splitted by '|' from a dataframe, returns the first occurence in the dataframe.
+            If no column is found, returns None
+            If the value is null (0, False, None, ...), returns None
+        Args:
+            value (str): The string containing the possible columns, splitted by '|'. e.g. "column1|column2|column3"
+            df (pd.DataFrame): The dataframe where the columns are searched
+        Returns:
+            str: The first column found in the dataframe, or None
+        """
         if not value:
             return value
 
@@ -22,6 +32,8 @@ def chooseColumn(self,value,df):
             if column in df.columns:
                 return column
 
+        return None
+
     def updateDimensions(self,df):
         dimensions = {}
         for k,v in self.dimensions.items():

tests/report/test_transformationFactory.py

@@ -105,6 +105,21 @@ def test_speedupStrategy(self):
         ignore_columns = ["optimal","half-optimal"]
         assert np.isclose(calculated_df.loc[:,[col for col in calculated_df.columns if col not in ignore_columns]],pivot.loc[pivot.index.min(),:] / pivot).all()
 
+
+    @pytest.mark.parametrize(("param_names","expected"),[
+        ("param1","param1"),
+        ("param1|non_existent","param1"),
+        ("non_existent|param2","param2"),
+        ("non_existent|param2|param3","param2"),
+        ("non_existent",None),
+        (0,0), (None,None), (False,None),
+    ])
+    def test_chooseColumn(self,param_names,expected):
+        df = pd.DataFrame(columns=["param1","param2","param3","param4"])
+        assert PerformanceStrategy.chooseColumn(param_names,df) == expected
+
+
+
 class TestComplexStrategies:
     plot_config = PlotConfigMocker(
         xaxis=AxisMocker(parameter="xaxis",label="x"),