Method read

tables/array.py:895–938

Get data in the array as an object of the current flavor. The start, stop and step parameters can be used to select only a *range of rows* in the array. Their meanings are the same as in the built-in range() Python function, except that negative values of step are n

(
        self,
        start: int | None = None,
        stop: int | None = None,
        step: int | None = None,
        out: np.ndarray | None = None,
    )

        return arr

    def read(
        self,
        start: int | None = None,
        stop: int | None = None,
        step: int | None = None,
        out: np.ndarray | None = None,
    ) -> np.ndarray:
        """Get data in the array as an object of the current flavor.

        The start, stop and step parameters can be used to select only a
        *range of rows* in the array.  Their meanings are the same as in
        the built-in range() Python function, except that negative values
        of step are not allowed yet. Moreover, if only start is specified,
        then stop will be set to start + 1. If you do not specify neither
        start nor stop, then *all the rows* in the array are selected.

        The out parameter may be used to specify a NumPy array to receive
        the output data.  Note that the array must have the same size as
        the data selected with the other parameters.  Note that the array's
        datatype is not checked and no type casting is performed, so if it
        does not match the datatype on disk, the output will not be correct.
        Also, this parameter is only valid when the array's flavor is set
        to 'numpy'.  Otherwise, a TypeError will be raised.

        When data is read from disk in NumPy format, the output will be
        in the current system's byteorder, regardless of how it is stored
        on disk.
        The exception is when an output buffer is supplied, in which case
        the output will be in the byteorder of that output buffer.

        .. versionchanged:: 3.0
           Added the *out* parameter.

        """
        self._g_check_open()
        if out is not None and self.flavor != "numpy":
            msg = (
                f"Optional 'out' argument may only be supplied if array "
                f"flavor is 'numpy', currently is {self.flavor}"
            )
            raise TypeError(msg)
        start, stop, step = self._process_range_read(start, stop, step)
        arr = self._read(start, stop, step, out)
        return internal_to_flavor(arr, self.flavor)

    def _g_copy_with_stats(
        self,