nodestep.middleware.todolist¶

TodoListMiddleware, which gives the model a to-do list per thread.

Name	What it is
Middleware
`TodoListMiddleware`	Give the model a todo list per thread, kept in this instance's memory.
Items
`TodoItem`	A todo item with its task and state.
`TodoItemState`	Progress state of a todo item.
`TodoListSnapshot`	The current todo list.
Errors
`TodoListMiddlewareError`	Raised when the todo tools run without a thread id.

Middleware¶

TodoListMiddleware¶

Give the model a todo list per thread, kept in this instance's memory.

Subclass of Middleware.

The list is not part of the graph state: a state store, history, fork and other processes do not see it. Without a state store, a run without thread_id= gets a generated thread and so an empty list.

Methods

`items_for(thread_id)`¶

Return the todo list of a thread.

items_for(thread_id) -> list[TodoItem]

Parameters
`thread_id`	`str`

Returns
`list[TodoItem]`	The stored list itself; changing it changes the thread's todos.

`tools()`¶

Return the read_todos and write_todos tools of this instance.

tools() -> tuple[Tool, ...]

Items¶

TodoItem¶

TodoItem(*, task, state=TodoItemState.PENDING)

A todo item with its task and state.

Attributes
`task`	`str`
`state`	`TodoItemState`

TodoItemState¶

Progress state of a todo item.

Attributes
`PENDING`		`"pending"`, the state of a new item.
`IN_PROGRESS`		`"in_progress"`.
`COMPLETED`		`"completed"`.
`BLOCKED`		`"blocked"`.
`CANCELLED`		`"cancelled"`.
`FAILED`		`"failed"`.

TodoListSnapshot¶

TodoListSnapshot(*, items)

The current todo list.

Attributes
`items`	`list[TodoItem]`

Errors¶

TodoListMiddlewareError¶

Raised when the todo tools run without a thread id.

Subclass of NodestepError.