Bump to next version, add docs regarding migration to v0.14.0

Author: uriyyo

docs/v0_14_migration.md

@@ -0,0 +1,36 @@
+# Breaking Changes in v0.14
+
+## 1. `total` becomes required by default
+
+`total` field now becomes required in `Page` and `LimitOffsetPage` classes.
+It was previously optional, but now it is required for non-optional pages.
+
+## 2. `UseIncludeTotal` updates `total` field type.
+
+`UseIncludeTotal` customization now updates `total` field to required or optional based on its value.
+
+## 3. `CursorPage` now includes `total` field by default
+
+`CursorPage` class now includes `total` field by default.
+Now all pages have same default behavior regarding `total` field.
+
+You can still use `UseIncludeTotal` to disable `total` field in `CursorPage`.
+
+```python
+from typing import TypeVar
+
+from fastapi_pagination.cursor import CursorPage
+from fastapi_pagination.customization import UseIncludeTotal, CustomizedPage
+
+T = TypeVar("T")
+
+CursorPageNoTotal = CustomizedPage[
+    CursorPage[T],
+    UseIncludeTotal(False),
+]
+
+```
+
+## 4. `beanie` min version update
+
+`beanie` package now requires version `2.0.0` or higher.

fastapi_pagination/customization.py

@@ -352,7 +352,7 @@ def _make_field_optional(field: Any) -> Any:
 
         field = copy(field)
 
-        field.annotation = Optional[field.annotation]  # type: ignore[assignment]
+        field.annotation = Optional[field.annotation]
         field.default = None
         field.default_factory = None
 
@@ -389,7 +389,7 @@ def _make_field_required(field: Any) -> Any:
         assert isinstance(field, _PydanticField)
 
         field = copy(field)
-        field.required = True  # type: ignore[attr-defined]
+        field.required = True
         field.default = ...
         field.default_factory = None
 

fastapi_pagination/ext/sqlmodel.py

@@ -110,7 +110,7 @@ def paginate(
             session,
             query,
             params,
-            count_query=count_query,
+            count_query=count_query,  # type: ignore[arg-type]
             subquery_count=subquery_count,
             transformer=transformer,
             additional_data=additional_data,
@@ -122,7 +122,7 @@ def paginate(
         session,
         query,
         params,
-        count_query=count_query,
+        count_query=count_query,  # type: ignore[arg-type]
         subquery_count=subquery_count,
         transformer=transformer,  # type: ignore[arg-type]
         additional_data=additional_data,

mkdocs.yml

@@ -90,6 +90,7 @@ nav:
           - "Cursor Pagination": integrations/sqlalchemy/cursor_pagination.md
           - "Relationships": integrations/sqlalchemy/relationships.md
   - "Migration to v0.13.x": "v0_13_migration.md"
+  - "Migration to v0.14.x": "v0_14_migration.md"
   - "FAQ":
       - "FAQ": faq/faq.md
   - "Contributing": contributing.md

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-pagination"
-version = "0.13.2"
+version = "0.14.0b1"
 description = "FastAPI pagination"
 authors = [
     { name = "Yurii Karabas", email = "[email protected]" },
@@ -53,31 +53,11 @@ piccolo = ["piccolo>=0.89,<1.25"]
 motor = ["motor>=3.6.0,<4.0.0"]
 bunnet = ["bunnet>=1.1.0,<2"]
 mongoengine = ["mongoengine>=0.23.1,<0.30.0"]
-beanie = ["beanie>=1.25.0"]
+beanie = ["beanie>=2.0.0"]
 scylla-driver = ["scylla-driver>=3.25.6,<4"]
 odmantic = ["odmantic>=1.0.2,<2"]
 elasticsearch = ["elasticsearch-dsl>=8.13.0,<9"]
 firestore = ["google-cloud-firestore>=2.19.0,<3"]
-all = [
-    "sqlmodel>=0.0.22",
-    "SQLAlchemy>=1.3.20",
-    "databases>=0.6.0",
-    "orm>=0.3.1",
-    "odmantic>=1.0.2,<2",
-    "tortoise-orm>=0.22.0",
-    "asyncpg>=0.24.0",
-    "django<6.0.0",
-    "piccolo>=0.89,<1.25",
-    "motor>=3.6.0,<4.0.0",
-    "mongoengine>=0.23.1,<0.30.0",
-    "pony>=0.7.16,<0.8",
-    "beanie>=1.25.0",
-    "sqlakeyset>=2.0.1680321678,<3",
-    "scylla-driver>=3.25.6,<4",
-    "bunnet>=1.1.0,<2",
-    "elasticsearch-dsl>=8.13.0,<9",
-    "google-cloud-firestore>=2.19.0,<3",
-]
 
 [project.urls]
 Repository = "https://github.com/uriyyo/fastapi-pagination"