Skip to content
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.

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

TST: enable faster coverage in Python>=3.12 #16466

Merged
merged 1 commit into from
May 30, 2024

Conversation

neutrinoceros
Copy link
Contributor

Description

Since version 7.4.2, coverage now fallback gracefully when the option isn't available (i.e. on Python 3.11 and older). This feature is still documented as experimental (as of version 7.5.1), but the migration cost is so low that it seems worth a shot.
Currently it only affects one regular tox env, but the gain (~40%) is significant.

Fixes #15975

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

Copy link

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

pyproject.toml Outdated
@@ -61,7 +61,7 @@ test_all = [
"ipykernel",
"ipython>=7.32",
"ipywidgets",
"coverage[toml]",
"coverage[toml]>=7.4.2",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess the real constraint would be !=7.4.0,!=7.4.1 which are the only two versions that know about the environment variable but don't have a graceful fallback mechanism for it, but this seemed tidier.

@neutrinoceros
Copy link
Contributor Author

Alas, gracefully falling back still means that a warning is emitted, which is enough to fail jobs running coverage with older Pythons. Let me draft this and fix for now. I'll fix it later.

@neutrinoceros neutrinoceros marked this pull request as draft May 16, 2024 17:28
@pllim pllim added this to the v7.0.0 milestone May 16, 2024
@neutrinoceros neutrinoceros force-pushed the tst/15975/fast_coverage branch 4 times, most recently from ebaa2ac to 90d2e31 Compare May 17, 2024 09:46
@neutrinoceros neutrinoceros marked this pull request as ready for review May 30, 2024 09:16
@mhvk
Copy link
Contributor

mhvk commented May 30, 2024

Alas, gracefully falling back still means that a warning is emitted, which is enough to fail jobs running coverage with older Pythons. Let me draft this and fix for now. I'll fix it later.

Really nice speed-up! We can just ignore the warning perhaps? Alternatively, pin coverage to <7.4 for lower python?

@neutrinoceros
Copy link
Contributor Author

pin coverage to <7.4 for lower python?

This was my solution until I realized I could simply use the env var in py312 envs only. Now this is stable and doesn't prevent upgrades for any Python.

Copy link
Contributor

@mhvk mhvk left a comment

Choose a reason for hiding this comment

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

OK, happy to hear the warning was already solved by ensuring the option is only set for python 3.12.

This is a bit far from my expertise, but this seems straightforward. In follow-up, we perhaps should use coverage only on python 3.12...

@mhvk mhvk merged commit fb4ff54 into astropy:main May 30, 2024
28 checks passed
@neutrinoceros neutrinoceros deleted the tst/15975/fast_coverage branch May 30, 2024 15:40
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.

TST: coverage overhead mostly goes away in Python >= 3.12
3 participants