moving refresh component to separate namespace

Author: hellovolcano

src/nipanel/_streamlit_panel_initializer.py

@@ -1,8 +1,11 @@
+from streamlit.components.v1 import components
 from typing import cast
 
 import streamlit as st
 
 from nipanel._streamlit_panel_value_accessor import StreamlitPanelValueAccessor
+from nipanel._streamlit_constants import STREAMLIT_REFRESH_COMPONENT_URL
+from nipanel.panel_refresh import add_refresh_component
 
 PANEL_ACCESSOR_KEY = "StreamlitPanelValueAccessor"
 
@@ -22,7 +25,8 @@ def initialize_panel() -> StreamlitPanelValueAccessor:
         st.session_state[PANEL_ACCESSOR_KEY] = _initialize_panel_from_base_path()
 
     panel = cast(StreamlitPanelValueAccessor, st.session_state[PANEL_ACCESSOR_KEY])
-    # TODO: declare the refresh component here
+    refresh_component = add_refresh_component(panel.panel_id)
+    refresh_component()
     return panel
 
 

src/nipanel/_streamlit_panel_value_accessor.py

@@ -1,17 +1,13 @@
 from __future__ import annotations
 
-from typing import final, Any
+from typing import final
 
 import grpc
-import streamlit.components.v1 as components
 from ni_measurement_plugin_sdk_service.discovery import DiscoveryClient
 from ni_measurement_plugin_sdk_service.grpc.channelpool import GrpcChannelPool
 
 from nipanel._panel_value_accessor import PanelValueAccessor
-from nipanel._streamlit_constants import (
-    STREAMLIT_PYTHON_PANEL_SERVICE,
-    STREAMLIT_REFRESH_COMPONENT_URL,
-)
+from nipanel._streamlit_constants import STREAMLIT_PYTHON_PANEL_SERVICE
 
 
 @final
@@ -46,12 +42,4 @@ def __init__(
             discovery_client=discovery_client,
             grpc_channel_pool=grpc_channel_pool,
             grpc_channel=grpc_channel,
-        )
-
-    def refresh(self) -> Any:
-        """Get the Streamlit component for refreshing the panel."""
-        _panel_refresh_component = components.declare_component(
-            "panelRefreshComponent",
-            url=f"{STREAMLIT_REFRESH_COMPONENT_URL}/{self.panel_id}",
-        )
-        return _panel_refresh_component()
+        )

src/nipanel/panel_refresh/__init__.py

@@ -0,0 +1,14 @@
+""" Panel refresh component for Streamlit. """
+
+import streamlit.components.v1 as components
+from nipanel._streamlit_constants import STREAMLIT_REFRESH_COMPONENT_URL
+
+def add_refresh_component(panel_id):
+
+    refresh_component = components.declare_component(
+        "panelRefreshComponent",
+        url=f"{STREAMLIT_REFRESH_COMPONENT_URL}/{panel_id}",
+        key=f"panel_refresh_{panel_id}",
+    )
+
+    return refresh_component