Add stubs for _async methods #615
Description
Checklist
- I have looked into the Readme and Examples, and have not found a suitable solution or answer.
- I have looked into the API documentation and have not found a suitable solution or answer.
- I have searched the issues and have not found a suitable solution or answer.
- I have searched the Auth0 Community forums and have not found a suitable solution or answer.
- I agree to the terms within the Auth0 Code of Conduct.
Describe the problem you'd like to have solved
The built-in asyncify is very useful, but the way it's implemented means that typing checking (such as via Pyre) and IDEs have no idea these exist.
Describe the ideal solution
Add function stubs for every method that supports async with type hinting.
Alternatives and current workarounds
No response
Additional context
No response
Activity
Avasam commentedon Apr 14, 2025
#678 (comment)
kishore7snehil commentedon Apr 25, 2025
I believe this issue can be closed now as we already have a workaround discussed on this thread.
Dreamsorcerer commentedon Apr 25, 2025
Isn't that workaround to wait for Avasam to merge the typeshed PR and then use types-auth0-python instead? Still looks to me like something needs to be done in this repo in order to provide types directly and close #612.
kishore7snehil commentedon Apr 25, 2025
@Dreamsorcerer There was a PR for the same where it was asked to add the
.pyfiles in the repo itself. I suggested to use the script to generate the async files.That's the same approach @Avasam (correct me if I am wrong ) is pushing forward but with some specific tweaks to the generation logic.
If he is willing to add a PR to this repo, I can review it and take it forward.
Dreamsorcerer commentedon Apr 25, 2025
Of course. My point was just that this issue isn't closed until that PR gets created and merged.
Avasam commentedon May 3, 2025
If you don't mind having a script to run once in a while to "keep the stubs in sync". I can migrate the script I made for python/typeshed#13826 to over here.
Can probably include some CI check to ensure that running it wouldn't produce any change (ie: not forgotten by the contributor).
I see you have a https://github.com/auth0/auth0-python/blob/master/.pre-commit-config.yaml , it could also be added there.
Then I think you'll have everything you need to declare this library as "first-party typed".
kishore7snehil commentedon May 8, 2025
@Avasam Please feel free to open a PR. I can review it and will update you acordingly.