fix pagination urls type

Author: giancarloromeo

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

@@ -3,8 +3,7 @@
 from re import Pattern
 from typing import Annotated, Final, TypeAlias
 
-import pydantic
-from pydantic import Field, PositiveInt, StringConstraints
+from pydantic import Field, HttpUrl, PositiveInt, StringConstraints
 from pydantic_core import core_schema
 
 from .basic_regex import (
@@ -130,9 +129,6 @@ class LongTruncatedStr(ConstrainedStr):
 IdInt: TypeAlias = PositiveInt
 PrimaryKeyInt: TypeAlias = PositiveInt
 
-AnyHttpUrl = Annotated[str, pydantic.AnyHttpUrl]
-
-HttpUrl = Annotated[str, pydantic.HttpUrl]
 
 # https e.g. https://techterms.com/definition/https
 class HttpSecureUrl(HttpUrl):

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

@@ -3,6 +3,7 @@
 from pydantic import (
     AnyHttpUrl,
     BaseModel,
+    BeforeValidator,
     ConfigDict,
     Field,
     NonNegativeInt,
@@ -14,13 +15,17 @@
 
 from .utils.common_validators import none_to_empty_list_pre_validator
 
+_ANY_HTTP_URL_ADAPTER: TypeAdapter = TypeAdapter(AnyHttpUrl)
+
 # Default limit values
 #  - Using same values across all pagination entrypoints simplifies
 #    interconnecting paginated calls
 MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE: Final[int] = 50
 
 
-PageLimitInt: TypeAlias = Annotated[int, Field(ge=1, lt=MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE)]
+PageLimitInt: TypeAlias = Annotated[
+    int, Field(ge=1, lt=MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE)
+]
 
 DEFAULT_NUMBER_OF_ITEMS_PER_PAGE: Final[PageLimitInt] = TypeAdapter(
     PageLimitInt
@@ -92,7 +97,14 @@ class PageRefs(BaseModel, Generic[RefT]):
     model_config = ConfigDict(extra="forbid")
 
 
-class PageLinks(PageRefs[Annotated[str, AnyHttpUrl]]):
+class PageLinks(
+    PageRefs[
+        Annotated[
+            str,
+            BeforeValidator(lambda x: str(_ANY_HTTP_URL_ADAPTER.validate_python(x))),
+        ]
+    ]
+):
     ...
 
 

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

@@ -1,9 +1,8 @@
 from math import ceil
 from typing import Any, Protocol, TypedDict, Union, runtime_checkable
 
-from pydantic import TypeAdapter
+from pydantic import AnyHttpUrl, TypeAdapter
 
-from .basic_types import AnyHttpUrl
 from .rest_pagination import PageLinks, PageMetaInfoLimitOffset
 
 # NOTE: In this repo we use two type of URL-like data structures:
@@ -30,6 +29,7 @@ def replace_query_params(self, **kwargs: Any) -> "_StarletteURL":
 
 
 _URLType = Union[_YarlURL, _StarletteURL]
+_ANY_HTTP_URL_ADAPTER: TypeAdapter = TypeAdapter(AnyHttpUrl)
 
 
 def _replace_query(url: _URLType, query: dict[str, Any]) -> str:
@@ -73,29 +73,29 @@ def paginate_data(
         ),
         _links=PageLinks(
             self=(
-                TypeAdapter(AnyHttpUrl).validate_python(
+                _ANY_HTTP_URL_ADAPTER.validate_python(
                     _replace_query(request_url, {"offset": offset, "limit": limit}),
                 )
             ),
-            first=TypeAdapter(AnyHttpUrl).validate_python(
+            first=_ANY_HTTP_URL_ADAPTER.validate_python(
                 _replace_query(request_url, {"offset": 0, "limit": limit})
             ),
-            prev=TypeAdapter(AnyHttpUrl).validate_python(
+            prev=_ANY_HTTP_URL_ADAPTER.validate_python(
                 _replace_query(
                     request_url, {"offset": max(offset - limit, 0), "limit": limit}
                 ),
             )
             if offset > 0
             else None,
-            next=TypeAdapter(AnyHttpUrl).validate_python(
+            next=_ANY_HTTP_URL_ADAPTER.validate_python(
                 _replace_query(
                     request_url,
                     {"offset": min(offset + limit, last_page * limit), "limit": limit},
                 ),
             )
             if offset < (last_page * limit)
             else None,
-            last=TypeAdapter(AnyHttpUrl).validate_python(
+            last=_ANY_HTTP_URL_ADAPTER.validate_python(
                 _replace_query(
                     request_url, {"offset": last_page * limit, "limit": limit}
                 ),

packages/models-library/tests/test_rest_pagination_utils.py

@@ -75,7 +75,7 @@ def test_paginating_data(base_url):
         offset += len(data_chunk)
         assert model_instance.links.next is not None
 
-        data_obj: PageDict = paginate_data(
+        data_obj: PageDict = paginate_data(  # type: ignore[no-redef]
             data_chunk,
             request_url=URL(model_instance.links.next),
             total=total_number_of_items,
@@ -127,7 +127,7 @@ def test_paginating_data(base_url):
     assert offset == last_chunk_offset
 
     assert model_instance.links.next is not None
-    data_obj: PageDict = paginate_data(
+    data_obj: PageDict = paginate_data(  # type: ignore[no-redef]
         data_chunk,
         request_url=URL(model_instance.links.next),
         total=total_number_of_items,