API Reference¶

`dynapydantic` ¶

dynapydantic - dynamic tracking of pydantic models

`Polymorphic` ¶

Annotation used to mark a type as having duck-typing behavior

This annotation is only valid for SubclassTrackingModel's.

Similar to SerializeAsAny, a field annotated with this shall serialize as according to its actual type, not the field annotation type. In addition, parsing will function as if the field annotation type were the union of all tracked subclasses.

If a UnionRealization (or the string value of one) is passed as the second argument, it will override the default value for the union realization that is stored in the class.

Source code in src/dynapydantic/annotations.py

class Polymorphic:
    """Annotation used to mark a type as having duck-typing behavior

    This annotation is only valid for SubclassTrackingModel's.

    Similar to SerializeAsAny, a field annotated with this shall serialize as
    according to its actual type, not the field annotation type. In addition,
    parsing will function as if the field annotation type were the union of
    all tracked subclasses.

    If a UnionRealization (or the string value of one) is passed as the
    second argument, it will override the default value for the union
    realization that is stored in the class.
    """

    def __class_getitem__(
        cls,
        item: type[ModelT] | tuple[type[ModelT], UnionRealization | str],
    ) -> ty.Annotated[type[ModelT], ...]:
        """Get the annotation for the pydantic field"""
        if isinstance(item, tuple):
            if len(item) > 2:  # noqa: PLR2004
                msg = (
                    "dynapydantic.Polymorphic takes 1 or 2 arguments "
                    f"({len(item)} given)"
                )
                raise TypeError(msg)

            return _polymorphic_cgi(*item)
        return _polymorphic_cgi(item)

`__class_getitem__(item: type[ModelT] | tuple[type[ModelT], UnionRealization | str]) -> ty.Annotated[type[ModelT], ...]` ¶

Get the annotation for the pydantic field

Source code in src/dynapydantic/annotations.py

def __class_getitem__(
    cls,
    item: type[ModelT] | tuple[type[ModelT], UnionRealization | str],
) -> ty.Annotated[type[ModelT], ...]:
    """Get the annotation for the pydantic field"""
    if isinstance(item, tuple):
        if len(item) > 2:  # noqa: PLR2004
            msg = (
                "dynapydantic.Polymorphic takes 1 or 2 arguments "
                f"({len(item)} given)"
            )
            raise TypeError(msg)

        return _polymorphic_cgi(*item)
    return _polymorphic_cgi(item)

`Union` ¶

Annotation used to get the union out of a dynapydantic entity

This annotation is primarily used for using the union of all models in a TrackingGroup as a field annotation. It can be used with SubclassTrackingModel, but in general, Polymorphic is preferable.

Source code in src/dynapydantic/annotations.py

class Union:
    """Annotation used to get the union out of a dynapydantic entity

    This annotation is primarily used for using the union of all models in
    a `TrackingGroup` as a field annotation. It can be used with
    `SubclassTrackingModel`, but in general, `Polymorphic` is preferable.
    """

    @ty.overload
    def __class_getitem__(cls, item: type[ModelT]) -> type[ModelT]: ...

    @ty.overload
    def __class_getitem__(cls, item: TrackingGroup) -> ty.Any: ...  # noqa: ANN401

    def __class_getitem__(cls, item: TrackingGroup | type[ModelT]) -> object:
        """Return the union"""
        return union(item)

`__class_getitem__(item: TrackingGroup | type[ModelT]) -> object` ¶

__class_getitem__(item: type[ModelT]) -> type[ModelT]

__class_getitem__(item: TrackingGroup) -> ty.Any

Return the union

Source code in src/dynapydantic/annotations.py

def __class_getitem__(cls, item: TrackingGroup | type[ModelT]) -> object:
    """Return the union"""
    return union(item)