Remove deprecated API (#1415)

Author: uriyyo

fastapi_pagination/api.py

@@ -14,7 +14,6 @@
 ]
 
 import inspect
-import warnings
 from collections.abc import AsyncIterator, Iterator, Sequence
 from contextlib import AbstractContextManager, ExitStack, asynccontextmanager, contextmanager, suppress
 from contextvars import ContextVar
@@ -37,7 +36,6 @@
 from fastapi.routing import APIRoute, APIRouter
 from pydantic import BaseModel
 from starlette.routing import request_response
-from typing_extensions import deprecated
 
 from .bases import AbstractPage, AbstractParams
 from .default import Page
@@ -81,97 +79,23 @@ def pagination_items() -> Sequence[Any]:
         raise RuntimeError("pagination_items must be called inside create_page") from None
 
 
-_DEPRECATED_PARAM_MSG = """
-'{param}' is no longer can be passed as a positional argument, use keyword argument instead.
-Positional arguments are deprecated and will be removed in the next major release (0.13.0).
-"""
-
-_SENTINEL: Any = object()
-
-
-@overload
 def create_page(
     items: Sequence[T],
     /,
-    **kwargs: Any,
-) -> AbstractPage[T]:
-    pass
-
-
-@overload
-@deprecated(
-    "'total' and 'params' are deprecated parameters, use keyword arguments instead. "
-    "These parameters are deprecated and will be removed in the next major release (0.13.0).",
-)
-def create_page(
-    items: Sequence[T],
-    total: Optional[int] = _SENTINEL,
-    params: Optional[AbstractParams] = _SENTINEL,
-    /,
-    **kwargs: Any,
-) -> AbstractPage[T]:
-    pass
-
-
-def create_page(
-    items: Sequence[T],
-    total: Optional[int] = _SENTINEL,
-    params: Optional[AbstractParams] = _SENTINEL,
-    /,
+    total: Optional[int] = None,
+    params: Optional[AbstractParams] = None,
     **kwargs: Any,
 ) -> AbstractPage[T]:
     """
     Creates an instance of AbstractPage with provided items and optional parameters.
 
-    This function uses positional-only arguments for `items`, `total`, and `params` to enforce explicit naming
-    of these parameters when calling the function.
-    The use of positional-only arguments also prevents the caller from providing these arguments more than once.
-
-    The `total` and `params` parameters are deprecated and may be removed in future versions.
-    Their use will emit a DeprecationWarning.
-
-    Args:
-        items (Sequence[T]): A sequence of items to be included in the page.
-        total (Optional[int], deprecated): The total number of items. If not provided, defaults to _SENTINEL.
-            If 'total' is specified in kwargs, it will raise a TypeError.
-        params (Optional[AbstractParams], deprecated): The parameters for the page.
-        If not provided, defaults to _SENTINEL.
-            If 'params' is specified in kwargs, it will raise a TypeError.
-
-    Keyword Args:
-        **kwargs (Any): Additional parameters. 'total' and 'params' are not allowed in kwargs.
-
     Returns:
         AbstractPage[T]: An instance of AbstractPage containing the provided items and additional parameters.
-
-    Raises:
-        TypeError: If 'total' or 'params' are specified more than once (either as named arguments or in kwargs).
-        DeprecationWarning: If 'total' or 'params' are provided (as these are deprecated parameters).
     """
-
-    if params is not _SENTINEL:
-        if "params" in kwargs:
-            raise TypeError("create_page() got multiple values for argument 'params'")
-
-        kwargs["params"] = params
-
-        warnings.warn(
-            _DEPRECATED_PARAM_MSG.format(param="params"),
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-    if total is not _SENTINEL:
-        if "total" in kwargs:
-            raise TypeError("create_page() got multiple values for argument 'total'")
-
+    if total is not None:
         kwargs["total"] = total
-
-        warnings.warn(
-            _DEPRECATED_PARAM_MSG.format(param="total"),
-            DeprecationWarning,
-            stacklevel=2,
-        )
+    if params is not None:
+        kwargs["params"] = params
 
     with _ctx_var_with_reset(_items_val, items):
         return _page_val.get().create(items, **kwargs)

fastapi_pagination/async_paginator.py

@@ -37,7 +37,7 @@ async def paginate(
 
     return create_page(
         t_items,
-        total=total,
+        total=total,  # type: ignore[arg-type]
         params=params,
         **(additional_data or {}),
     )

fastapi_pagination/bases.py

@@ -11,8 +11,6 @@
     "is_limit_offset",
 ]
 
-import inspect
-import warnings
 from abc import ABC, abstractmethod
 from contextlib import suppress
 from dataclasses import dataclass
@@ -23,10 +21,9 @@
     Generic,
     Optional,
     TypeVar,
-    cast,
 )
 
-from .utils import IS_PYDANTIC_V2, get_caller
+from .utils import IS_PYDANTIC_V2
 
 if IS_PYDANTIC_V2:
     from pydantic import BaseModel as GenericModel
@@ -44,7 +41,7 @@ class PydanticUndefinedAnnotation(Exception):  # type: ignore[no-redef]
 
 from collections.abc import Sequence
 
-from typing_extensions import Self, TypeGuard, deprecated
+from typing_extensions import Self, TypeGuard
 
 from .types import Cursor, GreaterEqualZero, ParamsType
 
@@ -109,36 +106,6 @@ def to_raw_params(self) -> BaseRawParams:
         pass
 
 
-def _new_page_signature(items: Sequence[T], params: AbstractParams, **kwargs: Any) -> type:
-    return int
-
-
-_NEW_SIGNATURE = inspect.signature(_new_page_signature)
-
-
-def _check_for_old_sign(func: Any) -> bool:
-    sign = inspect.signature(func)
-
-    try:
-        sign.bind([], None)
-    except TypeError:
-        return True
-
-    has_kwargs = False
-    pos_params = []
-    for param in sign.parameters.values():
-        if param.kind == param.POSITIONAL_OR_KEYWORD:
-            pos_params.append(param.name)
-        elif param.kind == param.VAR_KEYWORD:
-            has_kwargs = True
-        elif param.kind == param.KEYWORD_ONLY and param.default is inspect.Parameter.empty:
-            return True
-        elif param.kind in {param.POSITIONAL_ONLY, param.VAR_POSITIONAL}:
-            return True
-
-    return not (pos_params == ["items", "params"] and has_kwargs)
-
-
 class AbstractPage(GenericModel, Generic[T], ABC):
     __params_type__: ClassVar[type[AbstractParams]]
 
@@ -166,94 +133,15 @@ def __pydantic_init_subclass__(cls, **kwargs: Any) -> None:
                 with suppress(PydanticUndefinedAnnotation):
                     cls.model_rebuild(force=True)
 
-    def __init_subclass__(cls, **kwargs: Any) -> None:
-        try:
-            is_same = cls.create.__func__ is AbstractPage.create.__func__  # type: ignore[attr-defined]
-        except AttributeError:
-            is_same = False
-
-        if not is_same and _check_for_old_sign(cls.create):
-            warnings.warn(
-                "The signature of the `AbstractPage.create` method has changed. "
-                f"Please, update it to the new one. {_NEW_SIGNATURE}"
-                "\nSupport of old signature will be removed in the next major release (0.13.0).",
-                DeprecationWarning,
-                stacklevel=3,
-            )
-
-        super().__init_subclass__(**kwargs)
-
     @classmethod
     @abstractmethod
     def create(
-        cls: type[C],
-        *args: Any,
-        **kwargs: Any,
-    ) -> C:
-        pass
-
-    @classmethod
-    def _old_customization(
-        cls,
-        custom_params: Optional[type[AbstractParams]] = None,
-        /,
-        *,
-        cls_name: Optional[str] = None,
-        module: Optional[str] = None,
-        **kwargs: Any,
-    ) -> type[Self]:
-        from .customization import CustomizedPage, PageCustomizer, UseModule, UseName, UseParams, UseParamsFields
-
-        args: list[PageCustomizer] = []
-
-        if cls_name:
-            args.append(UseName(cls_name))
-        if module:
-            args.append(UseModule(module))
-        if custom_params:
-            args.append(UseParams(custom_params))
-        if kwargs:
-            args.append(UseParamsFields(**kwargs))
-
-        return cast(type[Self], CustomizedPage[(cls, *args)])
-
-    @classmethod
-    @deprecated(
-        "`with_custom_options` method is deprecated, please use "
-        "`fastapi_pagination.customization.CustomizePage` instead. "
-        "This method will be removed in the next major release (0.13.0)."
-    )
-    def with_custom_options(
         cls,
-        *,
-        cls_name: Optional[str] = None,
-        module: Optional[str] = None,
+        items: Sequence[T],
+        params: AbstractParams,
         **kwargs: Any,
-    ) -> type[Self]:
-        return cls._old_customization(
-            cls_name=cls_name,
-            module=module or get_caller(),
-            **kwargs,
-        )
-
-    @classmethod
-    @deprecated(
-        "`with_params` method is deprecated, please use "
-        "`fastapi_pagination.customization.CustomizePage` instead. "
-        "This method will be removed in the next major release (0.13.0)."
-    )
-    def with_params(
-        cls,
-        custom_params: type[AbstractParams],
-        *,
-        cls_name: Optional[str] = None,
-        module: Optional[str] = None,
-    ) -> type[Self]:
-        return cls._old_customization(
-            custom_params,
-            cls_name=cls_name,
-            module=module or get_caller(),
-        )
+    ) -> Self:
+        pass
 
     if IS_PYDANTIC_V2:
         model_config = {

fastapi_pagination/default.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 __all__ = [
-    "OptionalParams",
     "Page",
     "Params",
 ]
@@ -12,7 +11,6 @@
 
 from fastapi import Query
 from pydantic import BaseModel
-from typing_extensions import deprecated
 
 from .bases import AbstractParams, BasePage, RawParams
 from .types import GreaterEqualOne, GreaterEqualZero
@@ -32,16 +30,6 @@ def to_raw_params(self) -> RawParams:
         )
 
 
-@deprecated(
-    "`OptionalParams` class is deprecated, please use "
-    "`CustomizePage[Page, UseOptionalParams()]` instead. "
-    "This class will be removed in the next major release (0.13.0)."
-)
-class OptionalParams(Params):
-    page: Optional[int] = Query(None, ge=1, description="Page number")  # type: ignore[assignment]
-    size: Optional[int] = Query(None, ge=1, le=100, description="Page size")  # type: ignore[assignment]
-
-
 class Page(BasePage[T], Generic[T]):
     page: Optional[GreaterEqualOne]
     size: Optional[GreaterEqualOne]