You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
I have read this thread around "Define a JSON type" python/typing#182 and I think that now that mypy supports recursive type, it might make sense to introduce this type to the Home Assistant code base.
Note: it might not fit every situation.
It might force the user to add instance checks assert isinstance(json_data["value"], dict) before calling json_data["value"]["sub_value"]
If it returns JSONType then the first thing any code needs to do is to run an isinstance check for the returned value, as due to being a union, most operations won't be valid on it. However, in some cases it's arguably okay to assume that the returned value is a dict, for example. If this an internal data file, we can be reasonably sure that the format is what we expect. I didn't think about object_hook but that might be another thing to consider.
If a user wants to do the type check they can add an annotation if the return type is Any:
data = json.load(...) # type: JSONType
if isinstance(data, dict):
...
This, for example, would be rejected if the return type is a union, but would be fine if the return type is Any:
data = json.load(...) # type: Dict[str, Any] # error if load() return type is union
...
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.
Proposed change
I have read this thread around "Define a JSON type" python/typing#182 and I think that now that mypy supports recursive type, it might make sense to introduce this type to the Home Assistant code base.
Linked to #85603
Type of change
Additional information
Checklist
black --fast homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all..coveragerc.To help with the load of incoming pull requests: