Skip to content

feat: Add public types for metadata objects (fixes #3795)#3812

Closed
abishop1990 wants to merge 1 commit intozarr-developers:mainfrom
abishop1990:issue-3795-metadata-types
Closed

feat: Add public types for metadata objects (fixes #3795)#3812
abishop1990 wants to merge 1 commit intozarr-developers:mainfrom
abishop1990:issue-3795-metadata-types

Conversation

@abishop1990
Copy link
Contributor

Exports metadata types as public API.

  • ArrayV2Metadata, ArrayV3Metadata
  • GroupMetadata, ChunkGrid, ChunkKeyEncoding
  • Users can now: from zarr import ArrayV3Metadata

All validation passed locally (5372 tests).

Expose metadata types as public API from the main zarr module:
- ArrayV2Metadata and ArrayV3Metadata from zarr.core.metadata
- GroupMetadata, ImplicitGroupMarker, and ConsolidatedMetadata from zarr.core.group
- ChunkGrid and RegularChunkGrid from zarr.core.chunk_grids
- ChunkKeyEncoding, DefaultChunkKeyEncoding, and V2ChunkKeyEncoding from zarr.core.chunk_key_encodings

These types can now be imported directly from zarr for better type hints and API clarity.

Also add __all__ exports to zarr.core.group to explicitly declare public types.
@d-v-b
Copy link
Contributor

d-v-b commented Mar 21, 2026

IMO these classes are not ready to be made public. they require a range of internal design changes first.

@abishop1990
Copy link
Contributor Author

IMO these classes are not ready to be made public. they require a range of internal design changes first.

Understood, closing PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants