remove clear_value, has_value, and get_value_ids

Author: Mike Prosser

protos/ni/pythonpanel/v1/python_panel_service.proto

@@ -37,10 +37,6 @@ service PythonPanelService {
   // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
   rpc SetValue(SetValueRequest) returns (SetValueResponse);
 
-  // Clear a value for a control on the panel
-  // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
-  rpc ClearValue(ClearValueRequest) returns (ClearValueResponse);
-
   // Close a panel
   // Status Codes for errors:
   // - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
@@ -104,17 +100,6 @@ message SetValueRequest {
 message SetValueResponse {
 }
 
-message ClearValueRequest {
-  // Unique ID of the panel
-  string panel_id = 1;
-
-  // Unique ID of the value
-  string value_id = 2;
-}
-
-message ClearValueResponse {
-}
-
 message ClosePanelRequest {
   // Unique ID of the panel
   string panel_id = 1;

src/ni/pythonpanel/v1/python_panel_service_pb2.py

@@ -173,36 +173,6 @@ class SetValueResponse(google.protobuf.message.Message):
 
 global___SetValueResponse = SetValueResponse
 
-@typing.final
-class ClearValueRequest(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 the 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___ClearValueRequest = ClearValueRequest
-
-@typing.final
-class ClearValueResponse(google.protobuf.message.Message):
-    DESCRIPTOR: google.protobuf.descriptor.Descriptor
-
-    def __init__(
-        self,
-    ) -> None: ...
-
-global___ClearValueResponse = ClearValueResponse
-
 @typing.final
 class ClosePanelRequest(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor

src/ni/pythonpanel/v1/python_panel_service_pb2.pyi

@@ -35,11 +35,6 @@ def __init__(self, channel):
                 request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.SetValueRequest.SerializeToString,
                 response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.SetValueResponse.FromString,
                 )
-        self.ClearValue = channel.unary_unary(
-                '/ni.pythonpanel.v1.PythonPanelService/ClearValue',
-                request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.ClearValueRequest.SerializeToString,
-                response_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.ClearValueResponse.FromString,
-                )
         self.ClosePanel = channel.unary_unary(
                 '/ni.pythonpanel.v1.PythonPanelService/ClosePanel',
                 request_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.ClosePanelRequest.SerializeToString,
@@ -88,14 +83,6 @@ def SetValue(self, request, context):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
-    def ClearValue(self, request, context):
-        """Clear a value for a control on the panel
-        - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
-        """
-        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
-        context.set_details('Method not implemented!')
-        raise NotImplementedError('Method not implemented!')
-
     def ClosePanel(self, request, context):
         """Close a panel
         Status Codes for errors:
@@ -128,11 +115,6 @@ def add_PythonPanelServiceServicer_to_server(servicer, server):
                     request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.SetValueRequest.FromString,
                     response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.SetValueResponse.SerializeToString,
             ),
-            'ClearValue': grpc.unary_unary_rpc_method_handler(
-                    servicer.ClearValue,
-                    request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.ClearValueRequest.FromString,
-                    response_serializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.ClearValueResponse.SerializeToString,
-            ),
             'ClosePanel': grpc.unary_unary_rpc_method_handler(
                     servicer.ClosePanel,
                     request_deserializer=ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.ClosePanelRequest.FromString,
@@ -217,23 +199,6 @@ def SetValue(request,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
 
-    @staticmethod
-    def ClearValue(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/ClearValue',
-            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.ClearValueRequest.SerializeToString,
-            ni_dot_pythonpanel_dot_v1_dot_python__panel__service__pb2.ClearValueResponse.FromString,
-            options, channel_credentials,
-            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
-
     @staticmethod
     def ClosePanel(request,
             target,

src/ni/pythonpanel/v1/python_panel_service_pb2_grpc.py

@@ -58,14 +58,6 @@ class PythonPanelServiceStub:
     - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
     """
 
-    ClearValue: grpc.UnaryUnaryMultiCallable[
-        ni.pythonpanel.v1.python_panel_service_pb2.ClearValueRequest,
-        ni.pythonpanel.v1.python_panel_service_pb2.ClearValueResponse,
-    ]
-    """Clear a value for a control on the panel
-    - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
-    """
-
     ClosePanel: grpc.UnaryUnaryMultiCallable[
         ni.pythonpanel.v1.python_panel_service_pb2.ClosePanelRequest,
         ni.pythonpanel.v1.python_panel_service_pb2.ClosePanelResponse,
@@ -115,14 +107,6 @@ class PythonPanelServiceAsyncStub:
     - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
     """
 
-    ClearValue: grpc.aio.UnaryUnaryMultiCallable[
-        ni.pythonpanel.v1.python_panel_service_pb2.ClearValueRequest,
-        ni.pythonpanel.v1.python_panel_service_pb2.ClearValueResponse,
-    ]
-    """Clear a value for a control on the panel
-    - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
-    """
-
     ClosePanel: grpc.aio.UnaryUnaryMultiCallable[
         ni.pythonpanel.v1.python_panel_service_pb2.ClosePanelRequest,
         ni.pythonpanel.v1.python_panel_service_pb2.ClosePanelResponse,
@@ -180,16 +164,6 @@ class PythonPanelServiceServicer(metaclass=abc.ABCMeta):
         - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
         """
 
-    @abc.abstractmethod
-    def ClearValue(
-        self,
-        request: ni.pythonpanel.v1.python_panel_service_pb2.ClearValueRequest,
-        context: _ServicerContext,
-    ) -> typing.Union[ni.pythonpanel.v1.python_panel_service_pb2.ClearValueResponse, collections.abc.Awaitable[ni.pythonpanel.v1.python_panel_service_pb2.ClearValueResponse]]:
-        """Clear a value for a control on the panel
-        - INVALID_ARGUMENT: The specified identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
-        """
-
     @abc.abstractmethod
     def ClosePanel(
         self,

src/ni/pythonpanel/v1/python_panel_service_pb2_grpc.pyi

@@ -13,7 +13,6 @@
     EnumeratePanelsRequest,
     GetValueRequest,
     SetValueRequest,
-    ClearValueRequest,
 )
 from ni.pythonpanel.v1.python_panel_service_pb2_grpc import PythonPanelServiceStub
 from ni_measurement_plugin_sdk_service.discovery import DiscoveryClient
@@ -120,16 +119,6 @@ def get_value(self, panel_id: str, value_id: str) -> object:
         the_value = from_any(response.value)
         return the_value
 
-    def clear_value(self, panel_id: str, value_id: str) -> None:
-        """Clear the value for the control with value_id.
-
-        Args:
-            panel_id: The ID of the panel.
-            value_id: The ID of the control.
-        """
-        clear_value_request = ClearValueRequest(panel_id=panel_id, value_id=value_id)
-        self._invoke_with_retry(self._get_stub().ClearValue, clear_value_request)
-
     def _get_stub(self) -> PythonPanelServiceStub:
         if self._stub is None:
             if self._grpc_channel is not None:

src/nipanel/_panel_client.py

@@ -58,30 +58,3 @@ def set_value(self, value_id: str, value: object) -> None:
             value: The value
         """
         self._panel_client.set_value(self._panel_id, value_id, value)
-
-    def clear_value(self, value_id: str) -> None:
-        """Clear the value for a control on the panel.
-
-        Args:
-            value_id: The id of the value
-        """
-        self._panel_client.clear_value(self._panel_id, value_id)
-
-    def has_value(self, value_id: str) -> bool:
-        """Check if the panel has a value with the given ID.
-
-        Args:
-            value_id: The id of the value
-
-        Returns:
-            True if the panel has the value, False otherwise.
-        """
-        return value_id in self.get_value_ids()
-
-    def get_value_ids(self) -> list[str]:
-        """Get the value IDs that have been set for the panel.
-
-        Returns:
-            A list of value IDs for the panel.
-        """
-        return self._panel_client.enumerate_panels()[self._panel_id][1]

src/nipanel/_panel_value_accessor.py

@@ -68,29 +68,6 @@ def test___set_value___enumerate_panels_shows_value(
     assert client.enumerate_panels() == {"panel1": (False, ["val1"])}
 
 
-def test___set_value___clear_value___enumerate_panels_shows_no_value(
-    fake_panel_channel: grpc.Channel,
-) -> None:
-    client = create_panel_client(fake_panel_channel)
-    client.set_value("panel1", "val1", "value1")
-
-    client.clear_value("panel1", "val1")
-
-    assert client.enumerate_panels() == {"panel1": (False, [])}
-
-
-def test___set_values___clear_value_2___enumerate_panels_has_value_1(
-    fake_panel_channel: grpc.Channel,
-) -> None:
-    client = create_panel_client(fake_panel_channel)
-    client.set_value("panel1", "val1", "value1")
-    client.set_value("panel1", "val2", "value2")
-
-    client.clear_value("panel1", "val2")
-
-    assert client.enumerate_panels() == {"panel1": (False, ["val1"])}
-
-
 def test___set_value___gets_value(fake_panel_channel: grpc.Channel) -> None:
     client = create_panel_client(fake_panel_channel)
 

tests/unit/test_panel_client.py

@@ -111,7 +111,7 @@ def test___first_open_panel_fails___open_panel___gets_value(
     assert panel.get_value(value_id) == string_value
 
 
-def test___unopened_panel___set_value___has_value(
+def test___unopened_panel___set_value___client_has_value(
     fake_panel_channel: grpc.Channel,
 ) -> None:
     """Test that set_value() succeeds before the user opens the panel."""
@@ -121,21 +121,7 @@ def test___unopened_panel___set_value___has_value(
     string_value = "test_value"
     panel.set_value(value_id, string_value)
 
-    assert panel.has_value(value_id)
-
-
-def test___set_value___clear_value___does_not_have_value(
-    fake_panel_channel: grpc.Channel,
-) -> None:
-    """Test that set_value() succeeds before the user opens the panel."""
-    panel = StreamlitPanel("my_panel", "path/to/script", grpc_channel=fake_panel_channel)
-    value_id = "test_id"
-    string_value = "test_value"
-    panel.set_value(value_id, string_value)
-
-    panel.clear_value(value_id)
-
-    assert not panel.has_value(value_id)
+    assert panel._panel_client.enumerate_panels() == {"my_panel": (False, [value_id])}
 
 
 def test___unopened_panel___get_unset_value___raises_exception(

tests/unit/test_streamlit_panel.py

@@ -13,8 +13,6 @@
     GetValueResponse,
     SetValueRequest,
     SetValueResponse,
-    ClearValueRequest,
-    ClearValueResponse,
 )
 from ni.pythonpanel.v1.python_panel_service_pb2_grpc import PythonPanelServiceServicer
 
@@ -69,14 +67,6 @@ def SetValue(self, request: SetValueRequest, context: Any) -> SetValueResponse:
         self._panel_value_ids[request.panel_id][request.value_id] = request.value
         return SetValueResponse()
 
-    def ClearValue(  # noqa: N802
-        self, request: ClearValueRequest, context: Any
-    ) -> ClearValueResponse:
-        """Trivial implementation for testing."""
-        if request.panel_id in self._panel_value_ids:
-            self._panel_value_ids[request.panel_id].pop(request.value_id, None)
-        return ClearValueResponse()
-
     def fail_next_open_panel(self) -> None:
         """Set whether the OpenPanel method should fail the next time it is called."""
         self._fail_next_open_panel = True