Fix packaging of Cython hash directories#12500
Conversation
for more information, see https://pre-commit.ci
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12500 +/- ##
==========================================
+ Coverage 98.77% 98.94% +0.16%
==========================================
Files 128 131 +3
Lines 44890 46680 +1790
Branches 2383 2421 +38
==========================================
+ Hits 44340 46186 +1846
+ Misses 390 369 -21
+ Partials 160 125 -35
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Merging this PR will not alter performance
Comparing Footnotes
|
| @@ -0,0 +1,2 @@ | |||
| Excluded generated Cython ``.hash`` directories from source distributions and wheels. | |||
There was a problem hiding this comment.
| Excluded generated Cython ``.hash`` directories from source distributions and wheels. | |
| Excluded generated Cython :file:`.hash/` directories from source distributions and wheels |
There was a problem hiding this comment.
Addressed in commit 59436d4 — switched the changelog entry to Sphinx's :file: role for the generated .hash/ directory.
What do these changes do?
Exclude generated Cython
.hashdirectories from aiohttp source distributions and wheels.Are there changes in behavior for the user?
No runtime behavior changes. Release artifacts no longer include generated build hash metadata.
Is it a substantial burden for the maintainers to support this?
No. This is a small packaging exclusion that keeps generated build metadata out of distributions.
Related issue number
Fixes #10860.
Checklist
CONTRIBUTORS.txtCHANGES/foldername it
<issue_or_pr_num>.<type>.rst(e.g.588.bugfix.rst)if you don't have an issue number, change it to the pull request
number after creating the PR
.bugfix: A bug fix for something the maintainers deemed animproper undesired behavior that got corrected to match
pre-agreed expectations.
.feature: A new behavior, public APIs. That sort of stuff..deprecation: A declaration of future API removals and breakingchanges in behavior.
.breaking: When something public is removed in a breaking way.Could be deprecated in an earlier release.
.doc: Notable updates to the documentation structure or buildprocess.
.packaging: Notes for downstreams about unobvious side effectsand tooling. Changes in the test invocation considerations and
runtime assumptions.
.contrib: Stuff that affects the contributor experience. e.g.Running tests, building the docs, setting up the development
environment.
.misc: Changes that are hard to assign to any of the abovecategories.
Make sure to use full sentences with correct case and punctuation,
for example:
Use the past tense or the present tense a non-imperative mood,
referring to what's changed compared to the last released version
of this project.
Validation:
AIOHTTP_NO_EXTENSIONS=1 /tmp/aiohttp-build-venv/bin/python -m build --sdist --wheel.tar.gzand.whlcontain no/.hash/entries after creating a sampleaiohttp/_websocket/.hash/directory./tmp/aiohttp-build-venv/bin/python tools/check_changes.py 10860.packaging.rst