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

Consider (u)int64 as safe #87

Merged
merged 1 commit into from
Feb 1, 2024
Merged

Consider (u)int64 as safe #87

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
25 changes: 10 additions & 15 deletions h5grove/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,27 +194,21 @@ def get_type_metadata(type_id: h5py.h5t.TypeID) -> TypeMetadata:


def _sanitize_dtype(dtype: np.dtype) -> np.dtype:
"""Convert dtype to a dtype supported by js-numpy-parser.
"""Sanitize numpy dtype to one with a matching typed array in modern JavaScript.

See https://github.com/ludwigschubert/js-numpy-parser

:raises ValueError: For unsupported array dtype
:raises ValueError: If trying to sanitize a non-numeric numpy dtype
"""
if dtype.kind not in ("f", "i", "u"):
raise ValueError("Unsupported array type")
raise ValueError(f"Unsupported numpy dtype `{dtype}`. Expected numeric dtype.")

# Convert to little endian
result = dtype.newbyteorder("<")

if result.kind == "i" and result.itemsize > 4:
return np.dtype("<i4") # int64 -> int32

if result.kind == "u" and result.itemsize > 4:
return np.dtype("<u4") # uint64 -> uint32

# Convert float16 to float32
if result.kind == "f" and result.itemsize < 4:
return np.dtype("<f4")

# Convert float128 to float64 (unavoidable loss of precision)
if result.kind == "f" and result.itemsize > 8:
return np.dtype("<f8")

Expand All @@ -230,16 +224,17 @@ def convert(data: T, dtype: Optional[str] = "origin") -> T:
:param data: nD array or scalar to convert
:param dtype: Data type conversion query parameter
- `origin` (default): No conversion
- `safe`: Convert to a type supported by JS typedarray (https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
- `safe`: Convert to type with matching JS TypedArray (https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)

:raises QueryArgumentError: When using `dtype=safe` to convert non-numeric data
:raises QueryArgumentError: For unsupported `dtype` argument
"""
if dtype in ("origin", None):
return data

if dtype == "safe":
if not is_numeric_data(data):
raise QueryArgumentError(
f"Unsupported dtype {dtype} for non-numeric content"
)
raise QueryArgumentError(f"Unsupported dtype {dtype} for non-numeric data")
return data.astype(_sanitize_dtype(data.dtype), order="C", copy=False)

raise QueryArgumentError(f"Unsupported dtype {dtype}")
Expand Down
Loading