Merge remote-tracking branch 'origin/main' into users/jfriedri/lofi-support-for-builtin-sequences

Author: jfriedri-ni

.github/workflows/report_test_results.yml

@@ -24,7 +24,7 @@ jobs:
       - name: List downloaded files
         run: ls -lR
       - name: Publish test results
-        uses: EnricoMi/publish-unit-test-result-action@afb2984f4d89672b2f9d9c13ae23d53779671984 # v2.19.0
+        uses: EnricoMi/publish-unit-test-result-action@3a74b2957438d0b6e2e61d67b05318aa25c9e6c6 # v2.20.0
         with:
           files: "test_results/**/*.xml"
         if: always()

examples/sample/README.md

@@ -0,0 +1,15 @@
+## Sample
+
+This is a nipanel example that displays an interactive Streamlit app and updates its values.
+
+### Feature
+
+- Supports various data types
+
+### Required Software
+
+- Python 3.9 or later
+
+### Usage
+
+Run `poetry run examples/sample/sample.py`

examples/sample/sample.py

@@ -0,0 +1,22 @@
+"""This example demonstrates how to open/update a Streamlit application using nipanel package."""
+
+import pathlib
+
+import nipanel
+
+script_path = pathlib.Path(__file__)
+panel_script_path = str(script_path.with_name("sample_panel.py"))
+
+panel = nipanel.StreamlitPanel(
+    panel_id="sample_panel",
+    streamlit_script_uri=panel_script_path,
+)
+panel.open_panel()
+panel.set_value("sample_string", "Hello, World!")
+panel.set_value("sample_int", 42)
+panel.set_value("sample_float", 3.14)
+panel.set_value("sample_bool", True)
+
+input("Press Enter to close the panel...")
+
+panel.close_panel(reset=True)

examples/sample/sample_panel.py

@@ -0,0 +1,23 @@
+"""Streamlit application script for displaying values using nipanel package."""
+
+import streamlit as st
+
+import nipanel
+
+panel = nipanel.StreamlitPanelValueAccessor(panel_id="sample_panel")
+
+st.title("Sample Panel")
+
+col1, col2 = st.columns([0.4, 0.6])
+
+with col1:
+    st.write("String")
+    st.write("Integer")
+    st.write("Float")
+    st.write("Boolean")
+
+with col2:
+    st.write(panel.get_value("sample_string"))
+    st.write(panel.get_value("sample_int"))
+    st.write(panel.get_value("sample_float"))
+    st.write(panel.get_value("sample_bool"))

poetry.lock

@@ -16,20 +16,39 @@ option ruby_package = "NI::PythonPanel::V1";
 
 // Service interface for interacting with python panels
 service PythonPanelService {
+  // Enumerate the panels available in the system
+  // Status Codes for errors:
+  rpc EnumeratePanels(EnumeratePanelsRequest) returns (EnumeratePanelsResponse);
+
   // Open a panel
   // 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
   rpc OpenPanel(OpenPanelRequest) returns (OpenPanelResponse);
 
   // Get a value for a control on the panel
   // Status Codes for errors:
-  // - NOT_FOUND: the panel with the specified id was not found
+  // - INVALID_ARGUMENT: The specified 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);
 
   // Set a value for a control on the panel
   // Status Codes for errors:
-  // - NOT_FOUND: the panel with the specified id was not found
+  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
   rpc SetValue(SetValueRequest) returns (SetValueResponse);
+
+  // Close a panel
+  // Status Codes for errors:
+  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
+  rpc ClosePanel(ClosePanelRequest) returns (ClosePanelResponse);
+}
+
+message EnumeratePanelsRequest {
+}
+
+message EnumeratePanelsResponse {
+  // The list of panels available in the system
+  repeated string panel_ids = 1;
 }
 
 message OpenPanelRequest {
@@ -40,12 +59,12 @@ message OpenPanelRequest {
   string panel_uri = 2;
 }
 
-message OpenPanelResponse {  
+message OpenPanelResponse {
 }
 
 message GetValueRequest {
   // Unique ID of the panel
-  string panel_id = 1;  
+  string panel_id = 1;
 
   // Unique ID of value
   string value_id = 2;
@@ -58,14 +77,25 @@ message GetValueResponse {
 
 message SetValueRequest {
   // Unique ID of the panel
-  string panel_id = 1;  
-  
+  string panel_id = 1;
+
   // Unique ID of the value
   string value_id = 2;
 
   // The value
   google.protobuf.Any value = 3;
 }
 
-message SetValueResponse {  
+message SetValueResponse {
+}
+
+message ClosePanelRequest {
+  // Unique ID of the panel
+  string panel_id = 1;
+
+  // Reset all storage associated with panel
+  bool reset = 2;
+}
+
+message ClosePanelResponse {
 }

protos/ni/pythonpanel/v1/python_panel_service.proto

@@ -4,13 +4,43 @@ isort:skip_file
 """
 
 import builtins
+import collections.abc
 import google.protobuf.any_pb2
 import google.protobuf.descriptor
+import google.protobuf.internal.containers
 import google.protobuf.message
 import typing
 
 DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 
+@typing.final
+class EnumeratePanelsRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    def __init__(
+        self,
+    ) -> None: ...
+
+global___EnumeratePanelsRequest = EnumeratePanelsRequest
+
+@typing.final
+class EnumeratePanelsResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PANEL_IDS_FIELD_NUMBER: builtins.int
+    @property
+    def panel_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """The list of panels available in the system"""
+
+    def __init__(
+        self,
+        *,
+        panel_ids: collections.abc.Iterable[builtins.str] | None = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["panel_ids", b"panel_ids"]) -> None: ...
+
+global___EnumeratePanelsResponse = EnumeratePanelsResponse
+
 @typing.final
 class OpenPanelRequest(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
@@ -116,3 +146,33 @@ class SetValueResponse(google.protobuf.message.Message):
     ) -> None: ...
 
 global___SetValueResponse = SetValueResponse
+
+@typing.final
+class ClosePanelRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PANEL_ID_FIELD_NUMBER: builtins.int
+    RESET_FIELD_NUMBER: builtins.int
+    panel_id: builtins.str
+    """Unique ID of the panel"""
+    reset: builtins.bool
+    """Reset all storage associated with panel"""
+    def __init__(
+        self,
+        *,
+        panel_id: builtins.str = ...,
+        reset: builtins.bool = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["panel_id", b"panel_id", "reset", b"reset"]) -> None: ...
+
+global___ClosePanelRequest = ClosePanelRequest
+
+@typing.final
+class ClosePanelResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    def __init__(
+        self,
+    ) -> None: ...
+
+global___ClosePanelResponse = ClosePanelResponse