fix: preserve a leading BOM when set_key and unset_key rewrite a file - #687
Open
MohammedAlkindi wants to merge 2 commits into
Open
fix: preserve a leading BOM when set_key and unset_key rewrite a file#687MohammedAlkindi wants to merge 2 commits into
MohammedAlkindi wants to merge 2 commits into
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
The parser strips a leading UTF-8 BOM so the first variable is read correctly, but the stripped BOM never reaches the bindings that set_key and unset_key write back out. Rewriting a file that had one therefore dropped it silently, changing a part of the file the caller did not ask to touch. Carry it across in rewrite(), which both writers share.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
set_key and unset_key drop a leading UTF-8 BOM from files that have one.
#640 made the parser strip a leading BOM so the first variable parses. That stripped BOM never reaches the bindings, so the rewrite path writes the file back without it:
rewrite() now carries it across, so both writers keep it. Only files that already had a BOM change behaviour. The check is encoding-safe: a latin-1 file never decodes to \ufeff, and utf-16 handles its own BOM in the codec.
Tests: one for set_key, one for unset_key. Both fail on main on the missing BOM and pass with the fix. Full suite 207 passed / 50 skipped, ruff check and ruff format --check clean.
mypy reports one error here, tests/test_fifo_dotenv.py:15: Module has no attribute "mkfifo". It is pre-existing and unrelated: I confirmed it on a clean checkout of main. It appears because I ran mypy on Windows, where os.mkfifo does not exist, so CI will not see it.
Related: #640, #637