faust.cli.agents

Program faust agents used to list agents.

class faust.cli.agents.agents(ctx: Context, *args: Any, key_serializer: Optional[Union[CodecT, str]] = None, value_serializer: Optional[Union[CodecT, str]] = None, **kwargs: Any)

List agents.

title = 'Agents'

headers = ['name', 'topic', 'help']

sortkey = operator.attrgetter('name')

options: Optional[OptionList] = [option('--local/--no-local', help='Include agents using a local channel')]

async run(local: bool) → None

Dump list of available agents in this application.

Return type:

None

agents(*, local: bool = False) → Sequence[AgentT]

Convert list of agents to terminal table rows.

Return type:

_GenericAlias[AgentT]

agent_to_row(agent: AgentT) → Sequence[str]

Convert agent fields to terminal table row.

Return type:

_GenericAlias[str]

app: AppT

key_serializer: Optional[Union[CodecT, str]]

The codec used to serialize keys. Taken from instance parameters or key_serializer.

value_serialier: Optional[Union[CodecT, str]]

The codec used to serialize values. Taken from instance parameters or value_serializer.