colander_data_converter.base.types.base

class colander_data_converter.base.types.base.CommonEntityType[source]

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.

Config:

  • str_strip_whitespace: bool = True

  • arbitrary_types_allowed: bool = True

  • from_attributes: bool = True

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 icon: str | None = None

Optional icon name for the model type (e.g., mdi:home).

field nf_icon: str | None = None

Optional NerdFont icon name for the model type.

field value_example: str | None = None

Optional example value for the model type.

field regex: str | None = None

Optional regex used to suggest a type based on the entity name.

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)[source]
Return type:

List[Dict]