TryGetValueRequest

Author: Mike Prosser

protos/ni/pythonpanel/v1/python_panel_service.proto

@@ -50,7 +50,7 @@ service PythonPanelService {
   // - INVALID_ARGUMENT: 
   //   - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
   //   - The value identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
-  rpc TryGetValue(GetValueRequest) returns (TryGetValueResponse);
+  rpc TryGetValue(TryGetValueRequest) returns (TryGetValueResponse);
 
   // Set a value for a control on the panel
   // Status Codes for errors:
@@ -119,6 +119,14 @@ message GetValueResponse {
   google.protobuf.Any value = 1;
 }
 
+message TryGetValueRequest {
+  // Unique ID of the panel
+  string panel_id = 1;
+
+  // Unique ID of value
+  string value_id = 2;
+}
+
 message TryGetValueResponse {
   // The value, if  it was found
   optional google.protobuf.Any value = 1;

src/ni/pythonpanel/v1/python_panel_service_pb2.py

@@ -176,6 +176,26 @@ class GetValueResponse(google.protobuf.message.Message):
 
 global___GetValueResponse = GetValueResponse
 
+@typing.final
+class TryGetValueRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PANEL_ID_FIELD_NUMBER: builtins.int
+    VALUE_ID_FIELD_NUMBER: builtins.int
+    panel_id: builtins.str
+    """Unique ID of the panel"""
+    value_id: builtins.str
+    """Unique ID of value"""
+    def __init__(
+        self,
+        *,
+        panel_id: builtins.str = ...,
+        value_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["panel_id", b"panel_id", "value_id", b"value_id"]) -> None: ...
+
+global___TryGetValueRequest = TryGetValueRequest
+
 @typing.final
 class TryGetValueResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor

src/ni/pythonpanel/v1/python_panel_service_pb2.pyi

@@ -37,7 +37,7 @@ def __init__(self, channel):
                 )
         self.TryGetValue = channel.unary_unary(
                 '/ni.pythonpanel.v1.PythonPanelService/TryGetValue',
-                request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueRequest.SerializeToString,
+                request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueRequest.SerializeToString,
                 response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueResponse.FromString,
                 )
         self.SetValue = channel.unary_unary(
@@ -143,7 +143,7 @@ def add_PythonPanelServiceServicer_to_server(servicer, server):
             ),
             'TryGetValue': grpc.unary_unary_rpc_method_handler(
                     servicer.TryGetValue,
-                    request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueRequest.FromString,
+                    request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueRequest.FromString,
                     response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueResponse.SerializeToString,
             ),
             'SetValue': grpc.unary_unary_rpc_method_handler(
@@ -242,7 +242,7 @@ def TryGetValue(request,
             timeout=None,
             metadata=None):
         return grpc.experimental.unary_unary(request, target, '/ni.pythonpanel.v1.PythonPanelService/TryGetValue',
-            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueRequest.SerializeToString,
+            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueRequest.SerializeToString,
             ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueResponse.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

src/ni/pythonpanel/v1/python_panel_service_pb2_grpc.py

@@ -67,7 +67,7 @@ class PythonPanelServiceStub:
     """
 
     TryGetValue: grpc.UnaryUnaryMultiCallable[
-        ni.pythonpanel.v1.python_panel_service_pb2.GetValueRequest,
+        ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueRequest,
         ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueResponse,
     ]
     """Try to get a value for a control on the panel
@@ -137,7 +137,7 @@ class PythonPanelServiceAsyncStub:
     """
 
     TryGetValue: grpc.aio.UnaryUnaryMultiCallable[
-        ni.pythonpanel.v1.python_panel_service_pb2.GetValueRequest,
+        ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueRequest,
         ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueResponse,
     ]
     """Try to get a value for a control on the panel
@@ -217,7 +217,7 @@ class PythonPanelServiceServicer(metaclass=abc.ABCMeta):
     @abc.abstractmethod
     def TryGetValue(
         self,
-        request: ni.pythonpanel.v1.python_panel_service_pb2.GetValueRequest,
+        request: ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueRequest,
         context: _ServicerContext,
     ) -> typing.Union[ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueResponse, collections.abc.Awaitable[ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueResponse]]:
         """Try to get a value for a control on the panel

src/ni/pythonpanel/v1/python_panel_service_pb2_grpc.pyi

@@ -12,6 +12,7 @@
     StopPanelRequest,
     EnumeratePanelsRequest,
     GetValueRequest,
+    TryGetValueRequest,
     SetValueRequest,
 )
 from ni.pythonpanel.v1.python_panel_service_pb2_grpc import PythonPanelServiceStub
@@ -168,7 +169,7 @@ def try_get_value(self, panel_id: str, value_id: str) -> object | None:
                 - INVALID_ARGUMENT: If the panel identifier or value identifier contains
                   invalid characters (only alphanumeric characters and underscores are allowed).
         """
-        try_get_value_request = GetValueRequest(panel_id=panel_id, value_id=value_id)
+        try_get_value_request = TryGetValueRequest(panel_id=panel_id, value_id=value_id)
         response = self._invoke_with_retry(self._get_stub().TryGetValue, try_get_value_request)
         if response.HasField("value"):
             return from_any(response.value)

src/nipanel/_panel_client.py

@@ -6,6 +6,7 @@
     StopPanelRequest,
     EnumeratePanelsRequest,
     GetValueRequest,
+    TryGetValueRequest,
     SetValueRequest,
 )
 from ni.pythonpanel.v1.python_panel_service_pb2_grpc import PythonPanelServiceStub
@@ -81,7 +82,7 @@ def test___set_value___try_get_value___gets_response(
     set_request = SetValueRequest(panel_id="test_panel", value_id="test_value", value=test_value)
     python_panel_service_stub.SetValue(set_request)
 
-    request = GetValueRequest(panel_id="test_panel", value_id="test_value")
+    request = TryGetValueRequest(panel_id="test_panel", value_id="test_value")
     response = python_panel_service_stub.TryGetValue(request)
 
     assert response is not None  # Ensure response is returned
@@ -91,7 +92,7 @@ def test___set_value___try_get_value___gets_response(
 def test___no_value___try_get_value___gets_no_value(
     python_panel_service_stub: PythonPanelServiceStub,
 ) -> None:
-    request = GetValueRequest(panel_id="test_panel", value_id="test_value")
+    request = TryGetValueRequest(panel_id="test_panel", value_id="test_value")
     response = python_panel_service_stub.TryGetValue(request)
 
     assert response is not None  # Ensure response is returned

tests/unit/test_python_panel_service_stub.py

@@ -11,6 +11,7 @@
     PanelInformation,
     GetValueRequest,
     GetValueResponse,
+    TryGetValueRequest,
     TryGetValueResponse,
     SetValueRequest,
     SetValueResponse,
@@ -69,7 +70,7 @@ def GetValue(self, request: GetValueRequest, context: Any) -> GetValueResponse:
         return GetValueResponse(value=value)
 
     def TryGetValue(  # noqa: N802
-        self, request: GetValueRequest, context: Any
+        self, request: TryGetValueRequest, context: Any
     ) -> TryGetValueResponse:
         """Trivial implementation for testing."""
         if request.value_id not in self._panel_value_ids.get(request.panel_id, {}):