Skip to content

Commit d51d005

Browse files
committed
gh-80866: Copy caller attributes in TreeBuilder.start()
1 parent 910a92b commit d51d005

3 files changed

Lines changed: 58 additions & 0 deletions

File tree

‎Lib/test/test_xml_etree.py‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4339,6 +4339,53 @@ def test_treebuilder_elementfactory_none(self):
43394339
e = parser.close()
43404340
self._check_sample1_element(e)
43414341

4342+
def test_start_copies_attrs(self):
4343+
class DictSubclass(dict):
4344+
pass
4345+
4346+
for dict_type in (dict, DictSubclass):
4347+
for initial in ({}, {'key': 'value'}):
4348+
for factory in (None, ET.Element):
4349+
with self.subTest(dict_type=dict_type, initial=initial,
4350+
factory=factory):
4351+
attrs = dict_type(initial)
4352+
tb = ET.TreeBuilder(element_factory=factory)
4353+
elem = tb.start('root', attrs)
4354+
tb.end('root')
4355+
self.assertIs(tb.close(), elem)
4356+
attrs.clear()
4357+
attrs['caller'] = 'changed'
4358+
self.assertEqual(elem.attrib, initial)
4359+
elem.set('element', 'changed')
4360+
self.assertEqual(attrs, {'caller': 'changed'})
4361+
4362+
def test_start_reuses_attrs(self):
4363+
tb = ET.TreeBuilder()
4364+
root = tb.start('root', {})
4365+
attrs = {'id': 'first'}
4366+
tb.start('child', attrs)
4367+
tb.end('child')
4368+
attrs['id'] = 'second'
4369+
tb.start('child', attrs)
4370+
tb.end('child')
4371+
tb.end('root')
4372+
self.assertIs(tb.close(), root)
4373+
self.assertEqual([child.get('id') for child in root],
4374+
['first', 'second'])
4375+
4376+
def test_start_element_factory_attrs(self):
4377+
attrs = {'key': 'value'}
4378+
4379+
def factory(tag, attrib):
4380+
self.assertIs(attrib, attrs)
4381+
return ET.Element(tag, attrib)
4382+
4383+
tb = ET.TreeBuilder(element_factory=factory)
4384+
elem = tb.start('root', attrs)
4385+
tb.end('root')
4386+
self.assertIs(tb.close(), elem)
4387+
self.assertEqual(elem.attrib, attrs)
4388+
43424389
def test_subclass(self):
43434390
class MyTreeBuilder(ET.TreeBuilder):
43444391
def foobar(self, x):
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Fix :meth:`xml.etree.ElementTree.TreeBuilder.start` sharing the input attribute
2+
dictionary with created elements when using the default element factory.

‎Modules/_elementtree.c‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3116,6 +3116,15 @@ _elementtree_TreeBuilder_start_impl(TreeBuilderObject *self, PyObject *tag,
31163116
PyObject *attrs)
31173117
/*[clinic end generated code: output=e7e9dc2861349411 input=26cccb49c3b8b12f]*/
31183118
{
3119+
if (!self->element_factory) {
3120+
attrs = PyDict_Copy(attrs);
3121+
if (attrs == NULL) {
3122+
return NULL;
3123+
}
3124+
PyObject *node = treebuilder_handle_start(self, tag, attrs);
3125+
Py_DECREF(attrs);
3126+
return node;
3127+
}
31193128
return treebuilder_handle_start(self, tag, attrs);
31203129
}
31213130

0 commit comments

Comments
 (0)