typed_serialisable.FieldInfo

Usage

Source

typed_serialisable.FieldInfo(
    name,
    kind,
    expected_type=object,
    allow_none=False,
    default=None,
    xml_name=None,
    namespace=None,
    hyphenated=False,
    count=False,
    container_factory=list,
    validator=None,
    converter=None,
    parser=None,
    renderer=None,
    alias_target=None,
    parts=None,
    sequence_item_is_model=False,
    value_attribute="val",
    sequence_primitive_attribute=None,
    serialize=True
)

Parameter Attributes

name: str

kind: FieldKind

expected_type: Any = object


allow_none: bool = False

default: Any = None

xml_name: str | None = None

namespace: str | None = None

hyphenated: bool = False

count: bool = False

container_factory: Callable[…, Any] | type | None = list


validator: Callable[[Any], None] | None = None

converter: Callable[[Any], Any] | None = None

parser: Callable[[Any], Any] | None = None

renderer: Callable[[str, Any, str | None], Any] | None = None

alias_target: str | None = None

parts: dict[str, Any] | None = None

sequence_item_is_model: bool = False

value_attribute: str = "val"

sequence_primitive_attribute: str | None = None

serialize: bool = True