Skip to content

head's up about private zarr-python API usage #11378

@d-v-b

Description

@d-v-b

What is your issue?

The Zarr array wrapper in xarray uses zarr.Array._async_array, which is a private attribute, which makes xarray vulnerable to breaking changes if zarr changes anything about that private attribute.

For example: there's an open issue and a PR over in zarr-python about moving all the AsyncArray methods over to the Array class, with the eventual goal of phasing out the AsyncArray class entirely.

So the bad news is that the zarr.Array._async_array attribute might behave differently (e.g., emit a warning) or disappear entirely in a future release of zarr. the good news is that, if the aforementioned warnings / removal does occur, xarray will be able to use public async methods on the Array class to do whatever you are currently using _async_array to do.

Metadata

Metadata

Assignees

No one assigned

    Labels

    needs triageIssue that has not been reviewed by xarray team member

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions