ignore ANSI escape codes in the bar length calculation #592
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
Codecov Report
@@ Coverage Diff @@
## master #592 +/- ##
==========================================
- Coverage 99.28% 99.14% -0.14%
==========================================
Files 9 9
Lines 698 702 +4
Branches 123 125 +2
==========================================
+ Hits 693 696 +3
Misses 3 3
- Partials 2 3 +1 |
casperdcl
reviewed
Aug 14, 2018
| CUR_OS = _curos() | ||
| IS_WIN = CUR_OS in ['Windows', 'cli'] | ||
| IS_NIX = (not IS_WIN) and any( | ||
| CUR_OS.startswith(i) for i in | ||
| ['CYGWIN', 'MSYS', 'Linux', 'Darwin', 'SunOS', 'FreeBSD', 'NetBSD']) | ||
| RE_ANSI = re.compile(r"\x1b\[[;\d]*[A-Za-z]") |
There was a problem hiding this comment.
could this pick up non-ANSI codes? Maybe as per https://stackoverflow.com/a/1833984 we need \x1b.*?m or \x1b[^m]*m?
There was a problem hiding this comment.
I don't think it would, as this sequence matches Esc[ + (digits and ;) + (one letter), which should only occur in ANSI escape codes: http://ascii-table.com/ansi-escape-sequences.php
In the stackoverflow entry the problem is that the author used arbitrary character matching (.*).
There was a problem hiding this comment.
lgtm, technically other sequences accept = as well as strings, but they shouldn't be used in a progress bar.
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.
Fixes #591.
This strips ANSI escape codes from the description string before calculating the remaining length of the bar, such that strings containing e.g. color codes are still displayed with the correct width.