streamlit-nightly 1.29.1.dev20240107__py2.py3-none-any.whl → 1.29.1.dev20240108__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()

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_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_nightly-1.29.1.dev20240107.dist-info → streamlit_nightly-1.29.1.dev20240108.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: streamlit-nightly
-Version: 1.29.1.dev20240107
+Version: 1.29.1.dev20240108
 Summary: A faster way to build and share data apps
 Home-page: https://streamlit.io
 Author: Snowflake Inc

{streamlit_nightly-1.29.1.dev20240107.dist-info → streamlit_nightly-1.29.1.dev20240108.dist-info}/RECORD

@@ -33,7 +33,7 @@ streamlit/user_info.py,sha256=Ggv5OUw2BNLWbnqQ85agaPvAGarGtROVEWEm5uxExtI,1986
 streamlit/util.py,sha256=OjZXmz5t_h7SOuvauezUxuQblyUsxd_BzG2-WKGzuxI,6402
 streamlit/version.py,sha256=NNB_tfVDaLP-CtNeszLbnJVVyI_0hw8Q64NOPRnvkZo,3365
 streamlit/commands/__init__.py,sha256=Vrf1yVMOcTyhUPnYvsfyeL96Vpd5z8KoSV5ZzTcTQgU,616
-streamlit/commands/execution_control.py,sha256=ezG-wr59VLbjV4VMp2KXU1fT29MQ83s_0d9VwgnocGM,4587
+streamlit/commands/execution_control.py,sha256=zJWuxXgatM65egG3wiQyunBetE3lsltkxw0vslotu2k,5416
 streamlit/commands/experimental_query_params.py,sha256=tqUVoJglyQT97qYu0EkDVg0jENOVwKjPHByFoxxnkjA,5053
 streamlit/commands/page_config.py,sha256=w0T_wTzfDhGdMZLSNRMsYqGxqmH1FuE3dGMH3dW6JSk,12111
 streamlit/components/__init__.py,sha256=Vrf1yVMOcTyhUPnYvsfyeL96Vpd5z8KoSV5ZzTcTQgU,616
@@ -65,12 +65,12 @@ streamlit/elements/heading.py,sha256=1Q0qqKlkyIOi_ve-LTTwtYC-Kx-2eeXfwHwZvpNKtaU
 streamlit/elements/iframe.py,sha256=6bW5gPQt5-2FwnlFwjB2JHFOVZ-SOCT5x8VIg7skAC4,4387
 streamlit/elements/image.py,sha256=SEQ8m0FIXA4HNo11mUIjGL7perThMgZ9LH3tJU5dXGk,20076
 streamlit/elements/json.py,sha256=fMLeA9FcvV1n-SOWaO5XrAI41HoXNo5qY6u7hMVsLFM,3352
-streamlit/elements/layouts.py,sha256=JPUUz0AtXV4qmGt4FZksJ8xCcsKCpcqJfAbxQV5ARXk,21745
+streamlit/elements/layouts.py,sha256=dlCGuK98XiVMqStIIeUHMW_M_3BuqXekc7MRK4HdPkU,22513
 streamlit/elements/map.py,sha256=pPudBRZME_tFG2dwt8QCjYVV4eEdNINmLeiz2h_yBj0,16180
 streamlit/elements/markdown.py,sha256=rSsKWigW6ojZOYN4szreSSRPb6tGQVRaqIBW-mIKLNw,9912
 streamlit/elements/media.py,sha256=XT7w56fXwBLUgqTgNiMi_gSZg95kNP8C9SbtjROcfPg,14671
 streamlit/elements/metric.py,sha256=jKrpoIbSlKQI_Xw7Cy5ZxtJ0Bc-eKgdgDB3zBsuSJO4,9882
-streamlit/elements/plotly_chart.py,sha256=ed4R5Vo2dEsvbNahtOo9FvuunsstUEmnBnF6otZJt5M,8809
+streamlit/elements/plotly_chart.py,sha256=H2ZW64lJH60KK_uk-zS1jEQ_cIhi6z3ubzfjgmbFiGs,8810
 streamlit/elements/progress.py,sha256=OKPljeEoU18GqiCbgdWmElf7xWOwgYKnjWTo9sIi67o,4758
 streamlit/elements/pyplot.py,sha256=udVkpFR5jNNJPKScsIlH1GEJrRYy_bCWJwVU_aMEBK8,6578
 streamlit/elements/snow.py,sha256=LScypkYNNPWEnEwElspnAuHo8OqBmwJfyAo7dcjGezc,1407
@@ -278,7 +278,7 @@ streamlit/runtime/websocket_session_manager.py,sha256=ILbT86PWN-z2DyOxcAMqz-oPGD
 streamlit/runtime/caching/__init__.py,sha256=anR_SzNOFYDo_9_Y9liP5JnmTWjs3kq1kVX7maRfDNg,5012
 streamlit/runtime/caching/cache_data_api.py,sha256=w_zRUrqJ596yJ2KCQfN9phVV96CjEKyPpKhZCIvlXdw,26088
 streamlit/runtime/caching/cache_errors.py,sha256=u9LQlKKgq1XOVZA83eUhlKb1xhIFV6M50gIL2odcrEs,6351
-streamlit/runtime/caching/cache_resource_api.py,sha256=ajBEaMelMqCyd6NSdN0uRDL-htJD50kKIkKlfz7jkhA,21270
+streamlit/runtime/caching/cache_resource_api.py,sha256=tIUwNYUhOk9S4zmt9ZTSAqL4f0F2JEyYTxHBV5ACP38,21180
 streamlit/runtime/caching/cache_type.py,sha256=r_tzxXL_BAgVYTJr57qAiCjxoSdU7DdPRVliGGcKIaU,1095
 streamlit/runtime/caching/cache_utils.py,sha256=FIhrJTpdFMMYnwrmch_B5VHs0zzaB53AnxTAyVyrOK4,17802
 streamlit/runtime/caching/cached_message_replay.py,sha256=qxpwVc5Kvqd9sU1bKW5XQ-iDBFgzuYl9eGZG26i9ibM,18540
@@ -301,7 +301,7 @@ streamlit/runtime/scriptrunner/script_runner.py,sha256=hsz_veNsByrGNRLmZYhBY7uVB
 streamlit/runtime/state/__init__.py,sha256=UpfNfPrWJ6rVdD-qc0IP_bwZ4MrcNUjyU9wEKDK-eWM,1528
 streamlit/runtime/state/common.py,sha256=7p_wX1jegw_7KYeU8-oHqxOQKK5HybSLU7b1c1_1skA,7579
 streamlit/runtime/state/query_params.py,sha256=hBf4smsynEOoeG9IeNLFpOQBVXQijQgsQ9EhuPdqLkQ,5038
-streamlit/runtime/state/query_params_proxy.py,sha256=XkX3E-cW-9TcFFUgOsGAwYazwZ37f4J8XmyzZxtuACk,3078
+streamlit/runtime/state/query_params_proxy.py,sha256=GoSIHzchD6WrmxWcLr8xiRvt45VUPkm6MVA2enjtPWo,4161
 streamlit/runtime/state/safe_session_state.py,sha256=UIhqIDtpqP9sX7n3xo1o6X1ft-x6u7uHd34p8MoUAD0,5163
 streamlit/runtime/state/session_state.py,sha256=MbUxYklQOXzp5tZxOFML_izFR0l45zhAlINBfFaFhEk,26120
 streamlit/runtime/state/session_state_proxy.py,sha256=cQBtnC1S2awdXlKPKHPJxdQiL5bjObCjYnhyAGkep6g,5117
@@ -498,9 +498,9 @@ streamlit/web/server/server_util.py,sha256=_-RaGl6LU3gebVlW1W6VTAK_6G1S7Zv9ioSW2
 streamlit/web/server/stats_request_handler.py,sha256=namo6XxyEeACPbKlA9UjnXsJX8pMgVAQDmd7l1iUQvA,3410
 streamlit/web/server/upload_file_request_handler.py,sha256=WT7SnV6O6hmaK6K2R0smAvvf6LAL-UIMj1ucm5I7514,5034
 streamlit/web/server/websocket_headers.py,sha256=wZOcWCOZWIfn_omo6ymuy_HaMKa2MMHgri9I2aOggYw,1872
-streamlit_nightly-1.29.1.dev20240107.data/scripts/streamlit.cmd,sha256=ZEYM3vBJSp-k7vwSJ3ba5NzEk9-qHdSeLvGYAAe1mMw,676
-streamlit_nightly-1.29.1.dev20240107.dist-info/METADATA,sha256=nh6xbNyinJOdhmE-GsVsqGgPSh7rA8uEkDyKtPl7W0g,8180
-streamlit_nightly-1.29.1.dev20240107.dist-info/WHEEL,sha256=-G_t0oGuE7UD0DrSpVZnq1hHMBV9DD2XkS5v7XpmTnk,110
-streamlit_nightly-1.29.1.dev20240107.dist-info/entry_points.txt,sha256=uNJ4DwGNXEhOK0USwSNanjkYyR-Bk7eYQbJFDrWyOgY,53
-streamlit_nightly-1.29.1.dev20240107.dist-info/top_level.txt,sha256=V3FhKbm7G2LnR0s4SytavrjIPNIhvcsAGXfYHAwtQzw,10
-streamlit_nightly-1.29.1.dev20240107.dist-info/RECORD,,
+streamlit_nightly-1.29.1.dev20240108.data/scripts/streamlit.cmd,sha256=ZEYM3vBJSp-k7vwSJ3ba5NzEk9-qHdSeLvGYAAe1mMw,676
+streamlit_nightly-1.29.1.dev20240108.dist-info/METADATA,sha256=oeseS0DVVM0HrRumD9FlXhFaDYwY-BeX2q4ZPia3grQ,8180
+streamlit_nightly-1.29.1.dev20240108.dist-info/WHEEL,sha256=-G_t0oGuE7UD0DrSpVZnq1hHMBV9DD2XkS5v7XpmTnk,110
+streamlit_nightly-1.29.1.dev20240108.dist-info/entry_points.txt,sha256=uNJ4DwGNXEhOK0USwSNanjkYyR-Bk7eYQbJFDrWyOgY,53
+streamlit_nightly-1.29.1.dev20240108.dist-info/top_level.txt,sha256=V3FhKbm7G2LnR0s4SytavrjIPNIhvcsAGXfYHAwtQzw,10
+streamlit_nightly-1.29.1.dev20240108.dist-info/RECORD,,