Harmonizing limit and page_size parameters.

Author: chsou

c8y_api/model/_base.py

@@ -68,6 +68,32 @@ def get_all_by_path(dictionary: dict, paths: list[str] | dict[str, Any]) -> tupl
     return tuple(get_by_path(dictionary, p) for p in paths)
 
 
+def harmonize_page_size(limit: int, page_size: int) -> int:
+    """Harmonize/sanitize page_size for a database query.
+    
+    The page size should never exceed the given limit of a query. Hence, 
+    this function sets the page size to the limit if undefined or too large.
+    A smaller page size passes as this can be a performance consideration.
+
+    Returns:
+        Updated page size.
+    """
+    if not page_size or (limit and page_size > limit):
+        return limit
+    return page_size
+
+
+# def harmonize_limit_and_page_size(limit: int, page_size: int) -> tuple:
+#     """Harmonize/sanitize limit and page_size parameters for a database query.
+#
+#
+#
+#     """
+#     if not page_size or (limit and page_size > limit):
+#         return limit, limit  # page size to limit if not sensible
+#     return limit, page_size
+
+
 class _DictWrapper(MutableMapping, dict):
 
     def __init__(self, dictionary: dict, on_update=None):
@@ -772,7 +798,7 @@ def stringify(value):
                 tuples.append(('series', series))
         return tuples
 
-    def _prepare_query(self, resource: str = None, expression: str = None, **kwargs):
+    def _prepare_query(self, resource: str = None, expression: str = None, **kwargs: object) -> str | None:
         encoded = expression or urlencode(self._map_params(**kwargs))
         if not encoded:
             return resource or self.resource

c8y_api/model/administration.py

@@ -8,7 +8,7 @@
 from typing import Generator, List
 
 from c8y_api._base_api import CumulocityRestApi, AccessDeniedError
-from c8y_api.model._base import CumulocityResource, SimpleObject
+from c8y_api.model._base import CumulocityResource, SimpleObject, harmonize_page_size
 from c8y_api.model._parser import SimpleObjectParser, ComplexObjectParser, as_values as parse_as_values
 from c8y_api.model._util import _DateUtil
 from c8y_api.model.matcher import JsonMatcher
@@ -1162,7 +1162,7 @@ def select(
             owner=owner,
             only_devices=only_devices,
             with_subusers_count=with_subusers_count,
-            page_size=page_size,
+            page_size=harmonize_page_size(limit, page_size),
             **kwargs
         )
         return super()._iterate(

c8y_api/model/applications.py

@@ -6,7 +6,7 @@
 from typing import Generator, List, BinaryIO
 
 from c8y_api._base_api import CumulocityRestApi
-from c8y_api.model._base import SimpleObject, CumulocityResource
+from c8y_api.model._base import SimpleObject, CumulocityResource, harmonize_page_size
 from c8y_api.model._parser import SimpleObjectParser
 
 
@@ -316,7 +316,7 @@ def select(
             name=name, type=type, owner=owner, tenant=tenant,
             user=user, subscriber=subscriber, providedFor=provided_for,
             has_versions=has_versions,
-            page_size=page_size,
+            page_size=harmonize_page_size(limit, page_size),
             **kwargs
         )
         return super()._iterate(base_query, page_number, limit, None, None, Application.from_json)

c8y_api/model/audit.py

@@ -8,7 +8,7 @@
 
 from c8y_api._base_api import CumulocityRestApi
 from c8y_api.model.matcher import JsonMatcher
-from c8y_api.model._base import CumulocityResource, ComplexObject
+from c8y_api.model._base import CumulocityResource, ComplexObject, harmonize_page_size
 from c8y_api.model._parser import ComplexObjectParser, SimpleObjectParser, as_values as parse_as_values
 from c8y_api.model._util import _DateUtil
 
@@ -265,7 +265,7 @@ def select(
             before=before, after=after,
             min_age=min_age, max_age=max_age,
             reverse=reverse,
-            page_size=page_size,
+            page_size=harmonize_page_size(limit, page_size),
             **kwargs)
         return super()._iterate(
             base_query,

c8y_api/model/events.py

@@ -10,7 +10,7 @@
 
 from c8y_api._base_api import CumulocityRestApi
 from c8y_api.model.matcher import JsonMatcher
-from c8y_api.model._base import CumulocityResource, SimpleObject, ComplexObject
+from c8y_api.model._base import CumulocityResource, SimpleObject, ComplexObject, harmonize_page_size
 from c8y_api.model._parser import as_values as parse_as_values, ComplexObjectParser
 from c8y_api.model._util import _DateUtil
 
@@ -373,7 +373,7 @@ def select(self,
             reverse=reverse,
             with_source_assets=with_source_assets,
             with_source_devices=with_source_devices,
-            page_size=page_size,
+            page_size=harmonize_page_size(limit, page_size),
             **kwargs)
         return super()._iterate(
             base_query,

c8y_api/model/inventory.py

@@ -6,7 +6,7 @@
 from typing import Any, Generator, List
 
 from c8y_api.model.matcher import JsonMatcher
-from c8y_api.model._base import CumulocityResource
+from c8y_api.model._base import CumulocityResource, harmonize_page_size
 from c8y_api.model._parser import as_values as parse_as_values
 from c8y_api.model._util import _QueryUtil
 from c8y_api.model.managedobjects import ManagedObjectUtil, ManagedObject, Device, Availability, DeviceGroup
@@ -341,7 +341,7 @@ def select(
             limit=limit,
             include=include,
             exclude=exclude,
-            page_size=page_size,
+            page_size=harmonize_page_size(limit, page_size),
             page_number=page_number,
             as_values=as_values,
             **kwargs)
@@ -802,7 +802,7 @@ def get_all(  # noqa (changed signature)
             limit=limit,
             include=include,
             exclude=exclude,
-            page_size=page_size,
+            page_size=harmonize_page_size(limit, page_size),
             page_number=page_number,
             as_values=as_values,
             **kwargs))
@@ -1018,7 +1018,7 @@ def select(  # noqa (changed signature)
             limit=limit,
             include=include,
             exclude=exclude,
-            page_size=page_size,
+            page_size=harmonize_page_size(limit, page_size),
             page_number=page_number,
             as_values=as_values,
             **kwargs)

c8y_api/model/measurements.py

@@ -8,7 +8,7 @@
 
 from c8y_api._base_api import CumulocityRestApi
 
-from c8y_api.model._base import CumulocityResource, ComplexObject
+from c8y_api.model._base import CumulocityResource, ComplexObject, harmonize_page_size
 from c8y_api.model._parser import as_values as parse_as_values, ComplexObjectParser
 from c8y_api.model._base import _DictWrapper
 from c8y_api.model._util import _DateUtil
@@ -561,7 +561,7 @@ def select(
             min_age=min_age,
             max_age=max_age,
             reverse=reverse,
-            page_size=page_size,
+            page_size=harmonize_page_size(limit, page_size),
             **kwargs
         )
         return super()._iterate(

c8y_api/model/notification2.py

@@ -8,7 +8,7 @@
 import uuid
 
 from c8y_api._base_api import CumulocityRestApi
-from c8y_api.model._base import SimpleObject, CumulocityResource
+from c8y_api.model._base import SimpleObject, CumulocityResource, harmonize_page_size
 from c8y_api.model._parser import SimpleObjectParser
 
 
@@ -214,7 +214,7 @@ def select(
             source=source,
             subscription=subscription,
             typeFilter=type_filter,
-            page_size=page_size,
+            page_size=harmonize_page_size(limit, page_size),
             **kwargs)
         return super()._iterate(base_query, page_number, limit, None, None, Subscription.from_json)
 

c8y_api/model/operations.py

@@ -7,7 +7,7 @@
 
 from c8y_api._base_api import CumulocityRestApi
 from c8y_api.model.matcher import JsonMatcher
-from c8y_api.model._base import CumulocityResource, ComplexObject, SimpleObject, _DictWrapper
+from c8y_api.model._base import CumulocityResource, ComplexObject, SimpleObject, _DictWrapper, harmonize_page_size
 from c8y_api.model._parser import ComplexObjectParser, as_values as parse_as_values
 from c8y_api.model._util import _DateUtil
 
@@ -228,7 +228,7 @@ def select(
             before=before, after=after,
             min_age=min_age, max_age=max_age,
             date_from=date_from, date_to=date_to,
-            reverse=reverse, page_size=page_size,
+            reverse=reverse, page_size=harmonize_page_size(limit, page_size),
             **kwargs
         )
         return super()._iterate(
@@ -561,7 +561,7 @@ def select(self, limit: int = None, page_size: int = 1000, page_number: int = No
         Returns:
             Generator[BulkOperation]: Iterable of matching BulkOperation objects
         """
-        base_query = self._prepare_query(page_size=page_size)
+        base_query = self._prepare_query(page_size=harmonize_page_size(limit, page_size))
         return super()._iterate(base_query, page_number, limit, None, None, BulkOperation.from_json)
 
     def get_all(self, limit: int = None, page_size: int = 1000, page_number: int = None) -> List[BulkOperation]:

c8y_api/model/tenant_options.py

@@ -5,7 +5,7 @@
 from typing import Generator, List, Dict
 
 from c8y_api._base_api import CumulocityRestApi
-from c8y_api.model._base import SimpleObject, CumulocityResource
+from c8y_api.model._base import SimpleObject, CumulocityResource, harmonize_page_size
 from c8y_api.model._parser import SimpleObjectParser
 
 
@@ -150,7 +150,7 @@ def select(self, category: str = None, limit: int = None,
         """
         if not category:
             # select all
-            base_query = self._prepare_query(page_size=page_size)
+            base_query = self._prepare_query(page_size=harmonize_page_size(limit, page_size))
             yield from super()._iterate(base_query, page_number, limit, None, None, TenantOption.from_json)
         else:
             # select by category, this is just a single request