Skip to content

Use = as separator for the test run report#185

Merged
ngoldbaum merged 1 commit into
mainfrom
use-=-as-separator-for-terminal-reporter
Jun 26, 2026
Merged

Use = as separator for the test run report#185
ngoldbaum merged 1 commit into
mainfrom
use-=-as-separator-for-terminal-reporter

Conversation

@agriyakhetarpal

Copy link
Copy Markdown
Member

I noticed that the parallel test run summary has been using * as the separator, which feels a bit odd when browsing the full pytest summary, since the rest of the native section headers provided by pytest use = as the separator. This PR changes it to use =. Would this be fine?

I checked the blame while opening this PR, and did not astutely find a reason as to why * was chosen. The terminalreporter was introduced in c37a9ca with * and stayed in subsequent commits, was reorganised in 63ef3b1 to become a section, and kept the same character.

So while * makes it easier to visually distinguish this section in GitHub Actions CI/local terminal logs, I'm not sure if this was a deliberate design choice. Something for consideration, maybe...

@ngoldbaum

Copy link
Copy Markdown
Collaborator

Just to make it a little more clear for me, any chance you can make a before/after comparison for how the test output looks?

I seriously doubt anyone depends on the character we're using here so if = is more consistent it probably makes sense to switch.

@agriyakhetarpal

agriyakhetarpal commented Jun 26, 2026

Copy link
Copy Markdown
Member Author

Before this change, the test summary looks like (truncated logs):

tests/tests_here.py ·································

=============================== warnings summary ===============================
(warnings here))

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
************************** pytest-run-parallel report **************************
All tests were run in parallel! 🎉
====================== 634 passed, 14 warnings in 20.85s =======================

After this change, this will look like:

tests/tests_here.py ·································

=============================== warnings summary ===============================
(warnings here))

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
=========================== pytest-run-parallel report =========================
All tests were run in parallel! 🎉
====================== 634 passed, 14 warnings in 20.85s =======================

(The centering might be a little off, I did that manually)

@ngoldbaum

Copy link
Copy Markdown
Collaborator

Makes sense to me. I'm just going to go ahead and merge this. I'd be really really surprised if anyone depended on it.

@ngoldbaum ngoldbaum merged commit f8ca2c2 into main Jun 26, 2026
12 checks passed
@agriyakhetarpal agriyakhetarpal deleted the use-=-as-separator-for-terminal-reporter branch June 26, 2026 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants