BuildingsInfographicModel

database_builder.BuildingsInfographicModel()

Model for building infographic configuration.

Attributes

types : list[str]

List of building types.

icons : list[str]

List of icon names corresponding to each building type.

type_mapping : dict[str, TypeMapping]

Mapping of building types to their database filtering criteria.

impact_categories : ImpactCategoriesModel

Impact categories configuration.

Methods

Name Description
get_template Get a pre-configured template for building infographics.
validate_icons_length Validate that icons list length matches types list length.

get_template

database_builder.BuildingsInfographicModel.get_template(
    type: Literal['OSM', 'NSI'],
)

Get a pre-configured template for building infographics.

Parameters

type : Literal['OSM', 'NSI']

The database type to create a template for.

Returns

: BuildingsInfographicModel

Pre-configured building infographic model.

validate_icons_length

database_builder.BuildingsInfographicModel.validate_icons_length(icons, info)

Validate that icons list length matches types list length.

Parameters

icons : list[str]

List of icon names.

info : Any

Field validation info containing all field values.

Returns

: list[str]

The validated icons list.

Raises

: ValueError

If icons length doesn’t match types length.

Back to top