Add support for TypedDict #128
Draft
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
`TypedDicts` are used only within the type system for analysis and represent the keys of a dictionary and their corresponding types. They are a useful tool when providing type hints of a JSON payload or similar. For example the following code snippet will raise a false-positive alert from this flake8 plug-in: ```python class ApiPage(TypedDict): url: str next: str data: list[dict[str, Any]] ``` This is because a `TypedDict` is analysed as if it was a standard class. Since it is only used in the type system it is safe to ignore anything that inherits from `TypedDict` in this plugin.
gforcada
reviewed
Jun 9, 2024
There was a problem hiding this comment.
Nice work! 🌟
Maybe it's too late and I'm a bit tired, but I fail to see what's the problem with the N-deep examples, but as they are guarded with an xfail that would not be too much of a problem 👍🏾
As the PR is a draft I'm not approving.
Ping me whenever the PR is ready... what's missing ? 🤔
Again, thanks for the work!! 🙇🏾
| @@ -140,7 +140,9 @@ def run(self): | |||
|
|
|||
| def check_assignment(self, statement): | |||
| msg = self.assign_msg | |||
| if type(statement.__flake8_builtins_parent) is ast.ClassDef: | |||
| if isinstance(statement.__flake8_builtins_parent, ast.ClassDef): | |||
| if "TypedDict" in {a.id for a in statement.__flake8_builtins_parent.bases if isinstance(a, ast.Name)}: | |||
There was a problem hiding this comment.
@danjones1618 do we expect other typing classes to be used eventually here? 🤔
Given how long this conditional is, it might be worth refactoring into a function?
def base_classes_ids(self, statement):
return {a.id for a in statement.__flake8_builtins_parent.bases if isinstance(a, ast.Name)}
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.
TypedDictsare used only within the type system for analysis andrepresent the keys of a dictionary and their corresponding types.
They are a useful tool when providing type hints of a JSON payload or
similar.
For example the following code snippet will raise a false-positive alert
from this flake8 plug-in:
This is because a
TypedDictis analysed as if it was a standard class.Since it is only used in the type system it is safe to ignore anything
that inherits from
TypedDictin this plugin.Currently, this PR has the limitation that it does not handle inheritances.
There is also a foreseen issue where false positives will still occur if
the shadowing variable is in a class that inherits from a
TypedDictdefinedin another class.