Source code for dedoc.data_structures.concrete_annotations.italic_annotation

from flask_restx import Api, Model, fields

from dedoc.data_structures.annotation import Annotation


class ItalicAnnotation(Annotation):
    """
    Text written in italic inside the line.
    """
    name = "italic"
    valid_values = ["True", "False"]

    def __init__(self, start: int, end: int, value: str) -> None:
        """
        :param start: start of the italic text
        :param end: end of the italic text (not included)
        :param value: True if italic else False (False usually isn't used because you may not use this annotation at all)
        """
        try:
            bool(value)
        except ValueError:
            raise ValueError("the value of italic annotation should be True or False")
        super().__init__(start=start, end=end, name=ItalicAnnotation.name, value=value)

    @staticmethod
    def get_api_dict(api: Api) -> Model:
        return api.model("ItalicAnnotation", {
            "start": fields.Integer(description="annotation start index", required=True, example=0),
            "end": fields.Integer(description="annotation end index", required=True, example=4),
            "value": fields.String(description="indicator if the text is italic or not", required=True, example="True", enum=ItalicAnnotation.valid_values)
        })