Method itersorted

tables/table.py:1782–1815

Iterate table data in the order of the index of sortby column. The sortby column must have associated a full index. If you want to ensure a fully sorted order, the index must be a CSI one. You may want to use the checkCSI argument in order to explicitly check for the

(
        self,
        sortby: Column | str,
        checkCSI: bool = False,  # noqa: N803
        start: int | None = None,
        stop: int | None = None,
        step: int | None = None,
    )

            )

    def itersorted(
        self,
        sortby: Column | str,
        checkCSI: bool = False,  # noqa: N803
        start: int | None = None,
        stop: int | None = None,
        step: int | None = None,
    ) -> Iterator[tableextension.Row]:
        """Iterate table data in the order of the index of sortby column.

        The sortby column must have associated a full index.  If you want to
        ensure a fully sorted order, the index must be a CSI one.  You may want
        to use the checkCSI argument in order to explicitly check for the
        existence of a CSI index.

        The meaning of the start, stop and step arguments is the same as in
        :meth:`Table.read`.

        .. versionchanged:: 3.0
           If the *start* parameter is provided and *stop* is None then the
           table is iterated from *start* to the last line.
           In PyTables < 3.0 only one element was returned.

        """
        index = self._check_sortby_csi(sortby, checkCSI)
        # Adjust the slice to be used.
        start, stop, step = self._process_range(
            start, stop, step, warn_negstep=False
        )
        if (start > stop and 0 < step) or (start < stop and 0 > step):
            # Fall-back action is to return an empty iterator
            return iter([])
        row = tableextension.Row(self)
        return row._iter(start, stop, step, coords=index)

    def read_sorted(
        self,