🎨 Refactor: Replace direct imports of APP_SETTINGS_KEY with constants in multiple modules

Author: pcrespov

services/web/server/src/simcore_service_webserver/application_settings.py

@@ -4,7 +4,6 @@
 
 from aiohttp import web
 from common_library.basic_types import DEFAULT_FACTORY
-from common_library.exclude import Unset
 from common_library.logging.logging_utils_filtering import LoggerName, MessageSubstring
 from common_library.pydantic_fields_extension import is_nullable
 from models_library.basic_types import LogLevel, PortInt, VersionTag
@@ -608,9 +607,6 @@ def to_client_statics(self) -> dict[str, Any]:
         return {snake_to_camel(k): v for k, v in data.items()}
 
 
-_unset = Unset.VALUE
-
-
 def setup_settings(app: web.Application) -> ApplicationSettings:
     settings: ApplicationSettings = ApplicationSettings.create_from_envs()
     app[APP_SETTINGS_KEY] = settings

services/web/server/src/simcore_service_webserver/constants.py

@@ -1,18 +1,28 @@
 # pylint:disable=unused-import
 
-from typing import Final
+from typing import TYPE_CHECKING, Final
 
+from aiohttp import web
 from common_library.user_messages import user_message
 from servicelib.aiohttp.application_keys import (
     APP_AIOPG_ENGINE_KEY,
     APP_CONFIG_KEY,
     APP_FIRE_AND_FORGET_TASKS_KEY,
-    APP_SETTINGS_KEY,
 )
 from servicelib.aiohttp.request_keys import RQT_USERID_KEY
 
 from ._meta import APP_NAME
 
+if TYPE_CHECKING:
+    # Application settings key - defined here to avoid circular imports
+    from .application_settings import ApplicationSettings
+
+
+APP_SETTINGS_KEY: web.AppKey[ApplicationSettings] = web.AppKey(
+    "APP_SETTINGS_KEY", "ApplicationSettings"  # Use string to avoid import
+)
+
+
 # Application storage keys
 APP_PRODUCTS_KEY: Final[str] = f"{__name__ }.APP_PRODUCTS_KEY"
 

services/web/server/src/simcore_service_webserver/conversations/_controller/_conversations_messages_rest.py

@@ -22,7 +22,6 @@
 from models_library.utils.fastapi_encoders import jsonable_encoder
 from pydantic import BaseModel, ConfigDict
 from servicelib.aiohttp import status
-from servicelib.aiohttp.application_keys import APP_SETTINGS_KEY
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
     parse_request_path_parameters_as,
@@ -32,6 +31,7 @@
 from servicelib.rest_constants import RESPONSE_MODEL_POLICY
 
 from ..._meta import API_VTAG as VTAG
+from ...constants import APP_SETTINGS_KEY
 from ...email import email_service
 from ...fogbugz.settings import FogbugzSettings
 from ...login.decorators import login_required

services/web/server/src/simcore_service_webserver/conversations/plugin.py

@@ -3,9 +3,9 @@
 import logging
 
 from aiohttp import web
-from servicelib.aiohttp.application_keys import APP_SETTINGS_KEY
 from servicelib.aiohttp.application_setup import ModuleCategory, app_module_setup
 
+from ..constants import APP_SETTINGS_KEY
 from ._controller import _conversations_messages_rest, _conversations_rest
 
 _logger = logging.getLogger(__name__)

services/web/server/src/simcore_service_webserver/db/_aiopg.py

@@ -12,7 +12,6 @@
 from aiopg.sa import Engine, create_engine
 from common_library.json_serialization import json_dumps
 from servicelib.aiohttp.aiopg_utils import is_pg_responsive
-from servicelib.aiohttp.application_keys import APP_AIOPG_ENGINE_KEY
 from servicelib.logging_utils import log_context
 from servicelib.retry_policies import PostgresRetryPolicyUponInitialization
 from simcore_postgres_database.aiopg_errors import DBAPIError
@@ -25,6 +24,7 @@
 from tenacity import retry
 
 from .._meta import APP_NAME
+from ..constants import APP_AIOPG_ENGINE_KEY
 from .settings import PostgresSettings, get_plugin_settings
 
 _logger = logging.getLogger(__name__)

services/web/server/src/simcore_service_webserver/db/plugin.py

@@ -4,9 +4,9 @@
 from typing import Final
 
 from aiohttp import web
-from servicelib.aiohttp.application_keys import APP_AIOPG_ENGINE_KEY
 from servicelib.aiohttp.application_setup import ModuleCategory, app_module_setup
 
+from ..constants import APP_AIOPG_ENGINE_KEY
 from . import _aiopg, _asyncpg
 
 _logger = logging.getLogger(__name__)

services/web/server/src/simcore_service_webserver/diagnostics/settings.py

@@ -7,9 +7,10 @@
     ValidationInfo,
     field_validator,
 )
-from servicelib.aiohttp.application_keys import APP_SETTINGS_KEY
 from settings_library.base import BaseCustomSettings
 
+from ..constants import APP_SETTINGS_KEY
+
 
 class DiagnosticsSettings(BaseCustomSettings):
     DIAGNOSTICS_SLOW_DURATION_SECS: PositiveFloat = Field(

services/web/server/src/simcore_service_webserver/director_v2/_client.py

@@ -26,10 +26,6 @@
 
 SERVICE_HEALTH_CHECK_TIMEOUT = ClientTimeout(total=2, connect=1)
 
-APP_DIRECTOR_V2_CLIENT_KEY: Final = web.AppKey(
-    "APP_DIRECTOR_V2_CLIENT_KEY", "DirectorV2RestClient"
-)
-
 
 async def is_healthy(app: web.Application) -> bool:
     try:
@@ -104,6 +100,11 @@ async def stop_computation(self, project_id: ProjectID, user_id: UserID):
         )
 
 
+APP_DIRECTOR_V2_CLIENT_KEY: Final = web.AppKey(
+    "APP_DIRECTOR_V2_CLIENT_KEY", DirectorV2RestClient
+)
+
+
 def set_directorv2_client(app: web.Application, obj: DirectorV2RestClient):
     app[APP_DIRECTOR_V2_CLIENT_KEY] = obj
 

services/web/server/src/simcore_service_webserver/director_v2/plugin.py

@@ -1,13 +1,13 @@
 import logging
 
 from aiohttp import web
-from servicelib.aiohttp.application_keys import APP_SETTINGS_KEY
 from servicelib.aiohttp.application_setup import (
     ModuleCategory,
     app_module_setup,
     is_setup_completed,
 )
 
+from ..constants import APP_SETTINGS_KEY
 from ..rest.plugin import setup_rest
 from . import _controller
 from ._client import DirectorV2RestClient, get_directorv2_client, set_directorv2_client

services/web/server/src/simcore_service_webserver/director_v2/settings.py

@@ -1,5 +1,4 @@
-""" director v2 susystem configuration
-"""
+"""director v2 susystem configuration"""
 
 from functools import cached_property
 from typing import cast