StreamlitPanelConfiguration

Author: Mike Prosser

protos/ni/pythonpanel/v1/python_panel_service.proto

@@ -16,15 +16,14 @@ option ruby_package = "NI::PythonPanel::V1";
 
 // Service interface for interacting with python panels
 service PythonPanelService {
-  // Start a panel using a streamlit script (or connect to if it has already been started)
+  // Start a panel using the provided configuration (or connect to if it has already been started)
   // Status Codes for errors:
   // - INVALID_ARGUMENT: 
-  //   - The panel script filename doesn't end in .py.
   //   - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  //   - The panel configuration has an invalid argument.
   // - NOT_FOUND: 
-  //   - The panel script file was not found.
-  //   - The python executable file was not found.
-  rpc StartStreamlitPanel(StartStreamlitPanelRequest) returns (StartStreamlitPanelResponse);
+  //   - The panel configuration includes a file that was not found.
+  rpc StartPanel(StartPanelRequest) returns (StartPanelResponse);
 
   // Stop a panel
   // Status Codes for errors:
@@ -60,20 +59,28 @@ service PythonPanelService {
   rpc SetValue(SetValueRequest) returns (SetValueResponse);
 }
 
-message StartStreamlitPanelRequest {
+message StreamlitPanelConfiguration 
+{
+  // Absolute path of the streamlit script file on disk, or network path to the file. This must end in ".py".
+  string panel_script_path = 1;
+
+  // Path to the python interpreter to use for running the streamlit script.
+  string python_path = 2;
+}
+
+message StartPanelRequest {
   // Unique ID of the panel
   string panel_id = 1;
 
-  // Absolute path of the streamlit script file on disk, or network path to the file
-  string panel_script_path = 2;
-
-  // Path to the python interpreter to use for running the streamlit script.
-  string python_path = 3;
+  // Configuration for the panel
+  oneof panel_configuration {
+    StreamlitPanelConfiguration streamlit_panel_configuration = 2;
+  }
 }
 
-message StartStreamlitPanelResponse {
-  // Location of the panel's webpage 
-  string panel_url = 1; 
+message StartPanelResponse {
+  // Location of the panel 
+  string panel_uri = 1; 
 }
 
 message StopPanelRequest {
@@ -94,8 +101,8 @@ message PanelInformation {
   // Unique ID of the panel
   string panel_id = 1;
 
-  // Location of the panel's webpage
-  string panel_url = 2;
+  // Location of the panel
+  string panel_uri = 2;
 
   // IDs of all of the values associated with the panel
   repeated string value_ids = 3;

src/ni/pythonpanel/v1/python_panel_service_pb2.py

@@ -14,44 +14,62 @@ import typing
 DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 
 @typing.final
-class StartStreamlitPanelRequest(google.protobuf.message.Message):
+class StreamlitPanelConfiguration(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
-    PANEL_ID_FIELD_NUMBER: builtins.int
     PANEL_SCRIPT_PATH_FIELD_NUMBER: builtins.int
     PYTHON_PATH_FIELD_NUMBER: builtins.int
-    panel_id: builtins.str
-    """Unique ID of the panel"""
     panel_script_path: builtins.str
-    """Absolute path of the streamlit script file on disk, or network path to the file"""
+    """Absolute path of the streamlit script file on disk, or network path to the file. This must end in ".py"."""
     python_path: builtins.str
     """Path to the python interpreter to use for running the streamlit script."""
     def __init__(
         self,
         *,
-        panel_id: builtins.str = ...,
         panel_script_path: builtins.str = ...,
         python_path: builtins.str = ...,
     ) -> None: ...
-    def ClearField(self, field_name: typing.Literal["panel_id", b"panel_id", "panel_script_path", b"panel_script_path", "python_path", b"python_path"]) -> None: ...
+    def ClearField(self, field_name: typing.Literal["panel_script_path", b"panel_script_path", "python_path", b"python_path"]) -> None: ...
+
+global___StreamlitPanelConfiguration = StreamlitPanelConfiguration
+
+@typing.final
+class StartPanelRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PANEL_ID_FIELD_NUMBER: builtins.int
+    STREAMLIT_PANEL_CONFIGURATION_FIELD_NUMBER: builtins.int
+    panel_id: builtins.str
+    """Unique ID of the panel"""
+    @property
+    def streamlit_panel_configuration(self) -> global___StreamlitPanelConfiguration: ...
+    def __init__(
+        self,
+        *,
+        panel_id: builtins.str = ...,
+        streamlit_panel_configuration: global___StreamlitPanelConfiguration | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["panel_configuration", b"panel_configuration", "streamlit_panel_configuration", b"streamlit_panel_configuration"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["panel_configuration", b"panel_configuration", "panel_id", b"panel_id", "streamlit_panel_configuration", b"streamlit_panel_configuration"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["panel_configuration", b"panel_configuration"]) -> typing.Literal["streamlit_panel_configuration"] | None: ...
 
-global___StartStreamlitPanelRequest = StartStreamlitPanelRequest
+global___StartPanelRequest = StartPanelRequest
 
 @typing.final
-class StartStreamlitPanelResponse(google.protobuf.message.Message):
+class StartPanelResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
-    PANEL_URL_FIELD_NUMBER: builtins.int
-    panel_url: builtins.str
-    """Location of the panel's webpage"""
+    PANEL_URI_FIELD_NUMBER: builtins.int
+    panel_uri: builtins.str
+    """Location of the panel"""
     def __init__(
         self,
         *,
-        panel_url: builtins.str = ...,
+        panel_uri: builtins.str = ...,
     ) -> None: ...
-    def ClearField(self, field_name: typing.Literal["panel_url", b"panel_url"]) -> None: ...
+    def ClearField(self, field_name: typing.Literal["panel_uri", b"panel_uri"]) -> None: ...
 
-global___StartStreamlitPanelResponse = StartStreamlitPanelResponse
+global___StartPanelResponse = StartPanelResponse
 
 @typing.final
 class StopPanelRequest(google.protobuf.message.Message):
@@ -98,12 +116,12 @@ class PanelInformation(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
     PANEL_ID_FIELD_NUMBER: builtins.int
-    PANEL_URL_FIELD_NUMBER: builtins.int
+    PANEL_URI_FIELD_NUMBER: builtins.int
     VALUE_IDS_FIELD_NUMBER: builtins.int
     panel_id: builtins.str
     """Unique ID of the panel"""
-    panel_url: builtins.str
-    """Location of the panel's webpage"""
+    panel_uri: builtins.str
+    """Location of the panel"""
     @property
     def value_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
         """IDs of all of the values associated with the panel"""
@@ -112,10 +130,10 @@ class PanelInformation(google.protobuf.message.Message):
         self,
         *,
         panel_id: builtins.str = ...,
-        panel_url: builtins.str = ...,
+        panel_uri: builtins.str = ...,
         value_ids: collections.abc.Iterable[builtins.str] | None = ...,
     ) -> None: ...
-    def ClearField(self, field_name: typing.Literal["panel_id", b"panel_id", "panel_url", b"panel_url", "value_ids", b"value_ids"]) -> None: ...
+    def ClearField(self, field_name: typing.Literal["panel_id", b"panel_id", "panel_uri", b"panel_uri", "value_ids", b"value_ids"]) -> None: ...
 
 global___PanelInformation = PanelInformation
 

src/ni/pythonpanel/v1/python_panel_service_pb2.pyi

@@ -15,10 +15,10 @@ def __init__(self, channel):
         Args:
             channel: A grpc.Channel.
         """
-        self.StartStreamlitPanel = channel.unary_unary(
-                '/ni.pythonpanel.v1.PythonPanelService/StartStreamlitPanel',
-                request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartStreamlitPanelRequest.SerializeToString,
-                response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartStreamlitPanelResponse.FromString,
+        self.StartPanel = channel.unary_unary(
+                '/ni.pythonpanel.v1.PythonPanelService/StartPanel',
+                request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartPanelRequest.SerializeToString,
+                response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartPanelResponse.FromString,
                 )
         self.StopPanel = channel.unary_unary(
                 '/ni.pythonpanel.v1.PythonPanelService/StopPanel',
@@ -51,15 +51,14 @@ class PythonPanelServiceServicer(object):
     """Service interface for interacting with python panels
     """
 
-    def StartStreamlitPanel(self, request, context):
-        """Start a panel using a streamlit script (or connect to if it has already been started)
+    def StartPanel(self, request, context):
+        """Start a panel using the provided configuration (or connect to if it has already been started)
         Status Codes for errors:
         - INVALID_ARGUMENT: 
-        - The panel script filename doesn't end in .py.
         - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+        - The panel configuration has an invalid argument.
         - NOT_FOUND: 
-        - The panel script file was not found.
-        - The python executable file was not found.
+        - The panel configuration includes a file that was not found.
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
@@ -121,10 +120,10 @@ def SetValue(self, request, context):
 
 def add_PythonPanelServiceServicer_to_server(servicer, server):
     rpc_method_handlers = {
-            'StartStreamlitPanel': grpc.unary_unary_rpc_method_handler(
-                    servicer.StartStreamlitPanel,
-                    request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartStreamlitPanelRequest.FromString,
-                    response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartStreamlitPanelResponse.SerializeToString,
+            'StartPanel': grpc.unary_unary_rpc_method_handler(
+                    servicer.StartPanel,
+                    request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartPanelRequest.FromString,
+                    response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartPanelResponse.SerializeToString,
             ),
             'StopPanel': grpc.unary_unary_rpc_method_handler(
                     servicer.StopPanel,
@@ -163,7 +162,7 @@ class PythonPanelService(object):
     """
 
     @staticmethod
-    def StartStreamlitPanel(request,
+    def StartPanel(request,
             target,
             options=(),
             channel_credentials=None,
@@ -173,9 +172,9 @@ def StartStreamlitPanel(request,
             wait_for_ready=None,
             timeout=None,
             metadata=None):
-        return grpc.experimental.unary_unary(request, target, '/ni.pythonpanel.v1.PythonPanelService/StartStreamlitPanel',
-            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartStreamlitPanelRequest.SerializeToString,
-            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartStreamlitPanelResponse.FromString,
+        return grpc.experimental.unary_unary(request, target, '/ni.pythonpanel.v1.PythonPanelService/StartPanel',
+            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartPanelRequest.SerializeToString,
+            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.StartPanelResponse.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)