rename to TryGetValue

Author: Mike Prosser

protos/ni/pythonpanel/v1/python_panel_service.proto

@@ -18,27 +18,36 @@ 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.
   // Status Codes for errors:
   rpc EnumeratePanels(EnumeratePanelsRequest) returns (EnumeratePanelsResponse);
 
-  // Get a value for a control on the panel
+  // Try to 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.
-  rpc GetValue(GetValueRequest) returns (GetValueResponse);
+  // - 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);
 }
 
@@ -88,16 +97,16 @@ message EnumeratePanelsResponse {
   repeated PanelInformation panels = 1;
 }
 
-message GetValueRequest {
+message TryGetValueRequest {
   // Unique ID of the panel
   string panel_id = 1;
 
   // Unique ID of value
   string value_id = 2;
 }
 
-message GetValueResponse {
-  // The value
+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 GetValueRequest(google.protobuf.message.Message):
+class TryGetValueRequest(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
     PANEL_ID_FIELD_NUMBER: builtins.int
@@ -155,16 +155,16 @@ class GetValueRequest(google.protobuf.message.Message):
     ) -> None: ...
     def ClearField(self, field_name: typing.Literal["panel_id", b"panel_id", "value_id", b"value_id"]) -> None: ...
 
-global___GetValueRequest = GetValueRequest
+global___TryGetValueRequest = TryGetValueRequest
 
 @typing.final
-class GetValueResponse(google.protobuf.message.Message):
+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"""
+        """The value, if  it was found"""
 
     def __init__(
         self,
@@ -175,7 +175,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

@@ -30,10 +30,10 @@ 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,
+                response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueResponse.FromString,
                 )
         self.SetValue = channel.unary_unary(
                 '/ni.pythonpanel.v1.PythonPanelService/SetValue',
@@ -49,8 +49,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 +63,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!')
@@ -73,10 +78,12 @@ 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
+    def TryGetValue(self, request, context):
+        """Try to 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.
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
@@ -85,7 +92,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!')
@@ -109,10 +118,10 @@ 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,
+                    response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.TryGetValueResponse.SerializeToString,
             ),
             'SetValue': grpc.unary_unary_rpc_method_handler(
                     servicer.SetValue,
@@ -182,7 +191,7 @@ def EnumeratePanels(request,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
 
     @staticmethod
-    def GetValue(request,
+    def TryGetValue(request,
             target,
             options=(),
             channel_credentials=None,
@@ -192,9 +201,9 @@ def GetValue(request,
             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,
+        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)