cstar.orchestration.orchestration.Planner.retrieve_all

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_all#

Planner.retrieve_all(key: Literal['status'], default: Status | None = None, filter_fn: Callable[[Status], bool] | None = None) → Mapping[str, Status]#
Planner.retrieve_all(key: Literal['step'], default: Step | None = None, filter_fn: Callable[[Step], bool] | None = None) → Mapping[str, Step]
Planner.retrieve_all(key: Literal['task'], default: Task[Any] | None = None, filter_fn: Callable[[Task[Any]], bool] | None = None) → Mapping[str, Task[Any]]

Retrieve a user-defined value for every node in the plan.

Parameters:

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

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

  • filter_fn (Callable[[_TValue], bool] | None) – A filter function to execute against the returned values.

Returns:

Mapping[str, _TValue] – Mapping of node name to value retrieved for the key.