cleanup

Author: Mike Prosser

src/nipanel/_panel.py

@@ -60,7 +60,7 @@ def __exit__(
     def connect(self) -> None:
         """Connect to the panel and open it."""
         # TODO: use the channel pool
-        channel = insecure_channel(self._get_channel_url())
+        channel = insecure_channel(self._resolve_service_address())
         self._stub = PythonPanelServiceStub(channel)
         connect_request = ConnectRequest(panel_id=self._panel_id, panel_uri=self._panel_uri)
 
@@ -113,6 +113,6 @@ def set_value(self, value_id: str, value: object) -> None:
         pass
 
     @abstractmethod
-    def _get_channel_url(self) -> str:
+    def _resolve_service_address(self) -> str:
         """Resolve the service location for the panel."""
         raise NotImplementedError

src/nipanel/_streamlit_panel.py

@@ -21,7 +21,7 @@ def __init__(self, panel_id: str, streamlit_script_uri: str) -> None:
         """
         super().__init__(panel_id, streamlit_script_uri)
 
-    def _get_channel_url(self) -> str:
+    def _resolve_service_address(self) -> str:
         with GrpcChannelPool() as grpc_channel_pool:
             discovery_client = DiscoveryClient(grpc_channel_pool=grpc_channel_pool)
             service_location = discovery_client.resolve_service(

tests/unit/test_fake_python_panel_servicer.py

@@ -11,6 +11,7 @@
 def test___connect___gets_response(fake_python_panel_service_stub: PythonPanelServiceStub) -> None:
     request = ConnectRequest(panel_id="test_panel", panel_uri="path/to/panel")
     response = fake_python_panel_service_stub.Connect(request)
+
     assert response is not None  # Ensure response is returned
 
 
@@ -19,6 +20,7 @@ def test___disconnect___gets_response(
 ) -> None:
     request = DisconnectRequest(panel_id="test_panel")
     response = fake_python_panel_service_stub.Disconnect(request)
+
     assert response is not None  # Ensure response is returned
 
 
@@ -27,15 +29,16 @@ def test___get_value___gets_response(
 ) -> None:
     request = GetValueRequest(panel_id="test_panel", value_id="test_value")
     response = fake_python_panel_service_stub.GetValue(request)
+
     assert response is not None  # Ensure response is returned
     assert isinstance(response.value, Any)  # Ensure the value is of type `Any`
 
 
 def test___set_value___gets_response(
     fake_python_panel_service_stub: PythonPanelServiceStub,
 ) -> None:
-    value = Any()
-    value.value = b"test_data"
-    request = SetValueRequest(panel_id="test_panel", value_id="test_value", value=value)
+    test_value = Any(value=b"test_data")
+    request = SetValueRequest(panel_id="test_panel", value_id="test_value", value=test_value)
     response = fake_python_panel_service_stub.SetValue(request)
+
     assert response is not None  # Ensure response is returned

tests/unit/test_panel.py

@@ -1,10 +1,10 @@
 import grpc
 
-from tests.utils._fake_panel import FakePanel
+from tests.utils._port_panel import PortPanel
 
 
 def test___panel___has_panel_id_and_panel_uri() -> None:
-    panel = FakePanel(0, "my_panel", "path/to/script")
+    panel = PortPanel(0, "my_panel", "path/to/script")
     assert panel.panel_id == "my_panel"
     assert panel.panel_uri == "path/to/script"
 
@@ -13,7 +13,7 @@ def test___connected_panel___set_value___gets_same_value(
     fake_python_panel_service: tuple[grpc.Server, int],
 ) -> None:
     _, port = fake_python_panel_service
-    panel = FakePanel(port, "my_panel", "path/to/script")
+    panel = PortPanel(port, "my_panel", "path/to/script")
     panel.connect()
 
     panel.set_value("test_id", "test_value")
@@ -27,7 +27,7 @@ def test___with_panel___set_value___gets_same_value(
     fake_python_panel_service: tuple[grpc.Server, int],
 ) -> None:
     _, port = fake_python_panel_service
-    with FakePanel(port, "my_panel", "path/to/script") as panel:
+    with PortPanel(port, "my_panel", "path/to/script") as panel:
         panel.set_value("test_id", "test_value")
 
         # TODO: AB#3095681 - change asserted value to test_value

tests/utils/_fake_panel.py tests/utils/_port_panel.pytests/utils/_fake_panel.py renamed to tests/utils/_port_panel.py

@@ -1,11 +1,11 @@
 from nipanel._panel import Panel
 
 
-class FakePanel(Panel):
-    """This class allows you to connect to the FakePythonPanelService, for testing."""
+class PortPanel(Panel):
+    """This class allows you to connect to the PythonPanelService with a specified port, for testing."""
 
     def __init__(self, port: int, panel_id: str, panel_uri: str) -> None:
-        """Create a fake panel, for testing.
+        """Create a panel and connect to a specified port, for testing.
 
         Args:
             port: The port number for the gRPC server.
@@ -18,5 +18,5 @@ def __init__(self, port: int, panel_id: str, panel_uri: str) -> None:
         super().__init__(panel_id, panel_uri)
         self.port = port
 
-    def _get_channel_url(self) -> str:
+    def _resolve_service_address(self) -> str:
         return f"localhost:{self.port}"