Fix console markup escaping issue #1866
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
| with rich.progress.Progress( | ||
| "[progress.description]{task.description}", | ||
| "[progress.percentage]{task.percentage:>3.0f}%", | ||
| rich.progress.BarColumn(bar_width=None), | ||
| rich.progress.DownloadColumn(), | ||
| rich.progress.TransferSpeedColumn(), | ||
| ) as progress: | ||
| description = f"Downloading [bold]{download.name}" | ||
| download_task = progress.add_task(description, **kwargs) # type: ignore | ||
| description = f"Downloading [bold]{rich.markup.escape(download.name)}" |
There was a problem hiding this comment.
Hi, thanks for this :)
I think this is the only relevant change in this PR wrt the "markup leak" issue, right? By only adding that rich.markup.escape() call I was able to prevent eg --download "[blink red]file.out" from rendering.
I'm not sure what the effect of the syntax and kwargs bits are, but they seem non-related, so they should be kept out, sounds legit?
There was a problem hiding this comment.
Mainly the markup leak.
Replacing the kwargs was partly a simplification, but also covers the situation where there is no content length in the header. Consequently Rich will show a "in progress animation" rather than remain stuck at 0% until the download was finished.
|
Thanks @willmcgugan! |
Merged
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.
Escapes the download name so that it won't render console markup.