Clean up APIs and private modules

jacob720 · jacob720 · commit b929a6a164af · 2025-12-09T16:44:29.000Z
diff --git a/src/daq_config_server/app.py b/src/daq_config_server/app.py
@@ -9,13 +9,13 @@
 from fastapi import FastAPI, HTTPException, Request
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import JSONResponse, Response
+from src.daq_config_server.converters.convert import get_converted_file_contents
 from starlette import status
 
 from daq_config_server.config import Config
 from daq_config_server.constants import (
     ENDPOINTS,
 )
-from daq_config_server.converters import get_converted_file_contents
 from daq_config_server.log import set_up_logging
 from daq_config_server.whitelist import get_whitelist
 
diff --git a/src/daq_config_server/client.py b/src/daq_config_server/client.py
@@ -10,7 +10,7 @@
 from requests.exceptions import HTTPError
 
 from daq_config_server.app import ValidAcceptHeaders
-from daq_config_server.converters.models import ConfigModel
+from daq_config_server.models import ConfigModel
 
 from .constants import ENDPOINTS
 
diff --git a/src/daq_config_server/converters/__init__.py b/src/daq_config_server/converters/__init__.py
@@ -1,3 +1,8 @@
-from daq_config_server.converters.convert import get_converted_file_contents
+from ._base_model import ConfigModel
+from ._converter_utils import parse_value, remove_comments
 
-__all__ = ["get_converted_file_contents"]
+__all__ = [
+    "ConfigModel",
+    "remove_comments",
+    "parse_value",
+]
diff --git a/src/daq_config_server/converters/_base_model.py b/src/daq_config_server/converters/_base_model.py
diff --git a/src/daq_config_server/converters/_file_converter_map.py b/src/daq_config_server/converters/_file_converter_map.py
@@ -15,7 +15,8 @@
     detector_xy_lut,
     undulator_energy_gap_lut,
 )
-from daq_config_server.converters.models import ConfigModel
+
+from ._base_model import ConfigModel
 
 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
diff --git a/src/daq_config_server/converters/beamline_parameters/__init__.py b/src/daq_config_server/converters/beamline_parameters/__init__.py
@@ -0,0 +1,3 @@
+from ._converters import beamline_parameters_to_dict
+
+__all__ = ["beamline_parameters_to_dict"]
diff --git a/src/daq_config_server/converters/beamline_parameters/_models.py b/src/daq_config_server/converters/beamline_parameters/_models.py
diff --git a/src/daq_config_server/converters/convert.py b/src/daq_config_server/converters/convert.py
@@ -3,8 +3,9 @@
 from typing import Any
 
 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
+
+from ._base_model import ConfigModel
+from ._converter_utils import ConverterParseError
 
 
 def get_converted_file_contents(file_path: Path) -> dict[str, Any]:
diff --git a/src/daq_config_server/converters/display_config/__init__.py b/src/daq_config_server/converters/display_config/__init__.py
@@ -0,0 +1,4 @@
+from ._converters import display_config_to_model
+from ._models import DisplayConfig, DisplayConfigData
+
+__all__ = ["display_config_to_model", "DisplayConfig", "DisplayConfigData"]
diff --git a/src/daq_config_server/converters/display_config/_converters.py b/src/daq_config_server/converters/display_config/_converters.py
@@ -1,8 +1,6 @@
-from daq_config_server.converters._converter_utils import parse_value, remove_comments
-from daq_config_server.converters.display_config.models import (
-    DisplayConfig,
-    DisplayConfigData,
-)
+from daq_config_server.converters import parse_value, remove_comments
+
+from ._models import DisplayConfig, DisplayConfigData
 
 
 def display_config_to_model(contents: str) -> DisplayConfig:
diff --git a/src/daq_config_server/converters/display_config/_models.py b/src/daq_config_server/converters/display_config/_models.py
@@ -1,6 +1,6 @@
 from pydantic import model_validator
 
-from daq_config_server.converters.models import ConfigModel
+from daq_config_server.converters import ConfigModel
 
 
 class DisplayConfigData(ConfigModel):
diff --git a/src/daq_config_server/converters/lookup_tables/__init__.py b/src/daq_config_server/converters/lookup_tables/__init__.py
@@ -0,0 +1,17 @@
+from ._converters import (
+    beamline_pitch_lut,
+    beamline_roll_lut,
+    detector_xy_lut,
+    parse_lut,
+    undulator_energy_gap_lut,
+)
+from ._models import GenericLookupTable
+
+__all__ = [
+    "GenericLookupTable",
+    "parse_lut",
+    "detector_xy_lut",
+    "beamline_pitch_lut",
+    "beamline_roll_lut",
+    "undulator_energy_gap_lut",
+]
diff --git a/src/daq_config_server/converters/lookup_tables/_converters.py b/src/daq_config_server/converters/lookup_tables/_converters.py
@@ -1,7 +1,8 @@
 from typing import Any
 
-from daq_config_server.converters._converter_utils import parse_value, remove_comments
-from daq_config_server.converters.lookup_tables.models import GenericLookupTable
+from daq_config_server.converters import parse_value, remove_comments
+
+from ._models import GenericLookupTable
 
 
 def parse_lut(contents: str, *params: tuple[str, type | None]) -> GenericLookupTable:
diff --git a/src/daq_config_server/converters/lookup_tables/_models.py b/src/daq_config_server/converters/lookup_tables/_models.py
@@ -1,6 +1,6 @@
 from pydantic import model_validator
 
-from daq_config_server.converters.models import ConfigModel
+from daq_config_server.converters import ConfigModel
 
 
 class GenericLookupTable(ConfigModel):
diff --git a/src/daq_config_server/models/__init__.py b/src/daq_config_server/models/__init__.py
@@ -1,7 +1,9 @@
-from daq_config_server.converters.display_config.models import (
+from src.daq_config_server.converters.display_config import (
     DisplayConfig,
     DisplayConfigData,
 )
-from daq_config_server.converters.lookup_tables.models import GenericLookupTable
 
-__all__ = ["DisplayConfig", "DisplayConfigData", "GenericLookupTable"]
+from daq_config_server.converters import ConfigModel
+from daq_config_server.converters.lookup_tables import GenericLookupTable
+
+__all__ = ["ConfigModel", "DisplayConfig", "DisplayConfigData", "GenericLookupTable"]
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -5,6 +5,7 @@
 import pytest
 import xmltodict
 
+from daq_config_server.converters import ConfigModel
 from daq_config_server.converters.beamline_parameters._converters import (
     beamline_parameters_to_dict,
 )
@@ -14,7 +15,6 @@
 from daq_config_server.converters.lookup_tables._converters import (
     undulator_energy_gap_lut,
 )
-from daq_config_server.converters.models import ConfigModel
 from tests.constants import ServerFilePaths, TestDataPaths
 
 
diff --git a/tests/system_tests/test_client.py b/tests/system_tests/test_client.py
@@ -7,13 +7,11 @@
 import requests
 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.display_config.models import DisplayConfig
-from daq_config_server.converters.lookup_tables.models import GenericLookupTable
-from daq_config_server.converters.models import (
-    ConfigModel,
-)
+from daq_config_server.converters import ConfigModel
+from daq_config_server.converters._file_converter_map import FILE_TO_CONVERTER_MAP
+from daq_config_server.converters.display_config import DisplayConfig
+from daq_config_server.converters.lookup_tables import GenericLookupTable
 from tests.constants import (
     ServerFilePaths,
     TestDataPaths,
@@ -154,7 +152,7 @@ def test_request_for_file_with_converter_with_wrong_pydantic_model_errors(
 def test_all_files_in_file_converter_map_can_be_converted_to_dict(
     deployed_server: ConfigServer,
 ):
-    for filename in file_converter_map.FILE_TO_CONVERTER_MAP.keys():
+    for filename in FILE_TO_CONVERTER_MAP.keys():
         if filename.startswith("/tests/test_data/"):
             continue
         result = deployed_server.get_file_contents(filename, dict)
@@ -169,7 +167,7 @@ def test_all_files_in_file_converter_map_can_be_converted_to_target_type(
         "daq_config_server.converters._file_converter_map.xmltodict.parse.__annotations__",
         {"return": dict},  # Force a return type for xmltodict.parse()
     ):
-        for filename, converter in file_converter_map.FILE_TO_CONVERTER_MAP.items():
+        for filename, converter in FILE_TO_CONVERTER_MAP.items():
             if filename.startswith("/tests/test_data/"):
                 continue
             return_type = get_type_hints(converter)["return"]
diff --git a/tests/unit_tests/converters/test_beamline_parameters_converters.py b/tests/unit_tests/converters/test_beamline_parameters_converters.py
@@ -3,7 +3,7 @@
 import pytest
 from tests.constants import TestDataPaths
 
-from daq_config_server.converters.beamline_parameters._converters import (
+from daq_config_server.converters.beamline_parameters import (
     beamline_parameters_to_dict,
 )
 
diff --git a/tests/unit_tests/converters/test_convert.py b/tests/unit_tests/converters/test_convert.py
@@ -14,7 +14,7 @@
     beamline_parameters_to_dict,
 )
 from daq_config_server.converters.convert import get_converted_file_contents
-from daq_config_server.converters.lookup_tables.models import GenericLookupTable
+from daq_config_server.converters.lookup_tables import GenericLookupTable
 
 
 def test_get_converted_file_contents_uses_converter_if_file_in_map(
diff --git a/tests/unit_tests/converters/test_display_config_converters.py b/tests/unit_tests/converters/test_display_config_converters.py
@@ -3,12 +3,10 @@
 import pytest
 from tests.constants import TestDataPaths
 
-from daq_config_server.converters.display_config._converters import (
-    display_config_to_model,
-)
-from daq_config_server.models import (
+from daq_config_server.converters.display_config import (
     DisplayConfig,
     DisplayConfigData,
+    display_config_to_model,
 )
 
 
diff --git a/tests/unit_tests/converters/test_lookup_tables_converters.py b/tests/unit_tests/converters/test_lookup_tables_converters.py
@@ -1,14 +1,14 @@
 import pytest
 from tests.constants import TestDataPaths
 
-from daq_config_server.converters.lookup_tables._converters import (
+from daq_config_server.converters.lookup_tables import (
+    GenericLookupTable,
     beamline_pitch_lut,
     beamline_roll_lut,
     detector_xy_lut,
     parse_lut,
     undulator_energy_gap_lut,
 )
-from daq_config_server.models import GenericLookupTable
 
 
 def test_parse_lut_to_dict_gives_expected_result_and_can_be_jsonified():
diff --git a/tests/unit_tests/test_client.py b/tests/unit_tests/test_client.py
@@ -16,8 +16,8 @@
     _get_mime_type,
 )
 from daq_config_server.constants import ENDPOINTS
-from daq_config_server.converters.display_config.models import DisplayConfig
-from daq_config_server.converters.lookup_tables.models import GenericLookupTable
+from daq_config_server.converters.display_config import DisplayConfig
+from daq_config_server.converters.lookup_tables import GenericLookupTable
 from daq_config_server.testing import make_test_response
 
 test_path = Path("test")

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,8 @@`
`15`	`15`	`detector_xy_lut,`
`16`	`16`	`undulator_energy_gap_lut,`
`17`	`17`	`)`
`18`		`-from daq_config_server.converters.models import ConfigModel`
	`18`	`+`
	`19`	`+from ._base_model import ConfigModel`
`19`	`20`
`20`	`21`	`FILE_TO_CONVERTER_MAP: dict[str, Callable[[str], ConfigModel \| dict[str, Any]]] = { # type: ignore`
`21`	`22`	`"/tests/test_data/test_good_lut.txt": undulator_energy_gap_lut, # For system tests # noqa`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from ._converters import beamline_parameters_to_dict`
	`2`	`+`
	`3`	`+__all__ = ["beamline_parameters_to_dict"]`