Skip to content

gh-128136: Possibility to customize hardcoded xml declaration #128095

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

Closed
wants to merge 12 commits into from
Closed

gh-128136: Possibility to customize hardcoded xml declaration #128095

Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1f00810
Update ElementTree.py
pprossi Dec 19, 2024
9b3d903
Update ElementTree.py
pprossi Dec 19, 2024
dd0553f
Merge branch 'main' into pprossi-patch-elementtree2
pprossi Dec 19, 2024
b7967ae
Update test_xml_etree.py
pprossi Dec 20, 2024
b90f905
Update test_xml_etree.py
pprossi Dec 20, 2024
82eee7b
Merge branch 'python:main' into pprossi-patch-elementtree2
pprossi Dec 20, 2024
b90b81e
📜🤖 Added by blurb_it.
blurb-it[bot] Dec 20, 2024
6018922
Update 2024-12-20-18-54-53.gh-issue-128136.tgbvWt.rst
pprossi Dec 20, 2024
52bc8df
Update 2024-12-20-18-54-53.gh-issue-128136.tgbvWt.rst
pprossi Dec 20, 2024
5b15a7e
Update 2024-12-20-18-54-53.gh-issue-128136.tgbvWt.rst
pprossi Dec 20, 2024
f1235b5
Merge branch 'main' into pprossi-patch-elementtree2
pprossi Dec 20, 2024
d8a2300
Update ElementTree.py
pprossi Dec 21, 2024
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
15 changes: 13 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 @@ -679,6 +679,7 @@ def iterfind(self, path, namespaces=None):
def write(self, file_or_filename,
Copy link
Contributor

Choose a reason for hiding this comment

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

This should add a unit test to test it's behavior. Verify it whether the requirements are met.

Copy link
Author

Choose a reason for hiding this comment

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

Added some unit tests but there is'nt an issu to add an issue title.

and i think the change has little impact on Python users.

encoding=None,
xml_declaration=None,
xml_declaration_definition="<?xml version='{version}' encoding='{encoding}'?>",
default_namespace=None,
method=None, *,
short_empty_elements=True):
Expand All @@ -694,6 +695,14 @@ def write(self, file_or_filename,
is added if encoding IS NOT either of:
US-ASCII, UTF-8, or Unicode

*xml_declaration_definition* -- string for customizing encoding declaration
as documentation always shows doublequotes but
singlequote where hardcoded here.
to be rfc conform which allows doublequotes and
singlequote for declaration. default value is
untouched to pass tests.
placeholders: {version}, {encoding}

*default_namespace* -- sets the default XML namespace (for "xmlns")

*method* -- either "xml" (default), "html, "text", or "c14n"
Expand All @@ -719,8 +728,10 @@ def write(self, file_or_filename,
(xml_declaration is None and
encoding.lower() != "unicode" and
declared_encoding.lower() not in ("utf-8", "us-ascii"))):
write("<?xml version='1.0' encoding='%s'?>\n" % (
declared_encoding,))
# version configuration is'nt necessary, can be overwritten
# in declaration_definition at runtime
data = {'version':'1.0', 'encoding': declared_encoding}
write(xml_declaration_definition.format(**data)+"\n")
if method == "text":
_serialize_text(write, self._root)
else:
Expand Down
Loading