test pagination

cads_api_client/catalogue.py

@@ -1,6 +1,13 @@
+from __future__ import annotations
+
 import datetime
 from typing import Any, Dict, List, Optional
 
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
 import attrs
 import requests
 
@@ -12,10 +19,10 @@ class Collections(processing.ApiResponse):
     def collection_ids(self) -> List[str]:
         return [collection["id"] for collection in self.json["collections"]]
 
-    def next(self) -> Optional[processing.ApiResponse]:
+    def next(self) -> Optional[Self]:
         return self.from_rel_href(rel="next")
 
-    def prev(self) -> Optional[processing.ApiResponse]:
+    def prev(self) -> Optional[Self]:
         return self.from_rel_href(rel="prev")
 
 

cads_api_client/processing.py

@@ -7,6 +7,11 @@
 import urllib
 from typing import Any, Dict, List, Optional, Type, TypeVar
 
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
 import attrs
 import multiurl
 import requests
@@ -89,7 +94,7 @@ def get_link_href(self, **kwargs: str) -> str:
             raise RuntimeError(f"link not found or not unique {kwargs}")
         return links[0]["href"]
 
-    def from_rel_href(self, rel: str) -> Optional[ApiResponse]:
+    def from_rel_href(self, rel: str) -> Optional[Self]:
         rels = self.get_links(rel=rel)
         assert len(rels) <= 1
         if len(rels) == 1:

environment.yml

@@ -11,3 +11,4 @@ dependencies:
 - attrs
 - multiurl
 - requests
+- typing-extensions

pyproject.toml

@@ -15,7 +15,7 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
   "Topic :: Scientific/Engineering"
 ]
-dependencies = ["attrs", "multiurl", "requests"]
+dependencies = ["attrs", "multiurl", "requests", "typing-extensions"]
 description = "CADS API Python client"
 dynamic = ["version"]
 license = {file = "LICENSE"}

tests/integration_test_10_catalogue.py

@@ -4,17 +4,22 @@
 def test_collections(api_root_url: str) -> None:
     cat = catalogue.Catalogue(f"{api_root_url}/catalogue")
 
-    res = cat.collections()
+    res: catalogue.Collections | None = cat.collections()
 
     assert isinstance(res, catalogue.Collections)
     assert "collections" in res.json
     assert isinstance(res.json["collections"], list)
     assert "links" in res.json
     assert isinstance(res.json["links"], list)
 
-    expected_collection_id = "reanalysis-era5-single-levels"
+    collection_ids = res.collection_ids()
+    while len(collection_ids) != res.json["numberMatched"]:
+        res = res.next()
+        assert res is not None
+        collection_ids.extend(res.collection_ids())
 
-    assert expected_collection_id in res.collection_ids()
+    expected_collection_id = "reanalysis-era5-single-levels"
+    assert expected_collection_id in collection_ids
 
 
 def test_collections_limit(api_root_url: str) -> None: