refactor to use _StreamlitPanel subclass

Author: Mike Prosser

src/nipanel/_panel.py

@@ -2,6 +2,7 @@
 
 import sys
 import uuid
+from abc import ABC, abstractmethod
 from types import TracebackType
 from typing import Optional, Type, TYPE_CHECKING
 
@@ -14,15 +15,9 @@
         from typing_extensions import Self
 
 
-class Panel:
+class Panel(ABC):
     """This class allows you to connect to a panel and specify values for its controls."""
 
-    _stub: PythonPanelServiceStub | None
-    _panel_uri: str
-    _panel_id: str
-
-    __slots__ = ["_stub", "_panel_uri", "_panel_id", "__weakref__"]
-
     def __enter__(self) -> Self:
         """Enter the runtime context related to this object."""
         self.connect()
@@ -38,31 +33,17 @@ def __exit__(
         self.disconnect()
         return None
 
-    @classmethod
-    def streamlit_panel(cls, streamlit_script_path: str) -> Self:
-        """Create a panel using a streamlit script for the user interface.
-
-        Args:
-            streamlit_script_path: The file path of the streamlit script
-
-        Returns:
-            A new panel associated with the streamlit script
-        """
-        panel = cls()
-        panel._panel_uri = streamlit_script_path
-        panel._panel_id = str(uuid.uuid4())
-        return panel
-
+    @abstractmethod
     def connect(self) -> None:
         """Connect to the panel and open it."""
-        # TODO: AB#3095680 - Use gRPC pool management, create the _stub, and call _stub.Connect
         pass
 
+    @abstractmethod
     def disconnect(self) -> None:
         """Disconnect from the panel (does not close the panel)."""
-        # TODO: AB#3095680 - Use gRPC pool management, call _stub.Disconnect
         pass
 
+    @abstractmethod
     def get_value(self, value_id: str) -> object:
         """Get the value for a control on the panel.
 
@@ -72,15 +53,56 @@ def get_value(self, value_id: str) -> object:
         Returns:
             The value
         """
-        # TODO: AB#3095681 - get the Any from _stub.GetValue and convert it to the correct type
-        return "placeholder value"
+        pass
 
+    @abstractmethod
     def set_value(self, value_id: str, value: object) -> None:
         """Set the value for a control on the panel.
 
         Args:
             value_id: The id of the value
             value: The value
         """
+        pass
+
+    @classmethod
+    def streamlit_panel(cls, streamlit_script_path: str) -> Panel:
+        """Create a panel using a streamlit script for the user interface.
+
+        Args:
+            streamlit_script_path: The file path of the Streamlit script.
+
+        Returns:
+            A new StreamlitPanel instance.
+        """
+        return _StreamlitPanel(streamlit_script_path)
+
+
+class _StreamlitPanel(Panel):
+
+    _stub: PythonPanelServiceStub | None
+    _streamlit_script_uri: str
+    _panel_id: str
+
+    __slots__ = ["_stub", "_streamlit_script_uri", "_panel_id"]
+
+    def __init__(self, streamlit_script_uri: str):
+        self._streamlit_script_uri = streamlit_script_uri
+        self._panel_id = str(uuid.uuid4())
+        self._stub = None  # Initialize the gRPC stub
+
+    def connect(self) -> None:
+        # TODO: AB#3095680 - Use gRPC pool management, create the _stub, and call _stub.Connect
+        pass
+
+    def disconnect(self) -> None:
+        # TODO: AB#3095680 - Use gRPC pool management, call _stub.Disconnect
+        pass
+
+    def get_value(self, value_id: str) -> object:
+        # TODO: AB#3095681 - get the Any from _stub.GetValue and convert it to the correct type
+        return "placeholder value"
+
+    def set_value(self, value_id: str, value: object) -> None:
         # TODO: AB#3095681 - Convert the value to an Any and pass it to _stub.SetValue
         pass

tests/unit/test_panel.py

@@ -1,20 +1,6 @@
 import nipanel
 
 
-def test___streamlit_panel___uri_and_id_are_set() -> None:
-    panel = nipanel.Panel.streamlit_panel("path/to/script")
-
-    assert panel._panel_uri == "path/to/script"
-    assert panel._panel_id is not None
-
-
-def test___two_panels___have_different_ids() -> None:
-    panel1 = nipanel.Panel.streamlit_panel("path/to/script1")
-    panel2 = nipanel.Panel.streamlit_panel("path/to/script2")
-
-    assert panel1._panel_id != panel2._panel_id
-
-
 def test___connected_panel___set_value___gets_same_value() -> None:
     panel = nipanel.Panel.streamlit_panel("path/to/script")
     panel.connect()