aiohttp icon indicating copy to clipboard operation
aiohttp copied to clipboard

Add Better Typehints using Updated aiosignal

Open Vizonex opened this issue 7 months ago • 3 comments

What do these changes do?

Adds type hinting to TraceConfig using the updated branch of aiosignal. I actually filmed part of this on youtube funny enough and I made sure that I ran pytest tests for test_tracing.py passed. This this better than my other pull requests because we no longer need to use wrappers, thank goodness no need for nested code!

Are there changes in behavior for the user?

Only 3 which should be the following

  • _SignalCallback is now a TypeAlias as opposed to using a Protocol styled approach. The Benefit mainly revolves around Aiosignal's New ParamSpec which seems to be doing more good than I had originally thought. Originally I thought I had to use wrappers but this turns out that this is not the case and rather one of my own VS Extension's fault.
  • _T is now inside of _SignalCallback so that type checkers can catch unrelated types being carried around
  • Thanks to Aiosignal's new features users can now utilize the different TraceConfig callbacks as wrappers optionally.

Is it a substantial burden for the maintainers to support this?

Hopefully now I can stop deleting or removing pull requests now that I have figured out the problems on my end and fixed them all. I got rid of the need for needing wrapper properties which is a real blessing. The only thing I could see maintainers maybe raising an Eyebrow for is going to be the _T TypeVar being used with _SignalCallback which I did on purpose to ensure that if TraceConfig has passed a variable such as TraceConfig[dict] then dict should be expected by different linters to be passed.

Related issue number

  • Fixes #11036
  • Fixes #11123
  • Fixes https://github.com/aio-libs/aiosignal/pull/705

Checklist

  • [x] I think the code is well written
  • [x] Unit tests for the changes exist
  • [x] Documentation reflects the changes
  • [x] If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • [x] Add a new news fragment into the CHANGES/ folder
    • name 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 an improper 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 breaking changes 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 build process.
      • .packaging: Notes for downstreams about unobvious side effects and 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 above categories.
    • Make sure to use full sentences with correct case and punctuation, for example:

      Fixed issue with non-ascii contents in doctest text files
      -- by :user:`contributor-gh-handle`.
      

      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.

Vizonex avatar Jun 07 '25 18:06 Vizonex

CodSpeed Performance Report

Merging #11160 will not alter performance

Comparing Vizonex:Refractor-TraceConfig-Typehints (11d42bb) with master (8795da3)

Summary

✅ 59 untouched benchmarks

codspeed-hq[bot] avatar Jun 07 '25 18:06 codspeed-hq[bot]

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 98.85%. Comparing base (8795da3) to head (11d42bb). :warning: Report is 276 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #11160   +/-   ##
=======================================
  Coverage   98.85%   98.85%           
=======================================
  Files         131      131           
  Lines       42966    42967    +1     
  Branches     2314     2314           
=======================================
+ Hits        42476    42477    +1     
  Misses        340      340           
  Partials      150      150           
Flag Coverage Δ
CI-GHA 98.75% <100.00%> (+<0.01%) :arrow_up:
OS-Linux 98.47% <100.00%> (+<0.01%) :arrow_up:
OS-Windows 96.80% <100.00%> (-0.01%) :arrow_down:
OS-macOS 97.70% <100.00%> (+<0.01%) :arrow_up:
Py-3.10.11 97.34% <100.00%> (-0.01%) :arrow_down:
Py-3.10.17 97.83% <100.00%> (-0.01%) :arrow_down:
Py-3.11.12 98.02% <100.00%> (+<0.01%) :arrow_up:
Py-3.11.9 97.54% <100.00%> (-0.01%) :arrow_down:
Py-3.12.10 98.40% <100.00%> (+<0.01%) :arrow_up:
Py-3.13.3 98.38% <100.00%> (+<0.01%) :arrow_up:
Py-3.9.13 97.23% <100.00%> (-0.01%) :arrow_down:
Py-3.9.22 97.71% <100.00%> (+<0.01%) :arrow_up:
Py-pypy7.3.16 93.05% <100.00%> (-4.28%) :arrow_down:
VM-macos 97.70% <100.00%> (+<0.01%) :arrow_up:
VM-ubuntu 98.47% <100.00%> (+<0.01%) :arrow_up:
VM-windows 96.80% <100.00%> (-0.01%) :arrow_down:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jun 07 '25 18:06 codecov[bot]

should I try and coming up with a backport if an older version of aiosignal is being utilized?

Vizonex avatar Jun 07 '25 18:06 Vizonex

_AppSignal type has to be updated as well, I guess it should be Signal["Application"], not sure though

arcan1s avatar Jul 04 '25 10:07 arcan1s

_AppSignal type has to be updated as well, I guess it should be Signal["Application"], not sure though

@arcan1s I mostly left this pr dormant until the new update I helped create would be available to the public, should I try resuming this pull request or start a new one with better changes?

Vizonex avatar Jul 04 '25 15:07 Vizonex

@Vizonex I'm not maintainer 🙃 just found broken pipelines after the last aiosignal release

arcan1s avatar Jul 04 '25 15:07 arcan1s

@arcan1s Even better it seems someone did my job for me. Whoever it was, I want to say thank you. You accomplished my wishes. Let me close this because now this has been solved and the new update has done just that.

Vizonex avatar Jul 04 '25 16:07 Vizonex