extract StreamlitPanelConfiguration to streamlit_panel_configuration.proto

Author: Mike Prosser

CONTRIBUTING.md

@@ -22,7 +22,7 @@ See [GitHub's official documentation](https://help.github.com/articles/using-pul
 # Getting Started
 
 This is the command to generate the files in /src/ni/panels/v1/:
-`poetry run python -m grpc_tools.protoc --proto_path=protos --python_out=src/ --grpc_python_out=src/ --mypy_out=src/ --mypy_grpc_out=src/ ni/panels/v1/panel_service.proto ni/panels/v1/panel_types.proto`
+`poetry run python -m grpc_tools.protoc --proto_path=protos --python_out=src/ --grpc_python_out=src/ --mypy_out=src/ --mypy_grpc_out=src/ ni/panels/v1/panel_service.proto ni/panels/v1/panel_types.proto ni/panels/v1/streamlit_panel_configuration.proto`
 
 # Testing
 

protos/ni/panels/v1/panel_service.proto

@@ -59,23 +59,12 @@ service PanelService {
   rpc SetValue(SetValueRequest) returns (SetValueResponse);
 }
 
-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;
 
-  // Configuration for the panel
-  oneof panel_configuration {
-    StreamlitPanelConfiguration streamlit_panel_configuration = 2;
-  }
+  // Configuration for the panel, packed as Any
+  google.protobuf.Any panel_configuration = 2;
 }
 
 message StartPanelResponse {

protos/ni/panels/v1/streamlit_panel_configuration.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package ni.panels.v1;
+
+option cc_enable_arenas = true;
+option csharp_namespace = "NationalInstruments.Panels.V1";
+option go_package = "panelsv1";
+option java_multiple_files = true;
+option java_outer_classname = "StreamlitPanelConfigurationProto";
+option java_package = "com.ni.panels.v1";
+option objc_class_prefix = "NIPS";
+option php_namespace = "NI\\Panels\\V1";
+option ruby_package = "NI::Panels::V1";
+
+// Pack this into PanelService.StartPanelRequest.panel_configuration to start a Streamlit panel.
+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;
+}

src/ni/panels/v1/panel_service_pb2.py

@@ -13,45 +13,26 @@ import typing
 
 DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 
-@typing.final
-class StreamlitPanelConfiguration(google.protobuf.message.Message):
-    DESCRIPTOR: google.protobuf.descriptor.Descriptor
-
-    PANEL_SCRIPT_PATH_FIELD_NUMBER: builtins.int
-    PYTHON_PATH_FIELD_NUMBER: builtins.int
-    panel_script_path: builtins.str
-    """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_script_path: builtins.str = ...,
-        python_path: builtins.str = ...,
-    ) -> 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_CONFIGURATION_FIELD_NUMBER: builtins.int
     panel_id: builtins.str
     """Unique ID of the panel"""
     @property
-    def streamlit_panel_configuration(self) -> global___StreamlitPanelConfiguration: ...
+    def panel_configuration(self) -> google.protobuf.any_pb2.Any:
+        """Configuration for the panel, packed as Any"""
+
     def __init__(
         self,
         *,
         panel_id: builtins.str = ...,
-        streamlit_panel_configuration: global___StreamlitPanelConfiguration | None = ...,
+        panel_configuration: google.protobuf.any_pb2.Any | 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: ...
+    def HasField(self, field_name: typing.Literal["panel_configuration", b"panel_configuration"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["panel_configuration", b"panel_configuration", "panel_id", b"panel_id"]) -> None: ...
 
 global___StartPanelRequest = StartPanelRequest
 

src/ni/panels/v1/panel_service_pb2.pyi

@@ -0,0 +1,33 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class StreamlitPanelConfiguration(google.protobuf.message.Message):
+    """Pack this into PanelService.StartPanelRequest.panel_configuration to start a Streamlit panel."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PANEL_SCRIPT_PATH_FIELD_NUMBER: builtins.int
+    PYTHON_PATH_FIELD_NUMBER: builtins.int
+    panel_script_path: builtins.str
+    """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_script_path: builtins.str = ...,
+        python_path: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["panel_script_path", b"panel_script_path", "python_path", b"python_path"]) -> None: ...
+
+global___StreamlitPanelConfiguration = StreamlitPanelConfiguration

src/ni/panels/v1/streamlit_panel_configuration_pb2.py

@@ -0,0 +1,4 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+

src/ni/panels/v1/streamlit_panel_configuration_pb2.pyi

@@ -0,0 +1,17 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import abc
+import collections.abc
+import grpc
+import grpc.aio
+import typing
+
+_T = typing.TypeVar("_T")
+
+class _MaybeAsyncIterator(collections.abc.AsyncIterator[_T], collections.abc.Iterator[_T], metaclass=abc.ABCMeta): ...
+
+class _ServicerContext(grpc.ServicerContext, grpc.aio.ServicerContext):  # type: ignore[misc, type-arg]
+    ...

src/ni/panels/v1/streamlit_panel_configuration_pb2_grpc.py

@@ -5,8 +5,8 @@
 from typing import Callable, TypeVar
 
 import grpc
+from google.protobuf.any_pb2 import Any
 from ni.panels.v1.panel_service_pb2 import (
-    StreamlitPanelConfiguration,
     StartPanelRequest,
     StopPanelRequest,
     EnumeratePanelsRequest,
@@ -15,6 +15,7 @@
     SetValueRequest,
 )
 from ni.panels.v1.panel_service_pb2_grpc import PanelServiceStub
+from ni.panels.v1.streamlit_panel_configuration_pb2 import StreamlitPanelConfiguration
 from ni_measurement_plugin_sdk_service.discovery import DiscoveryClient
 from ni_measurement_plugin_sdk_service.grpc.channelpool import GrpcChannelPool
 from typing_extensions import ParamSpec
@@ -52,8 +53,10 @@ def start_streamlit_panel(self, panel_id: str, panel_script_path: str, python_pa
         streamlit_panel_configuration = StreamlitPanelConfiguration(
             panel_script_path=panel_script_path, python_path=python_path
         )
+        panel_configuration_any = Any()
+        panel_configuration_any.Pack(streamlit_panel_configuration)
         start_panel_request = StartPanelRequest(
-            panel_id=panel_id, streamlit_panel_configuration=streamlit_panel_configuration
+            panel_id=panel_id, panel_configuration=panel_configuration_any
         )
         response = self._invoke_with_retry(self._get_stub().StartPanel, start_panel_request)
         return response.panel_uri