From ab2a76c8a823941e01a5a672fc7da021df0b6f68 Mon Sep 17 00:00:00 2001 From: Eli Bendersky Date: Sat, 20 Apr 2013 05:53:50 -0700 Subject: [PATCH] Update ET documentation reprhasing the mention of the new IncrementalParser in the doc for iterparse. --- Doc/library/xml.etree.elementtree.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index da03764c0c..07ace48b77 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -387,6 +387,11 @@ Functions :class:`XMLParser` parser is used. Returns an :term:`iterator` providing ``(event, elem)`` pairs. + 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 + for asynchronous applications where blocking reads can't be made. For fully + asynchronous parsing, see :class:`IncrementalParser`. + .. note:: :func:`iterparse` only guarantees that it has seen the ">" @@ -397,10 +402,6 @@ Functions If you need a fully populated element, look for "end" events instead. - .. note:: - For real event-driven parsing, see :class:`IncrementalParser`. - - .. function:: parse(source, parser=None) Parses an XML section into an element tree. *source* is a filename or file -- 2.50.1