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

Migrate to using propcache for property caching #9394

Merged
merged 15 commits into from
Oct 8, 2024
Merged

Migrate to using propcache for property caching #9394

merged 15 commits into from
Oct 8, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Oct 2, 2024

What do these changes do?

aio-libs/yarl#1070 (comment)
Replaces reify with a shared implementation called propcache that will be maintained in a single place for yarl and aiohttp

The propcache package is derived from the property caching code in yarl and has been broken out to avoid maintaining it for multiple projects.

Are there changes in behavior for the user?

The propcache dep is now required

Related issue number

aio-libs/yarl#1070 (comment)

@bdraco bdraco added the backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot label Oct 2, 2024
requirements/constraints.txt Outdated Show resolved Hide resolved
requirements/constraints.txt Outdated Show resolved Hide resolved
requirements/cython.txt Outdated Show resolved Hide resolved
requirements/cython.txt Outdated Show resolved Hide resolved
requirements/dev.txt Outdated Show resolved Hide resolved
requirements/dev.txt Outdated Show resolved Hide resolved
requirements/doc.txt Outdated Show resolved Hide resolved
requirements/doc.txt Outdated Show resolved Hide resolved
requirements/lint.txt Outdated Show resolved Hide resolved
Copy link

codecov bot commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.58%. Comparing base (132dedb) to head (3280055).
Report is 4 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #9394      +/-   ##
==========================================
+ Coverage   98.57%   98.58%   +0.01%     
==========================================
  Files         107      107              
  Lines       35076    35012      -64     
  Branches     4153     4146       -7     
==========================================
- Hits        34575    34517      -58     
+ Misses        334      330       -4     
+ Partials      167      165       -2     
Flag Coverage Δ
CI-GHA 98.46% <100.00%> (+0.01%) ⬆️
OS-Linux 98.13% <100.00%> (+0.01%) ⬆️
OS-Windows 96.55% <100.00%> (+0.02%) ⬆️
OS-macOS 97.82% <100.00%> (+0.01%) ⬆️
Py-3.10.11 97.69% <100.00%> (+0.02%) ⬆️
Py-3.10.15 97.62% <100.00%> (+0.01%) ⬆️
Py-3.11.10 97.69% <100.00%> (+0.01%) ⬆️
Py-3.11.9 97.77% <100.00%> (+0.01%) ⬆️
Py-3.12.6 97.87% <100.00%> (-0.30%) ⬇️
Py-3.12.7 98.07% <100.00%> (?)
Py-3.13.0-rc.3 98.17% <100.00%> (+0.01%) ⬆️
Py-3.9.13 97.59% <100.00%> (+0.02%) ⬆️
Py-3.9.20 97.52% <100.00%> (+0.01%) ⬆️
Py-pypy7.3.16 97.15% <100.00%> (+0.02%) ⬆️
VM-macos 97.82% <100.00%> (+0.01%) ⬆️
VM-ubuntu 98.13% <100.00%> (+0.01%) ⬆️
VM-windows 96.55% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 5, 2024
CHANGES/9394.packaging.rst Outdated Show resolved Hide resolved
@bdraco bdraco changed the title DNM: Migrate to using propcache for property caching Migrate to using propcache for property caching Oct 5, 2024
@bdraco bdraco marked this pull request as ready for review October 5, 2024 22:58
CHANGES/9394.packaging.rst Outdated Show resolved Hide resolved
requirements/base.txt Outdated Show resolved Hide resolved
@webknjaz webknjaz requested review from Dreamsorcerer and removed request for asvetlov October 6, 2024 01:10
requirements/constraints.txt Outdated Show resolved Hide resolved
requirements/dev.txt Outdated Show resolved Hide resolved
requirements/runtime-deps.in Outdated Show resolved Hide resolved
requirements/runtime-deps.txt Outdated Show resolved Hide resolved
setup.cfg Outdated Show resolved Hide resolved
aiohttp/helpers.py Outdated Show resolved Hide resolved
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

Looks good, except for that __all__ change that I'm unsure about.

@bdraco
Copy link
Member Author

bdraco commented Oct 7, 2024

Thanks

aiohttp/helpers.py Fixed Show fixed Hide fixed
@bdraco
Copy link
Member Author

bdraco commented Oct 7, 2024

Looks good, except for that __all__ change that I'm unsure about.

aiohttp/multipart.py:38:1: error: Module "aiohttp.helpers" does not explicitly
export attribute "reify"  [attr-defined]
    from .helpers import CHAR, TOKEN, parse_mimetype, reify
    ^
aiohttp/client_reqrep.py:46:1: error: Module "aiohttp.helpers" does not
explicitly export attribute "reify"  [attr-defined]
    from .helpers import (
    ^
aiohttp/web_request.py:34:1: error: Module "aiohttp.helpers" does not
explicitly export attribute "reify"  [attr-defined]
    from .helpers import (
    ^
Found 3 errors in 3 files (checked 1[24](https://github.com/aio-libs/aiohttp/actions/runs/11223257651/job/31197512704?pr=9394#step:9:25) source files)
make: *** [Makefile:89: mypy] Error 1

Few options I can think of... not sure what is best

  1. keep it in __all__
  2. Import it as under_cached_property and add reify = under_cached_property in helpers.py
  3. Import it directly in the places its used above

@Dreamsorcerer
Copy link
Member

Yeah, we're kind of using __all__ here to signal to mypy that these things are explicit reexports. I don't expect anybody to import helpers.py in the first place really...

@bdraco
Copy link
Member Author

bdraco commented Oct 7, 2024

I don't expect anybody to import helpers.py in the first place really...

I agree, lets leave it in __all__

@bdraco bdraco merged commit e9edd04 into master Oct 8, 2024
38 of 39 checks passed
@bdraco bdraco deleted the propcache branch October 8, 2024 12:02
Copy link
Contributor

patchback bot commented Oct 8, 2024

Backport to 3.11: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply e9edd04 on top of patchback/backports/3.11/e9edd04475ef6bfb4a9a8535b2617443e7bc71d2/pr-9394

Backporting merged PR #9394 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/3.11/e9edd04475ef6bfb4a9a8535b2617443e7bc71d2/pr-9394 upstream/3.11
  4. Now, cherry-pick PR Migrate to using propcache for property caching #9394 contents into that branch:
    $ git cherry-pick -x e9edd04475ef6bfb4a9a8535b2617443e7bc71d2
    If it'll yell at you with something like fatal: Commit e9edd04475ef6bfb4a9a8535b2617443e7bc71d2 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x e9edd04475ef6bfb4a9a8535b2617443e7bc71d2
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Migrate to using propcache for property caching #9394 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/e9edd04475ef6bfb4a9a8535b2617443e7bc71d2/pr-9394
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@webknjaz
Copy link
Member

webknjaz commented Oct 8, 2024

I don't expect anybody to import helpers.py in the first place really...

I would, since it's not even underscored 🤷‍♂️

bdraco added a commit that referenced this pull request Oct 8, 2024
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <sviat@redhat.com>
(cherry picked from commit e9edd04)
bdraco added a commit that referenced this pull request Oct 8, 2024
…erty caching (#9434)

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants