Class: QgsFeatureIterator¶

Wrapper for iterator of features from vector data provider or vector layer.

Methods

`close`	Call to end the iteration.
`compileFailed`	Indicator if there was an error when sending the compiled query to the server.
`compileStatus`	Returns the status of expression compilation for filter expression requests.
`isClosed`	find out whether the iterator is still valid or closed already
`isValid`	Will return if this iterator is valid.
`nextFeature`	Fetch next feature and stores in f, returns `True` on success.
`rewind`	Resets the iterator to the starting position.

class qgis.core.QgsFeatureIterator[source]¶

Bases: object

__init__(): Construct invalid iterator

__init__(iter: QgsAbstractFeatureIterator | None)

Construct a valid iterator

Parameters:: iter (Optional[QgsAbstractFeatureIterator])

__init__(fi: QgsFeatureIterator)

Copy constructor copies the iterator, increases ref.count

Parameters:: fi (QgsFeatureIterator)

close(self) → bool[source]¶

Call to end the iteration. This frees any resources used by the iterator.

Return type:: bool

compileFailed(self) → bool[source]¶

Indicator if there was an error when sending the compiled query to the server. This indicates that there is something wrong with the expression compiler.

Added in version 3.2.

Return type:: bool

compileStatus(self) → QgsAbstractFeatureIterator.CompileStatus[source]¶

Returns the status of expression compilation for filter expression requests.

Return type:: QgsAbstractFeatureIterator.CompileStatus

isClosed(self) → bool[source]¶

find out whether the iterator is still valid or closed already

Return type:: bool

isValid(self) → bool[source]¶

Will return if this iterator is valid. An invalid iterator was probably introduced by a failed attempt to acquire a connection or is a default constructed iterator.