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

Fix for check-manifest pre-commit hook in Python 3.12 #344

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sfmig
Copy link
Contributor

@sfmig sfmig commented Nov 19, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
With Python 3.12, pre-commit run check-manifest returns an error of missing dependencies -- see more details in this issue.

To fix it,wheel needs to be specified as a dependency of check-manifest in the pre-commit config.

This error doesn't show up in CI because:

  • in CI, we run check-manifest with Python 3.10 and without the --no-build-isolation flag.
  • the linting action runs on python 3.10

Question

  • Right now, when we say we support Python 3.12 in practice we mean we run the code tests in Python 3.12.
  • But should we ensure other bits, like the developer tools, also run on the Python versions we support?
  • If so, maybe it makes sense if we ensure that the CI actions related to precommits run the latest python version?

What does this PR do?
Adds wheel as a dependency to check-manifest in the pre-commit config.

References

The most relevant is this issue. from the cookiecutter repo.

How has this PR been tested?

Tests pass locally and in CI.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

No.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@sfmig sfmig changed the title Add wheel as a dependency Fix for check-manifest pre-commit hook in Python 3.12 Nov 19, 2024
Copy link

sonarcloud bot commented Nov 19, 2024

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.77%. Comparing base (a3956c4) to head (534bc90).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #344   +/-   ##
=======================================
  Coverage   99.77%   99.77%           
=======================================
  Files          14       14           
  Lines         907      907           
=======================================
  Hits          905      905           
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@sfmig sfmig marked this pull request as ready for review November 19, 2024 20:23
@sfmig sfmig requested a review from a team November 19, 2024 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant