Read packaged resources with UTF-8#3723
Closed
PEliet wants to merge 2 commits into
Closed
Conversation
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Summary
Read packaged text resources with an explicit UTF-8 encoding.
Background
pre_commit.util.resource_text()currently callsTraversable.read_text()without an encoding. That makes the result depend on the operating system's default text encoding. A packaged resource containing non-ASCII text can therefore fail to load or be decoded differently on systems using a non-UTF-8 locale.Package resources are project-owned text files, so their encoding should be deterministic across local environments and CI.
Changes
encoding='UTF-8'when reading packaged resources.Tests
python -m pytest tests/util_test.py -qgit diff --checkAll targeted tests passed locally.