Enabling datalogger field to guess the process type from variable name suffix

Author: lewis-chambers

src/iotdevicesimulator/devices.py

@@ -493,8 +493,12 @@ def __init__(
 
         if not units is None:
             self.units = str(units)
+
         if not process is None:
             self.process = str(process)
+        else:
+            self.process = CR1000XField._get_process(name)
+
         if settable is not None:
             if not isinstance(settable, bool):
                 raise TypeError(
@@ -551,8 +555,7 @@ def _get_avg_xsd_type(values: list) -> XMLDataTypes:
 
         Args:
             values: The list of values to assess.
-        Returns:
-            XMLDataType: The resultant type."""
+        Returns: The resultant type."""
 
         if not hasattr(values, "__iter__"):
             values = [values]
@@ -572,8 +575,7 @@ def _get_xsd_type(value: str | int | float | bool | object) -> XMLDataTypes:
         Args:
             value: The item to convert.
 
-        Returns:
-            XMLDataTypes: The XML datatype.
+        Returns: The XML datatype.
         """
         if value is None:
             return XMLDataTypes.null
@@ -624,3 +626,32 @@ def _get_xsd_type(value: str | int | float | bool | object) -> XMLDataTypes:
         raise TypeError(
             f"Couldnt find XML datatype for value `{value}` and type: `{type(value)}`."
         )
+
+    @staticmethod
+    def _get_process(value: str) -> str:
+        """Calculates the process attribute based on the variable name.
+
+        Args:
+            value: The variable name to generate from.
+
+        Returns: The value of the expected process used.
+        """
+
+        value = value.lower()
+
+        if value.endswith("_std"):  # Standard Deviation
+            return "Std"
+        elif value.endswith("_avg"):  # Average
+            return "Avg"
+        elif value.endswith("_max"):  # Maximum
+            return "Max"
+        elif value.endswith("_min"):  # Minimum
+            return "Min"
+        elif value.endswith("_mom"):  # Moment
+            return "Mom"
+        elif value.endswith("_tot"):  # Totalize
+            return "Tot"
+        elif value.endswith("_cov"):  # Covariance
+            return "Cov"
+
+        return "Smp"  # Sample

src/tests/test_devices.py

@@ -691,7 +691,6 @@ def test_format_payload_errors(self):
         with self.assertRaises(ValueError):
             device._format_payload(bad_key_payload)
 
-
 class TestCR1000XField(unittest.TestCase):
     """Tests the datalogger field objects."""
 
@@ -814,5 +813,34 @@ def test_json_serialisation(self):
 
         self.assertEqual(json.dumps(obj, default=json_serial), expected)
 
+    @parameterized.expand([
+        ["Temp", "Smp"],
+        ["Temp_avg", "Avg"],
+        ["Temp_AVG", "Avg"],
+        ["Temp_avg_C", "Smp"],
+        ["Temp_STD", "Std"],
+        ["Temp_Max", "Max"],
+        ["Temp_Min", "Min"],
+        ["Temp_cov", "Cov"],
+        ["Temp_tot", "Tot"],
+        ["Temp_Mom", "Mom"],
+    ])
+    def test_process_calculation(self, variable: str, expected: str): 
+        """Tests that the expected process can be calculated."""
+
+        result = CR1000XField._get_process(variable)
+
+        self.assertEqual(result, expected)
+
+    @parameterized.expand([
+        ["Temp", "Smp"],
+        ["Temp_avg", "Avg"],
+        ["Temp_AVG", "Avg"],
+    ])
+    def test_initialization_with_process_calculated(self, name, expected):
+        """Checking that process gets set from the variable name."""
+        result = CR1000XField(name, data_type="xsd:float")
+
+        self.assertEqual(result.process, expected)
 if __name__ == "__main__":
     unittest.main()