asdf_pydantic.converter

Attributes

_ASDF_PYDANTIC_SINGLETON_CONVERTER

Classes

AsdfPydanticModel	ASDF Serialization and Deserialization:
AsdfPydanticConverter	Implements a converter compatible with all subclass of AsdfPydanticModel.

Module Contents

class asdf_pydantic.converter.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]

class Config

arbitrary_types_allowed = True

asdf_yaml_tree() → dict

classmethod schema_asdf(*, metaschema: str = 'http://stsci.edu/schemas/asdf/asdf-schema-1.0.0') → str

Get the ASDF schema definition for this model.

Parameters

metaschema, optional

A metaschema URI, by default “http://stsci.edu/schemas/asdf/asdf-schema-1.0.0”. See https://asdf.readthedocs.io/en/stable/asdf/extending/schemas.html#anatomy-of-a-schema for more options.

asdf_pydantic.converter._ASDF_PYDANTIC_SINGLETON_CONVERTER: AsdfPydanticConverter | None = None

class asdf_pydantic.converter.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]]

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)