Define local and home config file paths in a single place

Author: dieriver

simulaqron/settings/__init__.py

@@ -1,5 +1,5 @@
-from .network_config import NetworkConfigBuilder, DEFAULT_SIMULAQRON_NETWORK_FILENAME
-from .simulaqron_config import SimulaqronConfig, DEFAULT_SIMULAQRON_SETTINGS_FILENAME
+from .network_config import NetworkConfigBuilder, DEFAULT_SIMULAQRON_NETWORK_FILENAME, LOCAL_NETWORK_SETTINGS, HOME_NETWORK_SETTINGS
+from .simulaqron_config import SimulaqronConfig, DEFAULT_SIMULAQRON_SETTINGS_FILENAME, LOCAL_SIMULAQRON_SETTINGS, HOME_SIMULAQRON_SETTINGS
 from ._serialization import init_serialization
 
 init_serialization()
@@ -12,10 +12,4 @@
 # Centralized way to store the config of the network. It reads the local
 # configuration if exists, otherwise, it simply populates the in-memory
 # configs object with the default values
-network_config = NetworkConfigBuilder.load_from_known_sources()
-
-# We follow a similar approach with the network config builder: read the
-# file pointed by the simulaqron_settings (if exists) or initialize a new
-# builder that contains only the default network.
-# network_configs = NetworkConfigBuilder()
-# network_configs.read_from_file(simulaqron_settings.network_config_file)
+network_config = NetworkConfigBuilder.load_from_known_sources()

simulaqron/settings/_serialization.py

@@ -3,12 +3,11 @@
 from typing import Type, Dict, Any, List
 
 from dataclasses_serialization.json import JSONSerializer
-from dataclasses_serialization.serializer_base import (DeserializationError,
-                                                       dict_serialization)
+from dataclasses_serialization.serializer_base import DeserializationError
 
 from .network_config import NodeConfig, NetworkConfig, NetworkConfigBuilder
-from ..settings.simulaqron_config import (DEFAULT_SIMULAQRON_SETTINGS_FILENAME,
-                                          SimulaqronConfig, SimBackend)
+from ..settings import HOME_SIMULAQRON_SETTINGS
+from ..settings.simulaqron_config import SimulaqronConfig, SimBackend
 
 
 def init_serialization():
@@ -45,10 +44,11 @@ def path_serializer(obj: Path) -> str:
 # Registration of Deserializer for python enums
 @JSONSerializer.register_deserializer(Path)
 def path_deserializer(cls: Type[Path], path: str) -> Path:
-    if path == "$DEFAULT_NETWORK":
-        return (cls.home() / ".simulaqron" / DEFAULT_SIMULAQRON_SETTINGS_FILENAME).resolve()
-    # If the path is given, we will resolve it later
-    return cls(path)
+    match path:
+        case "$DEFAULT_NETWORK":
+            return HOME_SIMULAQRON_SETTINGS
+        case _:
+            return cls(path)
 
 
 @JSONSerializer.register_deserializer(SimulaqronConfig)

simulaqron/settings/network_config.py

@@ -12,7 +12,11 @@
 
 import simulaqron._default_config
 
+# Some helpers paths that point to the usual locations where the
+# configurations can reside:
 DEFAULT_SIMULAQRON_NETWORK_FILENAME = "simulaqron_network.json"
+HOME_NETWORK_SETTINGS = (Path.home() / ".simulaqron" / DEFAULT_SIMULAQRON_NETWORK_FILENAME).resolve()
+LOCAL_NETWORK_SETTINGS = (Path.cwd() / DEFAULT_SIMULAQRON_NETWORK_FILENAME).resolve()
 
 
 class NodeConfigType(StrEnum):
@@ -421,8 +425,8 @@ def _deserialize_from_file(cls, file_path: Path) -> Self:
 
     @classmethod
     def load_from_known_sources(cls) -> Self:
-        cwd_networks_file = (Path.cwd() / DEFAULT_SIMULAQRON_NETWORK_FILENAME).resolve()
-        home_networks_file = (Path.home() / ".simulaqron" / DEFAULT_SIMULAQRON_NETWORK_FILENAME).resolve()
+        cwd_networks_file = LOCAL_NETWORK_SETTINGS.resolve()
+        home_networks_file = HOME_NETWORK_SETTINGS.resolve()
 
         files_to_load = [cwd_networks_file, home_networks_file]
 

simulaqron/settings/simulaqron_config.py

@@ -40,10 +40,11 @@
 from dataclasses_serialization.json import JSONSerializer
 from dataclasses_serialization.json import JSONSerializerMixin
 
-# This is the name of the "local" simulaqron settings.
-# If a file named like this is found in the CWD, it will be
-# automatically loaded when creating the config file
+# Some helpers paths that point to the usual locations where the
+# configurations can reside:
 DEFAULT_SIMULAQRON_SETTINGS_FILENAME = "simulaqron_settings.json"
+LOCAL_SIMULAQRON_SETTINGS = (Path.cwd() / DEFAULT_SIMULAQRON_SETTINGS_FILENAME).resolve()
+HOME_SIMULAQRON_SETTINGS = (Path.home() / ".simulaqron" / DEFAULT_SIMULAQRON_SETTINGS_FILENAME).resolve()
 
 
 class SimBackend(JSONSerializerMixin, Enum):
@@ -97,8 +98,8 @@ def _deserialize_from_file(cls, file_path: Path) -> Self:
 
     @classmethod
     def load_from_known_sources(cls) -> Self:
-        cwd_settings_file = (Path.cwd() / DEFAULT_SIMULAQRON_SETTINGS_FILENAME).resolve()
-        home_settings_file = (Path.home() / ".simulaqron" / DEFAULT_SIMULAQRON_SETTINGS_FILENAME).resolve()
+        cwd_settings_file = LOCAL_SIMULAQRON_SETTINGS.resolve()
+        home_settings_file = HOME_SIMULAQRON_SETTINGS.resolve()
 
         files_to_load = [cwd_settings_file, home_settings_file]