Source code for dedoc.data_structures.line_metadata

from typing import Dict, Optional, Union

from dedoc.api.schema.line_metadata import LineMetadata as ApiLineMetadata
from dedoc.data_structures.hierarchy_level import HierarchyLevel
from dedoc.data_structures.serializable import Serializable


class LineMetadata(Serializable):
    """
    This class holds information about document node (and document line) metadata, such as page number or line level in a document hierarchy.

    :ivar tag_hierarchy_level: the hierarchy level of the line with its type directly extracted by some of the readers
        (usually information got from tags e.g. in docx or html readers)
    :ivar hierarchy_level: the hierarchy level of the line extracted by some of the structure extractors - the result type and level of the line.
        The lower the level of the hierarchy, the closer it is to the root, it's used to construct document tree.
    :ivar page_id: page number where paragraph starts, the numeration starts from page 0
    :ivar line_id: line number inside the entire document, the numeration starts from line 0

    :vartype tag_hierarchy_level: HierarchyLevel
    :vartype hierarchy_level: Optional[HierarchyLevel]
    :vartype page_id: int
    :vartype line_id: Optional[int]

    Additional variables may be added with other line metadata.
    """

    def __init__(self,
                 page_id: int,
                 line_id: Optional[int],
                 tag_hierarchy_level: Optional[HierarchyLevel] = None,
                 hierarchy_level: Optional[HierarchyLevel] = None,
                 **kwargs: Dict[str, Union[str, int, float]]) -> None:
        """
        :param page_id: page number where paragraph starts, the numeration starts from page 0
        :param line_id: line number inside the entire document, the numeration starts from line 0
        :param tag_hierarchy_level: the hierarchy level of the line with its type directly extracted by some of the readers
        :param hierarchy_level: the hierarchy level of the line extracted by some of the structure extractors - the result type and level of the line.
        """
        self.tag_hierarchy_level: HierarchyLevel = HierarchyLevel.create_unknown() if tag_hierarchy_level is None else tag_hierarchy_level
        self.hierarchy_level: Optional[HierarchyLevel] = hierarchy_level
        self.page_id: int = page_id
        self.line_id: Optional[int] = line_id
        for key, value in kwargs.items():
            setattr(self, key, value)

    def to_api_schema(self) -> ApiLineMetadata:
        paragraph_type = self.hierarchy_level.line_type if self.hierarchy_level is not None else HierarchyLevel.raw_text
        api_line_metadata = ApiLineMetadata(page_id=self.page_id, line_id=self.line_id, paragraph_type=paragraph_type)
        for key, value in vars(self).items():
            if not hasattr(api_line_metadata, key) and key not in ("tag_hierarchy_level", "hierarchy_level"):
                setattr(api_line_metadata, key, value)
        return api_line_metadata