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

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!

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

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.

@kishore7snehil Thoughts?

@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.

As the stubs are written here. You'd be loosing visibility on all the non-async methods and attributes. And declare the non-async versions of the classes as having _async methods.

Python's static typing system isn't powerful enough to generate attribute out of other attributes, or to extract type from signatures (unlike TypeSrcipt). You can't use base classes as generics either, that would make it so much easier.

Here's one way you could solve this (without changing anything at runtime):
Generate stubs for all classes you expect to "Asyncify" as was talked here. But with the following differences:

• Generate it in a subfolder that doesn't exist at runtime (ie: auth0._asyncified.*)
• Rename all the generated classes to help differentiate them (something like class UsersWrapped(Users): for base class Users)
• Decorate all generated classes with @typing.type_check_only
• Generate a massive overload for auth0.asyncify.asyncify that maps original classes to stub-only asyncified/wrapped classes.
• Optional: Generate said stubs on install/editable install/wheel creation. That way they don't pollute the source and history.

2nd option: writing a mypy plugin. But obviously that only works for mypy, and not other checkers.

Like this: https://github.com/Avasam/typeshed/pull/43/files#diff-2e519b89160890743c6aaa1d6e57c21160a2db3148ce891a8e5aa250b6bc9b62