Repository navigation
gh-90756: Fix ElementTree.write XML prolog for encoding 'utf-8-sig' - #31043
serhiy-storchaka merged 3 commits into
Conversation
Sorry, something went wrong.
When ElementTree object is to be written to the file, and when BOM is needed, the 'utf-8-sig' can be used for the purpose. However, the XML prolog then looks like... <?xml version='1.0' encoding='utf-8-sig'?> ... and that encoding in the prolog makes no sense. Therefore, the utf-8-sig is changed to utf-8 for the purpose.
|
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA). Recognized GitHub usernameWe couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames: This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. You can check yourself to see if the CLA has been received. Thanks again for the contribution, we look forward to reviewing it! |
Sorry, something went wrong.
|
Hello all, Finally, I have found how to add my GitHub name to the b.p.o. Done. I have also signed the PSF contributor agreement. The bpo-46598 was created, and the PR at b.p.o linked was added to point here. The pull-request changes should be easily understandable, and I have tried it on my local computer. Have a nice day, |
Sorry, something went wrong.
corona10
left a comment
There was a problem hiding this comment.
Please add the NEW.d for behavior changing
Sorry, something went wrong.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request. |
Sorry, something went wrong.
|
@corona10: Sorry, I am new in this workflow. What does it mean the "add the NEW.d for behavior changing"? Is it expected from me? |
Sorry, something went wrong.
|
Thanks. You need to include a NEWS entry to describe the change. Also, this needs a test. See the ElementTree tests under Lib/test/ There are already some that deal with encodings and the XML prologue. |
Sorry, something went wrong.
|
This PR is stale because it has been open for 30 days with no activity. |
Sorry, something went wrong.
# Conflicts: # Lib/xml/etree/ElementTree.py
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead. |
Sorry, something went wrong.
Normalize the declared encoding before deciding whether to write the declaration, so that utf-8-sig is treated as utf-8: the BOM already determines the encoding. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
serhiy-storchaka
left a comment
There was a problem hiding this comment.
Added tests and NEWS. Moved normalization so that the XML declaration is not written when xml_declaration is None (but BOM is). LGTM now.
Sorry, something went wrong.
…thonGH-31043) The BOM already determines the encoding, so the declaration is now omitted by default, and declares utf-8 if requested explicitly. Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
bpo-46598: Fix ElementTree.write XML prolog for encoding 'utf-8-sig'
When ElementTree object is to be written to the file, and when BOM
is needed, the 'utf-8-sig' can be used for the purpose.
However, the XML prolog then looks like...
... and that encoding in the prolog makes no sense. Therefore,
the utf-8-sig is changed to utf-8 for the purpose.
https://bugs.python.org/issue46598