Skip to content

docs: fix docstring for Array.cdata_shape #3768

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
maxrjones merged 3 commits into from
Mar 12, 2026
+19 −6
Merged

docs: fix docstring for Array.cdata_shape #3768

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2d7049
docs: fix docstring for Array.cdata_shape
maxrjones Mar 11, 2026
75c5bc5
Fix more docstrings
maxrjones Mar 11, 2026
3c4b6db
Update array.py
maxrjones Mar 11, 2026
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
25 changes: 19 additions & 6 deletions src/zarr/core/array.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1235,24 +1235,28 @@ def basename(self) -> str:
@property
def cdata_shape(self) -> tuple[int, ...]:
"""
The shape of the chunk grid for this array.
The number of chunks along each dimension.

When sharding is used, this counts inner chunks (not shards) per dimension.

Returns
-------
tuple[int, ...]
The shape of the chunk grid for this array.
The number of chunks along each dimension.
"""
return self._chunk_grid_shape

@property
def _chunk_grid_shape(self) -> tuple[int, ...]:
"""
The shape of the chunk grid for this array.
The number of chunks along each dimension.

When sharding is used, this counts inner chunks (not shards) per dimension.

Returns
-------
tuple[int, ...]
The shape of the chunk grid for this array.
The number of chunks along each dimension.
"""
return tuple(starmap(ceildiv, zip(self.shape, self.chunks, strict=True)))

Expand Down Expand Up @@ -2399,14 +2403,23 @@ def compressors(self) -> tuple[Numcodec, ...] | tuple[BytesBytesCodec, ...]:
@property
def cdata_shape(self) -> tuple[int, ...]:
"""
The shape of the chunk grid for this array.
The number of chunks along each dimension.

When sharding is used, this counts inner chunks (not shards) per dimension.
"""
return self.async_array._chunk_grid_shape

@property
def _chunk_grid_shape(self) -> tuple[int, ...]:
"""
The shape of the chunk grid for this array.
The number of chunks along each dimension.

When sharding is used, this counts inner chunks (not shards) per dimension.

Returns
-------
tuple[int, ...]
The number of chunks along each dimension.
"""
return self.async_array._chunk_grid_shape

Expand Down
Loading