✨ Refactor string truncation types to use Annotated with StringConstraints and trim_string_before

Author: pcrespov

packages/models-library/src/models_library/basic_types.py

@@ -14,6 +14,7 @@
     SIMPLE_VERSION_RE,
     UUID_RE,
 )
+from .utils.common_validators import trim_string_before
 
 assert issubclass(LogLevel, Enum)  # nosec
 assert issubclass(BootModeEnum, Enum)  # nosec
@@ -150,32 +151,36 @@ def concatenate(*args: "IDStr", link_char: str = " ") -> "IDStr":
         return IDStr(result)
 
 
-class ShortTruncatedStr(ConstrainedStr):
-    """A truncated string used to input e.g. titles or display names
-
-       - Strips whitespaces and truncate strings that exceed the specified characters limit (curtail_length).
-       - Ensures that the **input** data length to the API is controlled and prevents exceeding large inputs silently,
-       i.e. without raising errors.
-
-    SEE https://github.com/ITISFoundation/osparc-simcore/pull/5989#discussion_r1650506583
-
-    DEPRECATED: Use instead Annotated[str, StringConstraints(strip_whitespace=True), trim_string_before(max_length=600)]
-    """
-
-    strip_whitespace = True
-    curtail_length = 600
-
-
-class LongTruncatedStr(ConstrainedStr):
-    """Use to input e.g. descriptions or summaries
-
-    Analogous to ShortTruncatedStr
-
-    DEPRECATED: Use instead Annotated[str, StringConstraints(strip_whitespace=True), trim_string_before(max_length=65536)]
-    """
+_SHORT_TRUNCATED_STR_MAX_LENGTH: Final[int] = 600
+ShortTruncatedStr: TypeAlias = Annotated[
+    str,
+    StringConstraints(strip_whitespace=True),
+    trim_string_before(max_length=_SHORT_TRUNCATED_STR_MAX_LENGTH),
+    annotated_types.doc(
+        """
+        A truncated string used to input e.g. titles or display names.
+        Strips whitespaces and truncate strings that exceed the specified characters limit (curtail_length).
+        Ensures that the **input** data length to the API is controlled and prevents exceeding large inputs silently,
+        i.e. without raising errors.
+        """
+        # SEE https://github.com/ITISFoundation/osparc-simcore/pull/5989#discussion_r1650506583
+    ),
+]
 
-    strip_whitespace = True
-    curtail_length = 65536  # same as github descripton
+_LONG_TRUNCATED_STR_MAX_LENGTH: Final[int] = 65536  # same as github description
+LongTruncatedStr: TypeAlias = Annotated[
+    str,
+    StringConstraints(strip_whitespace=True),
+    trim_string_before(max_length=_LONG_TRUNCATED_STR_MAX_LENGTH),
+    annotated_types.doc(
+        """
+        A truncated string used to input e.g. descriptions or summaries.
+        Strips whitespaces and truncate strings that exceed the specified characters limit (curtail_length).
+        Ensures that the **input** data length to the API is controlled and prevents exceeding large inputs silently,
+        i.e. without raising errors.
+        """
+    ),
+]
 
 
 # auto-incremented primary-key IDs

packages/models-library/tests/test_basic_types.py

@@ -2,6 +2,7 @@
 
 import pytest
 from models_library.basic_types import (
+    _SHORT_TRUNCATED_STR_MAX_LENGTH,
     EnvVarKey,
     IDStr,
     MD5Str,
@@ -76,16 +77,13 @@ def test_string_identifier_constraint_type():
 
 
 def test_short_truncated_string():
+    curtail_length = _SHORT_TRUNCATED_STR_MAX_LENGTH
     assert (
-        TypeAdapter(ShortTruncatedStr).validate_python(
-            "X" * ShortTruncatedStr.curtail_length
-        )
-        == "X" * ShortTruncatedStr.curtail_length
+        TypeAdapter(ShortTruncatedStr).validate_python("X" * curtail_length)
+        == "X" * curtail_length
     )
 
     assert (
-        TypeAdapter(ShortTruncatedStr).validate_python(
-            "X" * (ShortTruncatedStr.curtail_length + 1)
-        )
-        == "X" * ShortTruncatedStr.curtail_length
+        TypeAdapter(ShortTruncatedStr).validate_python("X" * (curtail_length + 1))
+        == "X" * curtail_length
     )

packages/models-library/tests/test_projects.py

@@ -7,7 +7,8 @@
 
 import pytest
 from faker import Faker
-from models_library.api_schemas_webserver.projects import LongTruncatedStr, ProjectPatch
+from models_library.api_schemas_webserver.projects import ProjectPatch
+from models_library.basic_types import _LONG_TRUNCATED_STR_MAX_LENGTH
 from models_library.projects import Project
 
 
@@ -47,8 +48,7 @@ def test_project_with_thumbnail_as_empty_string(minimal_project: dict[str, Any])
 
 def test_project_patch_truncates_description():
     # NOTE: checks https://github.com/ITISFoundation/osparc-simcore/issues/5988
-    assert LongTruncatedStr.curtail_length
-    len_truncated = int(LongTruncatedStr.curtail_length)
+    len_truncated = _LONG_TRUNCATED_STR_MAX_LENGTH
 
     long_description = "X" * (len_truncated + 10)
     assert len(long_description) > len_truncated