Renamed 'from_file' to 'machine_config_from_file' for clarity

Author: tieneupin

src/murfey/cli/inject_spa_processing.py

@@ -87,7 +87,7 @@ def run():
         help="Path to EER fractionation file if relevant",
     )
 
-    zc = zocalo.configuration.from_file()
+    zc = zocalo.configuration.machine_config_from_file()
     zc.activate()
     zc.add_command_line_options(parser)
     workflows.transport.add_command_line_options(parser, transport_argument=True)

src/murfey/server/api/session_shared.py

@@ -9,7 +9,12 @@
 
 import murfey.server.prometheus as prom
 from murfey.util import safe_run, sanitise, secure_path
-from murfey.util.config import MachineConfig, from_file, get_machine_config, settings
+from murfey.util.config import (
+    MachineConfig,
+    get_machine_config,
+    machine_config_from_file,
+    settings,
+)
 from murfey.util.db import (
     DataCollection,
     DataCollectionGroup,
@@ -26,9 +31,9 @@
 @lru_cache(maxsize=5)
 def get_machine_config_for_instrument(instrument_name: str) -> Optional[MachineConfig]:
     if settings.murfey_machine_configuration:
-        return from_file(Path(settings.murfey_machine_configuration), instrument_name)[
-            instrument_name
-        ]
+        return machine_config_from_file(
+            Path(settings.murfey_machine_configuration), instrument_name
+        )[instrument_name]
     return None
 
 

src/murfey/server/demo_api.py

@@ -43,8 +43,8 @@
 from murfey.util import sanitise_path
 from murfey.util.config import (
     MachineConfig,
-    from_file,
     get_hostname,
+    machine_config_from_file,
     security_from_file,
 )
 from murfey.util.db import (
@@ -93,7 +93,9 @@ class Settings(BaseSettings):
 machine_config: dict[str, MachineConfig] = {}
 if settings.murfey_machine_configuration:
     microscope = get_microscope()
-    machine_config = from_file(Path(settings.murfey_machine_configuration), microscope)
+    machine_config = machine_config_from_file(
+        Path(settings.murfey_machine_configuration), microscope
+    )
 
 
 # This will be the homepage for a given microscope.
@@ -114,19 +116,19 @@ async def root(request: Request):
 def machine_info() -> Optional[MachineConfig]:
     instrument_name = os.getenv("BEAMLINE")
     if settings.murfey_machine_configuration and instrument_name:
-        return from_file(Path(settings.murfey_machine_configuration), instrument_name)[
-            instrument_name
-        ]
+        return machine_config_from_file(
+            Path(settings.murfey_machine_configuration), instrument_name
+        )[instrument_name]
     return None
 
 
 @lru_cache(maxsize=5)
 @router.get("/instruments/{instrument_name}/machine")
 def machine_info_by_name(instrument_name: str) -> Optional[MachineConfig]:
     if settings.murfey_machine_configuration:
-        return from_file(Path(settings.murfey_machine_configuration), instrument_name)[
-            instrument_name
-        ]
+        return machine_config_from_file(
+            Path(settings.murfey_machine_configuration), instrument_name
+        )[instrument_name]
     return None
 
 

src/murfey/util/config.py

@@ -147,7 +147,9 @@ def validate_software_versions(cls, v: dict[str, Any]) -> dict[str, str]:
         return v
 
 
-def from_file(config_file_path: Path, instrument: str = "") -> dict[str, MachineConfig]:
+def machine_config_from_file(
+    config_file_path: Path, instrument: str = ""
+) -> dict[str, MachineConfig]:
     with open(config_file_path, "r") as config_stream:
         config = yaml.safe_load(config_stream)
     return {
@@ -260,7 +262,7 @@ def get_machine_config(instrument_name: str = "") -> dict[str, MachineConfig]:
     }
     if settings.murfey_machine_configuration:
         microscope = instrument_name
-        machine_config = from_file(
+        machine_config = machine_config_from_file(
             Path(settings.murfey_machine_configuration), microscope
         )
     return machine_config