Fix --sort-reexports crash with non-seekable streams (e.g. stdin)#2547
Open
Abdu-Ahmed wants to merge 1 commit into
Open
Fix --sort-reexports crash with non-seekable streams (e.g. stdin)#2547Abdu-Ahmed wants to merge 1 commit into
Abdu-Ahmed wants to merge 1 commit into
Conversation
When --sort-reexports was used with stdin, isort crashed with io.UnsupportedOperation because core.process() called seek() on stdout, which is not seekable. Fix: in api.sort_stream(), if sort_reexports is enabled and the output stream is not seekable, swap it for an internal StringIO buffer before passing to core.process(). Fixes PyCQA#2393
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #2393
Problem
When running
isort --sort-reexports -with input piped from stdin,isort crashed with
io.UnsupportedOperation: underlying stream is not seekable. This happened becausecore.process()callsoutput_stream.seek()as part of reexport sorting, butsys.stdoutis not seekable.
Fix
In
api.sort_stream(), before callingcore.process(), check whetherthe output stream is seekable when
sort_reexportsis enabled. If not,use an internal
StringIObuffer, the same pattern already used fornon-readable streams in the atomic code path.
Test
Added regression test in
test_regressions.pythat verifies: