cj_attributes

Classes to read and process the attributes of all types of CityJSON objects in a standard way for all types and all branches of the pipeline.

Classes:

Name	Description
Attr	Base abstract class to store attributes.
AttrReader	Base abstract class to read attributes from CSV.
BdgAttr	Class to store the attributes of Building objects.
BdgAttrReader	Class to read attributes of Building objecys from CSV.
BdgPartAttr	Class to store the attributes of BuildingPart objects.
BdgPartAttrReader	Class to read attributes of BuildingPart objects from CSV.
BdgRoomAttr	Class to store the attributes of BuildingRoom objects.
BdgRoomAttrReader	Class to read attributes of BuildingRoom objects from CSV.
BdgStoreyAttr	Class to store the attributes of BuildingStorey objects.
BdgStoreyAttrReader	Class to read attributes of BuildingStorey objects from CSV.
BdgSubAttr	Class to store the attributes of building subdivisions.
BdgSubAttrReader	Class to read attributes of building subdivisions from CSV.
BdgUnitAttr	Class to store the attributes of BuildingUnit objects.
BdgUnitAttrReader	Class to read attributes of BuildingUnit objects from CSV.

Attr

Bases: abc.ABC

Base abstract class to store attributes.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class Attr(ABC):
    """
    Base abstract class to store attributes.
    """

    specific_columns: tuple[str, ...] = (KEY_COLUMN,)
    key_index: int | None = 0
    key_builder_index: int | None = None

    def __init__(
        self,
        attributes: dict[str, Any],
        cj_key: str,
        icon_position: IconPosition | list[float] | None,
    ) -> None:
        self.attributes = attributes
        self.cj_key = cj_key
        if isinstance(icon_position, IconPosition):
            self.icon_position = icon_position
        elif icon_position is None or len(icon_position) == 0:
            self.icon_position = None
        else:
            self.icon_position = IconPosition.from_list(icon_position)

AttrReader

Bases: typing.Generic[cj_helpers.cj_attributes.A], abc.ABC

Base abstract class to read attributes from CSV.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class AttrReader(Generic[A], ABC):
    """
    Base abstract class to read attributes from CSV.
    """

    attr_class: Type[A]

    def __init__(self, csv_path: Path) -> None:
        self.csv_path = csv_path
        self.specific_columns = self.attr_class.specific_columns
        self._key_to_attr: dict[str, A] = {}
        self._key_builder_counts = defaultdict(lambda: 0)
        self._read_attributes()
        self._organise_attributes()

    def _read_attributes(self) -> None:
        self.attributes_all, self.specific_values_all = csv_read_attributes(
            csv_path=self.csv_path, specific_columns=self.specific_columns
        )

    def _organise_attributes(self) -> None:
        if (
            self.attr_class.key_index is None
            and self.attr_class.key_builder_index is None
        ):
            raise RuntimeError(
                "Cannot have both `key_index` and `key_builder_index` be None."
            )

        for attributes, specific_values in zip(
            self.attributes_all, self.specific_values_all
        ):
            if self.attr_class.key_index is None:
                col_name, key_base_value = specific_values[
                    cast(int, self.attr_class.key_builder_index)
                ]
                cj_key = self._build_cj_key(col_name)
            else:
                _, cj_key = specific_values[self.attr_class.key_index]

            specific_values_map = {}
            for specific_col, col_name_value in zip(
                self.attr_class.specific_columns, specific_values
            ):
                name = COL_TO_NAME[specific_col]
                _, value = col_name_value
                specific_values_map[name] = value

            if self.attr_class.key_index is None:
                specific_values_map["cj_key"] = cj_key

            self._key_to_attr[cj_key] = self.attr_class(
                attributes=attributes, **specific_values_map
            )

    def _build_cj_key(self, col_name: str) -> str:
        count = self._key_builder_counts[col_name]
        cj_key = f"{col_name}@{count}"
        self._key_builder_counts[col_name] += 1
        return cj_key

    def get_key_to_attr(self):
        return deepcopy(self._key_to_attr)

    def get_attributes_by_cj_key(self, cj_key: str):
        try:
            return self._key_to_attr[cj_key]
        except KeyError as exc:
            raise ValueError(f"Object key '{cj_key}' does not exist.") from exc

    def __len__(self):
        return len(self._key_to_attr)

    def iterator(self):
        return iter(self._key_to_attr.items())

BdgAttr

Bases: cj_helpers.cj_attributes.Attr

Class to store the attributes of Building objects.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgAttr(Attr):
    """
    Class to store the attributes of Building objects.
    """

    specific_columns = (
        KEY_COLUMN,
        SPACE_ID_COLUMN,
        BAG_COLUMN,
        SKIP_COLUMN,
        ICON_POSITION_COLUMN,
    )
    key_index = 0
    key_builder_index = None

    def __init__(
        self,
        attributes: dict[str, Any],
        cj_key: str,
        space_id: str,
        icon_position: IconPosition | list[float] | None,
        bag_ids: list[str],
        skip: bool,
    ) -> None:
        super().__init__(
            attributes=attributes, cj_key=cj_key, icon_position=icon_position
        )
        self.bag_ids = bag_ids
        self.skip = skip
        self.space_id = space_id

BdgAttrReader

Bases: cj_helpers.cj_attributes.AttrReader[cj_helpers.cj_attributes.BdgAttr]

Class to read attributes of Building objecys from CSV.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgAttrReader(AttrReader[BdgAttr]):
    """
    Class to read attributes of Building objecys from CSV.
    """

    attr_class = BdgAttr

    def __init__(self, csv_path: Path) -> None:
        super().__init__(csv_path)

BdgPartAttr

Bases: cj_helpers.cj_attributes.Attr

Class to store the attributes of BuildingPart objects.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgPartAttr(Attr):
    """
    Class to store the attributes of BuildingPart objects.
    """

    specific_columns = (SPACE_ID_COLUMN,)
    key_index = 0
    key_builder_index = None

    def __init__(
        self,
        attributes: dict[str, Any],
        space_id: str,
    ) -> None:
        super().__init__(attributes=attributes, cj_key=space_id, icon_position=None)
        self.space_id = space_id

BdgPartAttrReader

Bases: cj_helpers.cj_attributes.AttrReader[cj_helpers.cj_attributes.BdgPartAttr]

Class to read attributes of BuildingPart objects from CSV.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgPartAttrReader(AttrReader[BdgPartAttr]):
    """
    Class to read attributes of BuildingPart objects from CSV.
    """

    attr_class = BdgPartAttr

    def __init__(self, csv_path: Path) -> None:
        super().__init__(csv_path)

BdgRoomAttr

Bases: cj_helpers.cj_attributes.Attr

Class to store the attributes of BuildingRoom objects.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgRoomAttr(Attr):
    """
    Class to store the attributes of BuildingRoom objects.
    """

    specific_columns = (SPACE_ID_COLUMN, ICON_POSITION_COLUMN, CODE_COLUMN)
    key_index = 0
    key_builder_index = None

    def __init__(
        self,
        attributes: dict[str, Any],
        space_id: str,
        icon_position: IconPosition | list[float] | None,
        code: str,
    ) -> None:
        super().__init__(
            attributes=attributes, cj_key=space_id, icon_position=icon_position
        )
        self.space_id = space_id
        self.code = code

BdgRoomAttrReader

Bases: cj_helpers.cj_attributes.AttrReader[cj_helpers.cj_attributes.BdgRoomAttr]

Class to read attributes of BuildingRoom objects from CSV.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgRoomAttrReader(AttrReader[BdgRoomAttr]):
    """
    Class to read attributes of BuildingRoom objects from CSV.
    """

    attr_class = BdgRoomAttr

    def __init__(self, csv_path: Path) -> None:
        super().__init__(csv_path)

BdgStoreyAttr

Bases: cj_helpers.cj_attributes.Attr

Class to store the attributes of BuildingStorey objects.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgStoreyAttr(Attr):
    """
    Class to store the attributes of BuildingStorey objects.
    """

    specific_columns = (SPACE_ID_COLUMN, STOREY_LEVEL_COLUMN, STOREY_SPACE_ID_COLUMN)
    key_index = 0
    key_builder_index = None

    def __init__(
        self,
        attributes: dict[str, Any],
        space_id: str,
        storey_level: float,
        storey_space_id: str,
    ) -> None:
        super().__init__(attributes=attributes, cj_key=space_id, icon_position=None)
        self.space_id = space_id
        self.storey_level = storey_level
        self.storey_space_id = storey_space_id

BdgStoreyAttrReader

Bases: cj_helpers.cj_attributes.AttrReader[cj_helpers.cj_attributes.BdgStoreyAttr]

Class to read attributes of BuildingStorey objects from CSV.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgStoreyAttrReader(AttrReader[BdgStoreyAttr]):
    """
    Class to read attributes of BuildingStorey objects from CSV.
    """

    attr_class = BdgStoreyAttr

    def __init__(self, csv_path: Path) -> None:
        super().__init__(csv_path)

BdgSubAttr

Bases: cj_helpers.cj_attributes.Attr

Class to store the attributes of building subdivisions.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgSubAttr(Attr):
    """
    Class to store the attributes of building subdivisions.
    """

    specific_columns = (
        KEY_COLUMN,
        SPACE_ID_COLUMN,
        PARENT_KEY_COLUMN,
        SKIP_COLUMN,
        ICON_POSITION_COLUMN,
    )
    key_index = 0
    key_builder_index = None

    def __init__(
        self,
        attributes: dict[str, Any],
        cj_key: str,
        space_id: str,
        icon_position: IconPosition | list[float] | None,
        parent_cj_key: str,
        skip: bool,
    ) -> None:
        super().__init__(
            attributes=attributes, cj_key=cj_key, icon_position=icon_position
        )
        self.parent_cj_key = parent_cj_key
        self.skip = skip
        self.space_id = space_id

BdgSubAttrReader

Bases: cj_helpers.cj_attributes.AttrReader[cj_helpers.cj_attributes.BdgSubAttr]

Class to read attributes of building subdivisions from CSV.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgSubAttrReader(AttrReader[BdgSubAttr]):
    """
    Class to read attributes of building subdivisions from CSV.
    """

    attr_class = BdgSubAttr

    def __init__(self, csv_path: Path) -> None:
        super().__init__(csv_path)

BdgUnitAttr

Bases: cj_helpers.cj_attributes.Attr

Class to store the attributes of BuildingUnit objects.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgUnitAttr(Attr):
    """
    Class to store the attributes of BuildingUnit objects.
    """

    specific_columns = (
        ICON_POSITION_COLUMN,
        CODE_COLUMN,
        UNIT_GLTF_COLUMN,
        UNIT_SPACES_COLUMN,
        UNIT_STOREYS_COLUMN,
    )
    key_index = None
    key_builder_index = 0

    def __init__(
        self,
        attributes: dict[str, Any],
        cj_key: str,
        icon_position: IconPosition | list[float] | None,
        code: str,
        unit_gltf: str,
        unit_spaces: list[str],
        unit_storeys: list[str],
    ) -> None:
        super().__init__(
            attributes=attributes, cj_key=cj_key, icon_position=icon_position
        )
        self.code = code
        self.unit_gltf = None if unit_gltf == "" else unit_gltf
        self.unit_spaces = unit_spaces
        self.unit_storeys = unit_storeys

        if len(self.unit_storeys) == 0:
            unit_storeys_set: set[str] = set()
            for space in self.unit_spaces:
                space_split = space.split(".")
                if len(space.split(".")) < 3:
                    continue
                storey = ".".join(space_split[:3])
                unit_storeys_set.add(storey)
            self.unit_storeys = list(unit_storeys_set)

BdgUnitAttrReader

Bases: cj_helpers.cj_attributes.AttrReader[cj_helpers.cj_attributes.BdgUnitAttr]

Class to read attributes of BuildingUnit objects from CSV.

Source code in python/src/data_pipeline/cj_helpers/cj_attributes.py

class BdgUnitAttrReader(AttrReader[BdgUnitAttr]):
    """
    Class to read attributes of BuildingUnit objects from CSV.
    """

    attr_class = BdgUnitAttr

    def __init__(self, csv_path: Path) -> None:
        super().__init__(csv_path)