Welcome To Our Shell

Mister Spy & Souheyl Bypass Shell

from typing import Optional, Literal

from pydantic import BaseModel

from ordermodel.position import Position


class Title(BaseModel):
    """Model to carry mask title information.

    Todo: Check iXML type InnerTitle for implementation.

    Type hint notation by 'pydantic'.
    (see https://pypi.org/project/pydantic/)

    Attributes:
        layer_number:
        title_number:
        title_text:
        title_parity: e.g. 'Wrong Reading', 'Right Reading'
        title_location:
        title_comment:
    """
    layer_number: int

    title_number: int
    title_text: str  # Todo: Validate max. length and check if iMask maximum is suitable.
    title_parity: Literal['Right Reading', 'Wrong Reading']
    title_location: Optional[str]  # Todo: Check if a specification would make sense (fixed set of literals for locations).
    title_comment: Optional[str]

    # iXML extensions
    title_jb_mebes_type: Literal['M', 'D', 'I', 'S'] = None
    title_position: Optional[Position]  # Todo: Check if required.