asdf_pydantic

asdf_pydantic#

Subpackages#

Submodules#

Classes#

AsdfPydanticConverter

Implements a converter compatible with all subclass of AsdfPydanticModel.

AsdfPydanticModel

ASDF Serialization and Deserialization:

Package Contents#

class asdf_pydantic.AsdfPydanticConverter#

Bases: asdf.extension.Converter

Implements a converter compatible with all subclass of AsdfPydanticModel.

The instance is a singleton.

_tag_to_class: dict[str, Type[asdf_pydantic.model.AsdfPydanticModel]]#
self#
classmethod add_models(*model_classes: Type[asdf_pydantic.model.AsdfPydanticModel]) → AsdfPydanticConverter#
property tags: tuple[str]#
property types: tuple[str | Type]#
select_tag(obj, tags, ctx)#
to_yaml_tree(obj: asdf_pydantic.model.AsdfPydanticModel, tag, ctx)#
from_yaml_tree(node, tag, ctx)#
class asdf_pydantic.AsdfPydanticModel#

Bases: pydantic.BaseModel

ASDF Serialization and Deserialization:

Serialize to ASDF yaml tree is done with the py:classmethod`AsdfPydanticModel.asdf_yaml_tree()` and deserialize to an AsdfPydanticModel object with py:meth`AsdfPydanticModel.parse_obj()`.

_tag: ClassVar[str | asdf.extension.TagDefinition]#
model_config#
asdf_yaml_tree() → dict#
classmethod get_tag_definition()#
classmethod get_tag_uri()#
classmethod model_asdf_schema(by_alias: bool = True, ref_template: str = DEFAULT_ASDF_SCHEMA_REF_TEMPLATE, schema_generator: type[asdf_pydantic.schema.GenerateAsdfSchema] = GenerateAsdfSchema)#

Get the ASDF schema definition for this model.

classmethod schema_asdf(*, metaschema: str = GenerateAsdfSchema.schema_dialect, **kwargs) → str#

Get the ASDF schema definition for this model.

Parameters#

metaschema, optional

A metaschema URI

Contents