Add a PXD only Cython extension for the WebSocket reader to improve performance

[bdraco]

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 +~100% of it as an extension without having to maintain a separate PYX file.

The reader has been moved to reader_py.py to ensure AIOHTTP_NO_EXTENSIONS does not load reader_c. There was some missing coverage in reader.py. Tests have been added to close the gap.

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.

The cythonized version can be examined with the following:

1. make cythonize
2. Run cythonize -X language_level=3 -a -i aiohttp/_websocket/reader_c.py
3. Examine aiohttp/_websocket/reader_c.html

Yellow lines in the html hint at python interaction. See https://cython.readthedocs.io/en/latest/src/tutorial/cython_tutorial.html https://pythonprogramming.net/introduction-and-basics-cython-tutorial/

Note that if you make changes to the .pxd file, cythonize may not see them until you touch aiohttp/_websocket/reader_c.py and run the above again.

[codspeed-hq]

CodSpeed Performance Report

Merging #9543 will improve performances by ×2.1

_{Comparing websocket_pxd_create (2165de1) with master (dd9a1fd)}

Summary

⚡ 1 improvements
✅ 3 untouched benchmarks

Benchmarks breakdown

	Benchmark	master	websocket_pxd_create	Change
⚡	test_read_one_hundred_websocket_text_messages[pyloop]	1,295.4 µs	624.3 µs	×2.1

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.58%. Comparing base (dd9a1fd) to head (2165de1).
Report is 621 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #9543   +/-   ##
=======================================
  Coverage   98.57%   98.58%           
=======================================
  Files         112      113    +1     
  Lines       35222    35251   +29     
  Branches     4184     4186    +2     
=======================================
+ Hits        34720    34751   +31     
+ Misses        339      338    -1     
+ Partials      163      162    -1     

Flag	Coverage Δ
CI-GHA	98.46% <99.54%> (+<0.01%)	⬆️
OS-Linux	98.13% <99.54%> (+<0.01%)	⬆️
OS-Windows	96.03% <21.36%> (-0.50%)	⬇️
OS-macOS	97.35% <21.36%> (-0.48%)	⬇️
Py-3.10.11	97.22% <21.36%> (-0.47%)	⬇️
Py-3.10.15	97.62% <99.54%> (+<0.01%)	⬆️
Py-3.11.10	97.69% <99.54%> (+0.01%)	⬆️
Py-3.11.9	97.29% <21.36%> (-0.48%)	⬇️
Py-3.12.7	98.17% <99.54%> (+<0.01%)	⬆️
Py-3.13.0	98.16% <99.54%> (+<0.01%)	⬆️
Py-3.9.13	97.12% <21.46%> (-0.47%)	⬇️
Py-3.9.20	97.52% <98.63%> (+<0.01%)	⬆️
Py-pypy7.3.16	97.17% <97.26%> (-0.01%)	⬇️
VM-macos	97.35% <21.36%> (-0.48%)	⬇️
VM-ubuntu	98.13% <99.54%> (+<0.01%)	⬆️
VM-windows	96.03% <21.36%> (-0.50%)	⬇️

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.

[bdraco]

We could probably get another 30% out of it if we stopped shipping around the data in a tuple since it has to be converted back to pyint. But thats probably not worth it

[patchback]

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

❌ Failed to cleanly apply 6ae2f05 on top of patchback/backports/3.11/6ae2f053e9989a759b140e42937e2138f80e502d/pr-9543

Backporting merged PR #9543 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/6ae2f053e9989a759b140e42937e2138f80e502d/pr-9543 upstream/3.11

4. Now, cherry-pick PR Add a PXD only Cython extension for the WebSocket reader to improve performance  #9543 contents into that branch:

   $ git cherry-pick -x 6ae2f053e9989a759b140e42937e2138f80e502d

   If it'll yell at you with something like fatal: Commit 6ae2f053e9989a759b140e42937e2138f80e502d is a merge but no -m option was given., add -m 1 as follows instead:

   $ git cherry-pick -m1 -x 6ae2f053e9989a759b140e42937e2138f80e502d

5. At this point, you'll probably encounter some merge conflicts. You must
   resolve them in to preserve the patch from PR Add a PXD only Cython extension for the WebSocket reader to improve performance  #9543 as close to the
   original as possible.
6. Push this branch to your fork on GitHub:

   $ git push origin patchback/backports/3.11/6ae2f053e9989a759b140e42937e2138f80e502d/pr-9543

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.