Terminate on empty page

CHANGELOG.md

@@ -10,14 +10,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Python 3.11 support [#347](https://github.com/stac-utils/pystac-client/pull/347)
-- `request_modifier` to `StacApiIO` to allow for additional authentication mechanisms (e.g. AWS SigV4) [#371](https://github.com/stac-utils/pystac-client/issues/371)
-- *Authentication* tutorial, demonstrating how to use to the provided hooks to use both basic and AWS SigV4 authentication [#371](https://github.com/stac-utils/pystac-client/issues/371)
+- `request_modifier` to `StacApiIO` to allow for additional authentication mechanisms (e.g. AWS SigV4) [#372](https://github.com/stac-utils/pystac-client/pull/372)
+- *Authentication* tutorial, demonstrating how to use to the provided hooks to use both basic and AWS SigV4 authentication [#372](https://github.com/stac-utils/pystac-client/pull/372)
 - CI checks for Windows and MacOS [#378](https://github.com/stac-utils/pystac-client/pull/378)
 
 ### Changed
 
 ### Fixed
 
+- Stop iteration on an empty page [#338](https://github.com/stac-utils/pystac-client/pull/338)
 - Some mishandled cases for datetime intervals [#363](https://github.com/stac-utils/pystac-client/pull/363)
 - Collection requests when the Client's url ends in a '/' [#373](https://github.com/stac-utils/pystac-client/pull/373), [#405](https://github.com/stac-utils/pystac-client/pull/405)
 - Parse datetimes more strictly [#364](https://github.com/stac-utils/pystac-client/pull/364)

pystac_client/stac_api_io.py

@@ -235,6 +235,8 @@ def get_pages(
         while next_link:
             link = Link.from_dict(next_link)
             page = self.read_json(link, parameters=parameters)
+            if not page.get("features", False):
+                return None
             yield page
 
             # get the next link and make the next request

tests/test_stac_api_io.py

@@ -168,3 +168,76 @@ def test_write(self, tmp_path: Path) -> None:
         with open(test_file) as file:
             data = file.read()
         assert data == "Hi there!"
+
+    def test_stop_on_empty_page(self, requests_mock: Mocker) -> None:
+        requests_mock.get(
+            "https://pystac-client.test/search",
+            status_code=200,
+            json={
+                "features": [{"foo": "bar"}],
+                "links": [
+                    {
+                        "rel": "next",
+                        "href": "https://pystac-client.test/search?token=baz",
+                    }
+                ],
+            },
+        )
+        requests_mock.get(
+            "https://pystac-client.test/search?token=baz",
+            status_code=200,
+            json={
+                "features": [],
+                "links": [
+                    {
+                        "rel": "next",
+                        "href": "https://pystac-client.test/search?token=baw",
+                    }
+                ],
+            },
+        )
+        requests_mock.get(
+            "https://pystac-client.test/search?token=baw",
+            status_code=500,
+            json={},
+        )
+        stac_api_io = StacApiIO()
+        pages = list(stac_api_io.get_pages("https://pystac-client.test/search"))
+        assert len(pages) == 1
+        assert pages[0]["features"][0]["foo"] == "bar"
+
+    def test_stop_on_featureless_page(self, requests_mock: Mocker) -> None:
+        requests_mock.get(
+            "https://pystac-client.test/search",
+            status_code=200,
+            json={
+                "features": [{"foo": "bar"}],
+                "links": [
+                    {
+                        "rel": "next",
+                        "href": "https://pystac-client.test/search?token=baz",
+                    }
+                ],
+            },
+        )
+        requests_mock.get(
+            "https://pystac-client.test/search?token=baz",
+            status_code=200,
+            json={
+                "links": [
+                    {
+                        "rel": "next",
+                        "href": "https://pystac-client.test/search?token=baw",
+                    }
+                ],
+            },
+        )
+        requests_mock.get(
+            "https://pystac-client.test/search?token=baw",
+            status_code=500,
+            json={},
+        )
+        stac_api_io = StacApiIO()
+        pages = list(stac_api_io.get_pages("https://pystac-client.test/search"))
+        assert len(pages) == 1
+        assert pages[0]["features"][0]["foo"] == "bar"