Skip to content
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

Warn the user when shape or chunks contains float values #2579

Merged
merged 2 commits into from
Dec 28, 2024
Merged

Warn the user when shape or chunks contains float values #2579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1134be0
Warn user when shape or chunks contains non-integer values like floats
faymanns Dec 20, 2024
1ae98fd
Test for non-integer warnings
faymanns Dec 20, 2024
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
9 changes: 8 additions & 1 deletion zarr/tests/test_creation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import os.path
import shutil
import warnings
import numbers

import numpy as np
import pytest
Expand Down Expand Up @@ -762,7 +763,13 @@ def test_create_with_storage_transformers(at_root):
)
def test_shape_chunk_ints(init_shape, init_chunks, shape, chunks):
g = open_group()
array = g.create_dataset("ds", shape=init_shape, chunks=init_chunks, dtype=np.uint8)
if not isinstance(init_shape[0], numbers.Integral) or not isinstance(
init_chunks[0], numbers.Integral
):
with pytest.warns(UserWarning):
array = g.create_dataset("ds", shape=init_shape, chunks=init_chunks, dtype=np.uint8)
else:
array = g.create_dataset("ds", shape=init_shape, chunks=init_chunks, dtype=np.uint8)

assert all(
isinstance(s, int) for s in array.shape
Expand Down
3 changes: 2 additions & 1 deletion zarr/tests/test_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ def test_normalize_shape():
with pytest.raises(TypeError):
normalize_shape(None)
with pytest.raises(ValueError):
normalize_shape("foo")
with pytest.warns(UserWarning):
normalize_shape("foo")


def test_normalize_chunks():
Expand Down
6 changes: 6 additions & 0 deletions zarr/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
Iterable,
cast,
)
import warnings

import numpy as np
from asciitree import BoxStyle, LeftAligned
Expand Down Expand Up @@ -88,6 +89,8 @@ def normalize_shape(shape: Union[int, Tuple[int, ...], None]) -> Tuple[int, ...]

# normalize
shape = cast(Tuple[int, ...], shape)
if not all(isinstance(s, numbers.Integral) for s in shape):
warnings.warn("shape contains non-integer value(s)", UserWarning, stacklevel=2)
shape = tuple(int(s) for s in shape)
return shape

Expand Down Expand Up @@ -176,6 +179,9 @@ def normalize_chunks(chunks: Any, shape: Tuple[int, ...], typesize: int) -> Tupl
if -1 in chunks or None in chunks:
chunks = tuple(s if c == -1 or c is None else int(c) for s, c in zip(shape, chunks))

if not all(isinstance(c, numbers.Integral) for c in chunks):
warnings.warn("chunks contains non-integer value(s)", UserWarning, stacklevel=2)

chunks = tuple(int(c) for c in chunks)
return chunks

Expand Down
Loading