renaming service configuration dir parameter

This commit is contained in:
Mose Müller
2023-12-21 13:36:08 +01:00
parent a303ba7f0b
commit 53be794a3c

View File

@ -34,11 +34,11 @@ class WebServer:
files directory. It also initializes web server settings based on configuration files directory. It also initializes web server settings based on configuration
files or generates default settings if necessary. files or generates default settings if necessary.
Configuration for the web server (like service settings directory and whether to Configuration for the web server (like service configuration directory and whether
generate new web settings) is determined in the following order of precedence: to generate new web settings) is determined in the following order of precedence:
1. Values provided directly to the constructor. 1. Values provided directly to the constructor.
2. Environment variable settings (via configuration classes like ServiceConfig and 2. Environment variable settings (via configuration classes like `ServiceConfig` and
WebServerConfig). `WebServerConfig`).
3. Default values defined in the configuration classes. 3. Default values defined in the configuration classes.
Args: Args:
@ -52,7 +52,7 @@ class WebServer:
frontend. If None, no custom styles are applied. Defaults to None. frontend. If None, no custom styles are applied. Defaults to None.
enable_cors (bool, optional): Flag to enable or disable CORS policy. When True, enable_cors (bool, optional): Flag to enable or disable CORS policy. When True,
CORS is enabled, allowing cross-origin requests. Defaults to True. CORS is enabled, allowing cross-origin requests. Defaults to True.
service_settings_dir (Path | None, optional): Path to the configuration service_config_dir (Path | None, optional): Path to the configuration
directory where the web settings will be stored. Defaults to None. directory where the web settings will be stored. Defaults to None.
generate_new_web_settings (bool | None, optional): Flag to enable or disable generate_new_web_settings (bool | None, optional): Flag to enable or disable
generation of new web settings if the configuration file is missing. Defaults generation of new web settings if the configuration file is missing. Defaults
@ -67,7 +67,7 @@ class WebServer:
port: int, port: int,
css: str | Path | None = None, css: str | Path | None = None,
enable_cors: bool = True, enable_cors: bool = True,
service_settings_dir: Path | None = None, service_config_dir: Path | None = None,
generate_new_web_settings: bool | None = None, generate_new_web_settings: bool | None = None,
**kwargs: Any, **kwargs: Any,
) -> None: ) -> None:
@ -79,8 +79,8 @@ class WebServer:
self.css = css self.css = css
self.enable_cors = enable_cors self.enable_cors = enable_cors
self._service_config_dir = ( self._service_config_dir = (
service_settings_dir service_config_dir
if service_settings_dir is not None if service_config_dir is not None
else ServiceConfig().service_config_dir else ServiceConfig().service_config_dir
) )
self._generate_new_web_settings = ( self._generate_new_web_settings = (