Fix opening STAC Assets with xarray:open_kwargs engine field #18
Conversation
This file contains 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
Update the core if-then logic to only set the 'engine' keyword argument when it is not already set in the `open_kwargs` dict. Included a regression unit test that extends the existing simple_zarr test to ensure that the fix works.
jsignell
reviewed
Mar 27, 2023
xpystac/core.py
Outdated
| default_kwargs["engine"] = "rasterio" | ||
| elif obj.media_type == "application/vnd+zarr": | ||
| _import_optional_dependency("zarr") | ||
| default_kwargs["engine"] = "zarr" | ||
|
|
||
| ds = xarray.open_dataset(obj.href, **default_kwargs, **open_kwargs, **kwargs) |
There was a problem hiding this comment.
Instead of making the changes above, we can just change this one line:
Suggested change
| ds = xarray.open_dataset(obj.href, **default_kwargs, **open_kwargs, **kwargs) | |
| ds = xarray.open_dataset(obj.href, **{**default_kwargs, **open_kwargs, **kwargs}) |
There was a problem hiding this comment.
Thanks, that's a nice and simple solution! I had to look up dictionary unpacking in https://peps.python.org/pep-0448, and check how the duplicate keys will be handled:
The keys in a dictionary remain in a right-to-left priority order, so {**{'a': 1}, 'a': 2, **{'a': 3}} evaluates to {'a': 3}. There is no restriction on the number or position of unpackings.
So the user-set kwargs should override the open_kwargs set in the STAC metadata, which in-turn should override the default_kwargs set by xpystac, following the logic mentioned in #16 (comment) 😃
jsignell
reviewed
Mar 27, 2023
| @@ -30,4 +30,9 @@ def test_to_xarray_reference_file(simple_reference_file): | |||
|
|
|||
| def test_to_xarray_zarr(simple_zarr): | |||
| ds = to_xarray(simple_zarr) | |||
| ds | |||
| assert ds | |||
Order of priority from lowest to highest is default_kwargs -> open_kwargs -> kwargs. See https://peps.python.org/pep-0448. Co-Authored-By: Julia Signell <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update the kwargs merging logic to have the 'engine' keyword argument from
default_kwargoverride the one set in theopen_kwargsdict. Included a regression unit test that extends the existing simple_zarr test to ensure that the fix for duplicate keys works.Note that the
xarray:open_kwargsfield is a part of thexarray-assetsSTAC extension (in Proposal stage), xref #16Fixes #17