node_task_item¶
- class atlas_doc_parser.nodes.node_task_item.NodeTaskItemAttrs(localId: str = REQ, state: Literal['TODO', 'DONE'] = REQ)[source]¶
Attributes for
NodeTaskItem.- Parameters:
localId – A unique identifier for the task item.
state – The state of the task item. Either “TODO” or “DONE”.
- class atlas_doc_parser.nodes.node_task_item.NodeTaskItem(type: str = 'taskItem', attrs: NodeTaskItemAttrs = REQ, content: list[NodeText | NodeDate | NodeEmoji | NodeHardBreak | NodeInlineCard | NodeMention | NodeStatus | NodePlaceholder | NodeInlineExtension | NodeMediaInline] = OPT)[source]¶
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”).
- to_markdown(ignore_error: bool = False) str[source]¶
Convert this node to Markdown format.
The default implementation raises
NotImplementedError. This is intentional for several reasons:Fail fast during development. When implementing new node types, we want to immediately discover which nodes haven’t implemented
to_markdown()rather than silently producing empty output or skipping content. This helps catch missing implementations early.The ignore_error parameter provides an escape hatch. In production, if our code has bugs or a node type is partially implemented, users can pass
ignore_error=Trueto gracefully skip nodes that fail to convert. This flag should be propagated recursively to all nestedto_markdown()calls via helper functions likecontent_to_markdown().Error handling is explicit. The library user decides whether to fail fast (for debugging and development) or degrade gracefully (for production use cases where partial output is acceptable).
Subclasses must override this method to provide actual conversion logic.
- Parameters:
ignore_error – If True, errors in nested conversions are silently skipped. If False (default), errors propagate immediately. This flag should be passed down to any nested
to_markdown()calls.- Returns:
The Markdown representation of this node.
- Raises:
NotImplementedError – Always raised by the base class to ensure subclasses implement this method.