buffalo_panel.config.SchemaFieldTree

class buffalo_panel.config.SchemaFieldTree(name, type_name, optional, docstring, metadata, object_schema=None, item_type_name=None, item_schema=None)[source]

Tree node describing one schema field.

Attributes

name

Field name on the parent dataclass.

type_name

Display-friendly type name for the field.

optional

Whether the field accepts None.

docstring

Short field documentation text, when available.

metadata

Structured machine-readable field metadata.

object_schema

Nested dataclass schema when the field value is a dataclass object.

item_type_name

Display-friendly item type name for list, tuple, or mapping values.

item_schema

Nested dataclass schema for list, tuple, or mapping items when known.

name: str

Field name on the parent dataclass.

type_name: str

Display-friendly type name for the field.

optional: bool

Whether the field accepts None.

docstring: str | None

Short field documentation text, when available.

metadata: SchemaFieldMetadata

Structured machine-readable field metadata.

object_schema: SchemaClassTree | None

Nested dataclass schema when the field value is a dataclass object.

item_type_name: str | None

Display-friendly item type name for list, tuple, or mapping values.

item_schema: SchemaClassTree | None

Nested dataclass schema for list, tuple, or mapping items when known.