Skip to content

docs: Clarified laziness of create_hierarchy (#2938) #2939

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Clarified laziness of create_hierarchy (#2938) #2939

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94afff7
docs: Clarified laziness of create_hierarchy (#2938)
Mar 30, 2025
b114cb1
Merge branch 'main' into main
d-v-b Apr 20, 2025
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
5 changes: 3 additions & 2 deletions src/zarr/core/sync_group.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,15 @@ def create_hierarchy(
overwrite: bool = False,
) -> Iterator[tuple[str, Group | Array]]:
"""
Create a complete zarr hierarchy from a collection of metadata objects.
Lazily create a complete zarr hierarchy from a collection of metadata objects.

This function will parse its input to ensure that the hierarchy is complete. Any implicit groups
will be inserted as needed. For example, an input like
```{'a/b': GroupMetadata}``` will be parsed to
```{'': GroupMetadata, 'a': GroupMetadata, 'b': Groupmetadata}```

After input parsing, this function then creates all the nodes in the hierarchy concurrently.
This function returns a generator that will create the nodes in the hierarchy
when consumed. After input parsing, this function then creates all the nodes in the hierarchy concurrently.

Arrays and Groups are yielded in the order they are created. This order is not stable and
should not be relied on.
Expand Down