Class IteratorResult

lib/sqlalchemy/engine/result.py:1812–1906

A :class:`_engine.Result` that gets data from a Python iterator of :class:`_engine.Row` objects or similar row-like data. .. versionadded:: 1.4

class IteratorResult(Result[Unpack[_Ts]]):
    """A :class:`_engine.Result` that gets data from a Python iterator of
    :class:`_engine.Row` objects or similar row-like data.

    .. versionadded:: 1.4

    """

    _hard_closed = False
    _soft_closed = False

    def __init__(
        self,
        cursor_metadata: ResultMetaData,
        iterator: Iterator[_InterimSupportsScalarsRowType],
        raw: Optional[Result[Any]] = None,
        _source_supports_scalars: bool = False,
        context: Optional[Any] = None,
    ):
        self._metadata = cursor_metadata
        self.iterator = iterator
        self.raw = raw
        self._source_supports_scalars = _source_supports_scalars
        self.context = context

    @property
    def closed(self) -> bool:
        """Return ``True`` if this :class:`_engine.IteratorResult` was
        **hard closed** by explicitly calling the :meth:`_engine.Result.close`
        method.

        The attribute is **not** True if the :class:`_engine.Result` was only
        **soft closed**; a "soft close" is the style of close that takes place
        for example when the :class:`.CursorResult` is returned for a DML
        only statement without RETURNING, or when all result rows are fetched.

        .. seealso::

            :attr:`.CursorResult.returns_rows` -  attribute specific to
            :class:`.CursorResult` which indicates if the result is one that
            may return zero or more rows

        """
        return self._hard_closed

    def _soft_close(self, hard: bool = False, **kw: Any) -> None:
        if hard:
            self._hard_closed = True
        if self.raw is not None:
            self.raw._soft_close(hard=hard, **kw)
        self.iterator = iter([])
        self._reset_memoizations()
        self._soft_closed = True

    def _raise_hard_closed(self) -> NoReturn:
        raise exc.ResourceClosedError("This result object is closed.")

    def _raw_row_iterator(self) -> Iterator[_RowData]: