Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make get_all_collections properly recursive #1361

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Make get_all_collections properly recursive #1361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7fbdfd
Make `get_all_collections` properly recursive
jsignell Jul 5, 2024
d7c0762
Merge branch 'main' into fix/get_all_collections
gadomski Jul 8, 2024
ba1f397
Update changelog
jsignell Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
- Allow object ID as input for getting APILayoutStrategy hrefs and add `items`, `collections`, `search`, `conformance`, `service_desc` and `service_doc` href methods. ([#1335](https://github.com/stac-utils/pystac/pull/1335))
- Update docstring of `name` argument to `Classification.apply` and `Classification.create` to agree with extension specification. ([#1356](https://github.com/stac-utils/pystac/pull/1356))

### Fixed

- Make `get_all_collections` properly recursive ([#1361](https://github.com/stac-utils/pystac/pull/1361))

## [v1.10.1] - 2024-05-03

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion pystac/catalog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ def get_all_collections(self) -> Iterable[Collection]:
any subcatalogs recursively."""
yield from self.get_collections()
for child in self.get_children():
yield from child.get_collections()
yield from child.get_all_collections()

def get_child_links(self) -> list[Link]:
"""Return all child links of this catalog.
Expand Down
27 changes: 24 additions & 3 deletions tests/test_catalog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,13 @@
make_posix_style,
make_relative_href,
)
from tests.utils import ARBITRARY_BBOX, ARBITRARY_GEOM, MockStacIO, TestCases
from tests.utils import (
ARBITRARY_BBOX,
ARBITRARY_EXTENT,
ARBITRARY_GEOM,
MockStacIO,
TestCases,
)


class CatalogTypeTest(unittest.TestCase):
Expand Down Expand Up @@ -1350,7 +1356,7 @@ def test_get_all_collections(self) -> None:
catalog = TestCases.case_1()
all_collections = list(catalog.get_all_collections())

assert len(all_collections) > 0
assert len(all_collections) == 4
assert all(isinstance(c, pystac.Collection) for c in all_collections)

def test_get_single_links_media_type(self) -> None:
Expand Down Expand Up @@ -1639,7 +1645,9 @@ def nested_catalog() -> pystac.Catalog:
└── variables
├── catalog.json
└── variable_a
├── catalog.json
└── catalog.json
└── variable_a_1
└── collection.json
"""
root = pystac.Catalog("root", "root")
variables = pystac.Catalog("variables", "variables")
Expand All @@ -1654,9 +1662,22 @@ def nested_catalog() -> pystac.Catalog:
variables.add_child(variable_a)
products.add_child(product_a)

variable_a_1 = pystac.Collection(
"variable_a_1", "variable_a_1", extent=ARBITRARY_EXTENT
)
variable_a.add_child(variable_a_1)

return root


def test_get_all_collections_deeply_nested(nested_catalog: pystac.Catalog) -> None:
catalog = nested_catalog
all_collections = list(catalog.get_all_collections())

assert len(all_collections) == 1
assert all(isinstance(c, pystac.Collection) for c in all_collections)


def test_set_parent_false_stores_in_proper_place_on_normalize_and_save(
nested_catalog: pystac.Catalog, tmp_path: Path
) -> None:
Expand Down