diff options
| author | Prometheus3375 <35541026+Prometheus3375@users.noreply.github.com> | 2023-10-31 16:16:55 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-31 16:16:55 (GMT) |
| commit | 5cc6c80a7797c08c884edf94de4fc7b6075e32ce (patch) | |
| tree | 8c75313f319165f17a3fed58325ba6ec838e6d80 /Doc | |
| parent | cf3dbe4c3df40e2d4d572c62623207ce29a9365b (diff) | |
| download | cpython-5cc6c80a7797c08c884edf94de4fc7b6075e32ce.zip cpython-5cc6c80a7797c08c884edf94de4fc7b6075e32ce.tar.gz cpython-5cc6c80a7797c08c884edf94de4fc7b6075e32ce.tar.bz2 | |
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>
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/xml.etree.elementtree.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index c9b3263..57cfbb8 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -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 |