refactor to make StreamlitPanel public instead of Panel

Author: Mike Prosser

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
     "python.testing.pytestArgs": [
-        "tests"
+        "."
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true

pyproject.toml

@@ -52,3 +52,7 @@ ignore_missing_imports = true
 skips = [
   "B101", # assert_used
 ]
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules --strict-markers"
+testpaths = ["src/nipanel", "tests"]

src/nipanel/__init__.py

@@ -1,8 +1,8 @@
 """The NI Panel."""
 
-from nipanel._panel import Panel
+from nipanel._streamlit_panel import StreamlitPanel
 
-__all__ = ["Panel"]
+__all__ = ["StreamlitPanel"]
 
 # Hide that it was defined in a helper file
-Panel.__module__ = __name__
+StreamlitPanel.__module__ = __name__

src/nipanel/_panel.py

@@ -18,6 +18,17 @@
 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 __init__(self, panel_uri: str) -> None:
+        """Initialize the panel."""
+        self._panel_uri = panel_uri
+        self._panel_id = str(uuid.uuid4())
+
     def __enter__(self) -> Self:
         """Enter the runtime context related to this object."""
         self.connect()
@@ -33,17 +44,16 @@ def __exit__(
         self.disconnect()
         return None
 
-    @abstractmethod
     def connect(self) -> None:
         """Connect to the panel and open it."""
-        pass
+        # TODO: AB#3095680 - Use gRPC pool management, create the _stub, and call _stub.Connect
+        self._resolve_service_location()
 
-    @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.
 
@@ -53,56 +63,20 @@ def get_value(self, value_id: str) -> object:
         Returns:
             The value
         """
-        pass
+        # TODO: AB#3095681 - get the Any from _stub.GetValue and convert it to the correct type
+        return "placeholder value"
 
-    @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
+
+    @abstractmethod
+    def _resolve_service_location(self) -> str:
+        """Resolve the service location for the panel."""
+        raise NotImplementedError

src/nipanel/_streamlit_panel.py

@@ -0,0 +1,22 @@
+from nipanel._panel import Panel
+
+
+class StreamlitPanel(Panel):
+    """This class allows you to connect to a Streamlit panel and specify values for its controls."""
+
+    __slots__ = ()
+
+    def __init__(self, streamlit_script_uri: str) -> None:
+        """Create a panel using a Streamlit script for the user interface.
+
+        Args:
+            streamlit_script_uri: The file path of the Streamlit script.
+
+        Returns:
+            A new StreamlitPanel instance.
+        """
+        super().__init__(streamlit_script_uri)
+
+    def _resolve_service_location(self) -> str:
+        # TODO: AB#3095680 - resolve to the Streamlit PythonPanelService
+        return ""

tests/unit/test_panel.py

@@ -1,8 +1,20 @@
 import nipanel
 
 
+def test___streamlit_panel___has_panel_id_and_panel_uri() -> None:
+    panel = nipanel.StreamlitPanel("path/to/script")
+    assert panel._panel_id is not None
+    assert panel._panel_uri == "path/to/script"
+
+
+def test___two_panels___have_different_panel_ids() -> None:
+    panel1 = nipanel.StreamlitPanel("path/to/script1")
+    panel2 = nipanel.StreamlitPanel("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 = nipanel.StreamlitPanel("path/to/script")
     panel.connect()
 
     panel.set_value("test_id", "test_value")
@@ -13,7 +25,7 @@ def test___connected_panel___set_value___gets_same_value() -> None:
 
 
 def test___with_panel___set_value___gets_same_value() -> None:
-    with nipanel.Panel.streamlit_panel("path/to/script") as panel:
+    with nipanel.StreamlitPanel("path/to/script") as panel:
 
         panel.set_value("test_id", "test_value")