feat: Add support for Literal types. #534
Open
Conversation
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
arunchaganty
force-pushed
the
arun-support-literals
branch
2 times, most recently
from
b128a02 to
fffd722
Compare
This commit extends support of dataclasses_json to dataclasses with fields annotated with Literal types. Literal types allow users to specify a list of valid values, e.g., ```python @DataClass class DataClassWithLiteral(DataClassJsonMixin): languages: Literal["C", "C++", "Java"] ``` When de-serializing data, this commit now validates that the JSON's values are one of those specified in the Literal type. Change in behavior: Using literal types would previously give users the following warning: ``` dataclasses_json/mm.py:357: UserWarning: Unknown type C at Foo.langs: typing.Literal['C', 'C++', 'Java']. It's advised to pass the correct marshmallow type to `mm_field`. ```
arunchaganty
force-pushed
the
arun-support-literals
branch
from
fffd722 to
41e3c26
Compare
|
Just ran into this issue and saw that it had an open PR. Awesome, thank you! Excited to see it merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This commit extends support of dataclasses_json to dataclasses with fields annotated with Literal types. Literal types allow users to specify a list of valid values, e.g.,
When de-serializing data, this commit now validates that the JSON's values are one of those specified in the Literal type.
Change in behavior:
Using literal types would previously give users the following warning:
Note: this is my first PR to the dataclasses_json library, so I'm not 100% sure what the conventions are. Happy to make any changes requested!