Skip to content

gh-112730: Use color to highlight error locations #112732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ambv merged 10 commits into from
Dec 6, 2023
Merged

gh-112730: Use color to highlight error locations #112732

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9bc06ed
gh-112730: Use color to highlight error locations
pablogsal Dec 4, 2023
7671e2d
Make it work on windows
pablogsal Dec 5, 2023
ff19eec
Reorder env variable checks
pablogsal Dec 5, 2023
9ae4c77
Add more docs
pablogsal Dec 5, 2023
e4a0717
Add more colors
pablogsal Dec 5, 2023
1838f1c
Add test for syntax error (and fix colorization)
pablogsal Dec 5, 2023
a84f929
Fix multiline output
pablogsal Dec 6, 2023
158c09f
Merge branch 'main' into gh-112730
ambv Dec 6, 2023
8a07163
s/PY_COLORS/PYTHON_COLORS/
ambv Dec 6, 2023
f0aea49
Make PYTHON_COLORS higher precedence than NO_COLOR and FORCE_COLOR
ambv Dec 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add test for syntax error (and fix colorization)
  • Loading branch information
@pablogsal
pablogsal committed Dec 5, 2023
commit 1838f1c8f5a18792a7b5a0f6c3e44a84348072c3
21 changes: 21 additions & 0 deletions Lib/test/test_traceback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4284,6 +4284,27 @@ def bar():
self.assertIn(boldr + ",4)" + reset, lines)
self.assertIn(red + "bar" + reset + boldr + "()" + reset, lines)

def test_colorized_syntax_error(self):
try:
compile("a $ b", "<string>", "exec")
except SyntaxError as e:
exc = traceback.TracebackException.from_exception(
e, capture_locals=True
)
actual = "".join(exc.format(colorize=True))
red = traceback._ANSIColors.RED
magenta = traceback._ANSIColors.MAGENTA
boldm = traceback._ANSIColors.BOLD_MAGENTA
boldr = traceback._ANSIColors.BOLD_RED
reset = traceback._ANSIColors.RESET
expected = "".join([
f' File {magenta}"<string>"{reset}, line {magenta}1{reset}\n',
f' a {boldr}${reset} b\n',
f' {boldr}^{reset}\n',
f'{boldm}SyntaxError{reset}: {magenta}invalid syntax{reset}\n']
)
self.assertIn(expected, actual)

def test_colorized_traceback_is_the_default(self):
def foo():
1/0
Expand Down
20 changes: 15 additions & 5 deletions Lib/traceback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1310,22 +1310,32 @@ def _format_syntax_error(self, stype, **kwargs):
# colorize from colno to end_colno
ltext = (
ltext[:colno] +
_ANSIColors.RED + ltext[colno:end_colno] + _ANSIColors.RESET +
_ANSIColors.BOLD_RED + ltext[colno:end_colno] + _ANSIColors.RESET +
ltext[end_colno:]
)
start_color = _ANSIColors.RED
start_color = _ANSIColors.BOLD_RED
end_color = _ANSIColors.RESET
yield ' {}\n'.format(ltext)
yield ' {}{}{}{}'.format(
yield ' {}{}{}{}\n'.format(
"".join(caretspace),
start_color,
('^' * (end_colno - colno) + "\n"),
('^' * (end_colno - colno)),
end_color,
)
else:
yield ' {}\n'.format(ltext)
msg = self.msg or "<no detail available>"
yield "{}: {}{}\n".format(stype, msg, filename_suffix)
if colorize:
yield "{}{}{}: {}{}{}{}\n".format(
_ANSIColors.BOLD_MAGENTA,
stype,
_ANSIColors.RESET,
_ANSIColors.MAGENTA,
msg,
_ANSIColors.RESET,
filename_suffix)
else:
yield "{}: {}{}\n".format(stype, msg, filename_suffix)

def format(self, *, chain=True, _ctx=None, **kwargs):
"""Format the exception.
Expand Down