Add QueryParamsProxy to streamlit api

lib/streamlit/__init__.py

@@ -66,7 +66,10 @@
 )
 from streamlit.runtime.metrics_util import gather_metrics as _gather_metrics
 from streamlit.runtime.secrets import secrets_singleton as _secrets_singleton
-from streamlit.runtime.state import SessionStateProxy as _SessionStateProxy
+from streamlit.runtime.state import (
+    SessionStateProxy as _SessionStateProxy,
+    QueryParamsProxy as _QueryParamsProxy,
+)
 from streamlit.user_info import UserInfoProxy as _UserInfoProxy
 from streamlit.commands.experimental_query_params import (
     get_query_params as _get_query_params,
@@ -192,6 +195,8 @@ def _update_logger() -> None:
 # Session State
 session_state = _SessionStateProxy()
 
+query_params = _QueryParamsProxy()
+
 # Caching
 cache_data = _cache_data
 cache_resource = _cache_resource

lib/streamlit/elements/json.py

@@ -17,7 +17,7 @@
 
 from streamlit.proto.Json_pb2 import Json as JsonProto
 from streamlit.runtime.metrics_util import gather_metrics
-from streamlit.runtime.state import SessionStateProxy
+from streamlit.runtime.state import QueryParamsProxy, SessionStateProxy
 from streamlit.user_info import UserInfoProxy
 
 if TYPE_CHECKING:
@@ -74,7 +74,7 @@ def json(
         """
         import streamlit as st
 
-        if isinstance(body, (SessionStateProxy, UserInfoProxy)):
+        if isinstance(body, (SessionStateProxy, UserInfoProxy, QueryParamsProxy)):
             body = body.to_dict()
 
         if not isinstance(body, str):

lib/streamlit/elements/write.py

@@ -25,7 +25,7 @@
 from streamlit.errors import StreamlitAPIException
 from streamlit.logger import get_logger
 from streamlit.runtime.metrics_util import gather_metrics
-from streamlit.runtime.state import SessionStateProxy
+from streamlit.runtime.state import QueryParamsProxy, SessionStateProxy
 from streamlit.string_util import is_mem_address_str, probably_contains_html_tags
 from streamlit.user_info import UserInfoProxy
 
@@ -234,7 +234,9 @@ def flush_buffer():
                 flush_buffer()
                 dot = vis_utils.model_to_dot(arg)
                 self.dg.graphviz_chart(dot.to_string())
-            elif isinstance(arg, (dict, list, SessionStateProxy, UserInfoProxy)):
+            elif isinstance(
+                arg, (dict, list, SessionStateProxy, UserInfoProxy, QueryParamsProxy)
+            ):
                 flush_buffer()
                 self.dg.json(arg)
             elif type_util.is_namedtuple(arg):

lib/streamlit/runtime/state/query_params.py

@@ -93,8 +93,9 @@ def clear(self) -> None:
         self._query_params.clear()
         self._send_query_param_msg()
 
-    def to_dict(self) -> Dict[str, Union[List[str], str]]:
-        return self._query_params
+    def to_dict(self) -> Dict[str, str]:
+        # return the last query param if multiple keys are set
+        return {key: self[key] for key in self._query_params}
 
 
 def missing_key_error_message(key: str) -> str:

lib/streamlit/runtime/state/query_params_proxy.py

@@ -69,6 +69,6 @@ def clear(self) -> None:
         with get_session_state().query_params() as qp:
             qp.clear()
 
-    def to_dict(self) -> Dict[str, Union[List[str], str]]:
+    def to_dict(self) -> Dict[str, str]:
         with get_session_state().query_params() as qp:
             return qp.to_dict()

lib/tests/streamlit/runtime/state/query_params_test.py

@@ -110,3 +110,8 @@ def test__setitem__raises_exception_for_embed_key(self):
     def test__setitem__raises_exception_for_embed_options_key(self):
         with pytest.raises(StreamlitAPIException):
             self.query_params["embed_options"] = "show_toolbar"
+
+    def test_to_dict(self):
+        self.query_params["baz"] = ""
+        result_dict = {"foo": "bar", "two": "y", "baz": ""}
+        assert self.query_params.to_dict() == result_dict

lib/tests/streamlit/streamlit_test.py

@@ -140,6 +140,7 @@ def test_public_api(self):
                 "cache",
                 "secrets",
                 "session_state",
+                "query_params",
                 "cache_data",
                 "cache_resource",
                 # Experimental APIs:

lib/tests/streamlit/write_test.py

@@ -29,7 +29,7 @@
 from streamlit.elements import write
 from streamlit.error_util import handle_uncaught_app_exception
 from streamlit.errors import StreamlitAPIException
-from streamlit.runtime.state import SessionStateProxy
+from streamlit.runtime.state import QueryParamsProxy, SessionStateProxy
 
 
 class StreamlitWriteTest(unittest.TestCase):
@@ -191,6 +191,13 @@ def test_session_state(self):
 
             p.assert_called_once()
 
+    def test_query_params(self):
+        """Test st.write with st.query_params."""
+        with patch("streamlit.delta_generator.DeltaGenerator.json") as p:
+            st.write(QueryParamsProxy())
+
+            p.assert_called_once()
+
     def test_snowpark_dataframe_write(self):
         """Test st.write with snowflake.snowpark.dataframe.DataFrame."""
         # Import package inside the test so the test suite still runs even if you don't