Skip to content

Rename the DimensionNames type to DimensionNamesLike. #3800

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.

Sign up for GitHub

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

Merged
d-v-b merged 1 commit into from
Mar 20, 2026
+33 −32
Merged

Rename the DimensionNames type to DimensionNamesLike. #3800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/zarr/api/asynchronous.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
from zarr.core.common import (
JSON,
AccessModeLiteral,
DimensionNames,
DimensionNamesLike,
MemoryOrder,
ZarrFormat,
_default_zarr_format,
Expand Down Expand Up @@ -914,7 +914,7 @@ async def create(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
config: ArrayConfigLike | None = None,
**kwargs: Any,
Expand Down
8 changes: 4 additions & 4 deletions src/zarr/api/synchronous.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
from zarr.core.common import (
JSON,
AccessModeLiteral,
DimensionNames,
DimensionNamesLike,
MemoryOrder,
ShapeLike,
ZarrFormat,
Expand Down Expand Up @@ -649,7 +649,7 @@ def create(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
config: ArrayConfigLike | None = None,
**kwargs: Any,
Expand Down Expand Up @@ -832,7 +832,7 @@ def create_array(
zarr_format: ZarrFormat | None = 3,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
overwrite: bool = False,
config: ArrayConfigLike | None = None,
Expand Down Expand Up @@ -1003,7 +1003,7 @@ def from_array(
zarr_format: ZarrFormat | None = None,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
overwrite: bool = False,
config: ArrayConfigLike | None = None,
Expand Down
30 changes: 15 additions & 15 deletions src/zarr/core/array.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
ZARR_JSON,
ZARRAY_JSON,
ZATTRS_JSON,
DimensionNames,
DimensionNamesLike,
MemoryOrder,
ShapeLike,
ZarrFormat,
Expand Down Expand Up @@ -389,7 +389,7 @@ async def create(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
# runtime
overwrite: bool = False,
data: npt.ArrayLike | None = None,
Expand Down Expand Up @@ -417,7 +417,7 @@ async def create(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
# runtime
overwrite: bool = False,
data: npt.ArrayLike | None = None,
Expand Down Expand Up @@ -445,7 +445,7 @@ async def create(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
# v2 only
chunks: ShapeLike | None = None,
dimension_separator: Literal[".", "/"] | None = None,
Expand Down Expand Up @@ -479,7 +479,7 @@ async def create(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
# v2 only
chunks: ShapeLike | None = None,
dimension_separator: Literal[".", "/"] | None = None,
Expand Down Expand Up @@ -630,7 +630,7 @@ async def _create(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
# v2 only
chunks: ShapeLike | None = None,
dimension_separator: Literal[".", "/"] | None = None,
Expand Down Expand Up @@ -742,7 +742,7 @@ def _create_metadata_v3(
fill_value: Any | None = DEFAULT_FILL_VALUE,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
attributes: dict[str, JSON] | None = None,
) -> ArrayV3Metadata:
"""
Expand Down Expand Up @@ -803,7 +803,7 @@ async def _create_v3(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
attributes: dict[str, JSON] | None = None,
overwrite: bool = False,
) -> AsyncArrayV3:
Expand Down Expand Up @@ -1998,7 +1998,7 @@ def create(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
# v2 only
chunks: tuple[int, ...] | None = None,
dimension_separator: Literal[".", "/"] | None = None,
Expand Down Expand Up @@ -2142,7 +2142,7 @@ def _create(
| None
) = None,
codecs: Iterable[Codec | dict[str, JSON]] | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
# v2 only
chunks: tuple[int, ...] | None = None,
dimension_separator: Literal[".", "/"] | None = None,
Expand Down Expand Up @@ -4266,7 +4266,7 @@ async def from_array(
zarr_format: ZarrFormat | None = None,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
overwrite: bool = False,
config: ArrayConfigLike | None = None,
Expand Down Expand Up @@ -4535,7 +4535,7 @@ async def init_array(
zarr_format: ZarrFormat | None = 3,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
overwrite: bool = False,
config: ArrayConfigLike | None = None,
) -> AnyAsyncArray:
Expand Down Expand Up @@ -4751,7 +4751,7 @@ async def create_array(
zarr_format: ZarrFormat | None = 3,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
overwrite: bool = False,
config: ArrayConfigLike | None = None,
Expand Down Expand Up @@ -4935,7 +4935,7 @@ def _parse_keep_array_attr(
order: MemoryOrder | None,
zarr_format: ZarrFormat | None,
chunk_key_encoding: ChunkKeyEncodingLike | None,
dimension_names: DimensionNames,
dimension_names: DimensionNamesLike,
) -> tuple[
tuple[int, ...] | Literal["auto"],
ShardsLike | None,
Expand All @@ -4946,7 +4946,7 @@ def _parse_keep_array_attr(
MemoryOrder | None,
ZarrFormat,
ChunkKeyEncodingLike | None,
DimensionNames,
DimensionNamesLike,
]:
if isinstance(data, Array):
if chunks == "keep":
Expand Down
3 changes: 2 additions & 1 deletion src/zarr/core/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
MemoryOrder = Literal["C", "F"]
AccessModeLiteral = Literal["r", "r+", "a", "w", "w-"]
ANY_ACCESS_MODE: Final = "r", "r+", "a", "w", "w-"
DimensionNames = Iterable[str | None] | None
DimensionNamesLike = Iterable[str | None] | None
DimensionNames = DimensionNamesLike # for backwards compatibility

TName = TypeVar("TName", bound=str)
TConfig = TypeVar("TConfig", bound=Mapping[str, object])
Expand Down
10 changes: 5 additions & 5 deletions src/zarr/core/group.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
ZATTRS_JSON,
ZGROUP_JSON,
ZMETADATA_V2_JSON,
DimensionNames,
DimensionNamesLike,
NodeType,
ShapeLike,
ZarrFormat,
Expand Down Expand Up @@ -1032,7 +1032,7 @@ async def create_array(
order: MemoryOrder | None = None,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
overwrite: bool = False,
config: ArrayConfigLike | None = None,
Expand Down Expand Up @@ -2483,7 +2483,7 @@ def create(
order: MemoryOrder | None = None,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
overwrite: bool = False,
config: ArrayConfigLike | None = None,
Expand Down Expand Up @@ -2627,7 +2627,7 @@ def create_array(
order: MemoryOrder | None = None,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
overwrite: bool = False,
config: ArrayConfigLike | None = None,
Expand Down Expand Up @@ -3025,7 +3025,7 @@ def array(
order: MemoryOrder | None = None,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
storage_options: dict[str, Any] | None = None,
overwrite: bool = False,
config: ArrayConfigLike | None = None,
Expand Down
4 changes: 2 additions & 2 deletions src/zarr/core/metadata/v3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
from zarr.core.common import (
JSON,
ZARR_JSON,
DimensionNames,
DimensionNamesLike,
NamedConfig,
parse_named_configuration,
parse_shapelike,
Expand Down Expand Up @@ -220,7 +220,7 @@ def __init__(
fill_value: object,
codecs: Iterable[Codec | dict[str, JSON] | NamedConfig[str, Any] | str],
attributes: dict[str, JSON] | None,
dimension_names: DimensionNames,
dimension_names: DimensionNamesLike,
storage_transformers: Iterable[dict[str, JSON]] | None = None,
extra_fields: Mapping[str, AllowedExtraField] | None = None,
) -> None:
Expand Down
6 changes: 3 additions & 3 deletions tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
from zarr.core.chunk_grids import RegularChunkGrid, _auto_partition
from zarr.core.common import (
JSON,
DimensionNames,
DimensionNamesLike,
MemoryOrder,
ShapeLike,
ZarrFormat,
Expand Down Expand Up @@ -313,7 +313,7 @@ def create_array_metadata(
zarr_format: ZarrFormat,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncoding | ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
) -> ArrayV2Metadata | ArrayV3Metadata:
"""
Create array metadata
Expand Down Expand Up @@ -452,7 +452,7 @@ def meta_from_array(
zarr_format: ZarrFormat = 3,
attributes: dict[str, JSON] | None = None,
chunk_key_encoding: ChunkKeyEncoding | ChunkKeyEncodingLike | None = None,
dimension_names: DimensionNames = None,
dimension_names: DimensionNamesLike = None,
) -> ArrayV3Metadata | ArrayV2Metadata:
"""
Create array metadata from an array
Expand Down