Class tigrbl.column.field_spec.FieldSpec

tigrbl.column.field_spec.FieldSpec dataclass

FieldSpec(
    py_type=Any,
    constraints=dict(),
    required_in=(),
    allow_null_in=(),
)

Describe Python-side metadata for a column or virtual field.

py_type denotes the expected Python type and may be omitted when the model attribute is annotated; the type will then be inferred. constraints mirrors arguments accepted by :func:pydantic.Field and participates in schema generation. required_in and allow_null_in govern which API verbs must supply the value or may explicitly send null in requests. Responses rely on Pydantic's built-in encoders based solely on the declared type.

py_type class-attribute instance-attribute

py_type = Any

constraints class-attribute instance-attribute

constraints = field(default_factory=dict)

required_in class-attribute instance-attribute

required_in = ()

allow_null_in class-attribute instance-attribute

allow_null_in = ()