Create ASDF tags with pydantic models
Project description
asdf-pydantic
Create ASDF tags with pydantic models.
from asdf_pydantic import AsdfPydanticModel
class Rectangle(AsdfPydanticModel):
_tag = "asdf://asdf-pydantic/examples/tags/rectangle-1.0.0"
width: float
height: float
# After creating extension and install ...
af = asdf.AsdfFile()
af["rect"] = Rectangle(width=1, height=1)
#ASDF 1.0.0
#ASDF_STANDARD 1.5.0
%YAML 1.1
%TAG ! tag:stsci.edu:asdf/
--- !core/asdf-1.1.0
asdf_library: !core/software-1.0.0 {
author: The ASDF Developers,
homepage: 'http://github.com/asdf-format/asdf',
name: asdf,
version: 2.14.3}
history:
extensions:
- !core/extension_metadata-1.0.0
extension_class: asdf.extension.BuiltinExtension
software: !core/software-1.0.0 {
name: asdf,
version: 2.14.3}
- !core/extension_metadata-1.0.0 {
extension_class: mypackage.shapes.ShapesExtension,
extension_uri: 'asdf://asdf-pydantic/shapes/extensions/shapes-1.0.0'}
rect: !<asdf://asdf-pydantic/shapes/tags/rectangle-1.0.0> {
height: 1.0,
width: 1.0}
...
Features
- Create ASDF tag from your pydantic models with batteries (converters) included.
- Validates data models as you create them and not only when reading and writing ASDF files.
- Preserve Python types when deserializing ASDF files.
- All the cool things that comes with pydantic (e.g., JSON encoder, JSON schema, Pydantic types)
- Comes with schemas.
Installation
pip install asdf-pydantic
Usage
Define your data model
# mypackage/shapes.py
from asdf_pydantic import AsdfPydanticModel
class Rectangle(AsdfPydanticModel):
_tag = "asdf://asdf-pydantic/examples/tags/rectangle-1.0.0"
width: float
height: float
Then create an extension with the converter included with asdf-pydantic:
# mypackage/extensions.py
from asdf.extension import Extension
from asdf_pydantic.converter import AsdfPydanticConverter
from mypackage.shapes import Rectangle
AsdfPydanticConverter.add_models(Rectangle)
class ShapesExtension(Extension):
extension_uri = "asdf://asdf-pydantic/examples/extensions/shapes-1.0.0"
converters = [AsdfPydanticConverter()]
tags = [*AsdfPydanticConverter().tags]
Install the extension either by entry point specification or add it to
asdf.get_config()
:
import asdf
from mypackage.extensions import ShapeExtension
asdf.get_config().add_extension(ShapesExtension())
af = asdf.AsdfFile()
af["rect"] = Rectangle(width=1, height=1)
with open("shapes.asdf", "wb") as fp:
af.write_to(fp)
:maxdepth: 1
autoapi
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
asdf_pydantic-1.0.3.tar.gz
(13.4 kB
view hashes)
Built Distribution
Close
Hashes for asdf_pydantic-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db781e46bf9f24f772bfc48c8f0be87de0f88b20d24b328a3d53e534970ec5e5 |
|
MD5 | 8b9abff974b1860b8fd2d04d6575b4a6 |
|
BLAKE2b-256 | e1704dc7f343d454e8a71cb7f921bc424041b1de1ae55655be838a5065cda110 |