From 4e767b5406651da45fea95e09b75d5f4dca4a4e7 Mon Sep 17 00:00:00 2001 From: pfackeldey Date: Tue, 21 Jul 2026 12:20:45 +0200 Subject: [PATCH 1/6] Use _colorize.get_colors() to allow disabling ANSI escape codes through environment variables --- Lib/profiling/sampling/pstats_collector.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Lib/profiling/sampling/pstats_collector.py b/Lib/profiling/sampling/pstats_collector.py index 7132cffd58f094a..c1da859202895d7 100644 --- a/Lib/profiling/sampling/pstats_collector.py +++ b/Lib/profiling/sampling/pstats_collector.py @@ -1,11 +1,12 @@ import collections import marshal import pstats -lazy from _colorize import ANSIColors +from _colorize import get_colors from .collector import Collector, extract_lineno from .constants import MICROSECONDS_PER_SECOND, PROFILING_MODE_CPU +ANSIColors = get_colors() class PstatsCollector(Collector): aggregating = True From d5d629f1dcecc465be3ec1d7fe420d248bfd6806 Mon Sep 17 00:00:00 2001 From: pfackeldey Date: Tue, 21 Jul 2026 12:24:55 +0200 Subject: [PATCH 2/6] add news entry --- .../next/Library/2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 Misc/NEWS.d/next/Library/2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst diff --git a/Misc/NEWS.d/next/Library/2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst b/Misc/NEWS.d/next/Library/2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst new file mode 100644 index 000000000000000..c3241b0c42c7e30 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst @@ -0,0 +1 @@ +Allow disabling terminal coloring for Tachyon's pstats collector. From 1be0172048a362598ab43e26626c996c3d1e554c Mon Sep 17 00:00:00 2001 From: pfackeldey Date: Thu, 23 Jul 2026 10:09:21 +0200 Subject: [PATCH 3/6] use get_colors() instead of ANSIColors enum also in Lib/profiling/sampling/sample.py --- Lib/profiling/sampling/sample.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Lib/profiling/sampling/sample.py b/Lib/profiling/sampling/sample.py index 6cb6dd483520887..2101305bb5839a4 100644 --- a/Lib/profiling/sampling/sample.py +++ b/Lib/profiling/sampling/sample.py @@ -6,10 +6,11 @@ import sysconfig import time from collections import deque -lazy from _colorize import ANSIColors +from _colorize import get_colors from .binary_collector import BinaryCollector +ANSIColors = get_colors() @contextlib.contextmanager def _pause_threads(unwinder, blocking): From f0d9823a9f09b030ded928186971006a6a8b3a09 Mon Sep 17 00:00:00 2001 From: pfackeldey Date: Thu, 23 Jul 2026 18:07:26 +0200 Subject: [PATCH 4/6] fix data_lines collection of pstats lines for no-color mode --- Lib/test/test_profiling/test_sampling_profiler/test_profiler.py | 1 + 1 file changed, 1 insertion(+) diff --git a/Lib/test/test_profiling/test_sampling_profiler/test_profiler.py b/Lib/test/test_profiling/test_sampling_profiler/test_profiler.py index 2f5a5e273286590..6b999e04e3d65c3 100644 --- a/Lib/test/test_profiling/test_sampling_profiler/test_profiler.py +++ b/Lib/test/test_profiling/test_sampling_profiler/test_profiler.py @@ -751,6 +751,7 @@ def test_print_sampled_stats_sort_by_name(self): and not "calls" in line # Skip summary lines and not "total time" in line # Skip summary lines and not "cumulative time" in line + and not "filename:lineno(function)" in line # Skip header line ): # Skip summary lines data_lines.append(line) From 7d8e13f2a015fcc8ff8b4a178ddaec7549d88731 Mon Sep 17 00:00:00 2001 From: pfackeldey Date: Thu, 23 Jul 2026 18:19:22 +0200 Subject: [PATCH 5/6] preserve lazy import of _colorize --- Lib/profiling/sampling/pstats_collector.py | 8 +++++--- Lib/profiling/sampling/sample.py | 10 +++++++--- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/Lib/profiling/sampling/pstats_collector.py b/Lib/profiling/sampling/pstats_collector.py index c1da859202895d7..dd3e7ef1c02c990 100644 --- a/Lib/profiling/sampling/pstats_collector.py +++ b/Lib/profiling/sampling/pstats_collector.py @@ -1,13 +1,11 @@ import collections import marshal import pstats -from _colorize import get_colors +lazy from _colorize import get_colors from .collector import Collector, extract_lineno from .constants import MICROSECONDS_PER_SECOND, PROFILING_MODE_CPU -ANSIColors = get_colors() - class PstatsCollector(Collector): aggregating = True @@ -179,6 +177,8 @@ def print_stats(self, sort=-1, limit=None, show_summary=True, mode=None): } # Print header with colors and proper alignment + ANSIColors = get_colors() + print(f"{ANSIColors.BOLD_BLUE}Profile Stats:{ANSIColors.RESET}") header_nsamples = f"{ANSIColors.BOLD_BLUE}{'nsamples':>{col_widths['nsamples']}}{ANSIColors.RESET}" @@ -270,6 +270,8 @@ def _determine_best_unit(max_value): def _print_summary(self, stats_list, total_samples): """Print summary of interesting functions.""" + ANSIColors = get_colors() + print( f"\n{ANSIColors.BOLD_BLUE}Summary of Interesting Functions:{ANSIColors.RESET}" ) diff --git a/Lib/profiling/sampling/sample.py b/Lib/profiling/sampling/sample.py index 2101305bb5839a4..0886baed3c75b5c 100644 --- a/Lib/profiling/sampling/sample.py +++ b/Lib/profiling/sampling/sample.py @@ -6,12 +6,10 @@ import sysconfig import time from collections import deque -from _colorize import get_colors +lazy from _colorize import get_colors from .binary_collector import BinaryCollector -ANSIColors = get_colors() - @contextlib.contextmanager def _pause_threads(unwinder, blocking): """Context manager to pause/resume threads around sampling if blocking is True.""" @@ -273,6 +271,8 @@ def _print_realtime_stats(self): ) # Max time = Min Hz # Build cache stats string if stats collection is enabled + ANSIColors = get_colors() + cache_stats_str = "" if self.collect_stats: try: @@ -306,6 +306,8 @@ def _print_unwinder_stats(self): except RuntimeError: return # Stats not enabled + ANSIColors = get_colors() + print(f"\n{ANSIColors.BOLD_BLUE}{'='*50}{ANSIColors.RESET}") print(f"{ANSIColors.BOLD_BLUE}Unwinder Statistics:{ANSIColors.RESET}") @@ -400,6 +402,8 @@ def _print_binary_stats(self, collector): except (ValueError, RuntimeError): return # Collector closed or stats unavailable + ANSIColors = get_colors() + print(f" {ANSIColors.CYAN}Binary Encoding:{ANSIColors.RESET}") repeat_records = stats.get('repeat_records', 0) From 43dd7fee1841aaaf338b757a7c4e3af4613607b0 Mon Sep 17 00:00:00 2001 From: Pablo Galindo Salgado Date: Thu, 24 Sep 2026 16:54:45 +0100 Subject: [PATCH 6/6] gh-154335: Cover profiler color policy and update NEWS --- Lib/profiling/sampling/pstats_collector.py | 1 + Lib/profiling/sampling/sample.py | 1 + .../test_sampling_profiler/test_profiler.py | 11 ++++++++++- .../2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst | 4 +++- 4 files changed, 15 insertions(+), 2 deletions(-) diff --git a/Lib/profiling/sampling/pstats_collector.py b/Lib/profiling/sampling/pstats_collector.py index dd3e7ef1c02c990..0f31d93582b83e7 100644 --- a/Lib/profiling/sampling/pstats_collector.py +++ b/Lib/profiling/sampling/pstats_collector.py @@ -6,6 +6,7 @@ from .collector import Collector, extract_lineno from .constants import MICROSECONDS_PER_SECOND, PROFILING_MODE_CPU + class PstatsCollector(Collector): aggregating = True diff --git a/Lib/profiling/sampling/sample.py b/Lib/profiling/sampling/sample.py index 0886baed3c75b5c..1dff6529ade0408 100644 --- a/Lib/profiling/sampling/sample.py +++ b/Lib/profiling/sampling/sample.py @@ -10,6 +10,7 @@ from .binary_collector import BinaryCollector + @contextlib.contextmanager def _pause_threads(unwinder, blocking): """Context manager to pause/resume threads around sampling if blocking is True.""" diff --git a/Lib/test/test_profiling/test_sampling_profiler/test_profiler.py b/Lib/test/test_profiling/test_sampling_profiler/test_profiler.py index 6b999e04e3d65c3..b1fbfb5a0de34dd 100644 --- a/Lib/test/test_profiling/test_sampling_profiler/test_profiler.py +++ b/Lib/test/test_profiling/test_sampling_profiler/test_profiler.py @@ -17,7 +17,7 @@ "Test only runs when _remote_debugging is available" ) -from test.support import force_not_colorized_test_class +from test.support import force_colorized, force_not_colorized_test_class def print_sampled_stats(stats, sort=-1, limit=None, show_summary=True, sample_interval_usec=100): @@ -484,6 +484,15 @@ def test_print_sampled_stats_basic(self): self.assertIn("func1", result) self.assertIn("func2", result) self.assertIn("func3", result) + self.assertNotIn("\x1b[", result) + + @force_colorized + def test_print_sampled_stats_colorized(self): + with io.StringIO() as output, mock.patch("sys.stdout", output): + print_sampled_stats(self.mock_stats) + result = output.getvalue() + + self.assertIn("\x1b[1;34mProfile Stats:", result) def test_print_sampled_stats_sorting(self): """Test different sorting options.""" diff --git a/Misc/NEWS.d/next/Library/2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst b/Misc/NEWS.d/next/Library/2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst index c3241b0c42c7e30..ffd923294551f2f 100644 --- a/Misc/NEWS.d/next/Library/2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst +++ b/Misc/NEWS.d/next/Library/2026-07-21-12-23-48.gh-issue-154335.SRf8Gr.rst @@ -1 +1,3 @@ -Allow disabling terminal coloring for Tachyon's pstats collector. +The :mod:`profiling.sampling` profiler now respects ``NO_COLOR``, +``FORCE_COLOR``, and ``PYTHON_COLORS`` and avoids colored output when +not writing to a terminal.