feat(zarr-metadata): re-export each v3 extension package's submodule names

packages/zarr-metadata/changes/4588.feature.md

@@ -0,0 +1 @@
+`zarr_metadata.v3.data_type`, `zarr_metadata.v3.codec`, `zarr_metadata.v3.chunk_grid` and `zarr_metadata.v3.chunk_key_encoding` re-export every name their submodules export, so `from zarr_metadata.v3.data_type import BoolDataTypeName, Uint8DataTypeName` works again, as it did before 0.6.0. Each name is the same object as in its submodule, which stays its documented home.

packages/zarr-metadata/src/zarr_metadata/v3/chunk_grid/__init__.py

@@ -5,12 +5,49 @@
 - `regular`     -- core v3 spec
 - `rectilinear` -- zarr-extensions
 
-Import a grid's types and its definition from its submodule:
+Import a grid's types and its definition from its submodule, or from this
+package, which re-exports every name its submodules export:
 `<X>ChunkGridMetadata`, the canonical type for the grid's permitted JSON
 shapes, `<X>ChunkGridObject`, `<X>ChunkGridConfiguration`, and
 `<X>_CHUNK_GRID`.
 
 See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#chunk-grids
 """
 
-__all__: list[str] = []
+from zarr_metadata.v3.chunk_grid.rectilinear import (
+    RECTILINEAR_CHUNK_GRID,
+    RECTILINEAR_CHUNK_GRID_NAME,
+    RectilinearChunkGridConfiguration,
+    RectilinearChunkGridMetadata,
+    RectilinearChunkGridName,
+    RectilinearChunkGridObject,
+    RectilinearDimSpec,
+    canonical_chunk_shapes,
+    canonical_dim_spec,
+)
+from zarr_metadata.v3.chunk_grid.regular import (
+    REGULAR_CHUNK_GRID,
+    REGULAR_CHUNK_GRID_NAME,
+    RegularChunkGridConfiguration,
+    RegularChunkGridMetadata,
+    RegularChunkGridName,
+    RegularChunkGridObject,
+)
+
+__all__ = [
+    "RECTILINEAR_CHUNK_GRID",
+    "RECTILINEAR_CHUNK_GRID_NAME",
+    "REGULAR_CHUNK_GRID",
+    "REGULAR_CHUNK_GRID_NAME",
+    "RectilinearChunkGridConfiguration",
+    "RectilinearChunkGridMetadata",
+    "RectilinearChunkGridName",
+    "RectilinearChunkGridObject",
+    "RectilinearDimSpec",
+    "RegularChunkGridConfiguration",
+    "RegularChunkGridMetadata",
+    "RegularChunkGridName",
+    "RegularChunkGridObject",
+    "canonical_chunk_shapes",
+    "canonical_dim_spec",
+]

packages/zarr-metadata/src/zarr_metadata/v3/chunk_key_encoding/__init__.py

@@ -9,12 +9,51 @@
   https://github.com/zarr-developers/zarr-specs/blob/fc7dd9c9beb5a50b87f9b08b00bf50fc0048482f/docs/v3/chunk-key-encodings/default/index.rst
   https://github.com/zarr-developers/zarr-specs/blob/fc7dd9c9beb5a50b87f9b08b00bf50fc0048482f/docs/v3/chunk-key-encodings/v2/index.rst
 
-Import an encoding's types and its definition from its submodule:
+Import an encoding's types and its definition from its submodule, or from
+this package, which re-exports every name its submodules export:
 `<X>ChunkKeyEncodingMetadata`, the canonical type for the encoding's
 permitted JSON shapes, `<X>ChunkKeyEncodingObject`,
 `<X>ChunkKeyEncodingConfiguration`, and `<X>_CHUNK_KEY_ENCODING`.
 
 See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#chunk-key-encoding
 """
 
-__all__: list[str] = []
+from zarr_metadata.v3.chunk_key_encoding.default import (
+    DEFAULT_CHUNK_KEY_ENCODING,
+    DEFAULT_CHUNK_KEY_ENCODING_NAME,
+    DEFAULT_CHUNK_KEY_ENCODING_SEPARATOR,
+    DefaultChunkKeyEncodingConfiguration,
+    DefaultChunkKeyEncodingMetadata,
+    DefaultChunkKeyEncodingName,
+    DefaultChunkKeyEncodingObject,
+    DefaultChunkKeyEncodingSeparator,
+)
+from zarr_metadata.v3.chunk_key_encoding.v2 import (
+    V2_CHUNK_KEY_ENCODING,
+    V2_CHUNK_KEY_ENCODING_NAME,
+    V2_CHUNK_KEY_ENCODING_SEPARATOR,
+    V2ChunkKeyEncodingConfiguration,
+    V2ChunkKeyEncodingMetadata,
+    V2ChunkKeyEncodingName,
+    V2ChunkKeyEncodingObject,
+    V2ChunkKeyEncodingSeparator,
+)
+
+__all__ = [
+    "DEFAULT_CHUNK_KEY_ENCODING",
+    "DEFAULT_CHUNK_KEY_ENCODING_NAME",
+    "DEFAULT_CHUNK_KEY_ENCODING_SEPARATOR",
+    "V2_CHUNK_KEY_ENCODING",
+    "V2_CHUNK_KEY_ENCODING_NAME",
+    "V2_CHUNK_KEY_ENCODING_SEPARATOR",
+    "DefaultChunkKeyEncodingConfiguration",
+    "DefaultChunkKeyEncodingMetadata",
+    "DefaultChunkKeyEncodingName",
+    "DefaultChunkKeyEncodingObject",
+    "DefaultChunkKeyEncodingSeparator",
+    "V2ChunkKeyEncodingConfiguration",
+    "V2ChunkKeyEncodingMetadata",
+    "V2ChunkKeyEncodingName",
+    "V2ChunkKeyEncodingObject",
+    "V2ChunkKeyEncodingSeparator",
+]

packages/zarr-metadata/src/zarr_metadata/v3/codec/__init__.py

@@ -2,11 +2,13 @@
 
 Each codec defined by the spec or by zarr-extensions has its own submodule
 (`blosc`, `bytes`, `cast_value`, `crc32c`, `gzip`, `scale_offset`,
-`sharding_indexed`, `transpose`, `vlen_bytes`, `vlen_utf8`, `zstd`). Import a codec's types and its
-definition from its submodule: `<X>CodecMetadata`, the canonical type for
-the codec's permitted JSON shapes (object form plus, where the spec allows,
-a bare-string short-hand form), `<X>CodecObject`, `<X>_CODEC`, and, for a
-codec that has a configuration, `<X>CodecConfiguration`.
+`sharding_indexed`, `transpose`, `vlen_bytes`, `vlen_utf8`, `zstd`). Import a
+codec's types and its definition from its submodule, or from this package,
+which re-exports every name its submodules export: `<X>CodecMetadata`, the
+canonical type for the codec's permitted JSON shapes (object form plus,
+where the spec allows, a bare-string short-hand form), `<X>CodecObject`,
+`<X>_CODEC`, and, for a codec that has a configuration,
+`<X>CodecConfiguration`.
 
 For the JSON of any codec entry (one of the entries in array metadata's
 `codecs`), import `ZarrV3MetadataFieldJSON` from `zarr_metadata.v3`. A
@@ -22,4 +24,188 @@
 See https://zarr-specs.readthedocs.io/en/latest/v3/codecs/index.html
 """
 
-__all__: list[str] = []
+from zarr_metadata.v3.codec.blosc import (
+    BLOSC_CNAME,
+    BLOSC_CODEC,
+    BLOSC_CODEC_NAME,
+    BLOSC_NO_SHUFFLE,
+    BLOSC_SHUFFLE,
+    BloscCName,
+    BloscCodecConfiguration,
+    BloscCodecMetadata,
+    BloscCodecName,
+    BloscCodecObject,
+    BloscShuffle,
+)
+from zarr_metadata.v3.codec.bytes import (
+    BYTES_CODEC,
+    BYTES_CODEC_NAME,
+    ENDIANNESS,
+    BytesCodecConfiguration,
+    BytesCodecMetadata,
+    BytesCodecName,
+    BytesCodecObject,
+    Endianness,
+)
+from zarr_metadata.v3.codec.cast_value import (
+    CAST_OUT_OF_RANGE_MODE,
+    CAST_ROUNDING_MODE,
+    CAST_VALUE_CODEC,
+    CAST_VALUE_CODEC_NAME,
+    CastOutOfRangeMode,
+    CastRoundingMode,
+    CastValueCodecConfiguration,
+    CastValueCodecMetadata,
+    CastValueCodecName,
+    CastValueCodecObject,
+    ScalarMap,
+    ScalarMapEntry,
+)
+from zarr_metadata.v3.codec.crc32c import (
+    CRC32C_CODEC,
+    CRC32C_CODEC_NAME,
+    Crc32cCodecMetadata,
+    Crc32cCodecName,
+    Crc32cCodecObject,
+)
+from zarr_metadata.v3.codec.gzip import (
+    GZIP_CODEC,
+    GZIP_CODEC_NAME,
+    GzipCodecConfiguration,
+    GzipCodecMetadata,
+    GzipCodecName,
+    GzipCodecObject,
+)
+from zarr_metadata.v3.codec.scale_offset import (
+    SCALE_OFFSET_CODEC,
+    SCALE_OFFSET_CODEC_NAME,
+    ScaleOffsetCodecConfiguration,
+    ScaleOffsetCodecMetadata,
+    ScaleOffsetCodecName,
+    ScaleOffsetCodecObject,
+)
+from zarr_metadata.v3.codec.sharding_indexed import (
+    SHARDING_INDEX_LOCATION,
+    SHARDING_INDEXED_CODEC,
+    SHARDING_INDEXED_CODEC_NAME,
+    ShardingIndexedCodecConfiguration,
+    ShardingIndexedCodecMetadata,
+    ShardingIndexedCodecName,
+    ShardingIndexedCodecObject,
+    ShardingIndexLocation,
+)
+from zarr_metadata.v3.codec.transpose import (
+    TRANSPOSE_CODEC,
+    TRANSPOSE_CODEC_NAME,
+    TransposeCodecConfiguration,
+    TransposeCodecMetadata,
+    TransposeCodecName,
+    TransposeCodecObject,
+)
+from zarr_metadata.v3.codec.vlen_bytes import (
+    VLEN_BYTES_CODEC,
+    VLEN_BYTES_CODEC_NAME,
+    VlenBytesCodecMetadata,
+    VlenBytesCodecName,
+    VlenBytesCodecObject,
+)
+from zarr_metadata.v3.codec.vlen_utf8 import (
+    VLEN_UTF8_CODEC,
+    VLEN_UTF8_CODEC_NAME,
+    VlenUtf8CodecMetadata,
+    VlenUtf8CodecName,
+    VlenUtf8CodecObject,
+)
+from zarr_metadata.v3.codec.zstd import (
+    ZSTD_CODEC,
+    ZSTD_CODEC_NAME,
+    ZSTD_MAX_LEVEL,
+    ZSTD_MIN_LEVEL,
+    ZstdCodecConfiguration,
+    ZstdCodecMetadata,
+    ZstdCodecName,
+    ZstdCodecObject,
+)
+
+__all__ = [
+    "BLOSC_CNAME",
+    "BLOSC_CODEC",
+    "BLOSC_CODEC_NAME",
+    "BLOSC_NO_SHUFFLE",
+    "BLOSC_SHUFFLE",
+    "BYTES_CODEC",
+    "BYTES_CODEC_NAME",
+    "CAST_OUT_OF_RANGE_MODE",
+    "CAST_ROUNDING_MODE",
+    "CAST_VALUE_CODEC",
+    "CAST_VALUE_CODEC_NAME",
+    "CRC32C_CODEC",
+    "CRC32C_CODEC_NAME",
+    "ENDIANNESS",
+    "GZIP_CODEC",
+    "GZIP_CODEC_NAME",
+    "SCALE_OFFSET_CODEC",
+    "SCALE_OFFSET_CODEC_NAME",
+    "SHARDING_INDEXED_CODEC",
+    "SHARDING_INDEXED_CODEC_NAME",
+    "SHARDING_INDEX_LOCATION",
+    "TRANSPOSE_CODEC",
+    "TRANSPOSE_CODEC_NAME",
+    "VLEN_BYTES_CODEC",
+    "VLEN_BYTES_CODEC_NAME",
+    "VLEN_UTF8_CODEC",
+    "VLEN_UTF8_CODEC_NAME",
+    "ZSTD_CODEC",
+    "ZSTD_CODEC_NAME",
+    "ZSTD_MAX_LEVEL",
+    "ZSTD_MIN_LEVEL",
+    "BloscCName",
+    "BloscCodecConfiguration",
+    "BloscCodecMetadata",
+    "BloscCodecName",
+    "BloscCodecObject",
+    "BloscShuffle",
+    "BytesCodecConfiguration",
+    "BytesCodecMetadata",
+    "BytesCodecName",
+    "BytesCodecObject",
+    "CastOutOfRangeMode",
+    "CastRoundingMode",
+    "CastValueCodecConfiguration",
+    "CastValueCodecMetadata",
+    "CastValueCodecName",
+    "CastValueCodecObject",
+    "Crc32cCodecMetadata",
+    "Crc32cCodecName",
+    "Crc32cCodecObject",
+    "Endianness",
+    "GzipCodecConfiguration",
+    "GzipCodecMetadata",
+    "GzipCodecName",
+    "GzipCodecObject",
+    "ScalarMap",
+    "ScalarMapEntry",
+    "ScaleOffsetCodecConfiguration",
+    "ScaleOffsetCodecMetadata",
+    "ScaleOffsetCodecName",
+    "ScaleOffsetCodecObject",
+    "ShardingIndexLocation",
+    "ShardingIndexedCodecConfiguration",
+    "ShardingIndexedCodecMetadata",
+    "ShardingIndexedCodecName",
+    "ShardingIndexedCodecObject",
+    "TransposeCodecConfiguration",
+    "TransposeCodecMetadata",
+    "TransposeCodecName",
+    "TransposeCodecObject",
+    "VlenBytesCodecMetadata",
+    "VlenBytesCodecName",
+    "VlenBytesCodecObject",
+    "VlenUtf8CodecMetadata",
+    "VlenUtf8CodecName",
+    "VlenUtf8CodecObject",
+    "ZstdCodecConfiguration",
+    "ZstdCodecMetadata",
+    "ZstdCodecName",
+    "ZstdCodecObject",
+]