Update __all__ to statically define reexports#3143
Merged
ocelotl merged 10 commits intoopen-telemetry:mainfrom Feb 15, 2023
Merged
Update __all__ to statically define reexports#3143ocelotl merged 10 commits intoopen-telemetry:mainfrom
__all__ to statically define reexports#3143ocelotl merged 10 commits intoopen-telemetry:mainfrom
Conversation
This prevents errors from typecheckers since they can now see that members are explicitly reexported
jenshnielsen
added a commit
to jenshnielsen/opentelemetry.io
that referenced
this pull request
Feb 1, 2023
With the merge of open-telemetry/opentelemetry-python#3143 this work around is no longer required and can be removed from the docs.
Contributor
Author
|
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 |
Member
|
Does the docs pass if you move the |
Contributor
Author
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 |
Member
|
Add an entry to the |
srikanthccv
approved these changes
Feb 13, 2023
jenshnielsen
added a commit
to jenshnielsen/opentelemetry.io
that referenced
this pull request
Feb 24, 2023
With the merge of open-telemetry/opentelemetry-python#3143 this work around is no longer required and can be removed from the docs.
10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: