client.get_value() and .try_get_value()

Author: Mike Prosser

protos/ni/pythonpanel/v1/python_panel_service.proto

@@ -35,13 +35,22 @@ service PythonPanelService {
   // Enumerate the panels available in the system, including information about the state of the panels and what values they have.
   // Status Codes for errors:
   rpc EnumeratePanels(EnumeratePanelsRequest) returns (EnumeratePanelsResponse);
+  
+  // Get a value for a control on the panel
+  // Status Codes for errors:
+  // - 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.
+  // - NOT_FOUND: 
+  //   - The value with the specified identifier was not found.
+  rpc GetValue(GetValueRequest) returns (GetValueResponse);
 
   // Try to get a value for a control on the panel
   // Status Codes for errors:
   // - 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(TryGetValueRequest) returns (TryGetValueResponse);
+  rpc TryGetValue(GetValueRequest) returns (TryGetValueResponse);
 
   // Set a value for a control on the panel
   // Status Codes for errors:
@@ -97,14 +106,19 @@ message EnumeratePanelsResponse {
   repeated PanelInformation panels = 1;
 }
 
-message TryGetValueRequest {
+message GetValueRequest {
   // Unique ID of the panel
   string panel_id = 1;
 
   // Unique ID of value
   string value_id = 2;
 }
 
+message GetValueResponse {
+  // The value
+  google.protobuf.Any value = 1;
+}
+
 message TryGetValueResponse {
   // The value, if  it was found
   optional google.protobuf.Any value = 1;

src/ni/pythonpanel/v1/python_panel_service_pb2.py

@@ -138,7 +138,7 @@ class EnumeratePanelsResponse(google.protobuf.message.Message):
 global___EnumeratePanelsResponse = EnumeratePanelsResponse
 
 @typing.final
-class TryGetValueRequest(google.protobuf.message.Message):
+class GetValueRequest(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
     PANEL_ID_FIELD_NUMBER: builtins.int
@@ -155,7 +155,26 @@ class TryGetValueRequest(google.protobuf.message.Message):
     ) -> None: ...
     def ClearField(self, field_name: typing.Literal["panel_id", b"panel_id", "value_id", b"value_id"]) -> None: ...
 
-global___TryGetValueRequest = TryGetValueRequest
+global___GetValueRequest = GetValueRequest
+
+@typing.final
+class GetValueResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    VALUE_FIELD_NUMBER: builtins.int
+    @property
+    def value(self) -> google.protobuf.any_pb2.Any:
+        """The value"""
+
+    def __init__(
+        self,
+        *,
+        value: google.protobuf.any_pb2.Any | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["value", b"value"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["value", b"value"]) -> None: ...
+
+global___GetValueResponse = GetValueResponse
 
 @typing.final
 class TryGetValueResponse(google.protobuf.message.Message):

src/ni/pythonpanel/v1/python_panel_service_pb2.pyi

@@ -30,9 +30,14 @@ def __init__(self, channel):
                 request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.EnumeratePanelsRequest.SerializeToString,
                 response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.EnumeratePanelsResponse.FromString,
                 )
+        self.GetValue = channel.unary_unary(
+                '/ni.pythonpanel.v1.PythonPanelService/GetValue',
+                request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueRequest.SerializeToString,
+                response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueResponse.FromString,
+                )
         self.TryGetValue = channel.unary_unary(
                 '/ni.pythonpanel.v1.PythonPanelService/TryGetValue',
-                request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueRequest.SerializeToString,
+                request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueRequest.SerializeToString,
                 response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueResponse.FromString,
                 )
         self.SetValue = channel.unary_unary(
@@ -78,6 +83,19 @@ def EnumeratePanels(self, request, context):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def GetValue(self, request, context):
+        """Get a value for a control on the panel
+        Status Codes for errors:
+        - 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.
+        - NOT_FOUND: 
+        - The value with the specified identifier was not found.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
     def TryGetValue(self, request, context):
         """Try to get a value for a control on the panel
         Status Codes for errors:
@@ -118,9 +136,14 @@ def add_PythonPanelServiceServicer_to_server(servicer, server):
                     request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.EnumeratePanelsRequest.FromString,
                     response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.EnumeratePanelsResponse.SerializeToString,
             ),
+            'GetValue': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetValue,
+                    request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueRequest.FromString,
+                    response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueResponse.SerializeToString,
+            ),
             'TryGetValue': grpc.unary_unary_rpc_method_handler(
                     servicer.TryGetValue,
-                    request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueRequest.FromString,
+                    request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueRequest.FromString,
                     response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueResponse.SerializeToString,
             ),
             'SetValue': grpc.unary_unary_rpc_method_handler(
@@ -190,6 +213,23 @@ def EnumeratePanels(request,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
 
+    @staticmethod
+    def GetValue(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, '/ni.pythonpanel.v1.PythonPanelService/GetValue',
+            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueRequest.SerializeToString,
+            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
     @staticmethod
     def TryGetValue(request,
             target,
@@ -202,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.TryGetValueRequest.SerializeToString,
+            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.GetValueRequest.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

@@ -53,8 +53,21 @@ class PythonPanelServiceStub:
     Status Codes for errors:
     """
 
+    GetValue: grpc.UnaryUnaryMultiCallable[
+        ni.pythonpanel.v1.python_panel_service_pb2.GetValueRequest,
+        ni.pythonpanel.v1.python_panel_service_pb2.GetValueResponse,
+    ]
+    """Get a value for a control on the panel
+    Status Codes for errors:
+    - 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.
+    - NOT_FOUND: 
+      - The value with the specified identifier was not found.
+    """
+
     TryGetValue: grpc.UnaryUnaryMultiCallable[
-        ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueRequest,
+        ni.pythonpanel.v1.python_panel_service_pb2.GetValueRequest,
         ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueResponse,
     ]
     """Try to get a value for a control on the panel
@@ -110,8 +123,21 @@ class PythonPanelServiceAsyncStub:
     Status Codes for errors:
     """
 
+    GetValue: grpc.aio.UnaryUnaryMultiCallable[
+        ni.pythonpanel.v1.python_panel_service_pb2.GetValueRequest,
+        ni.pythonpanel.v1.python_panel_service_pb2.GetValueResponse,
+    ]
+    """Get a value for a control on the panel
+    Status Codes for errors:
+    - 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.
+    - NOT_FOUND: 
+      - The value with the specified identifier was not found.
+    """
+
     TryGetValue: grpc.aio.UnaryUnaryMultiCallable[
-        ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueRequest,
+        ni.pythonpanel.v1.python_panel_service_pb2.GetValueRequest,
         ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueResponse,
     ]
     """Try to get a value for a control on the panel
@@ -173,10 +199,25 @@ class PythonPanelServiceServicer(metaclass=abc.ABCMeta):
         Status Codes for errors:
         """
 
+    @abc.abstractmethod
+    def GetValue(
+        self,
+        request: ni.pythonpanel.v1.python_panel_service_pb2.GetValueRequest,
+        context: _ServicerContext,
+    ) -> typing.Union[ni.pythonpanel.v1.python_panel_service_pb2.GetValueResponse, collections.abc.Awaitable[ni.pythonpanel.v1.python_panel_service_pb2.GetValueResponse]]:
+        """Get a value for a control on the panel
+        Status Codes for errors:
+        - 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.
+        - NOT_FOUND: 
+          - The value with the specified identifier was not found.
+        """
+
     @abc.abstractmethod
     def TryGetValue(
         self,
-        request: ni.pythonpanel.v1.python_panel_service_pb2.TryGetValueRequest,
+        request: ni.pythonpanel.v1.python_panel_service_pb2.GetValueRequest,
         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

@@ -11,7 +11,7 @@
     StartPanelRequest,
     StopPanelRequest,
     EnumeratePanelsRequest,
-    TryGetValueRequest,
+    GetValueRequest,
     SetValueRequest,
 )
 from ni.pythonpanel.v1.python_panel_service_pb2_grpc import PythonPanelServiceStub
@@ -116,6 +116,20 @@ def set_value(self, panel_id: str, value_id: str, value: object, notify: bool) -
         )
         self._invoke_with_retry(self._get_stub().SetValue, set_value_request)
 
+    def get_value(self, panel_id: str, value_id: str) -> object:
+        """Get the value for the control with value_id.
+
+        Args:
+            panel_id: The ID of the panel.
+            value_id: The ID of the control.
+
+        Returns:
+            The value.
+        """
+        try_get_value_request = GetValueRequest(panel_id=panel_id, value_id=value_id)
+        response = self._invoke_with_retry(self._get_stub().GetValue, try_get_value_request)
+        return from_any(response.value)
+
     def try_get_value(self, panel_id: str, value_id: str) -> tuple[bool, object]:
         """Try to get the value for the control with value_id.
 
@@ -127,7 +141,7 @@ def try_get_value(self, panel_id: str, value_id: str) -> tuple[bool, object]:
             A tuple containing a boolean indicating whether the value was successfully retrieved and
             the value itself (or None if not present).
         """
-        try_get_value_request = TryGetValueRequest(panel_id=panel_id, value_id=value_id)
+        try_get_value_request = GetValueRequest(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 True, from_any(response.value)

src/nipanel/_panel_client.py

@@ -1,4 +1,5 @@
 import grpc
+import pytest
 
 from nipanel._panel_client import PanelClient
 
@@ -50,7 +51,14 @@ def test___start_panels___stop_panel_1_without_reset___enumerate_has_both_panels
     }
 
 
-def test___get_unset_value___returns_not_found(fake_panel_channel: grpc.Channel) -> None:
+def test___get_unset_value_raises_exception(fake_panel_channel: grpc.Channel) -> None:
+    client = create_panel_client(fake_panel_channel)
+
+    with pytest.raises(Exception):
+        client.get_value("panel1", "unset_id")
+
+
+def test___try_get_unset_value___returns_not_found(fake_panel_channel: grpc.Channel) -> None:
     client = create_panel_client(fake_panel_channel)
 
     response = client.try_get_value("panel1", "unset_id")