Use TypeGuard in sphinx.util.inspect
#12283
Merged
Conversation
This file contains 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
picnixz
changed the title
sphinx.util.inspectsphinx.util.inspect [part 2d]
AA-Turner
force-pushed
the
cleanup/util-2d-type-guards
branch
from
ab3b8fb
to
120dbb7
Compare
AA-Turner
changed the title
sphinx.util.inspect [part 2d]TypeGuard for the sphinx.util.inspect functions
AA-Turner
changed the title
TypeGuard for the sphinx.util.inspect functionsTypeGuard in sphinx.util.inspect
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This adds better type annotations (namely type guards) for the inspect module. This helps in removing some
# type: ignorein other modules. In addition, I forced (in this PR and not the previous one) some literal values for the rendering modes.The main issue with
restifyandstringify_annotationis that those functions are really big and they were probably incremented along the years. However, with all thosetype: ignore, some assumptions were not explicitly stated and this is quite bothersome when you want to debug.