Add conditional coverage exclusions to trivial places #2268
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
These are either chronically uncovered up to a certain line or have flaky coverage. Either way, having them in is rather harmful for measurements.
These are version-dependent but are sometimes applied to conditionals checking the deps versions. They won't work perfectly but it's a start.
There was a problem hiding this comment.
Pull Request Overview
This PR adds coverage pragmas to version-specific code branches to improve coverage reporting. The pragmas instruct the coverage tool to exclude certain branches from coverage tracking when running on specific Python versions, which helps achieve more accurate coverage metrics since version-specific code paths won't be executed in all test environments.
Key changes:
- Added
exclude_alsoconfiguration to.coveragercto exclude@pytest.mark.xfaildecorated tests - Added version-specific coverage pragmas to conditional imports and version checks throughout the codebase
- Added explanatory comments for some coverage exclusions
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
.coveragerc |
Added exclude_also configuration to exclude xfail tests from coverage |
tests/test_sync.py |
Added pragma for Python 3.12 version check |
tests/test_cli_compile.py |
Added pragmas for version checks and FIXME comment about pip version coverage |
tests/conftest.py |
Added pragmas for pip and Click version checks with explanatory comment |
piptools/utils.py |
Added pragmas for Python version checks and pip version checks |
piptools/build.py |
Added pragmas for Python version-specific imports |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The patch adds version-dependent pragmas where no actual coverage can be provided.
They sometimes are applied to conditionals checking the deps versions and won't work perfectly but it's a start.
The change also excludes tests marked as
xfailfrom coverage — they are either chronically uncovered up to a certain line or have flaky coverage. Either way, having them in is rather harmful for measurements.Contributor checklist
changelog.d/(seechangelog.d/README.mdfor instructions) or the PR text says "no changelog needed".Maintainer checklist
bot:chronographer:skiplabel.