Explicitly use "locale" encoding for .pth files
#4265
Merged
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
abravalheri
force-pushed
the
locale-encoding
branch
from
ca7ebba
to
3bb4bc1
Compare
abravalheri
force-pushed
the
locale-encoding
branch
from
3bb4bc1
to
1dd135c
Compare
abravalheri
commented
Mar 7, 2024
| @@ -576,7 +576,7 @@ def check_pth_processing(self): | |||
| _one_liner( | |||
| """ | |||
| import os | |||
| f = open({ok_file!r}, 'w') | |||
| f = open({ok_file!r}, 'w', encoding="utf-8") | |||
There was a problem hiding this comment.
Throw-away file only used internally. It should not make a difference if we change its encoding.
abravalheri
commented
Mar 7, 2024
| @@ -491,7 +491,7 @@ def check_site_dir(self): # noqa: C901 # is too complex (12) # FIXME | |||
| try: | |||
| if test_exists: | |||
| os.unlink(testfile) | |||
| open(testfile, 'w').close() | |||
| open(testfile, 'wb').close() | |||
There was a problem hiding this comment.
"Touch" operation... can be done in the binary mode to avoid messing with encoding.
Avasam
reviewed
Mar 8, 2024
| # ``encoding="locale"``, this can be used to suppress the warning. | ||
| # However, please try to use UTF-8 when possible | ||
| # (.pth files are the notorious exception: python/cpython#77102, pypa/setuptools#3937). | ||
| LOCALE_ENCODING = "locale" if sys.version_info >= (3, 10) else None |
There was a problem hiding this comment.
@abravalheri Should this comment be the variable's docstring? So it can be picked-up by editors and the likes? For example:
There was a problem hiding this comment.
Initially I thought about doing that, but then I changed it back, because this module is not really targeting external users (it is not really part of the public API...)
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.
For the time being
.pthfiles in UTF-8 cause problems, see python/cpython#77102.CPython maintainers' recommendation is to use the default encoding of the underlying system.
The motivation of this PR is to help with the encoding warnings.
Summary of changes
"locale"encoding for.pthfiles.TODOcomments as reminders of other parts that may be moved to UTF-8, but there might be a risk.setuptools.compat.py39module. This tries to follow the methodology in Move compatibility modules into a compat package. #4212.Closes
Pull Request Checklist
newsfragments/.(See documentation for details)