[utils] Make update-checkout output more readable #41714
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
In Python 3, subprocess output is read as binary data by default, which isn’t what we want. Instead of reading process output as byte strings, then manually decoding them into strings, simply pass `text=True` to functions in the `subprocess` module, so that we get properly decoded strings right out the box. This fixes places that forget to do the decoding step — most especially, the `update-checkout` script. That script prints Git output as byte strings, which leads to unreadable results. Additionally, in shell.run, use the same pipe for capturing both stdout and stderr. The distinction is pretty pointless in this use case; however, keeping the two channels separate means that we lose the original ordering of printed messages, which does matter.
|
@swift-ci test |
|
Ah, I didn't know Python 2.7 was still a thing on the Linux bots 😬 |
|
@swift-ci test |
1 similar comment
|
@swift-ci test |
|
Before: After: Stdout and stderr are still garbled; I think the process pool isn't opening new pipes for each process. |
|
@swift-ci test |
lorentey
force-pushed
the
fix-update-checkout-output
branch
from
407e0ba to
a11b8d9
Compare
|
@swift-ci test |
1 similar comment
|
@swift-ci test |
…ed line with the repo name
lorentey
force-pushed
the
fix-update-checkout-output
branch
from
e182dce to
4f9cf1d
Compare
|
@swift-ci test |
lorentey
changed the title
|
And now it looks like this: Things are in order, and interleaved messages are neatly labeled with their corresponding repository name. |
|
Thanks @lorentey! |
|
It would be also nice if we stop printing all env variable with command line output. |
|
@shahmishal Fix at #41778 |
AnthonyLatsis
added
the
update-checkout
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 Python 3, subprocess output is read as binary data by default, which isn’t what we want.
Instead of reading process output as byte strings, then manually decoding them into strings, simply pass
text=Trueto functions in thesubprocessmodule, so that we get properly decoded strings right out the box.This fixes places that forget to do the decoding step — most especially, the
update-checkoutscript. That script prints Git output as byte strings, which leads to unreadable results.Additionally, in shell.run, use the same pipe for capturing both stdout and stderr. The distinction is pretty pointless in this use case; however, keeping the two channels separate means that we lose the original ordering of printed messages, which does matter.