colander_data_converter.base.types.base

class colander_data_converter.base.types.base.CommonEntityType

Bases: BaseModel, ABC

CommonEntityType is an abstract base class for defining shared attributes across various entity data types.

This class provides fields for identifiers, names, descriptions, and other metadata.

Fields:

• default_attributes (Dict[str, str] | None)

• description (str | None)

• name (str)

• short_name (str)

• svg_icon (str | None)

• type_hints (Dict[Any, Any] | None)

field short_name: str [Required]

A short name for the model type.

Constraints:

• max_length = 32

field name: str [Required]

The name of the model type.

Constraints:

• max_length = 512

field description: str | None = None

An optional description of the model type.

field svg_icon: str | None = None

Optional SVG icon for the model type.

field default_attributes: Dict[str, str] | None = None

Optional dictionary of default attributes.

field type_hints: Dict[Any, Any] | None = None

Optional dictionary of type hints.

colander_data_converter.base.types.base.load_entity_supported_types(name)

Return type:

List[Dict]