Skip to content

Possibility to customize hardcoded xml declaration #128091

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 1 commit into from
Closed

Possibility to customize hardcoded xml declaration #128091

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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,
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
switched to doublquotes here to stay on one format.
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