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
Reorder env variable checks
  • Loading branch information
@pablogsal
pablogsal committed Dec 5, 2023
commit ff19eecfcfe0d9d9d5a7aeb54c8645659c8c7979
8 changes: 4 additions & 4 deletions Lib/test/test_traceback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4314,8 +4314,8 @@ def foo():
self.assertEqual(actual, expected)

def test_colorized_detection_checks_for_environment_variables(self):
with unittest.mock.patch("sys.stderr") as stderr_mock:
stderr_mock.isatty.return_value = True
with unittest.mock.patch("os.isatty") as isatty_mock:
isatty_mock.return_value = True
with unittest.mock.patch("os.environ", {'TERM': 'dumb'}):
self.assertEqual(traceback._can_colorize(), False)
with unittest.mock.patch("os.environ", {'PY_COLORS': '1'}):
Expand All @@ -4325,12 +4325,12 @@ def test_colorized_detection_checks_for_environment_variables(self):
with unittest.mock.patch("os.environ", {'NO_COLOR': '1'}):
self.assertEqual(traceback._can_colorize(), False)
with unittest.mock.patch("os.environ", {'NO_COLOR': '1', "PY_COLORS": '1'}):
self.assertEqual(traceback._can_colorize(), True)
self.assertEqual(traceback._can_colorize(), False)
with unittest.mock.patch("os.environ", {'FORCE_COLOR': '1'}):
self.assertEqual(traceback._can_colorize(), True)
with unittest.mock.patch("os.environ", {'FORCE_COLOR': '1', 'NO_COLOR': '1'}):
self.assertEqual(traceback._can_colorize(), False)
stderr_mock.isatty.return_value = False
isatty_mock.return_value = False
self.assertEqual(traceback._can_colorize(), False)

if __name__ == "__main__":
Expand Down
18 changes: 11 additions & 7 deletions Lib/traceback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""Extract, format and print information about Python stack traces."""

import os
import io
import collections.abc
import itertools
import linecache
Expand Down Expand Up @@ -141,19 +142,22 @@ def _can_colorize():
except (ImportError, AttributeError):
return False

if not _COLORIZE:
if "NO_COLOR" in os.environ:
return False
if os.environ.get("PY_COLORS") == "1":
return True
if os.environ.get("PY_COLORS") == "0":
return False
if "NO_COLOR" in os.environ:
if not _COLORIZE:
return False
if "FORCE_COLOR" in os.environ:
return True
return (
hasattr(sys.stderr, "isatty") and sys.stderr.isatty() and os.environ.get("TERM") != "dumb"
)
if os.environ.get("PY_COLORS") == "1":
return True
if os.environ.get("TERM") == "dumb":
return False
try:
return os.isatty(sys.stderr.fileno())
except io.UnsupportedOperation:
return sys.stderr.isatty()

def _print_exception_bltin(exc, /):
file = sys.stderr if sys.stderr is not None else sys.__stderr__
Expand Down