Move models into their own module

Author: jacob720

src/daq_config_server/converters/_converter_utils.py

@@ -1,7 +1,7 @@
 import ast
 from typing import Any
 
-from pydantic import BaseModel, model_validator
+from daq_config_server.converters.models import GenericLut
 
 BEAMLINE_PARAMETER_KEYWORDS = ["FB", "FULL", "deadtime"]
 
@@ -27,22 +27,6 @@ def parse_value(value: str, convert_to: type | None = None) -> Any:
     return value
 
 
-class GenericLut(BaseModel):
-    column_names: list[str]
-    rows: list[list[int | float]]
-
-    @model_validator(mode="after")
-    def check_row_length_matches_n_columns(self):
-        n_columns = len(self.column_names)
-        for row in self.rows:
-            if len(row) != n_columns:
-                raise ValueError(
-                    f"Length of row {row} does not match number \
-                    of columns: {self.column_names}"
-                )
-        return self
-
-
 def parse_lut(contents: str, *params: tuple[str, type | None]) -> GenericLut:
     """Converts a lookup table to a dict, containing the names of each column and
     the rows as a 2D list.

src/daq_config_server/converters/_converters.py

@@ -1,7 +1,6 @@
 from typing import Any
 
 import xmltodict
-from pydantic import BaseModel, model_validator
 
 from daq_config_server.converters._converter_utils import (
     BEAMLINE_PARAMETER_KEYWORDS,
@@ -10,6 +9,7 @@
     parse_value,
     remove_comments,
 )
+from daq_config_server.converters.models import DisplayConfig, DisplayConfigData
 
 
 def beamline_parameters_to_dict(contents: str) -> dict[str, Any]:
@@ -35,33 +35,6 @@ def beamline_parameters_to_dict(contents: str) -> dict[str, Any]:
     return dict(config_pairs)
 
 
-class DisplayConfigData(BaseModel):
-    crosshairX: int
-    crosshairY: int
-    topLeftX: int
-    topLeftY: int
-    bottomRightX: int
-    bottomRightY: int
-
-
-class DisplayConfig(BaseModel):
-    zoom_levels: dict[float, DisplayConfigData]
-    required_zoom_levels: set[float] | None = None
-
-    @model_validator(mode="after")
-    def check_zoom_levels_match_required(self):
-        existing_keys = set(self.zoom_levels.keys())
-        if (
-            self.required_zoom_levels is not None
-            and self.required_zoom_levels != existing_keys
-        ):
-            raise ValueError(
-                f"Zoom levels {existing_keys} "
-                f"do not match required zoom levels: {self.required_zoom_levels}"
-            )
-        return self
-
-
 def display_config_to_dict(contents: str) -> DisplayConfig:
     """Converts a display config file into a dict. Every zoom level entry in the
     configuration file forms a key in the dict, with value being another dict. This

src/daq_config_server/converters/models.py

@@ -0,0 +1,44 @@
+from pydantic import BaseModel, model_validator
+
+
+class DisplayConfigData(BaseModel):
+    crosshairX: int
+    crosshairY: int
+    topLeftX: int
+    topLeftY: int
+    bottomRightX: int
+    bottomRightY: int
+
+
+class DisplayConfig(BaseModel):
+    zoom_levels: dict[float, DisplayConfigData]
+    required_zoom_levels: set[float] | None = None
+
+    @model_validator(mode="after")
+    def check_zoom_levels_match_required(self):
+        existing_keys = set(self.zoom_levels.keys())
+        if (
+            self.required_zoom_levels is not None
+            and self.required_zoom_levels != existing_keys
+        ):
+            raise ValueError(
+                f"Zoom levels {existing_keys} "
+                f"do not match required zoom levels: {self.required_zoom_levels}"
+            )
+        return self
+
+
+class GenericLut(BaseModel):
+    column_names: list[str]
+    rows: list[list[int | float]]
+
+    @model_validator(mode="after")
+    def check_row_length_matches_n_columns(self):
+        n_columns = len(self.column_names)
+        for row in self.rows:
+            if len(row) != n_columns:
+                raise ValueError(
+                    f"Length of row {row} does not match number \
+                    of columns: {self.column_names}"
+                )
+        return self

tests/system_tests/test_client.py

@@ -9,8 +9,7 @@
 
 import daq_config_server.converters._file_converter_map as file_converter_map
 from daq_config_server.client import ConfigServer
-from daq_config_server.converters._converter_utils import GenericLut
-from daq_config_server.converters._converters import DisplayConfig
+from daq_config_server.converters.models import DisplayConfig, GenericLut
 from tests.constants import (
     ServerFilePaths,
     TestDataPaths,

tests/unit_tests/test_converters.py

@@ -7,14 +7,11 @@
 
 from daq_config_server.converters._converter_utils import (
     ConverterParseError,
-    GenericLut,
     parse_lut,
     parse_value,
     remove_comments,
 )
 from daq_config_server.converters._converters import (
-    DisplayConfig,
-    DisplayConfigData,
     beamline_parameters_to_dict,
     beamline_pitch_lut,
     beamline_roll_lut,
@@ -24,6 +21,11 @@
     xml_to_dict,
 )
 from daq_config_server.converters.convert import get_converted_file_contents
+from daq_config_server.converters.models import (
+    DisplayConfig,
+    DisplayConfigData,
+    GenericLut,
+)
 from tests.constants import (
     TestDataPaths,
 )