Source code for dedoc.data_structures.table_metadata

from collections import OrderedDict
from typing import List, Optional

from flask_restx import Api, Model, fields

from dedoc.data_structures.cell_property import CellProperty
from dedoc.data_structures.serializable import Serializable


class TableMetadata(Serializable):
    """
    This class holds the information about the table location in the document and information about cell properties.
    """
    def __init__(self, page_id: Optional[int], uid: str = "", is_inserted: bool = False,
                 cell_properties: Optional[List[List[CellProperty]]] = None) -> None:
        """
        :param page_id: number of the page where table starts
        :param uid: unique identifier of the table
        :param is_inserted: indicator if table was already inserted into paragraphs list
        :param cell_properties: information about rowspan, colspan and invisibility of each cell
        """
        self.page_id = page_id
        self.uid = uid
        self.is_inserted = is_inserted
        self.cell_properties = cell_properties

    def to_dict(self) -> dict:
        res = OrderedDict()
        res["uid"] = self.uid
        res["page_id"] = self.page_id
        res["is_inserted"] = self.is_inserted
        res["cell_properties"] = [[cell_prop.to_dict() for cell_prop in row_prop] for row_prop in self.cell_properties] if self.cell_properties else None
        return res

    @staticmethod
    def get_api_dict(api: Api) -> Model:
        return api.model("TableMetadata", {
            "page_id": fields.Integer(readonly=False, description="table start page number"),
            "uid": fields.String(description="table unique id"),
            "is_inserted": fields.Boolean(description="was the table inserted into document body"),
            "cell_properties": fields.List(fields.List(fields.Nested(CellProperty.get_api_dict(api),
                                                                     description="cell properties, colspan, rowspan, etc",
                                                                     allow_null=True,
                                                                     skip_none=True)))
        })