-
Notifications
You must be signed in to change notification settings - Fork 637
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
Update __all__
to statically define reexports
#3143
Conversation
This prevents errors from typecheckers since they can now see that members are explicitly reexported
With the merge of open-telemetry/opentelemetry-python#3143 this work around is no longer required and can be removed from the docs.
This should be ready for review. I however noticed that the docs build fails.
This seems to be that Sphinx cannot find the reference for the Logger class in return types. Not sure why this is happening |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR!
Does the docs pass if you move the |
I will give it a try. I did try on a different branch to upgrade to newest Sphinx and replace autodoc_typehints with the build in sphinx feature. That seems to resolve this issue but triggers others |
Add an entry to the |
With the merge of open-telemetry/opentelemetry-python#3143 this work around is no longer required and can be removed from the docs.
Description
Update all
__all__
declarations to statically define all members. This resolves error messages from IDE/static type checkersFixes #3141
Type of change
How Has This Been Tested?
Ran tox locally.
No new functionality
This enables static checkers such as pylint to now verify that imported objects are being used
so removed a bunch of now redundant supress comments
Does This PR Require a Contrib Repo Change?
Checklist: