add panel_id input to create_streamlit_panel()

Author: Mike Prosser

examples/performance_checker/performance_checker_panel.py

@@ -13,7 +13,7 @@
 
 
 def profile_get_value(
-    panel: "nipanel.StreamlitPanelValueAccessor",
+    panel: "nipanel.PanelValueAccessor",
     value_id: str,
     default_value: Any = None,
     num_runs: int = 5,

src/nipanel/_streamlit_panel_initializer.py

@@ -12,19 +12,21 @@
 PANEL_ACCESSOR_KEY = "StreamlitPanelValueAccessor"
 
 
-def create_streamlit_panel(streamlit_script_path: Path) -> StreamlitPanel:
+def create_streamlit_panel(streamlit_script_path: Path, panel_id: str = "") -> StreamlitPanel:
     """Create a Streamlit panel with the specified script path.
 
-    This function initializes a Streamlit panel using the provided script path. It derives the panel
-    ID from the script's path, which it expects to be a valid Streamlit script. For example, if the
-    value for streamlit_script_path is "c:/example/some_example.py", then the panel's ID becomes
-    "some_example".
+    This function initializes a Streamlit panel using the provided script path. By default, it
+    derives the panel ID from the script's path, which it expects to be a valid Streamlit script.
+    For example, if the value for streamlit_script_path is "c:/example/some_example.py", then the
+    panel's ID becomes "some_example". Alternatively, you can specify a custom panel_id.
 
     Use this function when you want to create a new panel instance to use in a Streamlit
     application. Do not call this function from within a Streamlit script.
 
     Args:
         streamlit_script_path: The file path of the Streamlit script to be used for the panel.
+        panel_id: Optional custom panel ID. If not provided, it will be derived from the script
+            path.
 
     Returns:
         A StreamlitPanel instance initialized with the given panel ID.
@@ -39,7 +41,9 @@ def create_streamlit_panel(streamlit_script_path: Path) -> StreamlitPanel:
             "The provided script path must be a valid Streamlit script ending with '.py'."
         )
 
-    panel_id = streamlit_script_path.stem
+    if panel_id == "":
+        panel_id = streamlit_script_path.stem
+
     path_str = str(streamlit_script_path)
     return StreamlitPanel(panel_id, path_str)