address feedback

Author: Mike Prosser

src/nipanel/__init__.py

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

src/nipanel/nipanel.py src/nipanel/_panel.pysrc/nipanel/nipanel.py renamed to src/nipanel/_panel.py

@@ -1,20 +1,29 @@
-"""NI Panel."""
+from __future__ import annotations
 
+import sys
 import uuid
 from types import TracebackType
-from typing import Optional, Type
+from typing import Optional, Type, TYPE_CHECKING
 
+from ni.pythonpanel.v1.python_panel_service_pb2_grpc import PythonPanelServiceStub
 
-class NiPanel:
-    """This class allows you to access controls on the panel."""
+if TYPE_CHECKING:
+    if sys.version_info >= (3, 11):
+        from typing import Self
+    else:
+        from typing_extensions import Self
 
-    def __init__(self) -> None:
-        """Initialize the NiPanel instance."""
-        self._stub = None  # will be a PythonPanelServiceStub
-        self.panel_uri = ""
-        self.panel_id = ""
 
-    def __enter__(self) -> "NiPanel":
+class Panel:
+    """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()
         return self
@@ -30,18 +39,18 @@ def __exit__(
         return None
 
     @classmethod
-    def streamlit_panel(cls, streamlit_script_path: str) -> "NiPanel":
+    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:
-            NiPanel: A new panel associated with the streamlit script
+            A new panel associated with the streamlit script
         """
         panel = cls()
-        panel.panel_uri = streamlit_script_path
-        panel.panel_id = str(uuid.uuid4())
+        panel._panel_uri = streamlit_script_path
+        panel._panel_id = str(uuid.uuid4())
         return panel
 
     def connect(self) -> None:
@@ -61,7 +70,7 @@ def get_value(self, value_id: str) -> object:
             value_id: The id of the value
 
         Returns:
-            object: The value
+            The value
         """
         # TODO: AB#3095681 - get the Any from _stub.GetValue and convert it to the correct type
         return "placeholder value"

tests/unit/test_nipanel.py

@@ -0,0 +1,35 @@
+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()
+
+    panel.set_value("test_id", "test_value")
+
+    # TODO: AB#3095681 - change asserted value to test_value
+    assert panel.get_value("test_id") == "placeholder value"
+    panel.disconnect()
+
+
+def test___with_panel___set_value___gets_same_value() -> None:
+    with nipanel.Panel.streamlit_panel("path/to/script") as panel:
+
+        panel.set_value("test_id", "test_value")
+
+        # TODO: AB#3095681 - change asserted value to test_value
+        assert panel.get_value("test_id") == "placeholder value"