Merge pull request #202 from uriyyo/feature/remove-deprecated-api

♻️ Remove deprecated API

Author: uriyyo

fastapi_pagination/__init__.py

@@ -1,34 +1,23 @@
 from .api import (
     add_pagination,
     create_page,
-    pagination_params,
     request,
     resolve_params,
     response,
     set_page,
-    use_as_page,
-    using_page,
-    using_params,
-    using_response,
 )
-from .default import Page, PaginationParams, Params
+from .default import Page, Params
 from .limit_offset import LimitOffsetPage, LimitOffsetParams
 from .paginator import paginate
 
 __all__ = [
     "add_pagination",
     "create_page",
-    "pagination_params",
     "request",
     "resolve_params",
     "response",
     "set_page",
-    "use_as_page",
-    "using_page",
-    "using_params",
-    "using_response",
     "Page",
-    "PaginationParams",
     "Params",
     "LimitOffsetPage",
     "LimitOffsetParams",

fastapi_pagination/api.py

@@ -1,19 +1,6 @@
 import inspect
-import warnings
-from contextlib import contextmanager
 from contextvars import ContextVar
-from typing import (
-    Any,
-    Awaitable,
-    Callable,
-    ContextManager,
-    Iterator,
-    Optional,
-    Sequence,
-    Type,
-    TypeVar,
-    cast,
-)
+from typing import Awaitable, Callable, Optional, Sequence, Type, TypeVar, cast
 
 from fastapi import Depends, FastAPI, Request, Response
 from fastapi.dependencies.utils import (
@@ -23,8 +10,7 @@
 from fastapi.routing import APIRoute, APIRouter
 
 from .bases import AbstractPage, AbstractParams
-from .default import Page, Params
-from .utils import deprecated
+from .default import Page
 
 T = TypeVar("T")
 TAbstractParams = TypeVar("TAbstractParams", covariant=True, bound=AbstractParams)
@@ -133,61 +119,11 @@ def add_pagination(parent: ParentT) -> ParentT:
     return parent
 
 
-@deprecated
-def using_params(
-    params_type: Type[TAbstractParams],
-) -> Callable[[TAbstractParams], Awaitable[TAbstractParams]]:  # pragma: no cover
-    async def _pagination_params(*args, **kwargs) -> params_type:  # type: ignore
-        params = params_type(*args, **kwargs)  # type: ignore
-        params_value.set(params)
-        return params
-
-    _pagination_params.__signature__ = inspect.signature(params_type)  # type: ignore
-
-    return _pagination_params
-
-
-with warnings.catch_warnings():
-    warnings.simplefilter("ignore")
-    pagination_params = using_params(Params)
-
-
-@deprecated
-def using_page(page: Type[AbstractPage]) -> ContextManager[None]:  # pragma: no cover
-    token = page_type.set(page)
-
-    @contextmanager
-    def _reset() -> Iterator[None]:
-        try:
-            yield
-        finally:
-            page_type.reset(token)
-
-    return _reset()
-
-
-@deprecated
-def use_as_page(page: Any) -> Any:  # pragma: no cover
-    using_page(page)
-    return page
-
-
-@deprecated
-async def using_response(res: Response) -> None:  # pragma: no cover
-    response_value.set(res)
-
-
 __all__ = [
     "add_pagination",
     "create_page",
     "resolve_params",
     "response",
     "request",
     "set_page",
-    # deprecated api
-    "using_response",
-    "using_params",
-    "using_page",
-    "use_as_page",
-    "pagination_params",
 ]

fastapi_pagination/default.py

@@ -1,12 +1,11 @@
 from __future__ import annotations
 
-from typing import Any, Generic, Sequence, TypeVar
+from typing import Generic, Sequence, TypeVar
 
 from fastapi import Query
 from pydantic import BaseModel, conint
 
 from .bases import AbstractParams, BasePage, RawParams
-from .utils import deprecated
 
 T = TypeVar("T")
 
@@ -22,12 +21,6 @@ def to_raw_params(self) -> RawParams:
         )
 
 
-class PaginationParams(Params):
-    @deprecated  # type: ignore
-    def __init__(self, **kwargs: Any) -> None:  # pragma: no cover
-        super().__init__(**kwargs)
-
-
 class Page(BasePage[T], Generic[T]):
     page: conint(ge=1)  # type: ignore
     size: conint(ge=1)  # type: ignore
@@ -55,5 +48,4 @@ def create(
 __all__ = [
     "Params",
     "Page",
-    "PaginationParams",
 ]