Fix inconsistent encoding in config files, among different functions ans OSs #1682
Conversation
This file contains 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
…and OSs. On Windows the default Python text encoding is "cp1252", while on Unix is "utf-8". This affects open(), pathlib.Path().read_text() and pathlib.Path().write_text(). This explicitly sets the encoding on all read/write operations on text files. Before some function calls had an explicit encoding, other not.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
On Windows the default Python text encoding is
cp1252, while on Unix isutf-8. This affectsopen(),pathlib.Path().read_text()andpathlib.Path().write_text().This explicitly sets the encoding on all read/write operations on text files.
Before this, some function calls had an explicit encoding, other not. Such inconsistency might cause issues on Windows.
This does not introduce new tests, merely sets the explicit encoding on all function calls. A suitable test should check that all calls explicitly set the encoding. It might be easier and more robust to include the encoding in
hatch.utils.fs.Pathand make every read/write operation on text use that.This also resolves #1677.