Typed JSON dataclasses
Project description
JSON Dataclasses
Typed JSON dataclasses for Python 3.9+
Installation
pip install jsondataclasses
Usage
from datetime import date
from typing import Literal, Optional
from jsondataclasses import jsondataclass, jsonfield
def parse_date(date_string: str) -> date:
return date.fromisoformat(date_string.replace(".", "-"))
@jsondataclass
class Car:
make: Literal["Ford", "Renault", "Volkswagen"] = jsonfield("carMake")
model: str = jsonfield("model")
manufactured_at: date = jsonfield("dateOfManufacture", parse_date)
num_of_wheels: Optional[int] = jsonfield("numberOfWheels", default_value=4)
car = Car({
"carMake": "Ford",
"model": "Focus",
"dateOfManufacture": "2018.03.14"
})
print(car) # Car(make='Ford', model='Focus', manufactured_at=datetime.date(2018, 3, 14), num_of_wheels=4)
Class field types can be any primitive type (eg. str
, int
, datetime
),
a variadic generic (eg. list[str]
, Optional[int]
, Literal["hello", "world"]
),
or even another jsondataclass. The default_value
argument of jsonfield
will be used
if the specified key is not found in the dictionary and the type of the class field is not Optional[...]
.
In this case, the value of default_value
will be passed to the supplied parser function.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
jsondataclasses-0.0.6.tar.gz
(4.0 kB
view hashes)
Built Distribution
Close
Hashes for jsondataclasses-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe13fc53fc50997f1cd599bc2466f46c8fd433b26e4fec08f85e7f6a958d718c |
|
MD5 | 1411dd68eaedc76d54b8b21f0c3bff1e |
|
BLAKE2b-256 | ea761d52efd934c2b2f499fad2168264df79ac31ca13d890ca44f8b8380b46a6 |