Source code for dedoc.data_structures.concrete_annotations.spacing_annotation

from dedoc.data_structures.annotation import Annotation


class SpacingAnnotation(Annotation):
    """
    This annotation contains spacing between the current line and the previous one.
    It's measured in twentieths of a point or one hundredths of a line according to the standard Office Open XML File Formats.
    """
    name = "spacing"

    def __init__(self, start: int, end: int, value: str) -> None:
        """
        :param start: start of the annotated text (usually zero)
        :param end: end of the annotated text (usually end of the line)
        :param value: spacing between the current line and the previous one how it's defined in DOCX format (integer value)
        """
        try:
            int(value)
        except ValueError:
            raise ValueError(f"the value of spacing annotation should be a number, get {value}")
        super().__init__(start=start, end=end, name=SpacingAnnotation.name, value=value)