PythonPanelService.GetValue() and .TryGetValue() (#112)

* rename to TryGetValue

* test___no_value___try_get_value___gets_no_value

* client.get_value() and .try_get_value()

* cleanup

* cleanup

* joe's feedback

* TryGetValueRequest

* _PanelClient should not be public

---------

Co-authored-by: Mike Prosser <[email protected]>

Author: mikeprosserni

protos/ni/pythonpanel/v1/python_panel_service.proto

@@ -18,13 +18,18 @@ option ruby_package = "NI::PythonPanel::V1";
 service PythonPanelService {
   // Start a panel (or connect to if it has already been started)
   // Status Codes for errors:
-  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
-  // - NOT_FOUND: the file for the panel was not found
+  // - INVALID_ARGUMENT: 
+  //   - The panel script filename doesn't end in .py.
+  //   - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  // - NOT_FOUND: 
+  //   - The panel script file was not found.
+  //   - The python executable file was not found.
   rpc StartPanel(StartPanelRequest) returns (StartPanelResponse);
 
   // Stop a panel
   // Status Codes for errors:
-  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  // - INVALID_ARGUMENT:
+  //   - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
   rpc StopPanel(StopPanelRequest) returns (StopPanelResponse);
 
   // Enumerate the panels available in the system, including information about the state of the panels and what values they have.
@@ -33,12 +38,25 @@ service PythonPanelService {
 
   // Get a value for a control on the panel
   // Status Codes for errors:
-  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  // - 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);
+
   // Set a value for a control on the panel
   // Status Codes for errors:
-  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  // - 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 SetValue(SetValueRequest) returns (SetValueResponse);
 }
 
@@ -98,6 +116,19 @@ message GetValueRequest {
 
 message GetValueResponse {
   // The value
+  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

@@ -166,6 +166,45 @@ class GetValueResponse(google.protobuf.message.Message):
     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 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
+
+    VALUE_FIELD_NUMBER: builtins.int
+    @property
+    def value(self) -> google.protobuf.any_pb2.Any:
+        """The value, if  it was found"""
+
     def __init__(
         self,
         *,
@@ -175,7 +214,7 @@ class GetValueResponse(google.protobuf.message.Message):
     def ClearField(self, field_name: typing.Literal["_value", b"_value", "value", b"value"]) -> None: ...
     def WhichOneof(self, oneof_group: typing.Literal["_value", b"_value"]) -> typing.Literal["value"] | None: ...
 
-global___GetValueResponse = GetValueResponse
+global___TryGetValueResponse = TryGetValueResponse
 
 @typing.final
 class SetValueRequest(google.protobuf.message.Message):

src/ni/pythonpanel/v1/python_panel_service_pb2.pyi

@@ -35,6 +35,11 @@ def __init__(self, channel):
                 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,
+                response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueResponse.FromString,
+                )
         self.SetValue = channel.unary_unary(
                 '/ni.pythonpanel.v1.PythonPanelService/SetValue',
                 request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.SetValueRequest.SerializeToString,
@@ -49,8 +54,12 @@ class PythonPanelServiceServicer(object):
     def StartPanel(self, request, context):
         """Start a panel (or connect to if it has already been started)
         Status Codes for errors:
-        - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
-        - NOT_FOUND: the file for the panel was not found
+        - INVALID_ARGUMENT: 
+        - The panel script filename doesn't end in .py.
+        - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+        - NOT_FOUND: 
+        - The panel script file was not found.
+        - The python executable file was not found.
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
@@ -59,7 +68,8 @@ def StartPanel(self, request, context):
     def StopPanel(self, request, context):
         """Stop a panel
         Status Codes for errors:
-        - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+        - INVALID_ARGUMENT:
+        - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
@@ -76,7 +86,22 @@ def EnumeratePanels(self, request, context):
     def GetValue(self, request, context):
         """Get a value for a control on the panel
         Status Codes for errors:
-        - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+        - 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:
+        - 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.
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
@@ -85,7 +110,9 @@ def GetValue(self, request, context):
     def SetValue(self, request, context):
         """Set a value for a control on the panel
         Status Codes for errors:
-        - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+        - 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.
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
@@ -114,6 +141,11 @@ def add_PythonPanelServiceServicer_to_server(servicer, server):
                     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,
+                    response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueResponse.SerializeToString,
+            ),
             'SetValue': grpc.unary_unary_rpc_method_handler(
                     servicer.SetValue,
                     request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.SetValueRequest.FromString,
@@ -198,6 +230,23 @@ def GetValue(request,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
 
+    @staticmethod
+    def TryGetValue(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/TryGetValue',
+            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)
+
     @staticmethod
     def SetValue(request,
             target,