Open README.rst with utf-8 encoding #651
Merged
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
pganssle
reviewed
Mar 26, 2018
setup.py
Outdated
|
|
||
| def README(): | ||
| with open('README.rst') as f: | ||
| with open('README.rst', encoding='utf-8') as f: |
Member
There was a problem hiding this comment.
I think open does not take this keyword in Python 2.7.
io.open is the same as Python 3's open in both 2.7 and 3. That will fix this.
Member
|
@gergondet Thanks for this PR. Good catch! If you are not already in the Authors file, can you add yourself there as part of the PR? |
Contributor
Author
|
@pganssle I've changed |
f5acf8c to
1c6952c
Compare
Member
|
Awesome, thanks @gergondet. I squashed the fixup commit into the original README commit just for a cleaner history, but once CI passes I'll merge. Thanks for this PR. I should cut a new release with it relatively soon so that people installing from source with non-UTF-8 environments don't end up broken. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
With the current setup script, the build fails (I only tested with Python 3.4) in a non-UTF-8 environment
e.g.
LC_ALL=C pip3 install .fails prior to this patchThis fails because
openuses the system encoding by default and theREADME.rstfile contains non-ascii characters.This PR enforces the opening of
README.rstwith the UTF-8 encoding. This fixes the build when running the setup script on non-UTF-8 setups.