Skip to content

gh-140601: Add ResourceWarning to iterparse when not closed #140603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
serhiy-storchaka merged 17 commits into from
Nov 13, 2025
Merged

gh-140601: Add ResourceWarning to iterparse when not closed #140603

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
bf3f888
gh-140601: Add ResourceWarning to iterparse when not closed
osamakader Oct 25, 2025
e6c11de
Address review feedback from serhiy-storchaka
osamakader Oct 26, 2025
53f63b9
remove extra whitespace
osamakader Oct 26, 2025
c8ea776
remove unused import
osamakader Oct 26, 2025
fcd7ca0
Use % formatting instead of f-strings in __del__
osamakader Oct 26, 2025
0f9b509
Add assertions to verify ResourceWarning content
osamakader Oct 26, 2025
6e3b071
Remove redundant test_iterparse_resource_warning function
osamakader Oct 26, 2025
86fc36b
Remove source=self from ResourceWarning
osamakader Oct 26, 2025
329c09c
Add explicit close().
serhiy-storchaka Oct 27, 2025
dd20441
Reorganize tests.
serhiy-storchaka Oct 27, 2025
b1f67a4
Exhausted or failed iterators are auto-closed.
serhiy-storchaka Oct 27, 2025
15c0c5b
Add versionchanged directive for ResourceWarning
osamakader Oct 27, 2025
a7ef9f2
Merge branch 'main' into issue-140601-iterparse-warning
serhiy-storchaka Nov 12, 2025
766d510
Always emit a warning. Add tests for exhausted not closed iterator.
serhiy-storchaka Nov 12, 2025
53880a6
Apply suggestions from code review
serhiy-storchaka Nov 13, 2025
8a37683
Refactor tests.
serhiy-storchaka Nov 13, 2025
6c5c5e8
Merge branch 'main' into issue-140601-iterparse-warning
serhiy-storchaka Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Merge branch 'main' into issue-140601-iterparse-warning
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed Nov 13, 2025
commit 6c5c5e82c484b4bcac7bde34cc9b812ab0fa70b4
125 changes: 65 additions & 60 deletions Lib/test/test_xml_etree.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1303,56 +1303,56 @@ class IterparseTest(unittest.TestCase):
def test_basic(self):
iterparse = ET.iterparse

context = iterparse(SIMPLE_XMLFILE)
self.assertIsNone(context.root)
action, elem = next(context)
self.assertIsNone(context.root)
it = iterparse(SIMPLE_XMLFILE)
self.assertIsNone(it.root)
action, elem = next(it)
self.assertIsNone(it.root)
self.assertEqual((action, elem.tag), ('end', 'element'))
self.assertEqual([(action, elem.tag) for action, elem in context], [
self.assertEqual([(action, elem.tag) for action, elem in it], [
('end', 'element'),
('end', 'empty-element'),
('end', 'root'),
])
self.assertEqual(context.root.tag, 'root')
context.close()
self.assertEqual(it.root.tag, 'root')
it.close()

context = iterparse(SIMPLE_NS_XMLFILE)
self.assertEqual([(action, elem.tag) for action, elem in context], [
it = iterparse(SIMPLE_NS_XMLFILE)
self.assertEqual([(action, elem.tag) for action, elem in it], [
('end', '{namespace}element'),
('end', '{namespace}element'),
('end', '{namespace}empty-element'),
('end', '{namespace}root'),
])
context.close()
it.close()

def test_opened_file(self):
def test_external_file(self):
with open(SIMPLE_XMLFILE, 'rb') as source:
context = ET.iterparse(source)
action, elem = next(context)
it = ET.iterparse(source)
action, elem = next(it)
self.assertEqual((action, elem.tag), ('end', 'element'))
self.assertEqual([(action, elem.tag) for action, elem in context], [
self.assertEqual([(action, elem.tag) for action, elem in it], [
('end', 'element'),
('end', 'empty-element'),
('end', 'root'),
])
self.assertEqual(context.root.tag, 'root')
self.assertEqual(it.root.tag, 'root')

def test_events(self):
iterparse = ET.iterparse

events = ()
context = iterparse(SIMPLE_XMLFILE, events)
self.assertEqual([(action, elem.tag) for action, elem in context], [])
context.close()
it = iterparse(SIMPLE_XMLFILE, events)
self.assertEqual([(action, elem.tag) for action, elem in it], [])
it.close()

events = ()
context = iterparse(SIMPLE_XMLFILE, events=events)
self.assertEqual([(action, elem.tag) for action, elem in context], [])
context.close()
it = iterparse(SIMPLE_XMLFILE, events=events)
self.assertEqual([(action, elem.tag) for action, elem in it], [])
it.close()

events = ("start", "end")
context = iterparse(SIMPLE_XMLFILE, events)
self.assertEqual([(action, elem.tag) for action, elem in context], [
it = iterparse(SIMPLE_XMLFILE, events)
self.assertEqual([(action, elem.tag) for action, elem in it], [
('start', 'root'),
('start', 'element'),
('end', 'element'),
Expand All @@ -1362,13 +1362,16 @@ def test_events(self):
('end', 'empty-element'),
('end', 'root'),
])
context.close()
it.close()

def test_namespace_events(self):
iterparse = ET.iterparse

events = ("start", "end", "start-ns", "end-ns")
context = iterparse(SIMPLE_NS_XMLFILE, events)
it = iterparse(SIMPLE_NS_XMLFILE, events)
self.assertEqual([(action, elem.tag) if action in ("start", "end")
else (action, elem)
for action, elem in context], [
for action, elem in it], [
('start-ns', ('', 'namespace')),
('start', '{namespace}root'),
('start', '{namespace}element'),
Expand All @@ -1380,13 +1383,13 @@ def test_events(self):
('end', '{namespace}root'),
('end-ns', None),
])
context.close()
it.close()

events = ('start-ns', 'end-ns')
context = iterparse(io.StringIO(r"<root xmlns=''/>"), events)
res = [action for action, elem in context]
it = iterparse(io.BytesIO(br"<root xmlns=''/>"), events)
res = [action for action, elem in it]
self.assertEqual(res, ['start-ns', 'end-ns'])
context.close()
it.close()

def test_unknown_events(self):
iterparse = ET.iterparse
Expand All @@ -1411,14 +1414,14 @@ def test_non_utf8(self):
b"<body xmlns='http://&#233;ffbot.org/ns'\n"
b" xmlns:cl\xe9='http://effbot.org/ns'>text</body>\n")
events = ("start-ns",)
context = ET.iterparse(source, events)
self.assertEqual([(action, elem) for action, elem in context], [
it = ET.iterparse(source, events)
self.assertEqual([(action, elem) for action, elem in it], [
('start-ns', ('', 'http://\xe9ffbot.org/ns')),
('start-ns', ('cl\xe9', 'http://effbot.org/ns')),
])

def test_parsing_error(self):
source = io.StringIO("<document />junk")
source = io.BytesIO(b"<document />junk")
it = ET.iterparse(source)
action, elem = next(it)
self.assertEqual((action, elem.tag), ('end', 'document'))
Expand All @@ -1434,23 +1437,31 @@ def test_nonexistent_file(self):
def test_resource_warnings_not_exhausted(self):
# Not exhausting the iterator still closes the underlying file (bpo-43292)
# Not closing before del should emit ResourceWarning
it = ET.iterparse(SIMPLE_XMLFILE)
with warnings_helper.check_no_resource_warning(self):
it.close()
del it
gc_collect()

it = ET.iterparse(SIMPLE_XMLFILE)
with self.assertWarns(ResourceWarning) as wm:
it = ET.iterparse(SIMPLE_XMLFILE)
del it
gc_collect()
# Not 'unclosed file'.
self.assertIn('unclosed iterparse iterator', str(wm.warning))
self.assertIn(repr(SIMPLE_XMLFILE), str(wm.warning))
self.assertEqual(wm.filename, __file__)

it = ET.iterparse(SIMPLE_XMLFILE)
with warnings_helper.check_no_resource_warning(self):
it = ET.iterparse(SIMPLE_XMLFILE)
action, elem = next(it)
it.close()
del it
self.assertEqual((action, elem.tag), ('end', 'element'))
del it, elem
gc_collect()

it = ET.iterparse(SIMPLE_XMLFILE)
with self.assertWarns(ResourceWarning) as wm:
it = ET.iterparse(SIMPLE_XMLFILE)
action, elem = next(it)
self.assertEqual((action, elem.tag), ('end', 'element'))
del it, elem
Expand All @@ -1459,14 +1470,6 @@ def test_resource_warnings_not_exhausted(self):
self.assertIn(repr(SIMPLE_XMLFILE), str(wm.warning))
self.assertEqual(wm.filename, __file__)

with warnings_helper.check_no_resource_warning(self):
it = ET.iterparse(SIMPLE_XMLFILE)
action, elem = next(it)
it.close()
self.assertEqual((action, elem.tag), ('end', 'element'))
del it, elem
gc_collect()

def test_resource_warnings_failed_iteration(self):
self.addCleanup(os_helper.unlink, TESTFN)
with open(TESTFN, "wb") as f:
Expand All @@ -1475,47 +1478,47 @@ def test_resource_warnings_failed_iteration(self):
it = ET.iterparse(TESTFN)
action, elem = next(it)
self.assertEqual((action, elem.tag), ('end', 'document'))
with self.assertWarns(ResourceWarning) as wm:
with warnings_helper.check_no_resource_warning(self):
with self.assertRaises(ET.ParseError) as cm:
next(it)
self.assertEqual(str(cm.exception),
'junk after document element: line 1, column 12')
it.close()
del cm, it
gc_collect()
self.assertIn('unclosed iterparse iterator', str(wm.warning))
self.assertIn(repr(TESTFN), str(wm.warning))
self.assertEqual(wm.filename, __file__)

it = ET.iterparse(TESTFN)
action, elem = next(it)
self.assertEqual((action, elem.tag), ('end', 'document'))
with warnings_helper.check_no_resource_warning(self):
with self.assertWarns(ResourceWarning) as wm:
with self.assertRaises(ET.ParseError) as cm:
next(it)
self.assertEqual(str(cm.exception),
'junk after document element: line 1, column 12')
it.close()
del cm, it
gc_collect()
self.assertIn('unclosed iterparse iterator', str(wm.warning))
self.assertIn(repr(TESTFN), str(wm.warning))
self.assertEqual(wm.filename, __file__)

def test_resource_warnings_exhausted(self):
with self.assertWarns(ResourceWarning) as wm:
it = ET.iterparse(SIMPLE_XMLFILE)
it = ET.iterparse(SIMPLE_XMLFILE)
with warnings_helper.check_no_resource_warning(self):
list(it)
it.close()
del it
gc_collect()
self.assertIn('unclosed iterparse iterator', str(wm.warning))
self.assertIn(repr(SIMPLE_XMLFILE), str(wm.warning))
self.assertEqual(wm.filename, __file__)

with warnings_helper.check_no_resource_warning(self):
it = ET.iterparse(SIMPLE_XMLFILE)
it = ET.iterparse(SIMPLE_XMLFILE)
with self.assertWarns(ResourceWarning) as wm:
list(it)
it.close()
del it
gc_collect()
self.assertIn('unclosed iterparse iterator', str(wm.warning))
self.assertIn(repr(SIMPLE_XMLFILE), str(wm.warning))
self.assertEqual(wm.filename, __file__)

def test_close(self):
def test_close_not_exhausted(self):
iterparse = ET.iterparse

it = iterparse(SIMPLE_XMLFILE)
Expand Down Expand Up @@ -1550,6 +1553,8 @@ def test_close(self):
next(it)
it.close() # idempotent

def test_close_exhausted(self):
iterparse = ET.iterparse
it = iterparse(SIMPLE_XMLFILE)
list(it)
it.close()
Expand Down
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.