Fix colorization to not extend across newline boundary #68517
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
ansibot
added
affects_2.10
ansibot
added
needs_revision
|
this PR replaces #68375 and is intended to address the issue reported in AWX: ansible/awx#6357 I can report that it resolves the issue for me:
|
|
It would be nice to have some version of this also backported to 2.9.x. |
ghjm
commented
Mar 27, 2020
| @@ -27,7 +27,7 @@ def test_warning(capsys, mocker, warning_message): | |||
| d.warning(warning_message) | |||
| out, err = capsys.readouterr() | |||
| assert d._warns == {expected_warning_message: 1} | |||
| assert err == '\x1b[1;35m{0}\x1b[0m\n\x1b[1;35m\x1b[0m'.format(expected_warning_message.rstrip('\n')) | |||
| assert err == '\x1b[1;35m{0}\x1b[0m\n'.format(expected_warning_message.rstrip('\n')) | |||
There was a problem hiding this comment.
This was originally looking for:
\x1b[1;35m (color on) - {0} (the message) - \x1b[0m (color off) - \n (newline) - \x1b[1;35m (color on) - \x1b[0m (color off)
With this PR it now puts the newline outside the coloration, and does not unnecessarily turn the coloration on and off a second time. So it is now looking for:
\x1b[1;35m (color on) - {0} (the message) - \x1b[0m (color off) - \n (newline)
bcoca
approved these changes
Mar 27, 2020
FWIW, this cherry-picks without problems to the stable-2.9 branch. |
mattclay
removed
the
needs_triage
ansibot
added
support:community
ghjm
added a commit
to ghjm/ansible
that referenced
this pull request
Mar 28, 2020
* Fix colorization to not extend across newline boundary * Fix unit test to look for the newline outside the coloration * Add changelog fragment (cherry picked from commit 2068131)
mattclay
pushed a commit
that referenced
this pull request
Apr 15, 2020
* Fix colorization to not extend across newline boundary * Fix unit test to look for the newline outside the coloration * Add changelog fragment (cherry picked from commit 2068131)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
SUMMARY
The change in #65199 causes Tower formatting of stdout to break. The problem is that the ANSI color codes are added in a way that includes the newline within the colorization. If we colorize the string and then add the newline outside the color codes, everyone should be happy.
ISSUE TYPE
COMPONENT NAME
utils