soulfire.plugin_api_connect.PluginApiServiceSync

class soulfire.plugin_api_connect.PluginApiServiceSync

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:
        ...

list_plugin_apis(request: soulfire.plugin_api_pb2.ListPluginApisRequest, ctx: connectrpc.request.RequestContext[soulfire.plugin_api_pb2.ListPluginApisRequest, soulfire.plugin_api_pb2.ListPluginApisResponse]) → soulfire.plugin_api_pb2.ListPluginApisResponse

get_plugin_api(request: soulfire.plugin_api_pb2.GetPluginApiRequest, ctx: connectrpc.request.RequestContext[soulfire.plugin_api_pb2.GetPluginApiRequest, soulfire.plugin_api_pb2.GetPluginApiResponse]) → soulfire.plugin_api_pb2.GetPluginApiResponse

get_plugin_descriptor_set(request: soulfire.plugin_api_pb2.GetPluginDescriptorSetRequest, ctx: connectrpc.request.RequestContext[soulfire.plugin_api_pb2.GetPluginDescriptorSetRequest, soulfire.plugin_api_pb2.GetPluginDescriptorSetResponse]) → soulfire.plugin_api_pb2.GetPluginDescriptorSetResponse

watch_plugin_apis(request: soulfire.plugin_api_pb2.WatchPluginApisRequest, ctx: connectrpc.request.RequestContext[soulfire.plugin_api_pb2.WatchPluginApisRequest, soulfire.plugin_api_pb2.PluginApiEvent]) → collections.abc.Iterator[soulfire.plugin_api_pb2.PluginApiEvent]

watch_plugin_events(request: soulfire.plugin_api_pb2.WatchPluginEventsRequest, ctx: connectrpc.request.RequestContext[soulfire.plugin_api_pb2.WatchPluginEventsRequest, soulfire.plugin_api_pb2.PluginEvent]) → collections.abc.Iterator[soulfire.plugin_api_pb2.PluginEvent]