Issue #9708: Fix support for iterparse(parser=...) argument per documentation.

When _elementtree is imported, iterparse is redefined as a class and the parser
argument was ommitted. Fix this, and add a docstring to the class.

diff --git a/Lib/test/test_xml_etree.py b/Lib/test/test_xml_etree.py
index f6505d6641005a96dc11dfc1d7ac479a9c83b289..61161b6384278f1f72776dad70e489f407706538 100644 (file)
--- a/Lib/test/test_xml_etree.py
+++ b/Lib/test/test_xml_etree.py
@@ -1881,6 +1881,12 @@ class ElementIterTest(unittest.TestCase):
         sourcefile = serialize(doc, to_string=False)
         self.assertEqual(next(ET.iterparse(sourcefile))[0], 'end')
 
+        # With an explitit parser too (issue #9708)
+        sourcefile = serialize(doc, to_string=False)
+        parser = ET.XMLParser(target=ET.TreeBuilder())
+        self.assertEqual(next(ET.iterparse(sourcefile, parser=parser))[0],
+                         'end')
+
         tree = ET.ElementTree(None)
         self.assertRaises(AttributeError, tree.iter)
 

diff --git a/Lib/xml/etree/ElementTree.py b/Lib/xml/etree/ElementTree.py
index e8e309c3a0436e076fdb70332f3b5a27d6a498be..641d787dab3e3f0d531000811b8e583ecf41d1e6 100644 (file)
--- a/Lib/xml/etree/ElementTree.py
+++ b/Lib/xml/etree/ElementTree.py
@@ -1737,8 +1737,20 @@ else:
                     source.close()
 
     class iterparse:
+        """Parses an XML section into an element tree incrementally.
+
+        Reports what’s going on to the user. 'source' is a filename or file
+        object containing XML data. 'events' is a list of events to report back.
+        The supported events are the strings "start", "end", "start-ns" and
+        "end-ns" (the "ns" events are used to get detailed namespace
+        information). If 'events' is omitted, only "end" events are reported.
+        'parser' is an optional parser instance. If not given, the standard
+        XMLParser parser is used. Returns an iterator providing
+        (event, elem) pairs.
+        """
+
         root = None
-        def __init__(self, file, events=None):
+        def __init__(self, file, events=None, parser=None):
             self._close_file = False
             if not hasattr(file, 'read'):
                 file = open(file, 'rb')
@@ -1748,8 +1760,9 @@ else:
             self._index = 0
             self._error = None
             self.root = self._root = None
-            b = TreeBuilder()
-            self._parser = XMLParser(b)
+            if parser is None:
+                parser = XMLParser(target=TreeBuilder())
+            self._parser = parser
             self._parser._setevents(self._events, events)
 
         def __next__(self):