[ruff
] Fix invalid annotation in docs example
#16016
Merged
+37
−21
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.
Summary
Unfortunately the edits made by #15982 mean that the annotations in the second "Use instead" example are now incorrect, and would be rejected by a type checker. This is because
instance_dict
is declared as aClassVar
variable in the class body, which declares to the type checker that it is illegal to set the attribute on instances of the class (it can only be set on the class object itself). The attribute is then assigned toself
in the__init__
instance method, violating the annotation in the class body.This PR fixes the incorrect annotation and adds a couple more examples.
Test Plan
N/A