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

Separate aiohttp.http_websocket into multiple files #9542

Merged
merged 13 commits into from
Oct 27, 2024
Merged

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Oct 26, 2024

What do these changes do?

There are no functional changes here. The goal is to be able to able to make it easier to build a Cython implementation for the WebsocketReader

The idea is to be able to use a PXD file to augment the python code with types so cython can build an optimized version +~88% of it as an extension without having to maintain a separate PYX file #9543

I considered an alternate approach of adding a PYX version which would be a tiny bit faster, but the downside of having to maintain the same code twice and requiring significant Cython knowledge to work on the WebSocket reader lead me to a PXD only approach since only Cython types have to be maintained which has a much lower learning curve.

Note that there are a few lines missing coverage. I did not add any coverage here as the goal was to ensure the only change here was code relocation.

Are there changes in behavior for the user?

no, unless someone was importing internals which is why I added a changelog entry for an internal change.

There are not functional changes here. The goal is to be able to
able to make it easier to build a Cython implementation for the
WebsocketReader
There are not functional changes here. The goal is to be able to
able to make it easier to build a Cython implementation for the
WebsocketReader
There are not functional changes here. The goal is to be able to
able to make it easier to build a Cython implementation for the
WebsocketReader
There are not functional changes here. The goal is to be able to
able to make it easier to build a Cython implementation for the
WebsocketReader
@bdraco bdraco added the backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot label Oct 26, 2024
Copy link

codecov bot commented Oct 26, 2024

Codecov Report

Attention: Patch coverage is 98.17352% with 8 lines in your changes missing coverage. Please review.

Project coverage is 98.57%. Comparing base (5f4c052) to head (6e0fdcb).
Report is 1 commits behind head on master.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
tests/test_websocket_parser.py 70.00% 2 Missing and 1 partial ⚠️
aiohttp/_websocket/reader.py 98.93% 1 Missing and 1 partial ⚠️
aiohttp/_websocket/helpers.py 98.71% 1 Missing ⚠️
aiohttp/_websocket/models.py 98.71% 1 Missing ⚠️
aiohttp/_websocket/writer.py 98.76% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #9542      +/-   ##
==========================================
- Coverage   98.59%   98.57%   -0.03%     
==========================================
  Files         108      112       +4     
  Lines       35207    35222      +15     
  Branches     4184     4184              
==========================================
+ Hits        34714    34720       +6     
- Misses        330      339       +9     
  Partials      163      163              
Flag Coverage Δ
CI-GHA 98.45% <97.94%> (-0.03%) ⬇️
OS-Linux 98.13% <97.94%> (-0.02%) ⬇️
OS-Windows 96.53% <97.26%> (-0.01%) ⬇️
OS-macOS 97.82% <97.26%> (-0.03%) ⬇️
Py-3.10.11 97.68% <97.26%> (-0.03%) ⬇️
Py-3.10.15 97.61% <97.94%> (-0.02%) ⬇️
Py-3.11.10 97.68% <97.94%> (-0.02%) ⬇️
Py-3.11.9 97.76% <97.26%> (-0.04%) ⬇️
Py-3.12.7 98.17% <97.94%> (-0.03%) ⬇️
Py-3.13.0 98.15% <97.94%> (-0.03%) ⬇️
Py-3.9.13 97.58% <96.79%> (-0.03%) ⬇️
Py-3.9.20 97.51% <97.48%> (-0.02%) ⬇️
Py-pypy7.3.16 97.17% <97.02%> (+<0.01%) ⬆️
VM-macos 97.82% <97.26%> (-0.03%) ⬇️
VM-ubuntu 98.13% <97.94%> (-0.02%) ⬇️
VM-windows 96.53% <97.26%> (-0.01%) ⬇️

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.

Copy link

codspeed-hq bot commented Oct 26, 2024

CodSpeed Performance Report

Merging #9542 will not alter performance

Comparing websocket_pxd (6e0fdcb) with master (5f4c052)

Summary

✅ 4 untouched benchmarks

@bdraco
Copy link
Member Author

bdraco commented Oct 26, 2024

I'm torn on a backport 3.10 as well as otherwise it's going to make future backports harder but I think 3.10 is so short lived that the risk of breakage from users unexpectedly importing internals from http_websocket probably outweighs the small overhead of increased backport conflicts so I didn't tag it for 3.10 as well

@bdraco
Copy link
Member Author

bdraco commented Oct 26, 2024

Even though it's an internal change, only, I think it warrants a change log message

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 26, 2024
@bdraco bdraco changed the title Seperate http_websocket into multiple files Seperate aiohttp.http_websocket into multiple files Oct 26, 2024
@bdraco bdraco changed the title Seperate aiohttp.http_websocket into multiple files Separate aiohttp.http_websocket into multiple files Oct 26, 2024
@bdraco bdraco marked this pull request as ready for review October 26, 2024 21:32
aiohttp/_websocket/helpers.py Dismissed Show resolved Hide resolved
@bdraco bdraco merged commit dd9a1fd into master Oct 27, 2024
39 of 41 checks passed
@bdraco bdraco deleted the websocket_pxd branch October 27, 2024 18:54
Copy link
Contributor

patchback bot commented Oct 27, 2024

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

❌ Failed to cleanly apply dd9a1fd on top of patchback/backports/3.11/dd9a1fdf568de33bc444779ca5a273713223666c/pr-9542

Backporting merged PR #9542 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/dd9a1fdf568de33bc444779ca5a273713223666c/pr-9542 upstream/3.11
  4. Now, cherry-pick PR Separate aiohttp.http_websocket into multiple files #9542 contents into that branch:
    $ git cherry-pick -x dd9a1fdf568de33bc444779ca5a273713223666c
    If it'll yell at you with something like fatal: Commit dd9a1fdf568de33bc444779ca5a273713223666c is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x dd9a1fdf568de33bc444779ca5a273713223666c
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Separate aiohttp.http_websocket into multiple files #9542 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/dd9a1fdf568de33bc444779ca5a273713223666c/pr-9542
  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.

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.

1 participant