Skip to content
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

add warnings when using non-spec features with v3 #2556

Merged
merged 7 commits into from
Dec 16, 2024
Merged

Conversation

normanrz
Copy link
Member

@normanrz normanrz commented Dec 13, 2024

Adds warnings when using the following non-spec features with v3 groups and arrays:

  • vlen string and bytes dtypes
  • vlen-utf8 and vlen-bytes codecs
  • consolidated metadata

Fixes #2411

  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@normanrz normanrz self-assigned this Dec 13, 2024
@normanrz normanrz added this to the 3.0.0 milestone Dec 13, 2024
@normanrz
Copy link
Member Author

The warnings are currently xx is currently not part in the Zarr version 3 specification and may not be supported by other zarr implementations and may change in the future. I'm open to suggestions how to change the wording.

@normanrz normanrz requested review from jhamman and d-v-b December 13, 2024 16:07
@normanrz normanrz marked this pull request as ready for review December 13, 2024 17:13
Copy link
Member

@jhamman jhamman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @normanrz - I like it! I left one small comment on the wording of the warning.

Comment on lines 200 to 201
"Consolidated metadata is currently not part in the Zarr version 3 specification and "
"may not be supported by other zarr implementations and may change in the future.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Consolidated metadata is currently not part in the Zarr version 3 specification and "
"may not be supported by other zarr implementations and may change in the future.",
"Consolidated metadata is currently not part in the Zarr version 3 specification. It "
"may not be supported by other zarr implementations and may change in the future.",

@normanrz normanrz enabled auto-merge (squash) December 16, 2024 13:04
@normanrz normanrz merged commit 775979f into main Dec 16, 2024
32 checks passed
@normanrz normanrz deleted the warn-non-spec branch December 16, 2024 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[v3] It is possible to create v3 data with features not currently written into the spec (dtypes, codecs, etc.)
2 participants