udata-hydra-csvapi 0.4.3.dev2__py3-none-any.whl → 0.4.3.dev3__py3-none-any.whl

api_tabular/core/query.py

@@ -56,7 +56,7 @@ def build_sql_query_string(
                     agg_query += f'"{column[1:-1]}__{operator}":{column}.{operator}(),'
         # we pop the trailing comma (it's always there, by construction)
         sql_query.append(agg_query[:-1])
-    if page_size:
+    if page_size is not None:
         sql_query.append(f"limit={page_size}")
     if offset >= 1:
         sql_query.append(f"offset={offset}")

api_tabular/core/swagger.py

@@ -2,6 +2,7 @@ from typing import cast
 
 import yaml
 
+from api_tabular import config
 from api_tabular.core.utils import is_aggregation_allowed
 
 TYPE_POSSIBILITIES = {
@@ -165,9 +166,9 @@ def swagger_parameters(resource_columns: dict, resource_id: str) -> list:
         {
             "name": "page",
             "in": "query",
-            "description": "Specific page (page=value)",
+            "description": "Specific page, starting at 1 (page=value)",
             "required": False,
-            "schema": {"type": "integer"},
+            "schema": {"type": "integer", "minimum": 1},
             "example": 1,
         },
         {
@@ -175,7 +176,7 @@ def swagger_parameters(resource_columns: dict, resource_id: str) -> list:
             "in": "query",
             "description": "Number of results per page (page_size=value)",
             "required": False,
-            "schema": {"type": "integer"},
+            "schema": {"type": "integer", "minimum": 1, "maximum": config.PAGE_SIZE_MAX},
             "example": 20,
         },
         {

api_tabular/core/utils.py

@@ -1,3 +1,5 @@
+from collections.abc import Mapping
+
 from aiohttp.client import ClientResponse
 from aiohttp.web_response import Response
 
@@ -19,7 +21,24 @@ def process_total(res: Response | ClientResponse) -> int:
     return int(str_total)
 
 
-def build_offset(page: int, page_size: int) -> int:
+def _parse_int_param(query: Mapping[str, str], name: str, label: str, default: int) -> int:
+    raw = query.get(name)
+    if raw is None:
+        return default
+    try:
+        return int(raw)
+    except ValueError:
+        raise QueryException(400, None, "Invalid query string", f"{label} must be an integer")
+
+
+def parse_pagination(query: Mapping[str, str]) -> tuple[int, int, int]:
+    """Return (page, page_size, offset) from the query, raising a 400 on invalid values"""
+    page = _parse_int_param(query, "page", "Page", 1)
+    page_size = _parse_int_param(query, "page_size", "Page size", config.PAGE_SIZE_DEFAULT)
+    if page < 1:
+        raise QueryException(400, None, "Invalid query string", "Page must be at least 1")
+    if page_size < 1:
+        raise QueryException(400, None, "Invalid query string", "Page size must be at least 1")
     if page_size > config.PAGE_SIZE_MAX:
         raise QueryException(
             400,
@@ -27,4 +46,4 @@ def build_offset(page: int, page_size: int) -> int:
             "Invalid query string",
             f"Page size exceeds allowed maximum: {config.PAGE_SIZE_MAX}",
         )
-    return page_size * (page - 1) if page > 1 else 0
+    return page, page_size, page_size * (page - 1)

api_tabular/metrics/app.py

@@ -14,7 +14,7 @@ from api_tabular.core.health import check_health
 from api_tabular.core.query import build_sql_query_string
 from api_tabular.core.sentry import get_sentry_kwargs
 from api_tabular.core.url import build_link_with_page
-from api_tabular.core.utils import build_offset, process_total
+from api_tabular.core.utils import parse_pagination, process_total
 from api_tabular.core.version import get_app_version
 
 routes = web.RouteTableDef()
@@ -40,10 +40,7 @@ async def metrics_data(request):
     """
     model = request.match_info["model"]
     query_string = request.query_string.split("&") if request.query_string else []
-    page = int(request.query.get("page", "1"))
-    page_size = int(request.query.get("page_size", config.PAGE_SIZE_DEFAULT))
-
-    offset = build_offset(page, page_size)
+    page, page_size, offset = parse_pagination(request.query)
     try:
         sql_query = build_sql_query_string(query_string, page_size=page_size, offset=offset)
     except ValueError as e:

api_tabular/tabular/app.py

@@ -12,7 +12,7 @@ from api_tabular.core.health import check_health
 from api_tabular.core.sentry import get_sentry_kwargs
 from api_tabular.core.swagger import build_swagger_file
 from api_tabular.core.url import build_link_with_page, url_for
-from api_tabular.core.utils import build_offset
+from api_tabular.core.utils import parse_pagination
 from api_tabular.core.version import get_app_version
 from api_tabular.tabular.utils import (
     get_potential_indexes,
@@ -97,10 +97,7 @@ def build_next_page(
 async def resource_data(request):
     resource_id = request.match_info["rid"]
     query_string = request.query_string.split("&") if request.query_string else []
-    page = int(request.query.get("page", "1"))
-    page_size = int(request.query.get("page_size", config.PAGE_SIZE_DEFAULT))
-
-    offset = build_offset(page, page_size)
+    page, page_size, offset = parse_pagination(request.query)
 
     sql_query = await try_build_query(request, query_string, resource_id, page_size, offset)
     resource = await get_resource(request.app["csession"], resource_id, ["parsing_table"])

{udata_hydra_csvapi-0.4.3.dev2.dist-info → udata_hydra_csvapi-0.4.3.dev3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: udata-hydra-csvapi
-Version: 0.4.3.dev2
+Version: 0.4.3.dev3
 Summary: API for CSV converted by udata-hydra
 Author-email: "data.gouv.fr" <opendatateam@data.gouv.fr>
 License-Expression: MIT
@@ -365,8 +365,8 @@ column_name__sum
 
 #### Pagination
 ```
-page=1          # Page number (default: 1)
-page_size=20    # Items per page (default: 20, max: 50)
+page=1          # Page number (default: 1, min: 1)
+page_size=20    # Items per page (default: 20, min: 1, max: 50)
 ```
 
 #### Column Selection

{udata_hydra_csvapi-0.4.3.dev2.dist-info → udata_hydra_csvapi-0.4.3.dev3.dist-info}/RECORD

@@ -5,19 +5,19 @@ api_tabular/core/cors.py,sha256=QY006pAnR1fMBMJJTAeRGcopL_4LkY7YoA3y8KYk4dI,825
 api_tabular/core/data.py,sha256=5j-3d_el7LMoHpn6V__UdhYHD6GiJbwdH67jrnOYWZQ,1459
 api_tabular/core/error.py,sha256=xRt6fkQfsiupv0tWWzdX0DJjAKbw1n0tRxFyt15VBLA,1062
 api_tabular/core/health.py,sha256=NeFT1C00onvm3CbgesFAcN1N8bmelbQdEYFbmmftICQ,647
-api_tabular/core/query.py,sha256=Twlv-xLYzZ0YGzCDiJ1uJAH2nZT9hEATNSSPiHVnRU8,10226
+api_tabular/core/query.py,sha256=J7woFLDzA8RpMBXJKpKm8olDdZsp2_TQEROJtIaeokM,10238
 api_tabular/core/sentry.py,sha256=fN5MrDZszLnzLXF3b_nUymPVB0ffNn4PI7xS1GtJNyE,948
-api_tabular/core/swagger.py,sha256=eSCAu0TQsT2tlQiW7i-ueZB14qTd8TfHbUypZeeB-0w,14640
+api_tabular/core/swagger.py,sha256=mMEESM4UlgK-voyRTKrddVuUrlUMfTDOQtK1VrVp7Ak,14748
 api_tabular/core/url.py,sha256=af7VKfrMtKMzlHrGgtLDLuRBim4qFv7xlt2PYxAyW2g,761
-api_tabular/core/utils.py,sha256=VTxPiNWE3FF6f2aX5Q21XPezCL3sVZ_KICIrGBJRm_E,1071
+api_tabular/core/utils.py,sha256=Ghd9Un0HugFg4oEcEb5yB5FEop7tDSoX4OCzR8mcM-Y,1922
 api_tabular/core/version.py,sha256=OKLg0l1CpDRHV2hsqVgtSihoo3tg0aMG6kzMILtQ-bY,250
 api_tabular/metrics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-api_tabular/metrics/app.py,sha256=JY7GZSqCsihEcQy7SFTiKqvoyxfGRFaJ48CovNQTq4Y,4408
+api_tabular/metrics/app.py,sha256=m2H4qOvzvi8oDjCg1R23JAK6VaqDcrqYCz6ScIk9iAc,4305
 api_tabular/tabular/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-api_tabular/tabular/app.py,sha256=tbf1Ni_r_bbeivxlMNllVKRoqpajZId6SiurCn1hTas,6645
+api_tabular/tabular/app.py,sha256=fBnbIR2H3jm0suVVEfNuVdSccOwZeMKH__iekwmDVa8,6542
 api_tabular/tabular/utils.py,sha256=BL2nl04-3imBQG-RZiYvVMjxoBORi4lwrKq8NiWecLY,4487
-udata_hydra_csvapi-0.4.3.dev2.dist-info/licenses/LICENSE,sha256=fb-HAYw94ffh--z1cZrWbpk6YKM0p9WFG7kdd0K7uGQ,1062
-udata_hydra_csvapi-0.4.3.dev2.dist-info/METADATA,sha256=M20YFIrIz04duIJaLWGY05yNw7MDXO7kUmfSHTcdYVE,21819
-udata_hydra_csvapi-0.4.3.dev2.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
-udata_hydra_csvapi-0.4.3.dev2.dist-info/top_level.txt,sha256=MAaK09hxwPhIBBC0i1TdEBAgdu3W_gXnAZqk767gVak,12
-udata_hydra_csvapi-0.4.3.dev2.dist-info/RECORD,,
+udata_hydra_csvapi-0.4.3.dev3.dist-info/licenses/LICENSE,sha256=fb-HAYw94ffh--z1cZrWbpk6YKM0p9WFG7kdd0K7uGQ,1062
+udata_hydra_csvapi-0.4.3.dev3.dist-info/METADATA,sha256=mBjWOUsIDJAxQWABC7L49YdknGyNsX2tKDG3Sh7spTk,21835
+udata_hydra_csvapi-0.4.3.dev3.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+udata_hydra_csvapi-0.4.3.dev3.dist-info/top_level.txt,sha256=MAaK09hxwPhIBBC0i1TdEBAgdu3W_gXnAZqk767gVak,12
+udata_hydra_csvapi-0.4.3.dev3.dist-info/RECORD,,