fix: Block terminal summary for xdist workers. #978
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report❌ Patch coverage is @@ Coverage Diff @@
## main #978 +/- ##
==========================================
- Coverage 97.38% 97.32% -0.06%
==========================================
Files 21 21
Lines 1683 1685 +2
==========================================
+ Hits 1639 1640 +1
- Misses 44 45 +1 🚀 New features to boost your workflow:
|
noahnu
approved these changes
Apr 30, 2025
Collaborator
noahnu
left a comment
noahnu
left a comment
There was a problem hiding this comment.
The change makes sense to me. The controller prints the report.
Collaborator
|
@all-contributors add @paul-ollis for bug |
Contributor
|
I've put up a pull request to add @paul-ollis! 🎉 |
Collaborator
|
The main branch has unreleased changes from v5 on it so I'll have to create a v4 backport branch to get your change out earlier. I'll take a look later this week. |
Collaborator
|
🎉 This PR is included in version 5.0.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR prevents pytest_terminal_summary from executing in pytest-xdist worker processes.
I have seen this cause workers to use very high CPU (100% of a core or close) and cause a significant delay at the end of test runs (about 5 seconds).
I cannot see any reason why xdist worker should need to run the terminal summary, so simply preventing execution seems to be a sensible solution. Of course I may be wrong about this.
All tests appear to still pass. It is not obvious to me how to add a test for this change, but I do not think it is really necessary.
Related Issues
None.
Checklist
Additional Comments
No additional comments.