boulder-opal-scale-up-sdk 1.0.4__py3-none-any.whl → 1.0.6__py3-none-any.whl

boulderopalscaleupsdk/grpc_interceptors/error.py

@@ -0,0 +1,318 @@
+# Copyright 2025 Q-CTRL. All rights reserved.
+#
+# Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
+# copying or use of this file, via any medium, is strictly prohibited.
+# Proprietary and confidential. You may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#    https://q-ctrl.com/terms
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS. See the
+# License for the specific language.
+
+from __future__ import annotations
+
+import inspect
+import re
+from typing import TYPE_CHECKING, Any
+
+import grpc
+import grpc.aio
+
+from boulderopalscaleupsdk.errors import ScaleUpServerError
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncIterable, AsyncIterator
+
+# ------------------------
+# Helpers
+# ------------------------
+
+_GRPC_MESSAGE_RE = re.compile(r'grpc_message:"([^"]+)"')
+
+
+def _extract_peer_message(err: grpc.RpcError) -> str | None:
+    dbg = getattr(err, "debug_error_string", None)
+    if callable(dbg):
+        try:
+            s = dbg()
+        except (AttributeError, TypeError, RuntimeError):
+            return None
+        if isinstance(s, str):
+            m = _GRPC_MESSAGE_RE.search(s)
+            if m:
+                return m.group(1)
+    return None
+
+
+def _concise_error(err: grpc.RpcError, *, include_code: bool = False) -> str:
+    msg = _extract_peer_message(err) or (err.details() or "An unknown error occurred.")
+    if include_code:
+        try:
+            return f"{err.code().name}: {msg}"
+        except (AttributeError, ValueError):
+            pass
+    return msg
+
+
+# ------------------------
+# SYNC wrappers
+# ------------------------
+
+
+class _UnaryUnaryCallWrapper:
+    """Proxy that prettifies errors when .result() is called (sync)."""
+
+    def __init__(self, inner: Any, include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def result(self, timeout: float | None = None) -> Any:
+        try:
+            return self._inner.result(timeout)
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._inner, name)
+
+    def __bool__(self) -> bool:
+        return bool(self._inner)
+
+
+class _SyncRespIterWrapper:
+    """Wrap response-stream iterator to prettify RpcError during iteration (sync)."""
+
+    def __init__(self, inner: Any, include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def __iter__(self):
+        try:
+            yield from self._inner
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._inner, name)
+
+
+class _SyncReqIterWrapper:
+    """Wrap request-stream iterator to prettify RpcError while producing items (sync)."""
+
+    def __init__(self, inner: Any, include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def __iter__(self):
+        try:
+            yield from self._inner
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._inner, name)
+
+
+# ------------------------
+# ASYNC wrappers
+# ------------------------
+
+
+class _AioRespAsyncIterWrapper:
+    """
+    Async iterator proxy that prettifies errors from response streams (async).
+    Accepts the Call object (UnaryStreamCall or StreamStreamCall).
+    """
+
+    def __init__(self, inner: Any, include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def __aiter__(self) -> AsyncIterator[Any]:
+        async def gen() -> AsyncIterator[Any]:
+            try:
+                async for item in self._inner:
+                    yield item
+            except grpc.RpcError as e:
+                raise ScaleUpServerError(
+                    _concise_error(e, include_code=self._include_code),
+                ) from None
+
+        return gen()
+
+    async def initial_metadata(self) -> Any:
+        try:
+            return await self._inner.initial_metadata()
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    async def trailing_metadata(self) -> Any:
+        try:
+            return await self._inner.trailing_metadata()
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def cancel(self) -> None:
+        return self._inner.cancel()
+
+    def code(self) -> Any:
+        return self._inner.code()
+
+    def details(self) -> str:
+        return self._inner.details()
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._inner, name)
+
+
+class _AioReqAsyncIterWrapper:
+    """
+    Async request iterator wrapper that prettifies errors when producing request items.
+    Takes any AsyncIterable (not necessarily an AsyncIterator).
+    """
+
+    def __init__(self, inner: AsyncIterable[Any], include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def __aiter__(self) -> AsyncIterator[Any]:
+        async def gen() -> AsyncIterator[Any]:
+            try:
+                async for item in self._inner:
+                    yield item
+            except grpc.RpcError as e:
+                raise ScaleUpServerError(
+                    _concise_error(e, include_code=self._include_code),
+                ) from None
+
+        return gen()
+
+
+# ------------------------
+# Unified interceptor (sync + aio)
+# ------------------------
+
+
+class ErrorFormatterInterceptor(
+    # sync interfaces
+    grpc.UnaryUnaryClientInterceptor,
+    grpc.UnaryStreamClientInterceptor,
+    grpc.StreamUnaryClientInterceptor,
+    grpc.StreamStreamClientInterceptor,
+    # aio interfaces
+    grpc.aio.UnaryUnaryClientInterceptor,
+    grpc.aio.UnaryStreamClientInterceptor,
+    grpc.aio.StreamUnaryClientInterceptor,
+    grpc.aio.StreamStreamClientInterceptor,
+):
+    """
+    Prettifies gRPC errors raised by the server into ScaleUpServerError.
+
+    Works with both sync (grpc) and async (grpc.aio) channels.
+
+    - Detects whether `continuation` is a coroutine function.
+    - In async case, returns a coroutine that yields wrapped awaitable/async-iterable calls.
+    - In sync case, returns wrapped blocking call objects/iterators.
+    """
+
+    def __init__(self, include_code: bool = False) -> None:
+        self._include_code = include_code
+
+    # ---------- UNARY -> UNARY ----------
+
+    async def _async_unary_unary(self, continuation, client_call_details, request) -> Any:
+        try:
+            call = continuation(client_call_details, request)  # awaitable call
+            # Await here so callers receive the *message*, mirroring AuthInterceptor.
+            return await call
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def _sync_unary_unary(self, continuation, client_call_details, request) -> Any:
+        try:
+            call = continuation(client_call_details, request)  # blocking call
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+        return _UnaryUnaryCallWrapper(call, self._include_code)
+
+    def intercept_unary_unary(self, continuation, client_call_details, request):  # type: ignore[override]
+        if inspect.iscoroutinefunction(continuation):
+            return self._async_unary_unary(continuation, client_call_details, request)
+        return self._sync_unary_unary(continuation, client_call_details, request)
+
+    # ---------- UNARY -> STREAM ----------
+
+    async def _async_unary_stream(self, continuation, client_call_details, request) -> Any:
+        try:
+            resp_call = continuation(client_call_details, request)  # async-iterable call
+            # Do NOT await: return an iterator wrapper that prettifies stream errors.
+            return _AioRespAsyncIterWrapper(resp_call, self._include_code)
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def _sync_unary_stream(self, continuation, client_call_details, request) -> Any:
+        try:
+            resp_iter = continuation(client_call_details, request)  # iterator
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+        return _SyncRespIterWrapper(resp_iter, self._include_code)
+
+    def intercept_unary_stream(self, continuation, client_call_details, request):  # type: ignore[override]
+        if inspect.iscoroutinefunction(continuation):
+            return self._async_unary_stream(continuation, client_call_details, request)
+        return self._sync_unary_stream(continuation, client_call_details, request)
+
+    # ---------- STREAM -> UNARY ----------
+
+    async def _async_stream_unary(self, continuation, client_call_details, request_iterator) -> Any:
+        try:
+            wrapped_req = _AioReqAsyncIterWrapper(request_iterator, self._include_code)
+            call = continuation(client_call_details, wrapped_req)  # awaitable call
+            # Await and return the *message*.
+            return await call
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def _sync_stream_unary(self, continuation, client_call_details, request_iterator) -> Any:
+        try:
+            wrapped_req = _SyncReqIterWrapper(request_iterator, self._include_code)
+            call = continuation(client_call_details, wrapped_req)  # blocking call
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+        return _UnaryUnaryCallWrapper(call, self._include_code)
+
+    def intercept_stream_unary(self, continuation, client_call_details, request_iterator):  # type: ignore[override]
+        if inspect.iscoroutinefunction(continuation):
+            return self._async_stream_unary(continuation, client_call_details, request_iterator)
+        return self._sync_stream_unary(continuation, client_call_details, request_iterator)
+
+    # ---------- STREAM -> STREAM ----------
+
+    async def _async_stream_stream(
+        self,
+        continuation,
+        client_call_details,
+        request_iterator,
+    ) -> Any:
+        try:
+            wrapped_req = _AioReqAsyncIterWrapper(request_iterator, self._include_code)
+            resp_call = continuation(client_call_details, wrapped_req)  # async-iterable call
+            # Return iterator wrapper.
+            return _AioRespAsyncIterWrapper(resp_call, self._include_code)
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def _sync_stream_stream(self, continuation, client_call_details, request_iterator) -> Any:
+        try:
+            wrapped_req = _SyncReqIterWrapper(request_iterator, self._include_code)
+            resp_iter = continuation(client_call_details, wrapped_req)  # iterator
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+        return _SyncRespIterWrapper(resp_iter, self._include_code)
+
+    def intercept_stream_stream(self, continuation, client_call_details, request_iterator):  # type: ignore[override]
+        if inspect.iscoroutinefunction(continuation):
+            return self._async_stream_stream(continuation, client_call_details, request_iterator)
+        return self._sync_stream_stream(continuation, client_call_details, request_iterator)

boulderopalscaleupsdk/plotting/dtypes.py

@@ -19,7 +19,6 @@ from pydantic import (
     BaseModel,
     BeforeValidator,
     ConfigDict,
-    Field,
     PlainSerializer,
     ValidationError,
 )
@@ -28,9 +27,8 @@ from pydantic.dataclasses import dataclass
 
 def _array_validator(value: Any) -> np.ndarray:
     if isinstance(value, dict):
-        array = np.frombuffer(base64.b64decode(value["data"]), dtype=value["dtype"]).reshape(
-            value["shape"],
-        )
+        shape = [int(s) for s in value["shape"]]
+        array = np.frombuffer(base64.b64decode(value["data"]), dtype=value["dtype"]).reshape(shape)
     else:
         array = np.asarray(value, order="C")
 
@@ -82,17 +80,19 @@ class PlotConfig(BaseModel):
     x_ticks: Ticks | None = None
     y_ticks: Ticks | None = None
 
+    axes_ratio: float | None = None
     reverse_yaxis: bool = False
 
     report: PlotReport | None = None
 
 
-@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
+@dataclass(config=ConfigDict(arbitrary_types_allowed=True, extra="forbid"))
 class PlotData1D:
     x: _SerializableArray
     y: _SerializableArray
 
     style: Literal["dash", "solid", "scatter"]
+    color_index: int | None = None
 
     x_error: _SerializableArray | None = None
     y_error: _SerializableArray | None = None
@@ -112,7 +112,7 @@ class PlotData1D:
             raise ValueError("The shapes of y and y_error must match.")
 
 
-@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
+@dataclass(config=ConfigDict(arbitrary_types_allowed=True, extra="forbid"))
 class HeatmapData:
     x: _SerializableArray
     y: _SerializableArray
@@ -122,6 +122,7 @@ class HeatmapData:
 
     # Whether to display the heatmap values as text.
     heatmap_text: bool = False
+    color_map: Literal["sequential", "divergent"] = "sequential"
 
     def __post_init__(self):
         if self.x.ndim != 1:
@@ -157,16 +158,17 @@ class LinePlot(BaseModel):
 
     config: PlotConfig
     heatmap: HeatmapData | None = None
-    lines: Annotated[list[PlotData1D], Field(min_length=1)]
+    lines: list[PlotData1D] = []
     markers: list[Marker] = []
     vlines: list[VLine] = []
 
 
-@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
+@dataclass(config=ConfigDict(arbitrary_types_allowed=True, extra="forbid"))
 class HistogramData:
     data: _SerializableArray
     label: str | None = None
     opacity: float = 0.7
+    color_index: int | None = None
 
     def __post_init__(self):
         if self.data.ndim != 1:

boulderopalscaleupsdk/protobuf/v1/agent_pb2.py

@@ -17,7 +17,7 @@ from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2
 from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n-boulderopalscaleupsdk/protobuf/v1/agent.proto\x12!boulderopalscaleupsdk.protobuf.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1cgoogle/protobuf/struct.proto\"\x85\x01\n\x11RunProgramRequest\x12\'\n\x0f\x63ontroller_type\x18\x01 \x01(\tR\x0e\x63ontrollerType\x12\x18\n\x07program\x18\x02 \x01(\tR\x07program\x12-\n\x12\x63\x61librate_elements\x18\x03 \x03(\tR\x11\x63\x61librateElements\"H\n\x12RunProgramResponse\x12\x32\n\x08raw_data\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x07rawData\"_\n)RunQuantumMachinesMixerCalibrationRequest\x12\x1a\n\x08\x65lements\x18\x01 \x03(\tR\x08\x65lements\x12\x16\n\x06\x63onfig\x18\x02 \x01(\tR\x06\x63onfig\"k\n*RunQuantumMachinesMixerCalibrationResponse\x12\x18\n\x07success\x18\x01 \x01(\x08R\x07success\x12\x19\n\x05\x65rror\x18\x02 \x01(\tH\x00R\x05\x65rror\x88\x01\x01\x42\x08\n\x06_error\"G\n\x15\x44isplayResultsRequest\x12\x18\n\x07message\x18\x01 \x01(\tR\x07message\x12\x14\n\x05plots\x18\x02 \x03(\tR\x05plots\"F\n\x16\x44isplayResultsResponse\x12,\n\x05\x65mpty\x18\x01 \x01(\x0b\x32\x16.google.protobuf.EmptyR\x05\x65mpty2\xd0\x04\n\x0c\x41gentService\x12\x9b\x01\n\nRunProgram\x12\x34.boulderopalscaleupsdk.protobuf.v1.RunProgramRequest\x1a\x35.boulderopalscaleupsdk.protobuf.v1.RunProgramResponse\" \x82\xd3\xe4\x93\x02\x1a\"\x15/v1/agent/run_program:\x01*\x12\xf3\x01\n\"RunQuantumMachinesMixerCalibration\x12L.boulderopalscaleupsdk.protobuf.v1.RunQuantumMachinesMixerCalibrationRequest\x1aM.boulderopalscaleupsdk.protobuf.v1.RunQuantumMachinesMixerCalibrationResponse\"0\x82\xd3\xe4\x93\x02*\"%/v1/agent/run_qua_calibration_program:\x01*\x12\xab\x01\n\x0e\x44isplayResults\x12\x38.boulderopalscaleupsdk.protobuf.v1.DisplayResultsRequest\x1a\x39.boulderopalscaleupsdk.protobuf.v1.DisplayResultsResponse\"$\x82\xd3\xe4\x93\x02\x1e\"\x19/v1/agent/display_results:\x01*B\xa9\x02\n%com.boulderopalscaleupsdk.protobuf.v1B\nAgentProtoP\x01ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\xa2\x02\x03\x42PX\xaa\x02!Boulderopalscaleupsdk.Protobuf.V1\xca\x02!Boulderopalscaleupsdk\\Protobuf\\V1\xe2\x02-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\xea\x02#Boulderopalscaleupsdk::Protobuf::V1b\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n-boulderopalscaleupsdk/protobuf/v1/agent.proto\x12!boulderopalscaleupsdk.protobuf.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1cgoogle/protobuf/struct.proto\"\x85\x01\n\x11RunProgramRequest\x12\'\n\x0f\x63ontroller_type\x18\x01 \x01(\tR\x0e\x63ontrollerType\x12\x18\n\x07program\x18\x02 \x01(\tR\x07program\x12-\n\x12\x63\x61librate_elements\x18\x03 \x03(\tR\x11\x63\x61librateElements\"H\n\x12RunProgramResponse\x12\x32\n\x08raw_data\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x07rawData\"_\n)RunQuantumMachinesMixerCalibrationRequest\x12\x1a\n\x08\x65lements\x18\x01 \x03(\tR\x08\x65lements\x12\x16\n\x06\x63onfig\x18\x02 \x01(\tR\x06\x63onfig\"k\n*RunQuantumMachinesMixerCalibrationResponse\x12\x18\n\x07success\x18\x01 \x01(\x08R\x07success\x12\x19\n\x05\x65rror\x18\x02 \x01(\tH\x00R\x05\x65rror\x88\x01\x01\x42\x08\n\x06_error\"G\n\x15\x44isplayResultsRequest\x12\x18\n\x07message\x18\x01 \x01(\tR\x07message\x12\x14\n\x05plots\x18\x02 \x03(\tR\x05plots\"F\n\x16\x44isplayResultsResponse\x12,\n\x05\x65mpty\x18\x01 \x01(\x0b\x32\x16.google.protobuf.EmptyR\x05\x65mpty\"\\\n\nAskRequest\x12\x18\n\x07message\x18\x01 \x01(\tR\x07message\x12\x34\n\x16\x65xpected_response_type\x18\x02 \x01(\tR\x14\x65xpectedResponseType\")\n\x0b\x41skResponse\x12\x1a\n\x08response\x18\x01 \x01(\tR\x08response2\xd0\x05\n\x0c\x41gentService\x12\x9b\x01\n\nRunProgram\x12\x34.boulderopalscaleupsdk.protobuf.v1.RunProgramRequest\x1a\x35.boulderopalscaleupsdk.protobuf.v1.RunProgramResponse\" \x82\xd3\xe4\x93\x02\x1a\"\x15/v1/agent/run_program:\x01*\x12\xf3\x01\n\"RunQuantumMachinesMixerCalibration\x12L.boulderopalscaleupsdk.protobuf.v1.RunQuantumMachinesMixerCalibrationRequest\x1aM.boulderopalscaleupsdk.protobuf.v1.RunQuantumMachinesMixerCalibrationResponse\"0\x82\xd3\xe4\x93\x02*\"%/v1/agent/run_qua_calibration_program:\x01*\x12\xab\x01\n\x0e\x44isplayResults\x12\x38.boulderopalscaleupsdk.protobuf.v1.DisplayResultsRequest\x1a\x39.boulderopalscaleupsdk.protobuf.v1.DisplayResultsResponse\"$\x82\xd3\xe4\x93\x02\x1e\"\x19/v1/agent/display_results:\x01*\x12~\n\x03\x41sk\x12-.boulderopalscaleupsdk.protobuf.v1.AskRequest\x1a..boulderopalscaleupsdk.protobuf.v1.AskResponse\"\x18\x82\xd3\xe4\x93\x02\x12\"\r/v1/agent/ask:\x01*B\xa9\x02\n%com.boulderopalscaleupsdk.protobuf.v1B\nAgentProtoP\x01ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\xa2\x02\x03\x42PX\xaa\x02!Boulderopalscaleupsdk.Protobuf.V1\xca\x02!Boulderopalscaleupsdk\\Protobuf\\V1\xe2\x02-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\xea\x02#Boulderopalscaleupsdk::Protobuf::V1b\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -31,6 +31,8 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_AGENTSERVICE'].methods_by_name['RunQuantumMachinesMixerCalibration']._serialized_options = b'\202\323\344\223\002*\"%/v1/agent/run_qua_calibration_program:\001*'
   _globals['_AGENTSERVICE'].methods_by_name['DisplayResults']._loaded_options = None
   _globals['_AGENTSERVICE'].methods_by_name['DisplayResults']._serialized_options = b'\202\323\344\223\002\036\"\031/v1/agent/display_results:\001*'
+  _globals['_AGENTSERVICE'].methods_by_name['Ask']._loaded_options = None
+  _globals['_AGENTSERVICE'].methods_by_name['Ask']._serialized_options = b'\202\323\344\223\002\022\"\r/v1/agent/ask:\001*'
   _globals['_RUNPROGRAMREQUEST']._serialized_start=174
   _globals['_RUNPROGRAMREQUEST']._serialized_end=307
   _globals['_RUNPROGRAMRESPONSE']._serialized_start=309
@@ -43,6 +45,10 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_DISPLAYRESULTSREQUEST']._serialized_end=660
   _globals['_DISPLAYRESULTSRESPONSE']._serialized_start=662
   _globals['_DISPLAYRESULTSRESPONSE']._serialized_end=732
-  _globals['_AGENTSERVICE']._serialized_start=735
-  _globals['_AGENTSERVICE']._serialized_end=1327
+  _globals['_ASKREQUEST']._serialized_start=734
+  _globals['_ASKREQUEST']._serialized_end=826
+  _globals['_ASKRESPONSE']._serialized_start=828
+  _globals['_ASKRESPONSE']._serialized_end=869
+  _globals['_AGENTSERVICE']._serialized_start=872
+  _globals['_AGENTSERVICE']._serialized_end=1592
 # @@protoc_insertion_point(module_scope)

boulderopalscaleupsdk/protobuf/v1/agent_pb2.pyi

@@ -53,3 +53,17 @@ class DisplayResultsResponse(_message.Message):
     EMPTY_FIELD_NUMBER: _ClassVar[int]
     empty: _empty_pb2.Empty
     def __init__(self, empty: _Optional[_Union[_empty_pb2.Empty, _Mapping]] = ...) -> None: ...
+
+class AskRequest(_message.Message):
+    __slots__ = ("message", "expected_response_type")
+    MESSAGE_FIELD_NUMBER: _ClassVar[int]
+    EXPECTED_RESPONSE_TYPE_FIELD_NUMBER: _ClassVar[int]
+    message: str
+    expected_response_type: str
+    def __init__(self, message: _Optional[str] = ..., expected_response_type: _Optional[str] = ...) -> None: ...
+
+class AskResponse(_message.Message):
+    __slots__ = ("response",)
+    RESPONSE_FIELD_NUMBER: _ClassVar[int]
+    response: str
+    def __init__(self, response: _Optional[str] = ...) -> None: ...

boulderopalscaleupsdk/protobuf/v1/agent_pb2_grpc.py

@@ -30,6 +30,11 @@ class AgentServiceStub(object):
                 request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsRequest.SerializeToString,
                 response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsResponse.FromString,
                 )
+        self.Ask = channel.unary_unary(
+                '/boulderopalscaleupsdk.protobuf.v1.AgentService/Ask',
+                request_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.AskRequest.SerializeToString,
+                response_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.AskResponse.FromString,
+                )
 
 
 class AgentServiceServicer(object):
@@ -57,6 +62,13 @@ class AgentServiceServicer(object):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def Ask(self, request, context):
+        """Ask user for input.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
 
 def add_AgentServiceServicer_to_server(servicer, server):
     rpc_method_handlers = {
@@ -75,6 +87,11 @@ def add_AgentServiceServicer_to_server(servicer, server):
                     request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsRequest.FromString,
                     response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsResponse.SerializeToString,
             ),
+            'Ask': grpc.unary_unary_rpc_method_handler(
+                    servicer.Ask,
+                    request_deserializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.AskRequest.FromString,
+                    response_serializer=boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.AskResponse.SerializeToString,
+            ),
     }
     generic_handler = grpc.method_handlers_generic_handler(
             'boulderopalscaleupsdk.protobuf.v1.AgentService', rpc_method_handlers)
@@ -136,3 +153,20 @@ class AgentService(object):
             boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.DisplayResultsResponse.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def Ask(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/boulderopalscaleupsdk.protobuf.v1.AgentService/Ask',
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.AskRequest.SerializeToString,
+            boulderopalscaleupsdk_dot_protobuf_dot_v1_dot_agent__pb2.AskResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)