Sphinx v8 compatibility: separate the names of two mutually-shadowing variables whose types have diverged #14
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.
The values of these
key
variables would have clobbered each other in the past; their value is not used in subsequent code, however, so this value-overwriting behaviour does not have any impact on runtime behaviour.Prior to Sphinx v8, both of them had type
str
, and somypy
did not detect a problem. With Sphinx v8 their types diverge as a result of sphinx-doc/sphinx#12575 - one of them remainsstr
and the other becomesstr | None
.By assigning each of them a distinct variable name, this changeset resolves
mypy
validation errors when the Sphinx v8.0.0 codebase is installed as a type-checking dependency (discovered during #13).cc @AA-Turner