ITQC/pydase
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase.git synced 2025-04-20 08:20:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

renaming config option from generate_new_web_settings to generate_web_settings

Browse Source
This commit is contained in:
Mose Müller 2024-01-08 16:49:36 +01:00
parent 6a6d1b27aa
commit 9e77bae5e7
3 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/pydase/config.py
View File

@ -19,6 +19,6 @@ class ServiceConfig(BaseConfig): # type: ignore[misc]
class WebServerConfig(BaseConfig): # type: ignore[misc] class WebServerConfig(BaseConfig): # type: ignore[misc]
generate_new_web_settings: bool = False generate_web_settings: bool = False
CONFIG_SOURCES = EnvSource(allow=["GENERATE_NEW_WEB_SETTINGS"]) CONFIG_SOURCES = EnvSource(allow=["GENERATE_WEB_SETTINGS"])

9
src/pydase/server/web_server/web_server.py
View File

@ -69,7 +69,7 @@ class WebServer:
css: str | Path | None = None, css: str | Path | None = None,
enable_cors: bool = True, enable_cors: bool = True,
config_dir: Path = ServiceConfig().config_dir, config_dir: Path = ServiceConfig().config_dir,
generate_new_web_settings: bool = WebServerConfig().generate_new_web_settings, generate_web_settings: bool = WebServerConfig().generate_web_settings,
**kwargs: Any, **kwargs: Any,
) -> None: ) -> None:
self.observer = data_service_observer self.observer = data_service_observer
@ -80,7 +80,7 @@ class WebServer:
self.css = css self.css = css
self.enable_cors = enable_cors self.enable_cors = enable_cors
self._service_config_dir = config_dir self._service_config_dir = config_dir
self._generate_new_web_settings = generate_new_web_settings self._generate_web_settings = generate_web_settings
self._loop: asyncio.AbstractEventLoop self._loop: asyncio.AbstractEventLoop
self._initialise_configuration() self._initialise_configuration()
@ -101,7 +101,7 @@ class WebServer:
file_path = self._service_config_dir / "web_settings.json" file_path = self._service_config_dir / "web_settings.json"
if self._generate_new_web_settings: if self._generate_web_settings:
# File does not exist, create it with default content # File does not exist, create it with default content
logger.debug("Generating web settings file...") logger.debug("Generating web settings file...")
file_path.parent.mkdir( file_path.parent.mkdir(
@ -119,8 +119,7 @@ class WebServer:
"Reading configuration from file '%s' ...", file_path.absolute() "Reading configuration from file '%s' ...", file_path.absolute()
) )
with file_path.open("r", encoding="utf-8") as file: web_settings = json.loads(file_path.read_text())
web_settings = json.load(file)
return web_settings return web_settings

6
tests/server/web_server/test_web_server.py
View File

@ -38,10 +38,14 @@ def test_web_settings() -> None:
observer, observer,
host="0.0.0.0", host="0.0.0.0",
port=8001, port=8001,
generate_new_web_settings=True, generate_web_settings=True,
config_dir=Path(tmp), config_dir=Path(tmp),
) )
new_web_settings = server.web_settings new_web_settings = server.web_settings
# existing entries are not overwritten, new entries are appended # existing entries are not overwritten, new entries are appended
assert new_web_settings == {**web_settings, "added": {"displayName": "added"}} assert new_web_settings == {**web_settings, "added": {"displayName": "added"}}
assert json.loads(web_settings_file.read_text()) == {
**web_settings,
"added": {"displayName": "added"},
}