moved to common library

Author: Andrei Neagu

packages/common-library/requirements/_test.in

@@ -10,6 +10,7 @@
 
 coverage
 faker
+pydantic-settings
 pytest
 pytest-asyncio
 pytest-cov

packages/common-library/requirements/_test.txt

@@ -1,8 +1,12 @@
+annotated-types==0.7.0
+    # via
+    #   -c requirements/_base.txt
+    #   pydantic
 coverage==7.6.1
     # via
     #   -r requirements/_test.in
     #   pytest-cov
-faker==30.1.0
+faker==30.3.0
     # via -r requirements/_test.in
 icdiff==2.0.7
     # via pytest-icdiff
@@ -16,6 +20,17 @@ pluggy==1.5.0
     # via pytest
 pprintpp==0.4.0
     # via pytest-icdiff
+pydantic==2.9.2
+    # via
+    #   -c requirements/../../../requirements/constraints.txt
+    #   -c requirements/_base.txt
+    #   pydantic-settings
+pydantic-core==2.23.4
+    # via
+    #   -c requirements/_base.txt
+    #   pydantic
+pydantic-settings==2.5.2
+    # via -r requirements/_test.in
 pytest==8.3.3
     # via
     #   -r requirements/_test.in
@@ -44,7 +59,9 @@ pytest-sugar==1.0.0
 python-dateutil==2.9.0.post0
     # via faker
 python-dotenv==1.0.1
-    # via -r requirements/_test.in
+    # via
+    #   -r requirements/_test.in
+    #   pydantic-settings
 six==1.16.0
     # via python-dateutil
 termcolor==2.5.0
@@ -53,3 +70,5 @@ typing-extensions==4.12.2
     # via
     #   -c requirements/_base.txt
     #   faker
+    #   pydantic
+    #   pydantic-core

packages/common-library/requirements/_tools.txt

@@ -1,6 +1,6 @@
 astroid==3.3.5
     # via pylint
-black==24.8.0
+black==24.10.0
     # via -r requirements/../../../requirements/devenv.txt
 build==1.2.2.post1
     # via pip-tools

packages/common-library/src/common_library/pydantic_networks_extension.py

@@ -1,5 +1,12 @@
 from typing import Annotated, TypeAlias
+
 from pydantic import AfterValidator, AnyHttpUrl
 
 
-AnyHttpUrlLegacy: TypeAlias = Annotated[str, AnyHttpUrl, AfterValidator(lambda u: u.rstrip("/"))]
+def _strip_last_slash(url: str) -> str:
+    return url.rstrip("/")
+
+
+AnyHttpUrlLegacy: TypeAlias = Annotated[
+    str, AnyHttpUrl, AfterValidator(_strip_last_slash)
+]

packages/common-library/src/common_library/pydantic_settings_validators.py

@@ -0,0 +1,20 @@
+import datetime
+
+from pydantic import field_validator
+
+
+def _get_float_string_as_seconds(
+    v: datetime.timedelta | str | float,
+) -> datetime.timedelta | float | str:
+    if isinstance(v, str):
+        try:
+            return float(v)
+        except ValueError:
+            # returns format like "1:00:00"
+            return v
+    return v
+
+
+def validate_timedelta_in_legacy_mode(field: str):
+    """Transforms a float/int number into a valid datetime as it used to work in the past"""
+    return field_validator(field, mode="before")(_get_float_string_as_seconds)

packages/common-library/tests/test_pydantic_settings_validators.py

@@ -0,0 +1,42 @@
+from datetime import timedelta
+
+import pytest
+from common_library.pydantic_settings_validators import (
+    validate_timedelta_in_legacy_mode,
+)
+from faker import Faker
+from pydantic import Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
+
+
+def test_validate_timedelta_in_legacy_mode(
+    monkeypatch: pytest.MonkeyPatch, faker: Faker
+):
+    class Settings(BaseSettings):
+        APP_NAME: str
+        REQUEST_TIMEOUT: timedelta = Field(default=timedelta(seconds=40))
+
+        _legacy_parsing_request_timeout = validate_timedelta_in_legacy_mode(
+            "REQUEST_TIMEOUT"
+        )
+
+        model_config = SettingsConfigDict()
+
+    app_name = faker.pystr()
+    env_vars: dict[str, str] = {"APP_NAME": app_name}
+
+    # without timedelta
+    setenvs_from_dict(monkeypatch, env_vars)
+    settings = Settings()
+    print(settings.model_dump())
+    assert settings.APP_NAME == app_name
+    assert settings.REQUEST_TIMEOUT == timedelta(seconds=40)
+
+    # with timedelta in seconds
+    env_vars["REQUEST_TIMEOUT"] = "5555"
+    setenvs_from_dict(monkeypatch, env_vars)
+    settings = Settings()
+    print(settings.model_dump())
+    assert settings.APP_NAME == app_name
+    assert settings.REQUEST_TIMEOUT == timedelta(seconds=5555)

services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/core/settings.py

@@ -1,7 +1,10 @@
 import datetime
 from functools import cached_property
 
-from pydantic import Field, field_validator, parse_obj_as, validator
+from common_library.pydantic_settings_validators import (
+    validate_timedelta_in_legacy_mode,
+)
+from pydantic import Field, parse_obj_as, validator
 from settings_library.application import BaseApplicationSettings
 from settings_library.basic_types import LogLevel, VersionTag
 from settings_library.director_v2 import DirectorV2Settings
@@ -43,22 +46,9 @@ class _BaseApplicationSettings(BaseApplicationSettings, MixinLoggingSettings):
         ),
     )
 
-    # TODO: this should be a common validator put in some common library and not here to allow reuse
-    # wherever we used timedelta this should be in place otherwise it will fail where we overwrite the
-    # values via env vars
-    # GCR we need to talk where to place this one
-    @field_validator("DYNAMIC_SCHEDULER_STOP_SERVICE_TIMEOUT", mode="before")
-    @classmethod
-    def interpret_t_as_seconds(
-        cls, v: datetime.timedelta | str | float
-    ) -> datetime.timedelta | float | str:
-        if isinstance(v, str):
-            try:
-                return float(v)
-            except ValueError:
-                # returns format like "1:00:00"
-                return v
-        return v
+    _legacy_parsing_dynamic_scheduler_stop_service_timeout = (
+        validate_timedelta_in_legacy_mode("DYNAMIC_SCHEDULER_STOP_SERVICE_TIMEOUT")
+    )
 
     @cached_property
     def LOG_LEVEL(self):  # noqa: N802