Source code for atlas_doc_parser.nodes.node_task_item

# -*- coding: utf-8 -*-

import typing as T
import dataclasses

from func_args.api import REQ, OPT

from ..type_enum import TypeEnum
from ..mark_or_node import Base, BaseNode
from ..markdown_helpers import content_to_markdown

if T.TYPE_CHECKING:  # pragma: no cover
    from .node_text import NodeText
    from .node_date import NodeDate
    from .node_emoji import NodeEmoji
    from .node_hard_break import NodeHardBreak
    from .node_inline_card import NodeInlineCard
    from .node_mention import NodeMention
    from .node_status import NodeStatus
    from .node_placeholder import NodePlaceholder
    from .node_inline_extension import NodeInlineExtension
    from .node_media_inline import NodeMediaInline




@dataclasses.dataclass(frozen=True)
class NodeTaskItemAttrs(Base):
    """
    Attributes for :class:`NodeTaskItem`.

    :param localId: A unique identifier for the task item.
    :param state: The state of the task item. Either "TODO" or "DONE".
    """

    localId: str = REQ
    state: T.Literal["TODO", "DONE"] = REQ





@dataclasses.dataclass(frozen=True)
class NodeTaskItem(BaseNode):
    """
    A single task/checkbox item within a taskList.

    The taskItem node represents a checkable item in a task list. Each task
    item has a unique localId and a state indicating whether the task is
    complete ("DONE") or incomplete ("TODO").
    """

    type: str = TypeEnum.taskItem.value
    attrs: NodeTaskItemAttrs = REQ
    content: list[
        T.Union[
            "NodeText",
            "NodeDate",
            "NodeEmoji",
            "NodeHardBreak",
            "NodeInlineCard",
            "NodeMention",
            "NodeStatus",
            "NodePlaceholder",
            "NodeInlineExtension",
            "NodeMediaInline",
        ]
    ] = OPT



    def to_markdown(
        self,
        ignore_error: bool = False,
    ) -> str:
        return content_to_markdown(content=self.content, ignore_error=ignore_error)