# Generated from soulfire/plugin/example/v1/example.proto. DO NOT EDIT.
# Generated by protoc-gen-connectrpc-py v0.11.1 with parameter "protobuf=google".
# ruff: noqa: PGH004
# ruff: noqa
# fmt: off
from __future__ import annotations
from typing import Protocol, TYPE_CHECKING
from connectrpc.client import ConnectClient, ConnectClientSync
from connectrpc.code import Code
from connectrpc.compat import google_protobuf_binary_codec, google_protobuf_codecs
from connectrpc.compression.gzip import GzipCompression
from connectrpc.errors import ConnectError
from connectrpc.method import IdempotencyLevel, MethodInfo
from connectrpc.protocol import ProtocolType
from connectrpc.server import ConnectASGIApplication, ConnectWSGIApplication, Endpoint, EndpointSync
from pyqwest import Client, SyncClient
from .example_pb2 import EchoRequest, EchoResponse, Tick, WatchTicksRequest
if TYPE_CHECKING:
from collections.abc import AsyncGenerator, AsyncIterator, Iterable, Iterator, Mapping
from connectrpc.codec import Codec
from connectrpc.compression import Compression
from connectrpc.interceptor import Interceptor, InterceptorSync
from connectrpc.request import Headers, RequestContext
_DEFAULT_CODECS = google_protobuf_codecs()
_PROTO_BINARY_CODEC = google_protobuf_binary_codec()
_GZIP_COMPRESSION = GzipCompression()
[docs]
class ExamplePluginService(Protocol):
[docs]
async def echo(self, request: EchoRequest, ctx: RequestContext[EchoRequest, EchoResponse]) -> EchoResponse:
raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs]
def watch_ticks(self, request: WatchTicksRequest, ctx: RequestContext[WatchTicksRequest, Tick]) -> AsyncIterator[Tick]:
raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs]
class ExamplePluginServiceASGIApplication(ConnectASGIApplication[ExamplePluginService]):
def __init__(
self,
service: ExamplePluginService | AsyncGenerator[ExamplePluginService],
*,
interceptors: Iterable[Interceptor] = (),
read_max_bytes: int | None = None,
compressions: Iterable[Compression] | None = None,
codecs: Iterable[Codec] | None = _DEFAULT_CODECS,
) -> None:
super().__init__(
service=service,
endpoints=lambda svc: {
"/soulfire.plugin.example.v1.ExamplePluginService/Echo": Endpoint.unary(
method=MethodInfo(
name="Echo",
service_name="soulfire.plugin.example.v1.ExamplePluginService",
input=EchoRequest,
output=EchoResponse,
idempotency_level=IdempotencyLevel.UNKNOWN,
),
function=svc.echo,
),
"/soulfire.plugin.example.v1.ExamplePluginService/WatchTicks": Endpoint.server_stream(
method=MethodInfo(
name="WatchTicks",
service_name="soulfire.plugin.example.v1.ExamplePluginService",
input=WatchTicksRequest,
output=Tick,
idempotency_level=IdempotencyLevel.UNKNOWN,
),
function=svc.watch_ticks,
),
},
interceptors=interceptors,
read_max_bytes=read_max_bytes,
compressions=compressions,
codecs=codecs,
)
@property
def path(self) -> str:
"""Returns the URL path to mount the application to when serving multiple applications."""
return "/soulfire.plugin.example.v1.ExamplePluginService"
[docs]
class ExamplePluginServiceClient(ConnectClient):
def __init__(
self,
address: str,
*,
codec: Codec | None = _PROTO_BINARY_CODEC,
protocol: ProtocolType = ProtocolType.CONNECT,
accept_compression: Iterable[Compression] | None = None,
send_compression: Compression | None = _GZIP_COMPRESSION,
timeout_ms: int | None = None,
read_max_bytes: int | None = None,
interceptors: Iterable[Interceptor] = (),
http_client: Client | None = None,
) -> None:
super().__init__(
address=address,
codec=codec,
protocol=protocol,
accept_compression=accept_compression,
send_compression=send_compression,
timeout_ms=timeout_ms,
read_max_bytes=read_max_bytes,
interceptors=interceptors,
http_client=http_client,
)
[docs]
async def echo(
self,
request: EchoRequest,
*,
headers: Headers | Mapping[str, str] | None = None,
timeout_ms: int | None = None,
) -> EchoResponse:
return await self.execute_unary(
request=request,
method=MethodInfo(
name="Echo",
service_name="soulfire.plugin.example.v1.ExamplePluginService",
input=EchoRequest,
output=EchoResponse,
idempotency_level=IdempotencyLevel.UNKNOWN,
),
headers=headers,
timeout_ms=timeout_ms,
)
[docs]
def watch_ticks(
self,
request: WatchTicksRequest,
*,
headers: Headers | Mapping[str, str] | None = None,
timeout_ms: int | None = None,
) -> AsyncIterator[Tick]:
return self.execute_server_stream(
request=request,
method=MethodInfo(
name="WatchTicks",
service_name="soulfire.plugin.example.v1.ExamplePluginService",
input=WatchTicksRequest,
output=Tick,
idempotency_level=IdempotencyLevel.UNKNOWN,
),
headers=headers,
timeout_ms=timeout_ms,
)
[docs]
class ExamplePluginServiceSync(Protocol):
[docs]
def echo(self, request: EchoRequest, ctx: RequestContext[EchoRequest, EchoResponse]) -> EchoResponse:
raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs]
def watch_ticks(self, request: WatchTicksRequest, ctx: RequestContext[WatchTicksRequest, Tick]) -> Iterator[Tick]:
raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs]
class ExamplePluginServiceWSGIApplication(ConnectWSGIApplication):
def __init__(
self,
service: ExamplePluginServiceSync,
interceptors: Iterable[InterceptorSync] = (),
read_max_bytes: int | None = None,
compressions: Iterable[Compression] | None = None,
codecs: Iterable[Codec] | None = _DEFAULT_CODECS,
) -> None:
super().__init__(
endpoints={
"/soulfire.plugin.example.v1.ExamplePluginService/Echo": EndpointSync.unary(
method=MethodInfo(
name="Echo",
service_name="soulfire.plugin.example.v1.ExamplePluginService",
input=EchoRequest,
output=EchoResponse,
idempotency_level=IdempotencyLevel.UNKNOWN,
),
function=service.echo,
),
"/soulfire.plugin.example.v1.ExamplePluginService/WatchTicks": EndpointSync.server_stream(
method=MethodInfo(
name="WatchTicks",
service_name="soulfire.plugin.example.v1.ExamplePluginService",
input=WatchTicksRequest,
output=Tick,
idempotency_level=IdempotencyLevel.UNKNOWN,
),
function=service.watch_ticks,
),
},
interceptors=interceptors,
read_max_bytes=read_max_bytes,
compressions=compressions,
codecs=codecs,
)
@property
def path(self) -> str:
"""Returns the URL path to mount the application to when serving multiple applications."""
return "/soulfire.plugin.example.v1.ExamplePluginService"
[docs]
class ExamplePluginServiceClientSync(ConnectClientSync):
def __init__(
self,
address: str,
*,
codec: Codec | None = _PROTO_BINARY_CODEC,
protocol: ProtocolType = ProtocolType.CONNECT,
accept_compression: Iterable[Compression] | None = None,
send_compression: Compression | None = _GZIP_COMPRESSION,
timeout_ms: int | None = None,
read_max_bytes: int | None = None,
interceptors: Iterable[InterceptorSync] = (),
http_client: SyncClient | None = None,
) -> None:
super().__init__(
address=address,
codec=codec,
protocol=protocol,
accept_compression=accept_compression,
send_compression=send_compression,
timeout_ms=timeout_ms,
read_max_bytes=read_max_bytes,
interceptors=interceptors,
http_client=http_client,
)
[docs]
def echo(
self,
request: EchoRequest,
*,
headers: Headers | Mapping[str, str] | None = None,
timeout_ms: int | None = None,
) -> EchoResponse:
return self.execute_unary(
request=request,
method=MethodInfo(
name="Echo",
service_name="soulfire.plugin.example.v1.ExamplePluginService",
input=EchoRequest,
output=EchoResponse,
idempotency_level=IdempotencyLevel.UNKNOWN,
),
headers=headers,
timeout_ms=timeout_ms,
)
[docs]
def watch_ticks(
self,
request: WatchTicksRequest,
*,
headers: Headers | Mapping[str, str] | None = None,
timeout_ms: int | None = None,
) -> Iterator[Tick]:
return self.execute_server_stream(
request=request,
method=MethodInfo(
name="WatchTicks",
service_name="soulfire.plugin.example.v1.ExamplePluginService",
input=WatchTicksRequest,
output=Tick,
idempotency_level=IdempotencyLevel.UNKNOWN,
),
headers=headers,
timeout_ms=timeout_ms,
)