Skip to content

gh-135640: Adds type checking to ElementTree.ElementTree constructor #135643

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
merged 16 commits into from
Jul 3, 2025
Merged

gh-135640: Adds type checking to ElementTree.ElementTree constructor #135643

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
b0a8a64
Tenuous first fix
abstractedfox Jun 17, 2025
f0356c8
Remove commented assertions
abstractedfox Jun 17, 2025
06eaff5
Add tests for ElementTree constructor
abstractedfox Jun 17, 2025
6d4d65f
Add appropriate text to an exception
abstractedfox Jun 17, 2025
84b22d4
Make iselement stricter + incorporate feedback
abstractedfox Jun 22, 2025
1d2f0d9
Revert iselement to previous state
abstractedfox Jun 26, 2025
d5bbe23
Add iselement check to ElementTree.write
abstractedfox Jun 26, 2025
4e2f822
Make errors more descriptive
abstractedfox Jun 26, 2025
8b588f3
Fix whitespace
abstractedfox Jun 26, 2025
e1e489e
Rephrase news entry
abstractedfox Jun 26, 2025
28fcc69
Test: remove unnecessary fields for element-like
abstractedfox Jun 26, 2025
78118ea
Change error messages
abstractedfox Jun 27, 2025
bfd94cb
Correct error messages
abstractedfox Jul 3, 2025
7c3a3b2
Correct error message
abstractedfox Jul 3, 2025
97d5fa0
Tests for _setroot
abstractedfox Jul 3, 2025
c3fb864
Fix names
abstractedfox Jul 3, 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
7 changes: 7 additions & 0 deletions Lib/test/test_xml_etree.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,13 @@ def check_element(element):
self.assertRegex(repr(element), r"^<Element 't\xe4g' at 0x.*>$")
element = ET.Element("tag", key="value")

# Verify type checking for ElementTree constructor
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you make a separate test method, say "test_constructor" and put that test before test_interface? TiA


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add also a test where only an Element-like class is tested (only with a tag attribute, nothing else, not even inheriting from xml.etree.Element).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I tried this in a boilerplate file:

class element impl:
    def __init__(self, tag):
        self.tag = tag

..but an instance of that wasn't enough to be able to pass as a root element to an ElementTree instance, call write, and have it work as normal (assuming I understood you properly). I ended up needing to add iter(), items(), __len__(), text, and tail before it would. Was that what you meant?

As a side thought, if ElementTree supports custom element implementations, should I remove the type check and change iselement to check for all of those attributes instead?

with self.assertRaises(TypeError):
tree = ET.ElementTree("")
with self.assertRaises(TypeError):
tree = ET.ElementTree(ET.ElementTree())

# Make sure all standard element methods exist.

def check_method(method):
Expand Down
8 changes: 6 additions & 2 deletions Lib/xml/etree/ElementTree.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,9 @@ class ElementTree:

"""
def __init__(self, element=None, file=None):
# assert element is None or iselement(element)
if element is not None and not iselement(element):
raise TypeError(f"element must be etree.Element, "
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would appreciate either writing xml.etree.Element or Element only.

I also suspect that the isinstance() check was removed so that elements not inheriting from xml.Element still work, or elements that implement the XML interface without directly inheriting from it.

And the minimal element interface is "tag".

f"not {type(element).__name__}")
self._root = element # first node
if file:
self.parse(file)
Expand All @@ -543,7 +545,9 @@ def _setroot(self, element):
with the given element. Use with care!

"""
# assert iselement(element)
if not iselement(element):
raise TypeError(f"element must be etree.Element, "
f"not {type(element).__name__}")
self._root = element

def parse(self, source, parser=None):
Expand Down
Loading