New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Typecheck Json inner type #4332
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
addeda0
Add .venv/ to .gitignore
Bobronium fd298f3
Allow typecheckers to infer Json inner type
Bobronium d1421f5
Fix and improve mypy tests
Bobronium 45df1e3
Add type tests
Bobronium 20bd004
Add Json[Any] case to schema test
Bobronium bec6ebf
Update example in docs
Bobronium 4da7966
Add changes file
Bobronium 5f226d2
Use <3.9 compatible annotations for tests
Bobronium File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
.idea/ | ||
env/ | ||
venv/ | ||
.venv/ | ||
env3*/ | ||
Pipfile | ||
*.lock | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Allow type checkers to infer inner type of `Json` type. `Json[list[str]]` will be now inferred as `list[str]`. | ||
`Json[Any]` should be used instead of plain `Json`. | ||
Runtime behaviour is not changed. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,29 @@ | ||
from typing import List | ||
from typing import Any, List | ||
|
||
from pydantic import BaseModel, Json, ValidationError | ||
|
||
|
||
class SimpleJsonModel(BaseModel): | ||
json_obj: Json | ||
class AnyJsonModel(BaseModel): | ||
json_obj: Json[Any] | ||
|
||
|
||
class ComplexJsonModel(BaseModel): | ||
class ConstrainedJsonModel(BaseModel): | ||
json_obj: Json[List[int]] | ||
|
||
|
||
print(SimpleJsonModel(json_obj='{"b": 1}')) | ||
print(ComplexJsonModel(json_obj='[1, 2, 3]')) | ||
print(AnyJsonModel(json_obj='{"b": 1}')) | ||
print(ConstrainedJsonModel(json_obj='[1, 2, 3]')) | ||
try: | ||
ComplexJsonModel(json_obj=12) | ||
ConstrainedJsonModel(json_obj=12) | ||
except ValidationError as e: | ||
print(e) | ||
|
||
try: | ||
ComplexJsonModel(json_obj='[a, b]') | ||
ConstrainedJsonModel(json_obj='[a, b]') | ||
except ValidationError as e: | ||
print(e) | ||
|
||
try: | ||
ComplexJsonModel(json_obj='["a", "b"]') | ||
ConstrainedJsonModel(json_obj='["a", "b"]') | ||
except ValidationError as e: | ||
print(e) |
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
20: error: Unsupported operand types for + ("int" and "str") [operator] | ||
22: error: Unsupported operand types for + ("int" and "str") [operator] | ||
23: error: Unsupported operand types for + ("int" and "str") [operator] |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Humm, problem is this makes the output type compatibility better, but makes the input type compatibility worse.
Hence the "type ignore" here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, indeed. I thought that it's alright since it's kind of consistent throughout pydantic: you can even see same
type: ignore
's above for other types.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, agreed, also presumably it allows
bytes
.Hence why I said this is better than the status quo on balance.