cleanup

Author: Mike Prosser

src/nipanel/__init__.py

@@ -1,3 +1,5 @@
 """The NI Panel."""
+
 from nipanel.nipanel import NiPanel
-__all__ = ["NiPanel"]
+
+__all__ = ["NiPanel"]

src/nipanel/nipanel.py

@@ -1,31 +1,37 @@
+"""NI Panel."""
+
 import uuid
-import grpc
-from google.protobuf import any_pb2
-import ni.pythonpanel.v1.python_panel_service_pb2 as python_panel_service_pb2
-import ni.pythonpanel.v1.python_panel_service_pb2_grpc as python_panel_service_pb2_grpc
+from types import TracebackType
+from typing import Optional, Type
 
 
 class NiPanel:
-    """
-    This class allows you to access controls on the panel
-    """
+    """This class allows you to access controls on the panel."""
 
-    def __init__(self):
+    def __init__(self) -> None:
+        """Initialize the NiPanel instance."""
         self._stub = None  # will be a PythonPanelServiceStub
-        self.panel_uri = None
-        self.panel_id = None
+        self.panel_uri = ""
+        self.panel_id = ""
 
-    def __enter__(self):
+    def __enter__(self) -> "NiPanel":
+        """Enter the runtime context related to this object."""
         self.connect()
         return self
 
-    def __exit__(self, exc_type, exc_value, exc_traceback):
+    def __exit__(
+        self,
+        exctype: Optional[Type[BaseException]],
+        excinst: Optional[BaseException],
+        exctb: Optional[TracebackType],
+    ) -> Optional[bool]:
+        """Exit the runtime context related to this object."""
         self.disconnect()
+        return None
 
     @classmethod
-    def streamlit_panel(cls, streamlit_script_path: str):
-        """
-        Create a panel using a streamlit script for the user interface
+    def streamlit_panel(cls, streamlit_script_path: str) -> "NiPanel":
+        """Create a panel using a streamlit script for the user interface.
 
         Args:
             streamlit_script_path: The file path of the streamlit script
@@ -38,36 +44,30 @@ def streamlit_panel(cls, streamlit_script_path: str):
         panel.panel_id = str(uuid.uuid4())
         return panel
 
-    def connect(self):
-        """
-        Connect to the panel and open it.
-        """
-        # TODO: AB#3095680 - Use gRPC pool management from the Measurement Plugin SDK, create the _stub, and call _stub.Connect
+    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
 
-    def disconnect(self):
-        """
-        Disconnect from the panel (does not close the panel).
-        """
-        # TODO: AB#3095680 - Use gRPC pool management from the Measurement Plugin SDK, call _stub.Disconnect
+    def disconnect(self) -> None:
+        """Disconnect from the panel (does not close the panel)."""
+        # TODO: AB#3095680 - Use gRPC pool management, call _stub.Disconnect
         pass
 
-    def get_value(self, value_id: str):
-        """
-        Get the value for a control on the panel
+    def get_value(self, value_id: str) -> object:
+        """Get the value for a control on the panel.
 
         Args:
             value_id: The id of the value
 
         Returns:
             object: The value
         """
-        # TODO: AB#3095681 - get the Any from _stub.GetValue and convert it to the correct type to return it
+        # 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):
-        """
-        Set the value for a control on the panel
+    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

tests/__init__.py

@@ -1 +1 @@
-"""Tests for the `nipanel` package."""
+"""Tests for the `nipanel` package."""

tests/unit/test_nipanel.py

@@ -1,17 +1,19 @@
 from nipanel import NiPanel
 
+
 def test_streamlit_panel() -> None:
     panel = NiPanel.streamlit_panel("path/to/script")
     assert panel.panel_uri == "path/to/script"
     assert panel.panel_id is not None
-    panel.connect() # not implemented, but should not raise an error
-    panel.set_value("test_id", "test_value") # not implemented, but should not raise an error
-    assert panel.get_value("test_id") == "placeholder value" # not implemented, but should not raise an error
-    panel.disconnect() # not implemented, but should not raise an error
+    panel.connect()
+    panel.set_value("test_id", "test_value")
+    assert panel.get_value("test_id") == "placeholder value"
+    panel.disconnect()
+
 
 def test_with_streamlit_panel() -> None:
     with NiPanel.streamlit_panel("path/to/script") as panel:
         assert panel.panel_uri == "path/to/script"
         assert panel.panel_id is not None
-        panel.set_value("test_id", "test_value") # not implemented, but should not raise an error
-        assert panel.get_value("test_id") == "placeholder value" # not implemented, but should not raise an error
+        panel.set_value("test_id", "test_value")
+        assert panel.get_value("test_id") == "placeholder value"