Skip to content

[xml.etree] Allow comparing plain Element.tag with ET.Comment/PI #16735

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

Open
hrithiksaini99 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[xml.etree] Allow comparing plain Element.tag with ET.Comment/PI #16735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c6f19f
[xml.etree] Narrow the ET.Comment fix: return Element[Any] from find/…
hrithiksaini99 Nov 7, 2026
63d5b1a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 7, 2026
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
16 changes: 16 additions & 0 deletions stdlib/@tests/test_cases/check_xml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

from typing_extensions import assert_type
from xml.dom.minidom import Document
from xml.etree.ElementTree import Comment, ElementTree, ProcessingInstruction

document = Document()

Expand Down Expand Up @@ -29,3 +30,18 @@
assert_type(document.toprettyxml(" ", "\r\n", "UTF8"), bytes)
assert_type(document.toprettyxml(" ", "\r\n", "UTF8", True), bytes)
assert_type(document.toprettyxml(" ", "\r\n", standalone=True), str)


# Regression for #14671: ET.Comment/ProcessingInstruction are valid
# element tags at runtime (insert_comments=True), so a plain Element's
# tag must be comparable with them.
def check_comment_tag(doc: ElementTree) -> None:
for el in doc.findall("*"):
_ = el.tag is Comment
_ = el.tag is ProcessingInstruction


def check_comment_element() -> None:
c = Comment("a comment")
assert c.tag is Comment
assert c.tag is not ProcessingInstruction
18 changes: 9 additions & 9 deletions stdlib/xml/etree/ElementTree.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ class Element(Generic[_Tag]):
def append(self, subelement: Element[Any], /) -> None: ...
def clear(self) -> None: ...
def extend(self, elements: Iterable[Element[Any]], /) -> None: ...
def find(self, path: str, namespaces: dict[str, str] | None = None) -> Element | None: ...
def findall(self, path: str, namespaces: dict[str, str] | None = None) -> list[Element]: ...
def find(self, path: str, namespaces: dict[str, str] | None = None) -> Element[Any] | None: ...
def findall(self, path: str, namespaces: dict[str, str] | None = None) -> list[Element[Any]]: ...

@overload
def findtext(self, path: str, default: None = None, namespaces: dict[str, str] | None = None) -> str | None: ...
Expand All @@ -111,12 +111,12 @@ class Element(Generic[_Tag]):

def insert(self, index: int, subelement: Element[Any], /) -> None: ...
def items(self) -> ItemsView[str, str]: ...
def iter(self, tag: str | None = None) -> Generator[Element]: ...
def iter(self, tag: str | None = None) -> Generator[Element[Any]]: ...

@overload
def iterfind(self, path: Literal[""], namespaces: dict[str, str] | None = None) -> None: ... # type: ignore[overload-overlap]
@overload
def iterfind(self, path: str, namespaces: dict[str, str] | None = None) -> Generator[Element]: ...
def iterfind(self, path: str, namespaces: dict[str, str] | None = None) -> Generator[Element[Any]]: ...

def itertext(self) -> Generator[str]: ...
def keys(self) -> dict_keys[str, str]: ...
Expand Down Expand Up @@ -168,21 +168,21 @@ class ElementTree(Generic[_Root]):
def __init__(self, element: Element[Any] | None = None, file: _FileRead | None = None) -> None: ...
def getroot(self) -> _Root: ...
def _setroot(self, element: Element[Any]) -> None: ...
def parse(self, source: _FileRead, parser: XMLParser | None = None) -> Element: ...
def iter(self, tag: str | None = None) -> Generator[Element]: ...
def find(self, path: str, namespaces: dict[str, str] | None = None) -> Element | None: ...
def parse(self, source: _FileRead, parser: XMLParser | None = None) -> Element[Any]: ...
def iter(self, tag: str | None = None) -> Generator[Element[Any]]: ...
def find(self, path: str, namespaces: dict[str, str] | None = None) -> Element[Any] | None: ...

@overload
def findtext(self, path: str, default: None = None, namespaces: dict[str, str] | None = None) -> str | None: ...
@overload
def findtext(self, path: str, default: _T, namespaces: dict[str, str] | None = None) -> _T | str: ...

def findall(self, path: str, namespaces: dict[str, str] | None = None) -> list[Element]: ...
def findall(self, path: str, namespaces: dict[str, str] | None = None) -> list[Element[Any]]: ...

@overload
def iterfind(self, path: Literal[""], namespaces: dict[str, str] | None = None) -> None: ... # type: ignore[overload-overlap]
@overload
def iterfind(self, path: str, namespaces: dict[str, str] | None = None) -> Generator[Element]: ...
def iterfind(self, path: str, namespaces: dict[str, str] | None = None) -> Generator[Element[Any]]: ...

def write(
self,
Expand Down
Loading