Swap cdf_to_xarray to accept CDF instances, rather than filenames#313
Open
jphastings wants to merge 1 commit intolasp:mainfrom
Open
Swap cdf_to_xarray to accept CDF instances, rather than filenames#313jphastings wants to merge 1 commit intolasp:mainfrom
jphastings wants to merge 1 commit intolasp:mainfrom
Conversation
This change allows for CDF files loaded from S3 buckets to be converted to xarray Datasets, without being forced to retrieve the remote dataset, then load it from disk.
cdf_to_xarray now requires a CDF object, not a filename. `cdf_to_xarray("some.cdf")` would now be `cdf_to_xarray(CDF("some.cdf"))`
Member
|
Ah yeah, this is a great idea! But that said, I think we should keep the function backwards compatible for now, since cdf_to_xarray is used in quite a few places. Maybe we could just add a check at the beginning of the function like "if not isinstance(file, CDF) then file=CDF(file)"? |
Author
|
I’ll make the change and push shortly 😊 |
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
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.
This change allows for CDF instances (eg. loaded from S3 buckets) to be converted to xarray Datasets, without being forced to retrieve the remote dataset, then load it from disk.
fixes #312
I've implemented this as a breaking change to keep the function simple, but I'd be happy to rework that first argument as
filename_path_or_cdf: str | Path | CDFand convert internally if you wanted to maintain API compatibility.🚨 Breaking change 🚨
cdflib.xarray.cdf_to_xarraynow requires a CDF object, not a filename.