_PanelClient should not be public

Author: Mike Prosser

src/nipanel/_panel_client.py

@@ -1,5 +1,3 @@
-"""Client for accessing the NI Python Panel Service."""
-
 from __future__ import annotations
 
 import logging
@@ -31,9 +29,7 @@
 _logger = logging.getLogger(__name__)
 
 
-class PanelClient:
-    """Client for accessing the NI Python Panel Service."""
-
+class _PanelClient:
     def __init__(
         self,
         *,
@@ -43,15 +39,6 @@ def __init__(
         grpc_channel_pool: GrpcChannelPool | None = None,
         grpc_channel: grpc.Channel | None = None,
     ) -> None:
-        """Initialize the panel client.
-
-        Args:
-            provided_interface: The interface provided by the service.
-            service_class: The class of the service.
-            discovery_client: An optional discovery client.
-            grpc_channel: An optional panel gRPC channel.
-            grpc_channel_pool: An optional gRPC channel pool.
-        """
         self._initialization_lock = threading.Lock()
         self._provided_interface = provided_interface
         self._service_class = service_class
@@ -61,51 +48,17 @@ def __init__(
         self._stub: PythonPanelServiceStub | None = None
 
     def start_panel(self, panel_id: str, panel_script_path: str, python_path: str) -> str:
-        """Start the panel.
-
-        Args:
-            panel_id: The ID of the panel to start.
-            panel_script_path: The path of the panel script file.
-            python_path: The path to the Python executable.
-
-        Returns:
-            The URL of the panel.
-
-        Raises:
-            grpc.RpcError: With status code:
-                - INVALID_ARGUMENT: If the panel script filename doesn't end in .py, or
-                  if the panel identifier contains invalid characters (only alphanumeric
-                  characters and underscores are allowed).
-                - NOT_FOUND: If the panel script file or Python executable file was not found.
-        """
         start_panel_request = StartPanelRequest(
             panel_id=panel_id, panel_script_path=panel_script_path, python_path=python_path
         )
         response = self._invoke_with_retry(self._get_stub().StartPanel, start_panel_request)
         return response.panel_url
 
     def stop_panel(self, panel_id: str, reset: bool) -> None:
-        """Stop the panel.
-
-        Args:
-            panel_id: The ID of the panel to stop.
-            reset: Whether to reset all storage associated with panel.
-
-        Raises:
-            grpc.RpcError: With status code:
-                - INVALID_ARGUMENT: If the panel identifier contains invalid characters
-                  (only alphanumeric characters and underscores are allowed).
-        """
         stop_panel_request = StopPanelRequest(panel_id=panel_id, reset=reset)
         self._invoke_with_retry(self._get_stub().StopPanel, stop_panel_request)
 
     def enumerate_panels(self) -> dict[str, tuple[str, list[str]]]:
-        """Enumerate all available panels.
-
-        Returns:
-            A dictionary mapping panel IDs to a tuple containing the url of the panel (if it is
-            running) and a list of value IDs associated with the panel.
-        """
         enumerate_panels_request = EnumeratePanelsRequest()
         response = self._invoke_with_retry(
             self._get_stub().EnumeratePanels, enumerate_panels_request
@@ -115,60 +68,18 @@ def enumerate_panels(self) -> dict[str, tuple[str, list[str]]]:
         }
 
     def set_value(self, panel_id: str, value_id: str, value: object, notify: bool) -> None:
-        """Set the value for the control with value_id.
-
-        Args:
-            panel_id: The ID of the panel.
-            value_id: The ID of the control.
-            value: The value to set.
-            notify: Whether to notify other clients of the new value.
-
-        Raises:
-            grpc.RpcError: With status code:
-                - INVALID_ARGUMENT: If the panel identifier or value identifier contains
-                  invalid characters (only alphanumeric characters and underscores are allowed).
-        """
         new_any = to_any(value)
         set_value_request = SetValueRequest(
             panel_id=panel_id, value_id=value_id, value=new_any, notify=notify
         )
         self._invoke_with_retry(self._get_stub().SetValue, set_value_request)
 
     def get_value(self, panel_id: str, value_id: str) -> object:
-        """Get the value for the control with value_id.
-
-        Args:
-            panel_id: The ID of the panel.
-            value_id: The ID of the control.
-
-        Returns:
-            The value.
-
-        Raises:
-            grpc.RpcError: With status code:
-                - INVALID_ARGUMENT: If the panel identifier or value identifier contains
-                  invalid characters (only alphanumeric characters and underscores are allowed).
-                - NOT_FOUND: If the value with the specified identifier was not found.
-        """
         get_value_request = GetValueRequest(panel_id=panel_id, value_id=value_id)
         response = self._invoke_with_retry(self._get_stub().GetValue, get_value_request)
         return from_any(response.value)
 
     def try_get_value(self, panel_id: str, value_id: str) -> object | None:
-        """Try to get the value for the control with value_id.
-
-        Args:
-            panel_id: The ID of the panel.
-            value_id: The ID of the control.
-
-        Returns:
-            The value if found, otherwise None.
-
-        Raises:
-            grpc.RpcError: With status code:
-                - INVALID_ARGUMENT: If the panel identifier or value identifier contains
-                  invalid characters (only alphanumeric characters and underscores are allowed).
-        """
         try_get_value_request = TryGetValueRequest(panel_id=panel_id, value_id=value_id)
         response = self._invoke_with_retry(self._get_stub().TryGetValue, try_get_value_request)
         if response.HasField("value"):

src/nipanel/_panel_value_accessor.py

@@ -9,7 +9,7 @@
 from ni_measurement_plugin_sdk_service.discovery import DiscoveryClient
 from ni_measurement_plugin_sdk_service.grpc.channelpool import GrpcChannelPool
 
-from nipanel._panel_client import PanelClient
+from nipanel._panel_client import _PanelClient
 
 _T = TypeVar("_T")
 
@@ -37,7 +37,7 @@ def __init__(
         grpc_channel: grpc.Channel | None = None,
     ) -> None:
         """Initialize the accessor."""
-        self._panel_client = PanelClient(
+        self._panel_client = _PanelClient(
             provided_interface=provided_interface,
             service_class=service_class,
             discovery_client=discovery_client,

tests/unit/test_panel_client.py

@@ -1,7 +1,7 @@
 import grpc
 import pytest
 
-from nipanel._panel_client import PanelClient
+from nipanel._panel_client import _PanelClient
 
 
 def test___enumerate_is_empty(fake_panel_channel: grpc.Channel) -> None:
@@ -86,8 +86,8 @@ def test___set_value___gets_value(fake_panel_channel: grpc.Channel) -> None:
     assert client.try_get_value("panel1", "val1") == "value1"
 
 
-def create_panel_client(fake_panel_channel: grpc.Channel) -> PanelClient:
-    return PanelClient(
+def create_panel_client(fake_panel_channel: grpc.Channel) -> _PanelClient:
+    return _PanelClient(
         provided_interface="iface",
         service_class="svc",
         grpc_channel=fake_panel_channel,