np -> numpy

Author: d-v-b

docs/user-guide/data_types.rst

@@ -179,7 +179,7 @@ We do this with an abstract Zarr data type class: `ZDType <../api/zarr/dtype/ind
 which provides Zarr V2 and Zarr V3 compatibility routines for "native" data types.
 
 In this context, a "native" data type is a Python class, typically defined in another library, that
-models an array's data type. For example, ``np.dtypes.UInt8DType`` is a native data type defined in NumPy.
+models an array's data type. For example, ``numpy.dtypes.UInt8DType`` is a native data type defined in NumPy.
 Zarr Python wraps the NumPy ``uint8`` with a ``ZDType`` instance called
 `UInt8 <../api/zarr/dtype/index.html#zarr.dtype.ZDType>`_.
 

src/zarr/core/dtype/npy/bool.py

@@ -23,8 +23,8 @@ class Bool(ZDType[np.dtypes.BoolDType, np.bool_], HasItemSize):
     """
     A Zarr data type for arrays containing booleans.
 
-    Wraps the NumPy ``np.dtypes.BoolDType`` data type. Scalars for this data type are instances of
-    ``np.bool_``.
+    Wraps the ``numpy.dtypes.BoolDType`` data type. Scalars for this data type are instances of
+    ``numpy.bool_``.
 
     Attributes
     ----------
@@ -235,7 +235,7 @@ def cast_scalar(self, data: object) -> np.bool_:
 
         Returns
         -------
-        np.bool_
+        numpy.bool_
             The numpy boolean scalar.
 
         Raises
@@ -254,7 +254,7 @@ def default_scalar(self) -> np.bool_:
 
         Returns
         -------
-        np.bool_
+        numpy.bool_
             The default value.
         """
         return np.False_
@@ -290,7 +290,7 @@ def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.bool_:
 
         Returns
         -------
-        np.bool_
+        numpy.bool_
             The numpy boolean scalar.
 
         Raises

src/zarr/core/dtype/npy/bytes.py

@@ -37,8 +37,8 @@ class NullTerminatedBytes(ZDType[np.dtypes.BytesDType[int], np.bytes_], HasLengt
     """
     A Zarr data type for arrays containing fixed-length null-terminated byte sequences.
 
-    Wraps the NumPy ``np.dtypes.BytesDType`` data type. Scalars for this data type are instances of
-    ``np.bytes_``.
+    Wraps the ``numpy.dtypes.BytesDType`` data type. Scalars for this data type are instances of
+    ``numpy.bytes_``.
 
     This data type is parametrized by an integral length which specifies size in bytes of each
     scalar. Because this data type uses null-terminated semantics, indexing into
@@ -60,16 +60,16 @@ class NullTerminatedBytes(ZDType[np.dtypes.BytesDType[int], np.bytes_], HasLengt
     from_json(data, zarr_format) : NullTerminatedBytes
         Create NullTerminatedBytes from JSON data.
 
-    cast_scalar(data) : np.bytes_
+    cast_scalar(data) : numpy.bytes_
         Cast a python object to np.bytes_.
 
-    default_scalar() : np.bytes_
+    default_scalar() : numpy.bytes_
         Return the default scalar value.
 
     to_json_scalar(data, zarr_format) : str
         Convert input to a scalar and return as JSON data.
 
-    from_json_scalar(data, zarr_format) : np.bytes_
+    from_json_scalar(data, zarr_format) : numpy.bytes_
         Create np.bytes_ from JSON data.
 
     item_size : int
@@ -294,7 +294,7 @@ def _check_scalar(self, data: object) -> TypeGuard[BytesLike]:
 
     def _cast_scalar_unchecked(self, data: BytesLike) -> np.bytes_:
         """
-        Cast the provided scalar data to ``np.bytes_``, truncating if necessary.
+        Cast the provided scalar data to ``numpy.bytes_``, truncating if necessary.
 
         Parameters
         ----------
@@ -303,7 +303,7 @@ def _cast_scalar_unchecked(self, data: BytesLike) -> np.bytes_:
 
         Returns
         -------
-        np.bytes_
+        numpy.bytes_
             The casted data as a NumPy bytes scalar.
 
         Notes
@@ -331,7 +331,7 @@ def cast_scalar(self, data: object) -> np.bytes_:
 
         Returns
         -------
-        np.bytes_
+        numpy.bytes_
             The data cast as a NumPy bytes scalar.
 
         Raises
@@ -351,7 +351,7 @@ def default_scalar(self) -> np.bytes_:
 
         Returns
         -------
-        np.bytes_
+        numpy.bytes_
             The default scalar value.
         """
         return np.bytes_(b"")
@@ -391,7 +391,7 @@ def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.bytes_:
 
         Returns
         -------
-        np.bytes_
+        numpy.bytes_
             The NumPy bytes scalar obtained from decoding the base64 string.
 
         Raises
@@ -424,7 +424,7 @@ class RawBytes(ZDType[np.dtypes.VoidDType[int], np.void], HasLength, HasItemSize
     """
     A Zarr data type for arrays containing fixed-length sequences of raw bytes.
 
-    Wraps the NumPy ``void`` data type. Scalars for this data type are instances of ``np.void``.
+    Wraps the NumPy ``void`` data type. Scalars for this data type are instances of ``numpy.void``.
 
     This data type is parametrized by an integral length which specifies size in bytes of each
     scalar belonging to this data type.
@@ -454,7 +454,7 @@ class RawBytes(ZDType[np.dtypes.VoidDType[int], np.void], HasLength, HasItemSize
     to_json_scalar(data, zarr_format) : str
         Convert input to a scalar and return as JSON data.
 
-    from_json_scalar(data, zarr_format) : np.bytes_
+    from_json_scalar(data, zarr_format) : numpy.bytes_
         Create a np.void from JSON data.
 
     item_size : int
@@ -724,7 +724,7 @@ def _cast_scalar_unchecked(self, data: object) -> np.void:
 
         Returns
         -------
-        np.void
+        numpy.void
             The casted data as a NumPy void scalar.
 
         Notes
@@ -753,7 +753,7 @@ def cast_scalar(self, data: object) -> np.void:
 
         Returns
         -------
-        np.void
+        numpy.void
             The data cast as a NumPy void scalar.
 
         Raises
@@ -775,7 +775,7 @@ def default_scalar(self) -> np.void:
 
         Returns
         -------
-        np.void
+        numpy.void
             The default scalar value.
         """
         return self.to_native_dtype().type(("\x00" * self.length).encode("ascii"))
@@ -815,7 +815,7 @@ def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.void:
 
         Returns
         -------
-        np.void
+        numpy.void
             The NumPy void scalar.
 
         Raises

src/zarr/core/dtype/npy/complex.py

@@ -349,8 +349,8 @@ class Complex64(BaseComplex[np.dtypes.Complex64DType, np.complex64]):
     """
     A Zarr data type for arrays containing 64 bit complex floats.
 
-    Wraps the NumPy ``np.dtypes.Complex64DType`` data type. Scalars for this data type
-    are instances of ``np.complex64``.
+    Wraps the ``numpy.dtypes.Complex64DType`` data type. Scalars for this data type
+    are instances of ``numpy.complex64``.
 
     Attributes
     ----------
@@ -384,8 +384,8 @@ class Complex128(BaseComplex[np.dtypes.Complex128DType, np.complex128], HasEndia
     """
     A Zarr data type for arrays containing 64 bit complex floats.
 
-    Wraps the NumPy ``np.dtypes.Complex128DType`` data type. Scalars for this data type
-    are instances of ``np.complex128``.
+    Wraps the ``numpy.dtypes.Complex128DType`` data type. Scalars for this data type
+    are instances of ``numpy.complex128``.
 
     Attributes
     ----------

src/zarr/core/dtype/npy/float.py

@@ -317,8 +317,8 @@ class Float16(BaseFloat[np.dtypes.Float16DType, np.float16]):
     """
     A Zarr data type for arrays containing 16-bit floating point numbers.
 
-    Wraps the NumPy ``np.dtypes.Float16DType`` data type. Scalars for this data type are instances
-    of ``np.float16``.
+    Wraps the ``numpy.dtypes.Float16DType`` data type. Scalars for this data type are instances
+    of ``numpy.float16``.
 
     Attributes
     ----------
@@ -352,8 +352,8 @@ class Float32(BaseFloat[np.dtypes.Float32DType, np.float32]):
     """
     A Zarr data type for arrays containing 32-bit floating point numbers.
 
-    Wraps the NumPy ``np.dtypes.Float32DType`` data type. Scalars for this data type are instances
-    of ``np.float32``.
+    Wraps the ``numpy.dtypes.Float32DType`` data type. Scalars for this data type are instances
+    of ``numpy.float32``.
 
     Attributes
     ----------
@@ -387,8 +387,8 @@ class Float64(BaseFloat[np.dtypes.Float64DType, np.float64]):
     """
     A Zarr data type for arrays containing 64-bit floating point numbers.
 
-    Wraps the NumPy ``np.dtypes.Float64DType`` data type. Scalars for this data type are instances
-    of ``np.float64``.
+    Wraps the ``numpy.dtypes.Float64DType`` data type. Scalars for this data type are instances
+    of ``numpy.float64``.
 
     Attributes
     ----------

src/zarr/core/dtype/npy/int.py

@@ -258,8 +258,8 @@ class Int8(BaseInt[np.dtypes.Int8DType, np.int8]):
     """
     A Zarr data type for arrays containing 8-bit signed integers.
 
-    Wraps the NumPy ``np.dtypes.Int8DType`` data type. Scalars for this data type are
-    instances of ``np.int8``.
+    Wraps the ``numpy.dtypes.Int8DType`` data type. Scalars for this data type are
+    instances of ``numpy.int8``.
 
     Attributes
     ----------
@@ -413,7 +413,7 @@ class UInt8(BaseInt[np.dtypes.UInt8DType, np.uint8]):
     """
     A Zarr data type for arrays containing 8-bit unsigned integers.
 
-    Wraps the NumPy ``np.dtypes.UInt8DType`` data type. Scalars for this data type are instances of ``np.uint8``.
+    Wraps the ``numpy.dtypes.UInt8DType`` data type. Scalars for this data type are instances of ``numpy.uint8``.
 
     Attributes
     ----------
@@ -557,8 +557,8 @@ class Int16(BaseInt[np.dtypes.Int16DType, np.int16], HasEndianness):
     """
     A Zarr data type for arrays containing 16-bit signed integers.
 
-    Wraps the NumPy ``np.dtypes.Int16DType`` data type. Scalars for this data type are instances of
-    ``np.int16``.
+    Wraps the ``numpy.dtypes.Int16DType`` data type. Scalars for this data type are instances of
+    ``numpy.int16``.
 
     Attributes
     ----------
@@ -717,8 +717,8 @@ class UInt16(BaseInt[np.dtypes.UInt16DType, np.uint16], HasEndianness):
     """
     A Zarr data type for arrays containing 16-bit unsigned integers.
 
-    Wraps the NumPy ``np.dtypes.UInt16DType`` data type. Scalars for this data type are instances of
-    ``np.uint16``.
+    Wraps the ``numpy.dtypes.UInt16DType`` data type. Scalars for this data type are instances of
+    ``numpy.uint16``.
 
     Attributes
     ----------
@@ -877,8 +877,8 @@ class Int32(BaseInt[np.dtypes.Int32DType, np.int32], HasEndianness):
     """
     A Zarr data type for arrays containing 32-bit signed integers.
 
-    Wraps the NumPy ``np.dtypes.Int32DType`` data type. Scalars for this data type are instances of
-    ``np.int32``.
+    Wraps the ``numpy.dtypes.Int32DType`` data type. Scalars for this data type are instances of
+    ``numpy.int32``.
 
     Attributes
     ----------
@@ -1037,8 +1037,8 @@ class UInt32(BaseInt[np.dtypes.UInt32DType, np.uint32], HasEndianness):
     """
     A Zarr data type for arrays containing 32-bit unsigned integers.
 
-    Wraps the NumPy ``np.dtypes.UInt32DType`` data type. Scalars for this data type are instances of
-    ``np.uint32``.
+    Wraps the ``numpy.dtypes.UInt32DType`` data type. Scalars for this data type are instances of
+    ``numpy.uint32``.
 
     Attributes
     ----------
@@ -1193,8 +1193,8 @@ class Int64(BaseInt[np.dtypes.Int64DType, np.int64], HasEndianness):
     """
     A Zarr data type for arrays containing 64-bit signed integers.
 
-    Wraps the NumPy ``np.dtypes.Int64DType`` data type. Scalars for this data type are instances of
-    ``np.int64``.
+    Wraps the ``numpy.dtypes.Int64DType`` data type. Scalars for this data type are instances of
+    ``numpy.int64``.
 
     Attributes
     ----------
@@ -1349,8 +1349,8 @@ class UInt64(BaseInt[np.dtypes.UInt64DType, np.uint64], HasEndianness):
     """
     A Zarr data type for arrays containing 64-bit unsigned integers.
 
-    Wraps the NumPy ``np.dtypes.UInt64DType`` data type. Scalars for this data type
-    are instances of ``np.uint64``.
+    Wraps the ``numpy.dtypes.UInt64DType`` data type. Scalars for this data type
+    are instances of ``numpy.uint64``.
 
     Attributes
     ----------

src/zarr/core/dtype/npy/string.py

@@ -62,8 +62,8 @@ class FixedLengthUTF32(
     """
     A Zarr data type for arrays containing fixed-length UTF-32 strings.
 
-    Wraps the NumPy ``np.dtypes.StrDType`` data type. Scalars for this data type are instances of
-    ``np.str_``.
+    Wraps the ``numpy.dtypes.StrDType`` data type. Scalars for this data type are instances of
+    ``numpy.str_``.
 
     Attributes
     ----------
@@ -244,7 +244,7 @@ def default_scalar(self) -> np.str_:
 
         Returns
         -------
-        np.str_
+        numpy.str_
             The default scalar value.
         """
         return np.str_("")
@@ -280,7 +280,7 @@ def from_json_scalar(self, data: JSON, *, zarr_format: ZarrFormat) -> np.str_:
 
         Returns
         -------
-        np.str_
+        numpy.str_
             The native scalar value.
         """
         if check_json_str(data):
@@ -315,7 +315,7 @@ def cast_scalar(self, data: object) -> np.str_:
 
         Returns
         -------
-        np.str_
+        numpy.str_
             The native scalar value.
         """
         if self._check_scalar(data):
@@ -643,7 +643,7 @@ class VariableLengthUTF8(UTF8Base[np.dtypes.StringDType]):  # type: ignore[type-
         """
         A Zarr data type for arrays containing variable-length UTF-8 strings.
 
-        Wraps the NumPy ``np.dtypes.StringDType`` data type. Scalars for this data type are instances
+        Wraps the ``numpy.dtypes.StringDType`` data type. Scalars for this data type are instances
         of ``str``.
 
 
@@ -677,7 +677,7 @@ class VariableLengthUTF8(UTF8Base[np.dtypes.ObjectDType]):  # type: ignore[no-re
         """
         A Zarr data type for arrays containing variable-length UTF-8 strings.
 
-        Wraps the NumPy ``np.dtypes.ObjectDType`` data type. Scalars for this data type are instances
+        Wraps the ``numpy.dtypes.ObjectDType`` data type. Scalars for this data type are instances
         of ``str``.