Upgrade to non-experimental query api (#10)

Fixes #6.

Author: stonier

.github/workflows/pre-merge.yaml

@@ -18,7 +18,8 @@ jobs:
             python-py-version: "py38"
           - python-version: "3.10"
             python-py-version: "py310"
-    container: ghcr.io/${{ github.repository }}:${{ matrix.python-py-version }}-poetry-bullseye
+    container:
+      image: ghcr.io/${{ github.repository }}:${{ matrix.python-py-version }}-poetry-bullseye
       credentials:
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}    
@@ -48,11 +49,6 @@ jobs:
       # Project is installed separately to avoid always invalidating the cache
       - name: Poetry - Install Project
         run: poetry install --no-interaction
-      - name: Tox - Tests [py38]
-        # fast this time around since the last step did the installation, venv.bash will only check here
-        run: |
-          source ./venv.bash
-          tox -e py38
 
       - name: Tox - Tests
         run: poetry run tox --workdir ${{ env.VENV_DIR }} -e ${{ matrix.python-py-version }}

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "streamlit_parameters"
-version = "0.2.0"
+version = "0.1.5"
 description = "Streamlit parameter management for page configuration"
 authors = ["Daniel Stonier"]
 maintainers = ["Daniel Stonier <[email protected]>"]

setup.py

@@ -4,7 +4,7 @@
 
 
 install_requires = [
-    'streamlit>=1.12,<2'
+    'streamlit>=1.30,<2'
 ]
 
 tests_require = ['pytest', 'pytest-mock', 'tox']

streamlit_parameters/demos/parameters.py

@@ -15,7 +15,6 @@
 import datetime
 import functools
 import sys
-import typing
 
 import streamlit
 import streamlit.web.cli
@@ -214,8 +213,7 @@ def main():
     streamlit.write("## Debugging")
 
     streamlit.write("#### Query String")
-    query_string: typing.Dict[str, str] = streamlit.experimental_get_query_params()
-    streamlit.write(query_string)
+    streamlit.write(streamlit.query_params)
 
     streamlit.write("#### Parameters")
     streamlit.write(parameters.as_dict())

streamlit_parameters/parameters.py

@@ -486,7 +486,7 @@ def set_url_fields():
         for key, parameter in streamlit.session_state._parameters.items():
             if Parameters.is_set_all() or parameter.touched:
                 values[key] = parameter.to_str(parameter.value)
-        streamlit.experimental_set_query_params(**values)
+        streamlit.query_params.from_dict(values)
 
     @staticmethod
     def _already_registered(key: str) -> bool:
@@ -507,7 +507,4 @@ def _fetch_url_field(key: str) -> str:
         Raises:
             KeyError: if the field does not exist
         """
-        # TODO: raise error if multiple values in the query_string exist
-        return streamlit.experimental_get_query_params()[key][
-            0
-        ]  # always a list, get the first
+        return streamlit.query_params[key]

tests/test_parameters.py

@@ -19,10 +19,10 @@ def mock_session_state(mocker):
 def mock_query_params(mocker):
     """Add a pytest fixture that returns a function that mocks query params."""
     def func(key: str, value: str):
-        get_query_params = mocker.patch(
-            sut + ".streamlit.experimental_get_query_params"
+        mocker.patch.dict(
+            sut + ".streamlit.query_params",
+            {key: value}
         )
-        get_query_params.return_value = {key: [value]}
 
     return func
 
@@ -176,9 +176,9 @@ def test_register_string_parameter(
     assert parameter.default == "G'day!"
     assert parameter.value == "Hello"
     assert repr(parameter) == "Parameter(default=G'day!,value=Hello,touched=True)"
-    set_query_params = mocker.patch(sut + ".streamlit.experimental_set_query_params")
+    set_query_params = mocker.patch(sut + ".streamlit.runtime.state.query_params_proxy.QueryParamsProxy.from_dict")
     Parameters.set_url_fields()
-    set_query_params.assert_called_with(foo="Hello")
+    set_query_params.assert_called_with({"foo": "Hello"})
 
 
 def test_register_string_parameter_not_in_url(
@@ -223,14 +223,14 @@ def test_register_string_list_parameter(
         repr(parameter)
         == "Parameter(default=['flying', 'spaghetti', 'monster'],value=['flying', 'spaghetti', 'monster'],touched=True)"
     )
-    set_query_params = mocker.patch(sut + ".streamlit.experimental_set_query_params")
+    set_query_params = mocker.patch(sut + ".streamlit.runtime.state.query_params_proxy.QueryParamsProxy.from_dict")
     Parameters.set_url_fields()
-    set_query_params.assert_called_with(foo="['flying', 'spaghetti', 'monster']")
+    set_query_params.assert_called_with({"foo": "['flying', 'spaghetti', 'monster']"})
 
     # Now update value and make sure new value properly serialized in query params
     parameters.foo.update(new_value=["Hello", "world"])
     Parameters.set_url_fields()
-    set_query_params.assert_called_with(foo="['Hello', 'world']")
+    set_query_params.assert_called_with({"foo": "['Hello', 'world']"})
 
 
 def test_register_string_list_parameter_not_in_url(
@@ -278,9 +278,9 @@ def test_register_date_parameter(
     parameter = st.session_state._parameters["foo"]
     assert parameter.default == datetime.date(2021, 11, 1)
     assert parameter.value == datetime.date(2021, 11, 1)
-    set_query_params = mocker.patch(sut + ".streamlit.experimental_set_query_params")
+    set_query_params = mocker.patch(sut + ".streamlit.runtime.state.query_params_proxy.QueryParamsProxy.from_dict")
     Parameters.set_url_fields()
-    set_query_params.assert_called_with(foo="2021-11-01")
+    set_query_params.assert_called_with({"foo": "2021-11-01"})
 
 
 def test_register_date_parameter_not_in_url(
@@ -307,10 +307,10 @@ def test_register_date_range_parameter(
     assert parameter.value == (datetime.date(2021, 11, 1), datetime.date(2021, 11, 3))
 
     # Now update value and make sure new value properly serialized in query params
-    set_query_params = mocker.patch(sut + ".streamlit.experimental_set_query_params")
+    set_query_params = mocker.patch(sut + ".streamlit.runtime.state.query_params_proxy.QueryParamsProxy.from_dict")
     parameters.foo.update(new_value=(datetime.date(2023, 11, 1), datetime.date(2023, 11, 3)))
     Parameters.set_url_fields()
-    set_query_params.assert_called_with(foo='(2023-11-01,2023-11-03)')
+    set_query_params.assert_called_with({"foo": '(2023-11-01,2023-11-03)'})
 
 
 def test_as_dict(