Generate Avro Schemas from a Python class
Project description
Dataclasses Avro Schema Generator
Generate Avro Schemas from a Python class
Requirements:
python 3.7+
Installation
pip install dataclasses-avroschema
Usage:
from dataclasses_avroschema.schema_generator import SchemaGenerator
class User:
"An User"
name: str
age: int
pets: typing.List[str]
accounts: typing.Dict[str, int]
favorite_colors: typing.Tuple[str] = ("BLUE", "YELLOW", "GREEN")
country: str = "Argentina"
address: str = None
SchemaGenerator(User).avro_schema()
'{
"type": "record",
"name": "User",
"doc": "An User",
"fields": [
{"name": "name", "type": "string"},
{"name": "age", "type": "int"},
{"name": "pets", "type": "array", "items": "string"},
{"name": "accounts", "type": "map", "values": "int"},
{"name": "favorite_colors", "type": "enum", "symbols": ["BLUE", "YELLOW", "GREEN"]},
{"name": "country", "type": ["string", "null"], "default": "Argentina"},
{"name": "address", "type": ["null", "string"], "default": "null"}
]
}'
TODO:
- Schema relations
- Recursive Schemas
- Support for Avro Logical Types
- Custom Exceptions?
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
Close
Hashes for dataclasses-avroschema-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 349f5adb4e5de103df794d99555dc5c34ad9391e6ff489698017b84b0d94611c |
|
MD5 | 08b54e002c0b01961f4563fd25a0525c |
|
BLAKE2b-256 | f38603d5834d78b32f69195c6659aaf6fc382047ab697e3916c22de0a554a4a3 |