Skip to content

Add Better Typehints using Updated aiosignal #11160

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

Vizonex
Copy link
Contributor

@Vizonex Vizonex commented Jun 7, 2025

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

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • 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.
  • 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 Vizonex requested a review from asvetlov as a code owner June 7, 2025 18:15
Copy link

codspeed-hq bot commented Jun 7, 2025

CodSpeed Performance Report

Merging #11160 will not alter performance

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

Summary

✅ 59 untouched benchmarks

Copy link

codecov bot commented Jun 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.85%. Comparing base (8795da3) to head (11d42bb).

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%) ⬆️
OS-Linux 98.47% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.80% <100.00%> (-0.01%) ⬇️
OS-macOS 97.70% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.34% <100.00%> (-0.01%) ⬇️
Py-3.10.17 97.83% <100.00%> (-0.01%) ⬇️
Py-3.11.12 98.02% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.54% <100.00%> (-0.01%) ⬇️
Py-3.12.10 98.40% <100.00%> (+<0.01%) ⬆️
Py-3.13.3 98.38% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.23% <100.00%> (+<0.01%) ⬆️
Py-3.9.22 97.71% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 93.05% <100.00%> (-4.28%) ⬇️
VM-macos 97.70% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 98.47% <100.00%> (+<0.01%) ⬆️
VM-windows 96.80% <100.00%> (-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.

@Vizonex
Copy link
Contributor Author

Vizonex commented Jun 7, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

Migrating From aiosignal to aiocallback for TraceConfig to improve it's performance and readability.
1 participant