Skip to content

Terminal tab progress reporting issue #13072 #13395

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

Closed
wants to merge 2 commits into from
Closed

Terminal tab progress reporting issue #13072 #13395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31489b7
Fix #13072 Terminal tab process reporting issue
annatasio Apr 25, 2025
96b871f
Added #13072 changelog file and name to AUTHORS
annatasio Apr 25, 2025
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
1 change: 1 addition & 0 deletions AUTHORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Andrzej Klajnert
Andrzej Ostrowski
Andy Freeland
Anita Hammer
Anna Tasiopoulou
Anthon van der Neut
Anthony Shaw
Anthony Sottile
Expand Down
9 changes: 9 additions & 0 deletions changelog/13072.feature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Terminal tab progress reporting

Added support for displaying test progress in the terminal tab using OSC 9;4; ANSI sequence.
When pytest runs in a supported terminal emulator (like GNOME Terminal or ConEmu),
you'll see the test progress as a percentage in the terminal tab, allowing you to monitor
test execution progress without having to switch to the pytest tab.

This feature is automatically enabled when running in a compatible terminal and requires
no additional configuration.
18 changes: 18 additions & 0 deletions src/_pytest/terminal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,24 @@ def pytest_runtest_logreport(self, report: TestReport) -> None:
else:
markup = {}
self._progress_nodeids_reported.add(rep.nodeid)

# Calculate and send progress information to terminal tab
if self._show_progress_info:
total_items = 0
if hasattr(self, "_session") and self._session is not None:
if hasattr(self._session, "items"):
total_items = len(self._session.items)
Comment on lines +634 to +637
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need the hasattr checks given _session is set during __init__ (same for Session.items:

Suggested change
total_items = 0
if hasattr(self, "_session") and self._session is not None:
if hasattr(self._session, "items"):
total_items = len(self._session.items)
total_items = len(self._session.items) if self._session is not None else 0


if total_items > 0:
# Calculate progress percentage (0-100)
progress = int(len(self._progress_nodeids_reported) / total_items * 100)
# OSC 9;4;1;XX ST sequence for progress reporting
# 1 = set progress value, followed by percentage (0-100)
progress_sequence = f"\033]9;4;1;{progress}\033\\"
# Only write the sequence if we're in a terminal
if hasattr(self._tw, "_file") and self._tw._file.isatty():
Copy link
Member

@nicoddemus nicoddemus Apr 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this if should be done together with if self._show_progress_info, given if this is False we don't need to compute the progress at all. Also we can drop hasattr, as TerminalWriter is always set to a TextIO.

print(progress_sequence, end="", file=self._tw._file, flush=True)

if self.config.get_verbosity(Config.VERBOSITY_TEST_CASES) <= 0:
self._tw.write(letter, **markup)
# When running in xdist, the logreport and logfinish of multiple
Expand Down