Add stubs for async

[David-Gilman]

Changes

Currently type checkers such as pyre, mypy, and those included in IDEs can't handle async functions. This adds partial support by adding .pyi files for the management API functions ending in _async.

References

Resolves: #615

Testing

Tested with IDE and type checkers.

Checklist

• I have read the Auth0 general contribution guidelines
• I have read the Auth0 Code of Conduct
• All existing and new tests complete without errors

[David-Gilman]

@kishore7snehil Could I get a review and a merge please?

[kishore7snehil]

Hey @David-Gilman, I'm reviewing your PR now and will be adding comments soon. However, the merge won't be possible since Snyk is failing here. I'll take your changes and create a new PR to address this. I'll make sure to give you proper credits both in the PR and in the release. Thanks for your contribution!

[kishore7snehil]

Hey @David-Gilman, I’ve reviewed your PR. Instead of creating multiple .pyi files for async stubs manually, I’d recommend using a script to handle this, as having too many .pyi files might be confusing for developers.

I already have a script ready for this, and I can share the feature branch with you. You can check out the script in the scripts folder here and try running it using:

poetry run python scripts/generate_stubs.py

This will generate all the required .pyi files for the auth0/management folder.

Let me know if this approach works for you—if it does, we can close this PR and proceed with the scripted solution.

Also, I’m not in favor of adding .pyi files directly in the repo as it looks odd and can be confusing. Otherwise, we would have just added duplicate functions for async directly in each .py file.

cc: @kpark-hrp

[kishore7snehil]

I already have a script ready for this. You can check out the script in the scripts folder here and try running it using:

poetry run python scripts/generate_stubs.py

This will generate all the required .pyi files for the auth0/management folder.

I’m not in favor of adding .pyi files directly in the repo as it looks odd and can be confusing. Otherwise, we would have just added duplicate functions for async directly in each .py file.

[David-Gilman]

@kishore7snehil

That requires anyone use type checkers to maintain their own fork with the .pyi files.

Adding .pyi files is a common practice and would be relatively low maintenance, as well as a good middle ground between no type hints and having to maintain entire duplicate functions.

You could add your script to the CI check so that any changes get updated automatically in the PR.

If you feel strongly about this though and no other maintainers disagree with you, I can open a typeshed PR instead.

[David-Gilman]

@kishore7snehil Thoughts?

[kishore7snehil]

@David-Gilman I would suggest to go with typeshed PR.Meanwhile I will look out for adding the script in CI. But I can't give any immediate timeline right now as the team is working on high priority tasks.