Make models inherit from ConfigModel rather than BaseModel

Author: jacob720

src/daq_config_server/client.py

@@ -5,15 +5,16 @@
 
 import requests
 from cachetools import TTLCache, cachedmethod
-from pydantic import BaseModel, TypeAdapter
+from pydantic import TypeAdapter
 from requests import Response
 from requests.exceptions import HTTPError
 
 from daq_config_server.app import ValidAcceptHeaders
+from daq_config_server.converters.models import ConfigModel
 
 from .constants import ENDPOINTS
 
-TModel = TypeVar("TModel", bound=BaseModel)
+TModel = TypeVar("TModel", bound=ConfigModel)
 TNonModel = TypeVar("TNonModel", str, bytes, dict[str, Any])
 
 
@@ -27,7 +28,7 @@ def _get_mime_type(
     if (
         get_origin(requested_return_type) is dict
         or requested_return_type is dict
-        or issubclass(requested_return_type, BaseModel)
+        or issubclass(requested_return_type, ConfigModel)
     ):
         return ValidAcceptHeaders.JSON
     elif requested_return_type is bytes:

src/daq_config_server/converters/_file_converter_map.py

@@ -2,7 +2,6 @@
 from typing import Any
 
 import xmltodict
-from pydantic import BaseModel
 
 from daq_config_server.converters._converters import (
     beamline_parameters_to_dict,
@@ -12,8 +11,9 @@
     display_config_to_model,
     undulator_energy_gap_lut,
 )
+from daq_config_server.converters.models import ConfigModel
 
-FILE_TO_CONVERTER_MAP: dict[str, Callable[[str], BaseModel | dict[str, Any]]] = {  # type: ignore
+FILE_TO_CONVERTER_MAP: dict[str, Callable[[str], ConfigModel | dict[str, Any]]] = {  # type: ignore
     "/tests/test_data/test_good_lut.txt": undulator_energy_gap_lut,  # For system tests # noqa
     "/dls_sw/i23/software/aithre/aithre_display.configuration": display_config_to_model,
     "/dls_sw/i03/software/gda_versions/var/display.configuration": display_config_to_model,  # noqa

src/daq_config_server/converters/convert.py

@@ -2,10 +2,9 @@
 from pathlib import Path
 from typing import Any
 
-from pydantic import BaseModel
-
 import daq_config_server.converters._file_converter_map as file_converter_map
 from daq_config_server.converters._converter_utils import ConverterParseError
+from daq_config_server.converters.models import ConfigModel
 
 
 def get_converted_file_contents(file_path: Path) -> dict[str, Any]:
@@ -14,7 +13,7 @@ def get_converted_file_contents(file_path: Path) -> dict[str, Any]:
     if converter := file_converter_map.FILE_TO_CONVERTER_MAP.get(str(file_path)):
         try:
             contents = converter(raw_contents)
-            if isinstance(contents, BaseModel):
+            if isinstance(contents, ConfigModel):
                 return contents.model_dump()
             return contents
         except Exception as e:

src/daq_config_server/converters/models.py

@@ -1,7 +1,10 @@
 from pydantic import BaseModel, model_validator
 
 
-class DisplayConfigData(BaseModel):
+class ConfigModel(BaseModel): ...
+
+
+class DisplayConfigData(ConfigModel):
     crosshairX: int
     crosshairY: int
     topLeftX: int
@@ -10,7 +13,7 @@ class DisplayConfigData(BaseModel):
     bottomRightY: int
 
 
-class DisplayConfig(BaseModel):
+class DisplayConfig(ConfigModel):
     zoom_levels: dict[float, DisplayConfigData]
     required_zoom_levels: set[float] | None = None
 
@@ -28,7 +31,7 @@ def check_zoom_levels_match_required(self):
         return self
 
 
-class GenericLookupTable(BaseModel):
+class GenericLookupTable(ConfigModel):
     column_names: list[str]
     rows: list[list[int | float]]
 

tests/conftest.py

@@ -4,19 +4,19 @@
 
 import pytest
 import xmltodict
-from pydantic import BaseModel
 
 from daq_config_server.converters._converters import (
     beamline_parameters_to_dict,
     display_config_to_model,
     undulator_energy_gap_lut,
 )
+from daq_config_server.converters.models import ConfigModel
 from tests.constants import ServerFilePaths, TestDataPaths
 
 
 @pytest.fixture
 def mock_file_converter_map() -> Generator[
-    Mapping[str, Callable[[str], BaseModel | dict[str, Any]]], None, None
+    Mapping[str, Callable[[str], ConfigModel | dict[str, Any]]], None, None
 ]:
     with patch(
         "daq_config_server.converters._file_converter_map.FILE_TO_CONVERTER_MAP",

tests/system_tests/test_client.py

@@ -5,11 +5,15 @@
 
 import pytest
 import requests
-from pydantic import BaseModel, ValidationError
+from pydantic import ValidationError
 
 import daq_config_server.converters._file_converter_map as file_converter_map
 from daq_config_server.client import ConfigServer
-from daq_config_server.converters.models import DisplayConfig, GenericLookupTable
+from daq_config_server.converters.models import (
+    ConfigModel,
+    DisplayConfig,
+    GenericLookupTable,
+)
 from tests.constants import (
     ServerFilePaths,
     TestDataPaths,
@@ -157,6 +161,6 @@ def test_all_files_in_file_converter_map_can_be_converted_to_target_type(
     ):
         for filename, converter in file_converter_map.FILE_TO_CONVERTER_MAP.items():
             return_type = get_type_hints(converter)["return"]
-            assert return_type is dict or issubclass(return_type, BaseModel)
+            assert return_type is dict or issubclass(return_type, ConfigModel)
             result = server.get_file_contents(filename, return_type)
             assert isinstance(result, return_type)