Prevent crashing from UnicodeDecodeError #288
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
On Python 2, `sys.stdout` and `print` can normally handle any combination of `str` and `unicode` objects. However, `StringIO.StringIO` can only safely handle one or the other. If the program writes both a non-ASCII `unicode` string, and a non-ASCII `str` string, then the `getvalue()` method will fail with `UnicodeDecodeError` [1]. If `nose2.plugins.buffer` (which captures writes to `sys.stdout` in a `StringIO.StringIO`) is being used, that combination of writes, followed by a test failure, causes the script to suddenly abort, with the cryptic `UnicodeDecodeError`. This fix catches `UnicodeError` when trying to get the captured output, and will replace the captured output with a warning message. This bug is equivalent to nose-devs/nose#816 [2]. [1] <https://github.com/python/cpython/blob/2.7/Lib/StringIO.py#L258> [2] <nose-devs/nose#816>
|
@jmoldow thank you for the detailled explanation. Is this something you'd like to see in a 0.6 release or can it wait for 0.7? |
|
Doesn't matter to me. |
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 Python 2,
sys.stdoutandprintcan normally handle any combination ofstrandunicodeobjects. However,StringIO.StringIOcan only safely handle one or the other. If the program writes both a non-ASCIIunicodestring, and a non-ASCIIstrstring, then thegetvalue()method will fail withUnicodeDecodeError[1].If
nose2.plugins.buffer(which captures writes tosys.stdoutin aStringIO.StringIO) is being used, that combination of writes, followed by a test failure, causes the script to suddenly abort, with the crypticUnicodeDecodeError.This fix catches
UnicodeErrorwhen trying to get the captured output, and will replace the captured output with a warning message.This bug is equivalent to nose-devs/nose#816 [2].
[1] https://github.com/python/cpython/blob/2.7/Lib/StringIO.py#L258
[2] nose-devs/nose#816