rename initialize_panel to get_panel_accessor and throw exceptions when called improperly

Author: Mike Prosser

examples/all_types/all_types_panel.py

@@ -5,7 +5,7 @@
 
 import nipanel
 
-panel = nipanel.initialize_panel()
+panel = nipanel.get_panel_accessor()
 
 st.set_page_config(page_title="All Types Example", page_icon="📊", layout="wide")
 st.title("All Types Example")

examples/sample/sample_panel.py

@@ -4,7 +4,7 @@
 
 import nipanel
 
-panel = nipanel.initialize_panel()
+panel = nipanel.get_panel_accessor()
 
 
 st.set_page_config(page_title="Sample Panel Example", page_icon="📊", layout="wide")

examples/simple_graph/simple_graph_panel.py

@@ -3,10 +3,10 @@
 import streamlit as st
 from streamlit_echarts import st_echarts  # type: ignore
 
-from nipanel import initialize_panel
+import nipanel
 
 
-panel = initialize_panel()
+panel = nipanel.get_panel_accessor()
 
 st.set_page_config(page_title="Simple Graph Example", page_icon="📈", layout="wide")
 st.title("Simple Graph Example")

src/nipanel/__init__.py

@@ -4,12 +4,12 @@
 
 from nipanel._panel import Panel
 from nipanel._streamlit_panel import StreamlitPanel
-from nipanel._streamlit_panel_initializer import create_panel, initialize_panel
+from nipanel._streamlit_panel_initializer import create_panel, get_panel_accessor
 from nipanel._streamlit_panel_value_accessor import StreamlitPanelValueAccessor
 
 __all__ = [
     "create_panel",
-    "initialize_panel",
+    "get_panel_accessor",
     "Panel",
     "StreamlitPanel",
     "StreamlitPanelValueAccessor",

src/nipanel/_streamlit_panel_initializer.py

@@ -19,14 +19,19 @@ def create_panel(streamlit_script_path: Path) -> StreamlitPanel:
     "some_example".
 
     Use this function when you want to create a new panel instance to use in a Streamlit
-    application.
+    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.
 
     Returns:
         A StreamlitPanel instance initialized with the given panel ID.
     """
+    if st.get_option("server.baseUrlPath") != "":
+        raise RuntimeError(
+            "nipanel.create_panel() should not be called from a Streamlit script. Call nipanel.get_panel_accessor() instead."
+        )
+
     path_str = str(streamlit_script_path)
     if not path_str.endswith(".py"):
         raise ValueError(
@@ -37,17 +42,21 @@ def create_panel(streamlit_script_path: Path) -> StreamlitPanel:
     return StreamlitPanel(panel_id, path_str)
 
 
-def initialize_panel() -> StreamlitPanelValueAccessor:
+def get_panel_accessor() -> StreamlitPanelValueAccessor:
     """Initialize and return the Streamlit panel value accessor.
 
     This function retrieves the Streamlit panel value accessor for the current Streamlit script.
-    It is typically used within a Streamlit script to access and manipulate panel values.
-    The accessor will be cached in the Streamlit session state to ensure that it is reused across
-    reruns of the script.
+    This function should only be called from within a Streamlit script. The accessor will be cached
+    in the Streamlit session state to ensure that it is reused across reruns of the script.
 
     Returns:
         A StreamlitPanelValueAccessor instance for the current panel.
     """
+    if st.get_option("server.baseUrlPath") == "":
+        raise RuntimeError(
+            "nipanel.get_panel_accessor() should only be called from a Streamlit script. Call nipanel.create_panel() instead."
+        )
+
     if PANEL_ACCESSOR_KEY not in st.session_state:
         st.session_state[PANEL_ACCESSOR_KEY] = _initialize_panel_from_base_path()