Remove BooleanCoder from zarr writes#11318
Open
elyall wants to merge 6 commits intopydata:mainfrom
Open
Conversation
… the encoders; default of `None` calls new `_default_encode_cf_coders`
…ibility with old arrays encoded with `BooleanCoder`
64db4da to
1b0046a
Compare
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.
Description
The zarr backend currently converts boolean arrays to
int8before writing, using theBooleanCoderfrom the CF encoding pipeline. This was inherited from NetCDF compatibility (which can't store booleans natively), but zarr v2 and v3 both supportbooldtype directly. The conversion results in:int8with adtype: "bool"attribute, which non-xarray zarr readers don't understandThis PR skips
BooleanCoderduring zarr writes by:codersparameter toconventions.encode_cf_variable()so backends can customize the encoding chainencode_zarr_variable()pass a filtered coder list that excludesBooleanCoderThe decode path is unchanged --
BooleanCoder.decodeis attribute-driven (attrs.get('dtype') == 'bool'), so existing zarr stores written with the oldint8encoding still decode toboolcorrectly.Checklist
whats-new.rstAI Disclosure
BooleanCoderfor boolean arrays when writing to or reading from zarr files. Automatically skip BooleanCoder for all zarr writes (v2 and v3). Please provide a "Description" for the pull request and document changes inwhats-new.rst."