using pathlib.Path for paths instead of str

Signed-off-by: Valerie Gleason 👌 <[email protected]>

Author: hellovolcano

src/nipanel/_panel_client.py

@@ -8,12 +8,12 @@
 import grpc
 from google.protobuf.any_pb2 import Any
 from ni.panels.v1.panel_service_pb2 import (
-    StartPanelRequest,
-    StopPanelRequest,
     EnumeratePanelsRequest,
     GetValueRequest,
-    TryGetValueRequest,
     SetValueRequest,
+    StartPanelRequest,
+    StopPanelRequest,
+    TryGetValueRequest,
 )
 from ni.panels.v1.panel_service_pb2_grpc import PanelServiceStub
 from ni.panels.v1.streamlit_panel_configuration_pb2 import StreamlitPanelConfiguration
@@ -49,11 +49,11 @@ def __init__(
         self._stub: PanelServiceStub | None = None
 
     def start_streamlit_panel(
-        self, panel_id: str, panel_script_path: str, python_interpreter_path: str
+        self, panel_id: str, panel_script_path: pathlib.Path, python_interpreter_path: pathlib.Path
     ) -> str:
 
-        panel_script_url = pathlib.Path(panel_script_path).absolute().as_uri()
-        python_interpreter_url = pathlib.Path(python_interpreter_path).absolute().as_uri()
+        panel_script_url = panel_script_path.absolute().as_uri()
+        python_interpreter_url = python_interpreter_path.absolute().as_uri()
         streamlit_panel_configuration = StreamlitPanelConfiguration(
             panel_script_url=panel_script_url, python_interpreter_url=python_interpreter_url
         )

src/nipanel/_streamlit_panel.py

@@ -20,7 +20,7 @@ class StreamlitPanel(PanelValueAccessor):
     def __init__(
         self,
         panel_id: str,
-        panel_script_path: str,
+        panel_script_path: Path,
         *,
         discovery_client: DiscoveryClient | None = None,
         grpc_channel_pool: GrpcChannelPool | None = None,
@@ -51,7 +51,7 @@ def __init__(
         )
 
     @property
-    def panel_script_path(self) -> str:
+    def panel_script_path(self) -> Path:
         """Read-only accessor for the streamlit script file path."""
         return self._panel_script_path
 
@@ -60,7 +60,7 @@ def panel_url(self) -> str:
         """Read-only accessor for the panel's streamlit webpage URL."""
         return self._panel_url
 
-    def _get_python_path(self) -> str:
+    def _get_python_path(self) -> Path:
         """Get the Python interpreter path for the panel that ensures the same environment."""
         if sys.executable is None or sys.executable == "":
             raise RuntimeError("Python environment not found")
@@ -78,16 +78,16 @@ def _get_python_path(self) -> str:
                 bin_dir = "bin"
 
             # Construct path to the Python in the virtual environment based on sys.prefix
-            python_path = str(Path(sys.prefix) / bin_dir / python_executable)
+            python_path = Path(sys.prefix) / bin_dir / python_executable
 
             # Fall back to sys.executable if the constructed path doesn't exist
-            if not Path(python_path).exists():
-                python_path = str(Path(sys.executable).resolve())
+            if not python_path.exists():
+                python_path = Path(sys.executable).resolve()
         else:
             # If not in a .venv environment, use sys.executable
-            python_path = str(Path(sys.executable).resolve())
+            python_path = Path(sys.executable).resolve()
 
-        if sys.prefix not in python_path:
+        if sys.prefix not in str(python_path):
             # Ensure the Python path is within the current environment
             raise RuntimeError(
                 f"Python path '{python_path}' does not match the current environment prefix '{sys.prefix}'."

src/nipanel/_streamlit_panel_initializer.py

@@ -43,8 +43,7 @@ def create_streamlit_panel(streamlit_script_path: Path, panel_id: str = "") -> S
     if not panel_id:
         panel_id = streamlit_script_path.stem
 
-    path_str = str(streamlit_script_path)
-    return StreamlitPanel(panel_id, path_str)
+    return StreamlitPanel(panel_id, streamlit_script_path)
 
 
 def get_streamlit_panel_accessor() -> PanelValueAccessor:

tests/unit/test_panel_client.py

@@ -1,3 +1,5 @@
+from pathlib import Path
+
 import grpc
 import pytest
 
@@ -13,8 +15,8 @@ def test___enumerate_is_empty(fake_panel_channel: grpc.Channel) -> None:
 def test___start_panels___enumerate_has_panels(fake_panel_channel: grpc.Channel) -> None:
     client = _PanelClient(grpc_channel=fake_panel_channel)
 
-    client.start_streamlit_panel("panel1", "uri1", "python.exe")
-    client.start_streamlit_panel("panel2", "uri2", "python.exe")
+    client.start_streamlit_panel("panel1", Path("uri1"), Path("python.exe"))
+    client.start_streamlit_panel("panel2", Path("uri2"), Path("python.exe"))
 
     assert client.enumerate_panels() == {
         "panel1": ("http://localhost:50051/panel1", []),
@@ -26,8 +28,8 @@ def test___start_panels___stop_panel_1_with_reset___enumerate_has_panel_2(
     fake_panel_channel: grpc.Channel,
 ) -> None:
     client = _PanelClient(grpc_channel=fake_panel_channel)
-    client.start_streamlit_panel("panel1", "uri1", "python.exe")
-    client.start_streamlit_panel("panel2", "uri2", "python.exe")
+    client.start_streamlit_panel("panel1", Path("uri1"), Path("python.exe"))
+    client.start_streamlit_panel("panel2", Path("uri2"), Path("python.exe"))
 
     client.stop_panel("panel1", reset=True)
 
@@ -40,8 +42,8 @@ def test___start_panels___stop_panel_1_without_reset___enumerate_has_both_panels
     fake_panel_channel: grpc.Channel,
 ) -> None:
     client = _PanelClient(grpc_channel=fake_panel_channel)
-    client.start_streamlit_panel("panel1", "uri1", "python.exe")
-    client.start_streamlit_panel("panel2", "uri2", "python.exe")
+    client.start_streamlit_panel("panel1", Path("uri1"), Path("python.exe"))
+    client.start_streamlit_panel("panel2", Path("uri2"), Path("python.exe"))
 
     client.stop_panel("panel1", reset=False)