soulfire.task_connect.BotTaskServiceSync

class soulfire.task_connect.BotTaskServiceSync

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

start_bot_task(request: soulfire.task_pb2.StartBotTaskRequest, ctx: connectrpc.request.RequestContext[soulfire.task_pb2.StartBotTaskRequest, soulfire.task_pb2.BotTask]) → soulfire.task_pb2.BotTask

run_bot_task(request: soulfire.task_pb2.StartBotTaskRequest, ctx: connectrpc.request.RequestContext[soulfire.task_pb2.StartBotTaskRequest, soulfire.task_pb2.BotTaskEvent]) → collections.abc.Iterator[soulfire.task_pb2.BotTaskEvent]

get_bot_task(request: soulfire.task_pb2.GetBotTaskRequest, ctx: connectrpc.request.RequestContext[soulfire.task_pb2.GetBotTaskRequest, soulfire.task_pb2.BotTask]) → soulfire.task_pb2.BotTask

list_bot_tasks(request: soulfire.task_pb2.ListBotTasksRequest, ctx: connectrpc.request.RequestContext[soulfire.task_pb2.ListBotTasksRequest, soulfire.task_pb2.ListBotTasksResponse]) → soulfire.task_pb2.ListBotTasksResponse

watch_bot_task(request: soulfire.task_pb2.WatchBotTaskRequest, ctx: connectrpc.request.RequestContext[soulfire.task_pb2.WatchBotTaskRequest, soulfire.task_pb2.BotTaskEvent]) → collections.abc.Iterator[soulfire.task_pb2.BotTaskEvent]

watch_bot_tasks(request: soulfire.task_pb2.WatchBotTasksRequest, ctx: connectrpc.request.RequestContext[soulfire.task_pb2.WatchBotTasksRequest, soulfire.task_pb2.BotTaskEvent]) → collections.abc.Iterator[soulfire.task_pb2.BotTaskEvent]

cancel_bot_task(request: soulfire.task_pb2.CancelBotTaskRequest, ctx: connectrpc.request.RequestContext[soulfire.task_pb2.CancelBotTaskRequest, soulfire.task_pb2.BotTask]) → soulfire.task_pb2.BotTask