feat: adds ability to paginate using the pages API which was originally hidden to the user

Author: becelot

hostingde/dns/dns.py

@@ -47,6 +47,7 @@ def list_zones(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
+        page: Optional[int] = None,
         *args: list,
         **kwargs: dict
     ) -> HostingDePaginator[Zone]:
@@ -110,18 +111,20 @@ def list_zones(
         :param limit: The limit of objects to retrieve per call. If not set, defaults to 25.
         :param filter: A filter that is applied to the query
         :param sort: Configuration how results are sorted.
+        :param page: The page to retrieve. If limit is unset, 25 items will be retrieved.
         :return: An iterator that yields Zone objects.
         """
 
         uri = self._build_uri('dns', 'zonesFind')
 
-        return self._iter(uri, Zone, filter, limit, sort)
+        return self._iter(uri, Zone, filter, limit, sort, page)
 
     def list_zone_configs(
         self,
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
+        page: Optional[int] = None,
         *args: list,
         **kwargs: dict
     ) -> HostingDePaginator[ZoneConfig]:
@@ -171,18 +174,20 @@ def list_zone_configs(
         :param limit: The limit of objects to retrieve per call. If not set, defaults to 25.
         :param filter: A filter that is applied to the query
         :param sort: Configuration how results are sorted.
+        :param page: The page to retrieve. If limit is unset, 25 items will be retrieved.
         :return: An iterator that yields Zone objects.
         """
 
         uri = self._build_uri('dns', 'zoneConfigsFind')
 
-        return self._iter(uri, ZoneConfig, filter, limit, sort)
+        return self._iter(uri, ZoneConfig, filter, limit, sort, page)
 
     def list_records(
         self,
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
+        page: Optional[int] = None,
         *args: list,
         **kwargs: dict
     ) -> HostingDePaginator[Record]:
@@ -212,12 +217,13 @@ def list_records(
         :param limit: The limit of objects to retrieve per call. If not set, defaults to 25.
         :param filter: A filter that is applied to the query
         :param sort: Configuration how results are sorted.
+        :param page: The page to retrieve. If limit is unset, 25 items will be retrieved.
         :return: An iterator that yields Zone objects.
         """
 
         uri = self._build_uri('dns', 'recordsFind')
 
-        return self._iter(uri, Record, filter, limit, sort)
+        return self._iter(uri, Record, filter, limit, sort, page)
 
     def delete_zone(
         self, zone_config_id: Optional[str] = None, zone_name: Optional[str] = None, asynchronous: bool = None
@@ -254,6 +260,7 @@ def jobs_find(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
+        page: Optional[int] = None,
         *args: list,
         **kwargs: dict
     ) -> HostingDePaginator[Job]:
@@ -263,11 +270,12 @@ def jobs_find(
         :param limit: The limit of objects to retrieve per call. If not set, defaults to 25.
         :param filter: A filter that is applied to the query
         :param sort: Configuration how results are sorted.
+        :param page: The page to retrieve. If limit is unset, 25 items will be retrieved.
         :return: An iterator that yields ZoneConfig objects.
         """
         uri = self._build_uri('dns', 'jobsFind')
 
-        return self._iter(uri, Job, filter, limit, sort)
+        return self._iter(uri, Job, filter, limit, sort, page)
 
     def update_zone(
         self,

hostingde/domain/domain.py

@@ -36,6 +36,7 @@ def jobs_find(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
+        page: Optional[int] = None,
         *args: list,
         **kwargs: dict
     ) -> HostingDePaginator[Job]:
@@ -45,11 +46,12 @@ def jobs_find(
         :param limit: The limit of objects to retrieve per call. If not set, defaults to 25.
         :param filter: A filter that is applied to the query
         :param sort: Configuration how results are sorted.
+        :param page: The page to retrieve. If limit is unset, 25 items will be retrieved.
         :return: An iterator that yields ZoneConfig objects.
         """
         uri = self._build_uri('domain', 'jobsFind')
 
-        return self._iter(uri, Job, filter, limit, sort)
+        return self._iter(uri, Job, filter, limit, sort, page)
 
     def check_domain_name_availability(self, domain_names: Union[str, List[str]]) -> List[CheckAvailabilityResponse]:
         uri = self.build_uri('domainStatus')
@@ -71,6 +73,7 @@ def list_domains(
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
+        page: Optional[int] = None,
         *args: list,
         **kwargs: dict
     ) -> HostingDePaginator[Domain]:
@@ -80,18 +83,20 @@ def list_domains(
         :param limit: The limit of objects to retrieve per call. If not set, defaults to 25.
         :param filter: A filter that is applied to the query
         :param sort: Configuration how results are sorted.
+        :param page: The page to retrieve. If limit is unset, 25 items will be retrieved.
         :return: An iterator that yields Zone objects.
         """
 
         uri = self._build_uri('domain', 'domainsFind')
 
-        return self._iter(uri, Domain, filter, limit, sort)
+        return self._iter(uri, Domain, filter, limit, sort, page)
 
     def list_contacts(
         self,
         limit: Optional[int] = None,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
+        page: Optional[int] = None,
         *args: list,
         **kwargs: dict
     ) -> HostingDePaginator[DomainContact]:
@@ -101,12 +106,13 @@ def list_contacts(
         :param limit: The limit of objects to retrieve per call. If not set, defaults to 25.
         :param filter: A filter that is applied to the query
         :param sort: Configuration how results are sorted.
+        :param page: The page to retrieve. If limit is unset, 25 items will be retrieved.
         :return: An iterator that yields Zone objects.
         """
 
         uri = self._build_uri('domain', 'contactsFind')
 
-        return self._iter(uri, DomainContact, filter, limit, sort)
+        return self._iter(uri, DomainContact, filter, limit, sort, page)
 
     def register_domain(
         self,

hostingde/hostingde.py

@@ -96,6 +96,7 @@ def _iter(
         filter: Optional[FilterElement] = None,
         limit: Optional[int] = None,
         sort: Optional[SortConfiguration] = None,
+        page: Optional[int] = None,
     ) -> 'hostingde.HostingDePaginator[T]':
         """
         Use the generic filtering and sorting API to paginate over results.
@@ -108,7 +109,7 @@ def _iter(
         :return: The iterator for the resultset
         """
 
-        return hostingde.HostingDePaginator(self, instance_class, url, filter=filter, limit=limit, sort=sort)
+        return hostingde.HostingDePaginator(self, instance_class, url, filter=filter, limit=limit, sort=sort, page=page)
 
     def login(self, url: str, token: str) -> None:
         """

hostingde/paginator.py

@@ -32,6 +32,7 @@ def __init__(
         limit: Optional[int] = 25,
         filter: Optional[FilterElement] = None,
         sort: Optional[SortConfiguration] = None,
+        page: Optional[int] = None
     ):
         """
         Construct a new paginator.
@@ -43,8 +44,10 @@ def __init__(
         :param limit: The maximum number of entries to retrieve per API call
         :param filter: Filter the results based on a filter expression
         :param sort: Sort the results by a given field
+        :param page: Which page to query. Requires limit to be set, which defaults to 25.
         """
         super().__init__(parent)
+
         self.current_page = 1
         self.total_pages = -1
         self.results: List[R] = []
@@ -57,6 +60,10 @@ def __init__(
         self.instance_class = instance_class
         self._total_entries = -1
 
+        if page:
+            self.current_page = page
+            self.count = self.limit
+
     def __iter__(self):
         """
         This object is a iterator itself.

tests/unit/test_paginator.py

@@ -105,6 +105,35 @@ def test_paginator_no_more_data():
     assert count == 23
 
 
+@responses.activate
+def test_paginator_paged():
+    api = login('https://example.de/api', 'token')
+
+    url = 'https://example.de/api/demo'
+
+    paginator: HostingDePaginator = HostingDePaginator(api, instance_class=Record, url=url, page=2)
+
+    responses.add(
+        'POST',
+        url,
+        body=json.dumps(
+            {
+                "response": {
+                    "data": [
+                        Record.create_new_record('cloud.de', RecordType.A, f'127.0.0.{i}').to_json() for i in range(50)
+                    ],
+                    "totalPages": 2,
+                },
+                "status": "success",
+            }
+        ),
+    )
+
+    responses.add('POST', url, body=json.dumps({"response": {"data": [], "totalPages": 2}, "status": "success"}))
+
+    assert len(paginator.fetchall()) == 25
+
+
 @responses.activate
 def test_paginator_multipage():
     api = login('https://example.de/api', 'token')