Write bash completion output as raw bytes#1745
Open
behlole wants to merge 2 commits into
Open
Conversation
On Windows, sys.stdout is opened in text mode, which translates \n to \r\n. Typer's bash completion writes option names separated by \n; after text-mode translation those separators become \r\n, but bash on MSYS2 / Git Bash splits only on \n. The stray \r ends up attached to the next option name and shows up as ^M between completions. Encode the completion output to UTF-8 bytes before handing it to click.echo. click.echo writes bytes through the raw buffer, bypassing text-mode translation. On POSIX the output is unchanged. Closes fastapi#202
svlandeg
reviewed
May 18, 2026
Member
svlandeg
left a comment
svlandeg
left a comment
There was a problem hiding this comment.
I'll put this in draft as long as the CI is failing, feel free to mark as "ready for review" when everything is green! 🙏
Author
|
CI is green now — the failure on |
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
3 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.
Closes #202
On Windows,
sys.stdoutis opened in text mode, which translates\nto\r\n. Typer's bash completion writes option names separated by\n; after text-mode translation those separators become\r\n, but bash on MSYS2 / Git Bash splits only on\n. The stray\rends up attached to the next option name and shows up as^Mbetween completions:This PR encodes the completion output to UTF-8 bytes before handing it to
click.echo.click.echowrites bytes through the raw buffer, bypassing text-mode translation. On POSIX the output is unchanged.The regression test runs
subprocess.run(..., capture_output=True)withoutencoding="utf-8"so it reads the raw bytes, then asserts the in-string separator is a bare\n(the byte-level check would silently pass if subprocess decoded the bytes back to text). It complements the existingassert "delete\ndelete-all" in result.stdouttest, which still passes.