soulfire.plugin.example.v1.example_connect.ExamplePluginService

class soulfire.plugin.example.v1.example_connect.ExamplePluginService

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

async echo(request: soulfire.plugin.example.v1.example_pb2.EchoRequest, ctx: connectrpc.request.RequestContext[soulfire.plugin.example.v1.example_pb2.EchoRequest, soulfire.plugin.example.v1.example_pb2.EchoResponse]) → soulfire.plugin.example.v1.example_pb2.EchoResponse

watch_ticks(request: soulfire.plugin.example.v1.example_pb2.WatchTicksRequest, ctx: connectrpc.request.RequestContext[soulfire.plugin.example.v1.example_pb2.WatchTicksRequest, soulfire.plugin.example.v1.example_pb2.Tick]) → collections.abc.AsyncIterator[soulfire.plugin.example.v1.example_pb2.Tick]