-
Notifications
You must be signed in to change notification settings - Fork 49
Add .to_icechunk()
method to ManifestGroup
#591
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.
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
Draft
TomNicholas
wants to merge
3
commits into
zarr-developers:main
Choose a base branch
from
TomNicholas:ManifestGroup_to_icechunk
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,17 @@ | ||
from __future__ import annotations | ||
|
||
import textwrap | ||
from typing import Iterator, Mapping | ||
from time import datetime | ||
from typing import TYPE_CHECKING, Iterator, Mapping, Optional | ||
|
||
import xarray as xr | ||
from zarr.core.group import GroupMetadata | ||
|
||
from virtualizarr.manifests import ManifestArray | ||
|
||
if TYPE_CHECKING: | ||
from icechunk import IcechunkStore # type: ignore[import-not-found] | ||
|
||
|
||
class ManifestGroup( | ||
Mapping[str, "ManifestArray | ManifestGroup"], | ||
|
@@ -131,3 +135,70 @@ def to_virtual_dataset(self) -> xr.Dataset: | |
coord_names=coord_names, | ||
attrs=attributes, | ||
) | ||
|
||
@classmethod | ||
def from_virtual_dataset( | ||
cls, | ||
vds: xr.Dataset, | ||
) -> "ManifestGroup": | ||
""" | ||
Create a new ManifestGroup from a virtual dataset object. | ||
|
||
The virtual dataset should contain only virtual variables, i.e. those backed by ManifestArrays. | ||
|
||
Parameters | ||
---------- | ||
vds: xr.Dataset | ||
Virtual dataset, containing only virtual variables. | ||
""" | ||
|
||
for name, var in vds.variables.items(): | ||
if not isinstance(var.data, ManifestArray): | ||
raise TypeError( | ||
f"Cannot convert a dataset containing a loadable variable directly to a ManifestGroup, but found variable {name} has type {type(var.data)}" | ||
) | ||
|
||
manifestarrays = {name: var.data for name, var in vds.variables.items()} | ||
|
||
attributes = vds.attrs | ||
# TODO test this is correct | ||
attributes["dimension_names"] = " ".join(list(vds.dims)) | ||
# TODO test this constructor round-trips coordinates | ||
attributes["coordinates"] = " ".join(list(vds.coords)) | ||
|
||
return cls(arrays=manifestarrays, attributes=attributes) | ||
|
||
def to_icechunk( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The point of adding this on |
||
store: "IcechunkStore", | ||
group: Optional[str] = None, | ||
append_dim: Optional[str] = None, | ||
last_updated_at: Optional[datetime] = None, | ||
) -> None: | ||
""" | ||
Write the contents of this ManifestGroup into an Icechunk Store as virtual chunks. | ||
|
||
Parameters | ||
---------- | ||
store: IcechunkStore | ||
Store to write dataset into. | ||
group: str, optional | ||
Path of the group to write the dataset into (default: the root group). | ||
append_dim: str, optional | ||
Dimension along which to append the virtual dataset. | ||
last_updated_at: datetime, optional | ||
Datetime to use as a checksum for any virtual chunks written to the store | ||
with this operation. When not provided, no check is performed. | ||
|
||
Raises | ||
------ | ||
ValueError | ||
If the store is read-only. | ||
""" | ||
from virtualizarr.writers.icechunk import write_manifestgroup_to_icechunk | ||
|
||
write_manifestgroup_to_icechunk( | ||
store=store, | ||
group=group, | ||
append_dim=append_dim, | ||
last_updated_at=last_updated_at, | ||
) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could this functionality be moved to a different PR to constrain the scope of the ManifestGroup.to_icechunk feature?