Add compat layer for text based stream writers #756
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
In python2, if a stream has no encoding, unicode is encoded
using the default encoding. In python3, sys.stdout is already
text based (it expects str() types).
In python2, we introduce a compat layer that will give you a
stream writer that accepts unicode and encodes the contents into
the local.preferredencoding().
Simple repro: tag an ec2 instance with a unicode char and run:
aws ec2 describe-instances | grep TAGS
You'll get a ascii encode error. With this change you won't.
Fixes aws#742.
| import codecs | ||
| import locale | ||
| def get_stdout_text_writer(): | ||
| return codecs.getwriter(locale.getpreferredencoding())(sys.stdout) |
There was a problem hiding this comment.
Presumably putting this into a shared compat file means others might want to use it. Can we add some documentation (even just one sentence as a description) about what this does? It's a public function and not immediately obvious unless I track down where it is used below.
There was a problem hiding this comment.
yep I'll add a docstring.
|
Outside of the comment above this LGTM. 🚢-it when docs are updated. |
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.
In python2, if a stream has no encoding, unicode is encoded
using the default encoding. In python3, sys.stdout is already
text based (it expects str() types).
In python2, we introduce a compat layer that will give you a
stream writer that accepts unicode and encodes the contents into
the local.preferredencoding().
Simple repro: tag an ec2 instance with a unicode char and run:
You'll get a ascii encode error. With this change you won't.
Fixes #742.
cc @danielgtaylor