mirror of https://github.com/python/cpython
gh-93607: document `root` attribute of `iterparse` (#99410)
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
This commit is contained in:
parent
cf3dbe4c3d
commit
5cc6c80a77
|
@ -622,7 +622,9 @@ Functions
|
|||
*parser* is an optional parser instance. If not given, the standard
|
||||
:class:`XMLParser` parser is used. *parser* must be a subclass of
|
||||
:class:`XMLParser` and can only use the default :class:`TreeBuilder` as a
|
||||
target. Returns an :term:`iterator` providing ``(event, elem)`` pairs.
|
||||
target. Returns an :term:`iterator` providing ``(event, elem)`` pairs;
|
||||
it has a ``root`` attribute that references the root element of the
|
||||
resulting XML tree once *source* is fully read.
|
||||
|
||||
Note that while :func:`iterparse` builds the tree incrementally, it issues
|
||||
blocking reads on *source* (or the file it names). As such, it's unsuitable
|
||||
|
|
Loading…
Reference in New Issue