Explicitly export cron symbols for typecheckers #3072
Merged
Conversation
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
antonpirker
added
Component: DX
|
Hey @spladug, thanks for this PR! I'd prefer we go with |
|
Sure thing! |
spladug
force-pushed
the
reexport-cron-symbols
branch
from
e4706c5 to
88d4259
Compare
|
Rebased and updated to use |
sentrivana
approved these changes
Jun 12, 2024
|
Thanks @spladug, merged. :) |
arjennienhuis
pushed a commit
to arjennienhuis/sentry-python
that referenced
this pull request
Sep 30, 2024
Mypy with no_implicit_reexport = true does not see the symbols in sentry_sdk.crons as exported: my_file.py:10: error: Module "sentry_sdk.crons" does not explicitly export attribute "monitor" [attr-defined] Adding the symbols to __all__ marks them as exported and silences the error.
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.
Mypy with
no_implicit_reexport = truedoes not see the symbols insentry_sdk.cronsas exported.Adding the
X as Xto the imports marks the symbol as exported and silences the error.An alternative approach would be to list the symbols in
__all__. I'm happy to rework this if you'd prefer that.https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-no-implicit-reexport
I've not audited other parts of the library for this; this just fixes the one module that I'm hitting issues with.