cstar.orchestration.orchestration.Planner.retrieve

Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

cstar.orchestration.orchestration.Planner.retrieve#

Planner.retrieve(n: str, key: Literal['status'], default: Status | None = None) → Status | None#
Planner.retrieve(n: str, key: Literal['step'], default: LiveStep | None = None) → LiveStep | None
Planner.retrieve(n: str, key: Literal['task'], default: Task | None = None) → Task | None

Retrieve an attribute from a node in the plan.

Parameters:

  • n (str) – The node identifier.

  • key (str) – The key to be retrieved from the node.

  • default (t.Any | None) – The default value to retrieve if one is not found.

Returns:

t.Any – The value stored on the node retrieved using the key.