streamlit-nightly 1.29.1.dev20240107__py2.py3-none-any.whl → 1.29.1.dev20240109__py2.py3-none-any.whl

streamlit/commands/execution_control.py

@@ -56,7 +56,7 @@ def stop() -> NoReturn:  # type: ignore[misc]
 def rerun() -> NoReturn:  # type: ignore[misc]
     """Rerun the script immediately.
 
-    When `st.rerun()` is called, the script is halted - no more statements will
+    When ``st.rerun()`` is called, the script is halted - no more statements will
     be run, and the script will be queued to re-run from the top.
     """
 
@@ -80,7 +80,7 @@ def rerun() -> NoReturn:  # type: ignore[misc]
 def experimental_rerun() -> NoReturn:
     """Rerun the script immediately.
 
-    When `st.experimental_rerun()` is called, the script is halted - no
+    When ``st.experimental_rerun()`` is called, the script is halted - no
     more statements will be run, and the script will be queued to re-run
     from the top.
     """
@@ -94,13 +94,42 @@ def experimental_rerun() -> NoReturn:
 
 @gather_metrics("switch_page")
 def switch_page(page: str) -> NoReturn:  # type: ignore[misc]
-    """Switch the current programmatically page in a multi-page app.
-    When `st.switch_page()` is called with a page, the current page script is halted
-    and the requested page script will be queued to run from the top.
+    """Programmatically switch the current page in a multipage app.
+
+    When ``st.switch_page()`` is called, the current page execution stops and
+    the specified page runs as if the user clicked on it in the sidebar
+    navigation. The specified page must be recognized by Streamlit's multipage
+    architecture (your main Python file or a Python file in a ``pages/``
+    folder). Arbitrary Python scripts cannot be passed to ``st.switch_pages``.
+
     Parameters
     ----------
     page: str
-        The file path, relative to the main script, of the page to switch to.
+        The file path (relative to the main script) of the page to switch to.
+
+    Example
+    -------
+    Consider the following example given this file structure:
+
+    >>> your-repository/
+    >>> ├── pages/
+    >>> │   ├── page_1.py.py
+    >>> │   └── page_2.py.py
+    >>> └── your_app.py
+
+    >>> import streamlit as st
+    >>>
+    >>> if st.button("Home"):
+    >>>     st.switch_page("your_app.py")
+    >>> if st.button("Page 1"):
+    >>>     st.switch_page("pages/page_1.py")
+    >>> if st.button("Page 2"):
+    >>>     st.switch_page("pages/page_2.py")
+
+    .. output ::
+        https://doc-switch-page.streamlit.app/
+        height: 350px
+
     """
 
     ctx = get_script_run_ctx()
@@ -128,7 +157,7 @@ def switch_page(page: str) -> NoReturn:  # type: ignore[misc]
 
     ctx.script_requests.request_rerun(
         RerunData(
-            query_string="",
+            query_string=ctx.query_string,
             page_script_hash=matched_pages[0]["page_script_hash"],
         )
     )

streamlit/commands/experimental_query_params.py

@@ -16,15 +16,16 @@ import urllib.parse as parse
 from typing import Any, Dict, List, Union
 
 from streamlit import util
+from streamlit.constants import (
+    EMBED_OPTIONS_QUERY_PARAM,
+    EMBED_QUERY_PARAM,
+    EMBED_QUERY_PARAMS_KEYS,
+)
 from streamlit.errors import StreamlitAPIException
 from streamlit.proto.ForwardMsg_pb2 import ForwardMsg
 from streamlit.runtime.metrics_util import gather_metrics
 from streamlit.runtime.scriptrunner import get_script_run_ctx
 
-EMBED_QUERY_PARAM = "embed"
-EMBED_OPTIONS_QUERY_PARAM = "embed_options"
-EMBED_QUERY_PARAMS_KEYS = [EMBED_QUERY_PARAM, EMBED_OPTIONS_QUERY_PARAM]
-
 
 @gather_metrics("experimental_get_query_params")
 def get_query_params() -> Dict[str, List[str]]:

streamlit/constants.py

@@ -0,0 +1,17 @@
+# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2024)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+EMBED_QUERY_PARAM = "embed"
+EMBED_OPTIONS_QUERY_PARAM = "embed_options"
+EMBED_QUERY_PARAMS_KEYS = [EMBED_QUERY_PARAM, EMBED_OPTIONS_QUERY_PARAM]

streamlit/elements/layouts.py

@@ -93,7 +93,36 @@ class LayoutsMixin:
 
         .. output ::
             https://doc-container2.streamlit.app/
-            height: 480px
+            height: 300px
+
+        Using ``height`` to make a grid:
+
+        >>> import streamlit as st
+        >>>
+        >>> row1 = st.columns(3)
+        >>> row2 = st.columns(3)
+        >>>
+        >>> for col in row1 + row2:
+        >>>     tile = col.container(height=120, border=True)
+        >>>     tile.title(":balloon:")
+
+        .. output ::
+            https://doc-container3.streamlit.app/
+            height: 350px
+
+        Using ``height`` to create a scrolling container for long content:
+
+        >>> import streamlit as st
+        >>>
+        >>> long_text = "Lorem ipsum. " * 1000
+        >>>
+        >>> with st.container(height=300):
+        >>>     st.markdown(long_text)
+
+        .. output ::
+            https://doc-container4.streamlit.app/
+            height: 400px
+
         """
         block_proto = BlockProto()
         block_proto.allow_empty = False

streamlit/elements/plotly_chart.py

@@ -98,7 +98,7 @@ class PlotlyMixin:
 
         Parameters
         ----------
-        figure_or_data : plotly.graph_objs.Figure, plotly.graph_objs.Data,
+        figure_or_data : plotly.graph_objs.Figure, plotly.graph_objs.Data,\
             dict/list of plotly.graph_objs.Figure/Data
 
             See https://plot.ly/python/ for examples of graph descriptions.

streamlit/runtime/caching/cache_resource_api.py

@@ -303,8 +303,6 @@ class CacheResourceAPI:
               <https://docs.python.org/3/library/datetime.html#timedelta-objects>`_,
               e.g. ``timedelta(days=1)``.
 
-            Note that ``ttl`` will be ignored if ``persist="disk"`` or ``persist=True``.
-
         max_entries : int or None
             The maximum number of entries to keep in the cache, or None
             for an unbounded cache. When a new entry is added to a full cache,

streamlit/runtime/state/query_params.py

@@ -14,7 +14,9 @@
 
 from dataclasses import dataclass, field
 from typing import Dict, Iterable, Iterator, List, MutableMapping, Union
+from urllib import parse
 
+from streamlit.constants import EMBED_QUERY_PARAMS_KEYS
 from streamlit.errors import StreamlitAPIException
 from streamlit.proto.ForwardMsg_pb2 import ForwardMsg
 
@@ -29,7 +31,12 @@ class QueryParams(MutableMapping[str, str]):
 
     def __iter__(self) -> Iterator[str]:
         self._ensure_single_query_api_used()
-        return iter(self._query_params.keys())
+
+        return iter(
+            key
+            for key in self._query_params.keys()
+            if key not in EMBED_QUERY_PARAMS_KEYS
+        )
 
     def __getitem__(self, key: str) -> str:
         """Retrieves a value for a given key in query parameters.
@@ -38,6 +45,8 @@ class QueryParams(MutableMapping[str, str]):
         """
         self._ensure_single_query_api_used()
         try:
+            if key in EMBED_QUERY_PARAMS_KEYS:
+                raise KeyError(missing_key_error_message(key))
             value = self._query_params[key]
             if isinstance(value, list):
                 if len(value) == 0:
@@ -56,6 +65,10 @@ class QueryParams(MutableMapping[str, str]):
                 f"You cannot set a query params key `{key}` to a dictionary."
             )
 
+        if key in EMBED_QUERY_PARAMS_KEYS:
+            raise StreamlitAPIException(
+                "Query param embed and embed_options (case-insensitive) cannot be set programmatically."
+            )
         # Type checking users should handle the string serialization themselves
         # We will accept any type for the list and serialize to str just in case
         if isinstance(value, Iterable) and not isinstance(value, str):
@@ -66,6 +79,8 @@ class QueryParams(MutableMapping[str, str]):
 
     def __delitem__(self, key: str) -> None:
         try:
+            if key in EMBED_QUERY_PARAMS_KEYS:
+                raise KeyError(missing_key_error_message(key))
             del self._query_params[key]
             self._send_query_param_msg()
         except KeyError:
@@ -73,18 +88,19 @@ class QueryParams(MutableMapping[str, str]):
 
     def get_all(self, key: str) -> List[str]:
         self._ensure_single_query_api_used()
-        if key not in self._query_params:
+        if key not in self._query_params or key in EMBED_QUERY_PARAMS_KEYS:
             return []
         value = self._query_params[key]
         return value if isinstance(value, list) else [value]
 
     def __len__(self) -> int:
         self._ensure_single_query_api_used()
-        return len(self._query_params)
+        return len(
+            {key for key in self._query_params if key not in EMBED_QUERY_PARAMS_KEYS}
+        )
 
     def _send_query_param_msg(self) -> None:
         # Avoid circular imports
-        from streamlit.commands.experimental_query_params import _ensure_no_embed_params
         from streamlit.runtime.scriptrunner import get_script_run_ctx
 
         ctx = get_script_run_ctx()
@@ -93,27 +109,31 @@ class QueryParams(MutableMapping[str, str]):
         self._ensure_single_query_api_used()
 
         msg = ForwardMsg()
-        msg.page_info_changed.query_string = _ensure_no_embed_params(
-            self._query_params, ctx.query_string
+        msg.page_info_changed.query_string = parse.urlencode(
+            self._query_params, doseq=True
         )
         ctx.query_string = msg.page_info_changed.query_string
         ctx.enqueue(msg)
 
     def clear(self) -> None:
-        self._query_params.clear()
+        new_query_params = {}
+        for key, value in self._query_params.items():
+            if key in EMBED_QUERY_PARAMS_KEYS:
+                new_query_params[key] = value
+        self._query_params = new_query_params
+
         self._send_query_param_msg()
 
     def to_dict(self) -> Dict[str, str]:
         self._ensure_single_query_api_used()
-        # return the last query param if multiple keys are set
-        return {key: self[key] for key in self._query_params}
+        # return the last query param if multiple values are set
+        return {
+            key: self[key]
+            for key in self._query_params
+            if key not in EMBED_QUERY_PARAMS_KEYS
+        }
 
     def set_with_no_forward_msg(self, key: str, val: Union[List[str], str]) -> None:
-        # Avoid circular imports
-        from streamlit.commands.experimental_query_params import EMBED_QUERY_PARAMS_KEYS
-
-        if key.lower() in EMBED_QUERY_PARAMS_KEYS:
-            return
         self._query_params[key] = val
 
     def clear_with_no_forward_msg(self) -> None:

streamlit/runtime/state/query_params_proxy.py

@@ -20,7 +20,8 @@ from streamlit.runtime.state.session_state_proxy import get_session_state
 
 
 class QueryParamsProxy(MutableMapping[str, str]):
-    """A stateless singleton that proxies `st.query_params` interactions
+    """
+    A stateless singleton that proxies ``st.query_params`` interactions
     to the current script thread's QueryParams instance.
     """
 
@@ -68,15 +69,51 @@ class QueryParamsProxy(MutableMapping[str, str]):
 
     @gather_metrics("query_params.get_all")
     def get_all(self, key: str) -> List[str]:
+        """
+        Get a list of all query parameter values associated to a given key.
+
+        When a key is repeated as a query parameter within the URL, this method
+        allows all values to be obtained. In contrast, dict-like methods only
+        retrieve the last value when a key is repeated in the URL.
+
+        Parameters
+        ----------
+        key: str
+            The label of the query parameter in the URL.
+
+        Returns
+        -------
+        List[str]
+            A list of values associated to the given key. May return zero, one,
+            or multiple values.
+        """
         with get_session_state().query_params() as qp:
             return qp.get_all(key)
 
     @gather_metrics("query_params.clear")
     def clear(self) -> None:
+        """
+        Clear all query parameters from the URL of the app.
+
+        Returns
+        -------
+        None
+        """
         with get_session_state().query_params() as qp:
             qp.clear()
 
     @gather_metrics("query_params.to_dict")
     def to_dict(self) -> Dict[str, str]:
+        """
+        Get all query parameters as a dictionary.
+
+        When a key is repeated as a query parameter within the URL, this method
+        will return only the last value of each unique key.
+
+        Returns
+        -------
+        Dict[str,str]
+            A dictionary of the current query paramters in the app's URL.
+        """
         with get_session_state().query_params() as qp:
             return qp.to_dict()

streamlit/static/asset-manifest.json

@@ -1,7 +1,7 @@
 {
   "files": {
     "main.css": "./static/css/main.77d1c464.css",
-    "main.js": "./static/js/main.cbbf0bd5.js",
+    "main.js": "./static/js/main.3ab8e8d9.js",
     "static/js/9336.2d95d840.chunk.js": "./static/js/9336.2d95d840.chunk.js",
     "static/js/9330.c0dd1723.chunk.js": "./static/js/9330.c0dd1723.chunk.js",
     "static/js/7217.d970c074.chunk.js": "./static/js/7217.d970c074.chunk.js",
@@ -149,6 +149,6 @@
   },
   "entrypoints": [
     "static/css/main.77d1c464.css",
-    "static/js/main.cbbf0bd5.js"
+    "static/js/main.3ab8e8d9.js"
   ]
 }

streamlit/static/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"/><link rel="shortcut icon" href="./favicon.png"/><link rel="preload" href="./static/media/SourceSansPro-Regular.0d69e5ff5e92ac64a0c9.woff2" as="font" type="font/woff2" crossorigin><link rel="preload" href="./static/media/SourceSansPro-SemiBold.abed79cd0df1827e18cf.woff2" as="font" type="font/woff2" crossorigin><link rel="preload" href="./static/media/SourceSansPro-Bold.118dea98980e20a81ced.woff2" as="font" type="font/woff2" crossorigin><title>Streamlit</title><script>window.prerenderReady=!1</script><script defer="defer" src="./static/js/main.cbbf0bd5.js"></script><link href="./static/css/main.77d1c464.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"/><link rel="shortcut icon" href="./favicon.png"/><link rel="preload" href="./static/media/SourceSansPro-Regular.0d69e5ff5e92ac64a0c9.woff2" as="font" type="font/woff2" crossorigin><link rel="preload" href="./static/media/SourceSansPro-SemiBold.abed79cd0df1827e18cf.woff2" as="font" type="font/woff2" crossorigin><link rel="preload" href="./static/media/SourceSansPro-Bold.118dea98980e20a81ced.woff2" as="font" type="font/woff2" crossorigin><title>Streamlit</title><script>window.prerenderReady=!1</script><script defer="defer" src="./static/js/main.3ab8e8d9.js"></script><link href="./static/css/main.77d1c464.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>