Skip to content

Add type annotations to open_zarr #11226

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

Open
wavebyrd wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −23
Open

Add type annotations to open_zarr #11226

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
47 changes: 24 additions & 23 deletions xarray/backends/zarr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import json
import os
import struct
from collections.abc import Hashable, Iterable, Mapping
from collections.abc import Hashable, Iterable, Mapping, MutableMapping
from typing import TYPE_CHECKING, Any, Literal, Self, cast

import numpy as np
Expand All @@ -28,6 +28,7 @@
from xarray.core.treenode import NodePath
from xarray.core.types import ZarrWriteModes
from xarray.core.utils import (
Default,
FrozenDict,
HiddenKeyDict,
_default,
Expand All @@ -43,7 +44,7 @@
if TYPE_CHECKING:
from xarray.core.dataset import Dataset
from xarray.core.datatree import DataTree
from xarray.core.types import ZarrArray, ZarrGroup
from xarray.core.types import T_Chunks, ZarrArray, ZarrGroup


def _get_mappers(*, storage_options, store, chunk_store):
Expand Down Expand Up @@ -1411,30 +1412,30 @@ def _validate_encoding(self, encoding) -> None:


def open_zarr(
store,
group=None,
synchronizer=None,
chunks=_default,
decode_cf=True,
mask_and_scale=True,
decode_times=True,
concat_characters=True,
store: str | os.PathLike[Any] | MutableMapping | None,
Copy link
Collaborator

@headtr1ck headtr1ck Mar 19, 2026

Choose a reason for hiding this comment

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

Could you add the generic types of MutableMapping?
I don't actually know what it should be, probably MutableMapping[str, str]?

Copy link
Collaborator

@headtr1ck headtr1ck Mar 21, 2026

Choose a reason for hiding this comment

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

Actually mypy complains here. Maybe you can simply use xarray.backends.common.T_PathFileOrDataStore?

group: str | None = None,
synchronizer: object | None = None,
chunks: T_Chunks | Default = _default,
decode_cf: bool = True,
Copy link
Collaborator

@headtr1ck headtr1ck Mar 21, 2026

Choose a reason for hiding this comment

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

Mypy says that this can also take a CFTimeCoder?

mask_and_scale: bool = True,
decode_times: bool = True,
concat_characters: bool = True,
decode_coords: Literal["coordinates", "all"] | bool = True,
drop_variables=None,
consolidated=None,
overwrite_encoded_chunks=False,
chunk_store=None,
storage_options=None,
decode_timedelta=None,
use_cftime=None,
zarr_version=None,
zarr_format=None,
use_zarr_fill_value_as_mask=None,
drop_variables: str | Iterable[str] | None = None,
consolidated: bool | None = None,
overwrite_encoded_chunks: bool = False,
chunk_store: MutableMapping | None = None,
storage_options: dict[str, Any] | None = None,
decode_timedelta: bool | None = None,
use_cftime: bool | None = None,
zarr_version: int | None = None,
zarr_format: int | None = None,
use_zarr_fill_value_as_mask: bool | None = None,
chunked_array_type: str | None = None,
from_array_kwargs: dict[str, Any] | None = None,
create_default_indexes=True,
**kwargs,
):
create_default_indexes: bool = True,
**kwargs: Any,
) -> Dataset:
"""Load and decode a dataset from a Zarr store.

The `store` object should be a valid store for a Zarr group. `store`
Expand Down
Loading