streamlit-nightly 1.36.1.dev20240707__py2.py3-none-any.whl → 1.36.1.dev20240709__py2.py3-none-any.whl

streamlit/code_util.py

@@ -73,7 +73,7 @@ def get_method_args_from_code(args: list[Any], line: str) -> list[str]:
 
     Example
     -------
-    >>> line = 'foo(bar, baz, my(func, tion))'
+    >>> line = "foo(bar, baz, my(func, tion))"
     >>>
     >>> get_method_args_from_code(range(0, 3), line)
     ['bar', 'baz', 'my(func, tion)']

streamlit/commands/execution_control.py

@@ -39,11 +39,11 @@ def stop() -> NoReturn:  # type: ignore[misc]
     -------
     >>> import streamlit as st
     >>>
-    >>> name = st.text_input('Name')
+    >>> name = st.text_input("Name")
     >>> if not name:
     >>>   st.warning('Please input a name.')
     >>>   st.stop()
-    >>> st.success('Thank you for inputting a name.')
+    >>> st.success("Thank you for inputting a name.")
 
     """
     ctx = get_script_run_ctx()
@@ -151,6 +151,10 @@ def switch_page(page: str | StreamlitPage) -> NoReturn:  # type: ignore[misc]
 
         page_script_hash = matched_pages[0]["page_script_hash"]
 
+    # We want to reset query params (with exception of embed) when switching pages
+    with ctx.session_state.query_params() as qp:
+        qp.clear()
+
     ctx.script_requests.request_rerun(
         RerunData(
             query_string=ctx.query_string,

streamlit/commands/logo.py

@@ -81,7 +81,11 @@ def logo(
 
     >>> import streamlit as st
     >>>
-    >>> st.logo(LOGO_URL_LARGE, link="https://streamlit.io/gallery", icon_image=LOGO_URL_SMALL)
+    >>> st.logo(
+    ...     LOGO_URL_LARGE,
+    ...     link="https://streamlit.io/gallery",
+    ...     icon_image=LOGO_URL_SMALL,
+    ... )
 
     Try switching logos around in the following example:
 

streamlit/commands/navigation.py

@@ -126,14 +126,14 @@ def navigation(
     >>> import streamlit as st
     >>>
     >>> pages = {
-    ...     "Your account" : [
+    ...     "Your account": [
     ...         st.Page("create_account.py", title="Create your account"),
-    ...         st.Page("manage_account.py", title="Manage your account")
+    ...         st.Page("manage_account.py", title="Manage your account"),
     ...     ],
-    ...     "Resources" : [
+    ...     "Resources": [
     ...         st.Page("learn.py", title="Learn about us"),
-    ...         st.Page("trial.py", title="Try it out")
-    ...     ]
+    ...         st.Page("trial.py", title="Try it out"),
+    ...     ],
     ... }
     >>>
     >>> pg = st.navigation(pages)

streamlit/connections/base_connection.py

@@ -164,7 +164,7 @@ class BaseConnection(ABC, Generic[RawConnectionT]):
         >>> # Note: is_healthy() isn't a real method and is just shown for example here.
         >>> if not conn.is_healthy():
         ...     conn.reset()
-        ...
+        >>>
         >>> # Do stuff with conn...
         """
         self._raw_instance = None

streamlit/connections/snowpark_connection.py

@@ -205,7 +205,7 @@ class SnowparkConnection(BaseConnection["Session"]):
         >>> conn = st.connection("snowpark")
         >>> with conn.safe_session() as session:
         ...     df = session.table("mytable").limit(10).to_pandas()
-        ...
+        >>>
         >>> st.dataframe(df)
         """
         with self._lock:

streamlit/connections/sql_connection.py

@@ -186,7 +186,11 @@ class SQLConnection(BaseConnection["Engine"]):
         >>> import streamlit as st
         >>>
         >>> conn = st.connection("sql")
-        >>> df = conn.query("select * from pet_owners where owner = :owner", ttl=3600, params={"owner":"barbara"})
+        >>> df = conn.query(
+        ...     "select * from pet_owners where owner = :owner",
+        ...     ttl=3600,
+        ...     params={"owner": "barbara"},
+        ... )
         >>> st.dataframe(df)
         """
 

streamlit/delta_generator.py

@@ -577,15 +577,13 @@ class DeltaGenerator(
         >>> import numpy as np
         >>>
         >>> df1 = pd.DataFrame(
-        ...    np.random.randn(50, 20),
-        ...    columns=('col %d' % i for i in range(20)))
-        ...
+        ...     np.random.randn(50, 20), columns=("col %d" % i for i in range(20))
+        ... )
         >>> my_table = st.table(df1)
         >>>
         >>> df2 = pd.DataFrame(
-        ...    np.random.randn(50, 20),
-        ...    columns=('col %d' % i for i in range(20)))
-        ...
+        ...     np.random.randn(50, 20), columns=("col %d" % i for i in range(20))
+        ... )
         >>> my_table.add_rows(df2)
         >>> # Now the table shown in the Streamlit app contains the data for
         >>> # df1 followed by the data for df2.
@@ -602,14 +600,16 @@ class DeltaGenerator(
         And for plots whose datasets are named, you can pass the data with a
         keyword argument where the key is the name:
 
-        >>> my_chart = st.vega_lite_chart({
-        ...     'mark': 'line',
-        ...     'encoding': {'x': 'a', 'y': 'b'},
-        ...     'datasets': {
-        ...       'some_fancy_name': df1,  # <-- named dataset
-        ...      },
-        ...     'data': {'name': 'some_fancy_name'},
-        ... }),
+        >>> my_chart = st.vega_lite_chart(
+        ...     {
+        ...         "mark": "line",
+        ...         "encoding": {"x": "a", "y": "b"},
+        ...         "datasets": {
+        ...             "some_fancy_name": df1,  # <-- named dataset
+        ...         },
+        ...         "data": {"name": "some_fancy_name"},
+        ...     }
+        ... )
         >>> my_chart.add_rows(some_fancy_name=df2)  # <-- name used as keyword
 
         """

streamlit/elements/arrow.py

@@ -587,7 +587,9 @@ class ArrowMixin:
         >>> import pandas as pd
         >>> import numpy as np
         >>>
-        >>> df = pd.DataFrame(np.random.randn(10, 5), columns=("col %d" % i for i in range(5)))
+        >>> df = pd.DataFrame(
+        ...     np.random.randn(10, 5), columns=("col %d" % i for i in range(5))
+        ... )
         >>>
         >>> st.table(df)
 
@@ -633,11 +635,15 @@ class ArrowMixin:
         >>> import pandas as pd
         >>> import numpy as np
         >>>
-        >>> df1 = pd.DataFrame(np.random.randn(50, 20), columns=("col %d" % i for i in range(20)))
+        >>> df1 = pd.DataFrame(
+        ...     np.random.randn(50, 20), columns=("col %d" % i for i in range(20))
+        ... )
         >>>
         >>> my_table = st.table(df1)
         >>>
-        >>> df2 = pd.DataFrame(np.random.randn(50, 20), columns=("col %d" % i for i in range(20)))
+        >>> df2 = pd.DataFrame(
+        ...     np.random.randn(50, 20), columns=("col %d" % i for i in range(20))
+        ... )
         >>>
         >>> my_table.add_rows(df2)
         >>> # Now the table shown in the Streamlit app contains the data for
@@ -655,14 +661,16 @@ class ArrowMixin:
         And for plots whose datasets are named, you can pass the data with a
         keyword argument where the key is the name:
 
-        >>> my_chart = st.vega_lite_chart({
-        ...     'mark': 'line',
-        ...     'encoding': {'x': 'a', 'y': 'b'},
-        ...     'datasets': {
-        ...       'some_fancy_name': df1,  # <-- named dataset
-        ...      },
-        ...     'data': {'name': 'some_fancy_name'},
-        ... }),
+        >>> my_chart = st.vega_lite_chart(
+        ...     {
+        ...         "mark": "line",
+        ...         "encoding": {"x": "a", "y": "b"},
+        ...         "datasets": {
+        ...             "some_fancy_name": df1,  # <-- named dataset
+        ...         },
+        ...         "data": {"name": "some_fancy_name"},
+        ...     }
+        ... )
         >>> my_chart.add_rows(some_fancy_name=df2)  # <-- name used as keyword
 
         """

streamlit/elements/bokeh_chart.py

@@ -70,12 +70,8 @@ class BokehMixin:
         >>> x = [1, 2, 3, 4, 5]
         >>> y = [6, 7, 2, 4, 5]
         >>>
-        >>> p = figure(
-        ...     title='simple line example',
-        ...     x_axis_label='x',
-        ...     y_axis_label='y')
-        ...
-        >>> p.line(x, y, legend_label='Trend', line_width=2)
+        >>> p = figure(title="simple line example", x_axis_label="x", y_axis_label="y")
+        >>> p.line(x, y, legend_label="Trend", line_width=2)
         >>>
         >>> st.bokeh_chart(p, use_container_width=True)
 

streamlit/elements/code.py

@@ -58,7 +58,7 @@ class CodeMixin:
         >>>
         >>> code = '''def hello():
         ...     print("Hello, Streamlit!")'''
-        >>> st.code(code, language='python')
+        >>> st.code(code, language="python")
 
         """
         code_proto = CodeProto()

streamlit/elements/deck_gl_json_chart.py

@@ -91,37 +91,40 @@ class PydeckMixin:
         >>> import pydeck as pdk
         >>>
         >>> chart_data = pd.DataFrame(
-        ...    np.random.randn(1000, 2) / [50, 50] + [37.76, -122.4],
-        ...    columns=['lat', 'lon'])
+        ...     np.random.randn(1000, 2) / [50, 50] + [37.76, -122.4],
+        ...     columns=["lat", "lon"],
+        ... )
         >>>
-        >>> st.pydeck_chart(pdk.Deck(
-        ...     map_style=None,
-        ...     initial_view_state=pdk.ViewState(
-        ...         latitude=37.76,
-        ...         longitude=-122.4,
-        ...         zoom=11,
-        ...         pitch=50,
-        ...     ),
-        ...     layers=[
-        ...         pdk.Layer(
-        ...            'HexagonLayer',
-        ...            data=chart_data,
-        ...            get_position='[lon, lat]',
-        ...            radius=200,
-        ...            elevation_scale=4,
-        ...            elevation_range=[0, 1000],
-        ...            pickable=True,
-        ...            extruded=True,
+        >>> st.pydeck_chart(
+        ...     pdk.Deck(
+        ...         map_style=None,
+        ...         initial_view_state=pdk.ViewState(
+        ...             latitude=37.76,
+        ...             longitude=-122.4,
+        ...             zoom=11,
+        ...             pitch=50,
         ...         ),
-        ...         pdk.Layer(
-        ...             'ScatterplotLayer',
-        ...             data=chart_data,
-        ...             get_position='[lon, lat]',
-        ...             get_color='[200, 30, 0, 160]',
-        ...             get_radius=200,
-        ...         ),
-        ...     ],
-        ... ))
+        ...         layers=[
+        ...             pdk.Layer(
+        ...                 "HexagonLayer",
+        ...                 data=chart_data,
+        ...                 get_position="[lon, lat]",
+        ...                 radius=200,
+        ...                 elevation_scale=4,
+        ...                 elevation_range=[0, 1000],
+        ...                 pickable=True,
+        ...                 extruded=True,
+        ...             ),
+        ...             pdk.Layer(
+        ...                 "ScatterplotLayer",
+        ...                 data=chart_data,
+        ...                 get_position="[lon, lat]",
+        ...                 get_color="[200, 30, 0, 160]",
+        ...                 get_radius=200,
+        ...             ),
+        ...         ],
+        ...     )
+        ... )
 
         .. output::
            https://doc-pydeck-chart.streamlit.app/

streamlit/elements/doc_string.py

@@ -90,7 +90,7 @@ class HelpMixin:
         >>>     return 'Woof!'
         >>>
         >>>
-        >>> fido = Dog('poodle', 'white')
+        >>> fido = Dog("poodle", "white")
         >>>
         >>> st.help(fido)
 

streamlit/elements/empty.py

@@ -66,7 +66,7 @@ class EmptyMixin:
         >>> with placeholder.container():
         ...     st.write("This is one element")
         ...     st.write("This is another")
-        ...
+        >>>
         >>> # Clear all those elements:
         >>> placeholder.empty()
 

streamlit/elements/exception.py

@@ -59,7 +59,7 @@ class ExceptionMixin:
         -------
         >>> import streamlit as st
         >>>
-        >>> e = RuntimeError('This is an exception of type RuntimeError')
+        >>> e = RuntimeError("This is an exception of type RuntimeError")
         >>> st.exception(e)
 
         """

streamlit/elements/form.py

@@ -162,15 +162,14 @@ class FormMixin:
         >>> import streamlit as st
         >>>
         >>> with st.form("my_form"):
-        ...    st.write("Inside the form")
-        ...    slider_val = st.slider("Form slider")
-        ...    checkbox_val = st.checkbox("Form checkbox")
-        ...
-        ...    # Every form must have a submit button.
-        ...    submitted = st.form_submit_button("Submit")
-        ...    if submitted:
-        ...        st.write("slider", slider_val, "checkbox", checkbox_val)
+        ...     st.write("Inside the form")
+        ...     slider_val = st.slider("Form slider")
+        ...     checkbox_val = st.checkbox("Form checkbox")
         ...
+        ...     # Every form must have a submit button.
+        ...     submitted = st.form_submit_button("Submit")
+        ...     if submitted:
+        ...         st.write("slider", slider_val, "checkbox", checkbox_val)
         >>> st.write("Outside the form")
 
         .. output::

streamlit/elements/graphviz_chart.py

@@ -66,19 +66,19 @@ class GraphvizMixin:
         >>>
         >>> # Create a graphlib graph object
         >>> graph = graphviz.Digraph()
-        >>> graph.edge('run', 'intr')
-        >>> graph.edge('intr', 'runbl')
-        >>> graph.edge('runbl', 'run')
-        >>> graph.edge('run', 'kernel')
-        >>> graph.edge('kernel', 'zombie')
-        >>> graph.edge('kernel', 'sleep')
-        >>> graph.edge('kernel', 'runmem')
-        >>> graph.edge('sleep', 'swap')
-        >>> graph.edge('swap', 'runswap')
-        >>> graph.edge('runswap', 'new')
-        >>> graph.edge('runswap', 'runmem')
-        >>> graph.edge('new', 'runmem')
-        >>> graph.edge('sleep', 'runmem')
+        >>> graph.edge("run", "intr")
+        >>> graph.edge("intr", "runbl")
+        >>> graph.edge("runbl", "run")
+        >>> graph.edge("run", "kernel")
+        >>> graph.edge("kernel", "zombie")
+        >>> graph.edge("kernel", "sleep")
+        >>> graph.edge("kernel", "runmem")
+        >>> graph.edge("sleep", "swap")
+        >>> graph.edge("swap", "runswap")
+        >>> graph.edge("runswap", "new")
+        >>> graph.edge("runswap", "runmem")
+        >>> graph.edge("new", "runmem")
+        >>> graph.edge("sleep", "runmem")
         >>>
         >>> st.graphviz_chart(graph)
 

streamlit/elements/heading.py

@@ -94,8 +94,8 @@ class HeadingMixin:
         --------
         >>> import streamlit as st
         >>>
-        >>> st.header('This is a header with a divider', divider='rainbow')
-        >>> st.header('_Streamlit_ is :blue[cool] :sunglasses:')
+        >>> st.header("This is a header with a divider", divider="rainbow")
+        >>> st.header("_Streamlit_ is :blue[cool] :sunglasses:")
 
         .. output::
            https://doc-header.streamlit.app/
@@ -167,8 +167,8 @@ class HeadingMixin:
         --------
         >>> import streamlit as st
         >>>
-        >>> st.subheader('This is a subheader with a divider', divider='rainbow')
-        >>> st.subheader('_Streamlit_ is :blue[cool] :sunglasses:')
+        >>> st.subheader("This is a subheader with a divider", divider="rainbow")
+        >>> st.subheader("_Streamlit_ is :blue[cool] :sunglasses:")
 
         .. output::
            https://doc-subheader.streamlit.app/
@@ -234,8 +234,8 @@ class HeadingMixin:
         --------
         >>> import streamlit as st
         >>>
-        >>> st.title('This is a title')
-        >>> st.title('_Streamlit_ is :blue[cool] :sunglasses:')
+        >>> st.title("This is a title")
+        >>> st.title("_Streamlit_ is :blue[cool] :sunglasses:")
 
         .. output::
            https://doc-title.streamlit.app/

streamlit/elements/html.py

@@ -57,7 +57,9 @@ class HtmlMixin:
         -------
         >>> import streamlit as st
         >>>
-        >>> st.html("<p><span style='text-decoration: line-through double red;'>Oops</span>!</p>")
+        >>> st.html(
+        ...     "<p><span style='text-decoration: line-through double red;'>Oops</span>!</p>"
+        ... )
 
         .. output::
            https://doc-html.streamlit.app/

streamlit/elements/image.py

@@ -140,7 +140,7 @@ class ImageMixin:
         Example
         -------
         >>> import streamlit as st
-        >>> st.image('sunrise.jpg', caption='Sunrise by the mountains')
+        >>> st.image("sunrise.jpg", caption="Sunrise by the mountains")
 
         .. output::
            https://doc-image.streamlit.app/

streamlit/elements/json.py

@@ -58,16 +58,18 @@ class JsonMixin:
         -------
         >>> import streamlit as st
         >>>
-        >>> st.json({
-        ...     'foo': 'bar',
-        ...     'baz': 'boz',
-        ...     'stuff': [
-        ...         'stuff 1',
-        ...         'stuff 2',
-        ...         'stuff 3',
-        ...         'stuff 5',
-        ...     ],
-        ... })
+        >>> st.json(
+        ...     {
+        ...         "foo": "bar",
+        ...         "baz": "boz",
+        ...         "stuff": [
+        ...             "stuff 1",
+        ...             "stuff 2",
+        ...             "stuff 3",
+        ...             "stuff 5",
+        ...         ],
+        ...     }
+        ... )
 
         .. output::
            https://doc-json.streamlit.app/

streamlit/elements/layouts.py

@@ -73,11 +73,11 @@ class LayoutsMixin:
         >>> import streamlit as st
         >>>
         >>> with st.container():
-        ...    st.write("This is inside the container")
-        ...
-        ...    # You can call any Streamlit command, including custom components:
-        ...    st.bar_chart(np.random.randn(50, 3))
+        ...     st.write("This is inside the container")
         ...
+        ...     # You can call any Streamlit command, including custom components:
+        ...     st.bar_chart(np.random.randn(50, 3))
+        >>>
         >>> st.write("This is outside the container")
 
         .. output ::
@@ -201,16 +201,16 @@ class LayoutsMixin:
         >>> col1, col2, col3 = st.columns(3)
         >>>
         >>> with col1:
-        ...    st.header("A cat")
-        ...    st.image("https://static.streamlit.io/examples/cat.jpg")
-        ...
+        ...     st.header("A cat")
+        ...     st.image("https://static.streamlit.io/examples/cat.jpg")
+        >>>
         >>> with col2:
-        ...    st.header("A dog")
-        ...    st.image("https://static.streamlit.io/examples/dog.jpg")
-        ...
+        ...     st.header("A dog")
+        ...     st.image("https://static.streamlit.io/examples/dog.jpg")
+        >>>
         >>> with col3:
-        ...    st.header("An owl")
-        ...    st.image("https://static.streamlit.io/examples/owl.jpg")
+        ...     st.header("An owl")
+        ...     st.image("https://static.streamlit.io/examples/owl.jpg")
 
         .. output ::
             https://doc-columns1.streamlit.app/
@@ -386,16 +386,14 @@ class LayoutsMixin:
         >>> tab1, tab2, tab3 = st.tabs(["Cat", "Dog", "Owl"])
         >>>
         >>> with tab1:
-        ...    st.header("A cat")
-        ...    st.image("https://static.streamlit.io/examples/cat.jpg", width=200)
-        ...
+        ...     st.header("A cat")
+        ...     st.image("https://static.streamlit.io/examples/cat.jpg", width=200)
         >>> with tab2:
-        ...    st.header("A dog")
-        ...    st.image("https://static.streamlit.io/examples/dog.jpg", width=200)
-        ...
+        ...     st.header("A dog")
+        ...     st.image("https://static.streamlit.io/examples/dog.jpg", width=200)
         >>> with tab3:
-        ...    st.header("An owl")
-        ...    st.image("https://static.streamlit.io/examples/owl.jpg", width=200)
+        ...     st.header("An owl")
+        ...     st.image("https://static.streamlit.io/examples/owl.jpg", width=200)
 
         .. output ::
             https://doc-tabs1.streamlit.app/
@@ -799,7 +797,9 @@ class LayoutsMixin:
         ...     time.sleep(1)
         ...     st.write("Downloading data...")
         ...     time.sleep(1)
-        ...     status.update(label="Download complete!", state="complete", expanded=False)
+        ...     status.update(
+        ...         label="Download complete!", state="complete", expanded=False
+        ...     )
         >>>
         >>> st.button("Rerun")
 

streamlit/elements/lib/built_in_chart_utils.py

@@ -117,6 +117,17 @@ _MELTED_COLOR_COLUMN_NAME: Final = _MELTED_COLOR_COLUMN_TITLE + _PROTECTION_SUFF
 _NON_EXISTENT_COLUMN_NAME: Final = "DOES_NOT_EXIST" + _PROTECTION_SUFFIX
 
 
+def maybe_raise_stack_warning(
+    stack: bool | ChartStackType | None, command: str | None, docs_link: str
+):
+    # Check that the stack parameter is valid, raise more informative error message if not
+    if stack not in (None, True, False, "normalize", "center", "layered"):
+        raise StreamlitAPIException(
+            f'Invalid value for stack parameter: {stack}. Stack must be one of True, False, "normalize", "center", "layered" or None. '
+            f"See documentation for `{command}` [here]({docs_link}) for more information."
+        )
+
+
 def generate_chart(
     chart_type: ChartType,
     data: Data | None,
@@ -128,7 +139,7 @@ def generate_chart(
     size_from_user: str | float | None = None,
     width: int | None = None,
     height: int | None = None,
-    # Bar charts only:
+    # Bar & Area charts only:
     stack: bool | ChartStackType | None = None,
 ) -> tuple[alt.Chart, AddRowsMetadata]:
     """Function to use the chart's type, data columns and indices to figure out the chart's spec."""
@@ -457,11 +468,13 @@ def _melt_data(
     --------
 
     >>> import pandas as pd
-    >>> df = pd.DataFrame({
-    ...     "a": [1, 2, 3],
-    ...     "b": [4, 5, 6],
-    ...     "c": [7, 8, 9],
-    ... })
+    >>> df = pd.DataFrame(
+    ...     {
+    ...         "a": [1, 2, 3],
+    ...         "b": [4, 5, 6],
+    ...         "c": [7, 8, 9],
+    ...     }
+    ... )
     >>> _melt_data(df, ["a"], ["b", "c"], "value", "color")
     >>>    a color  value
     >>> 0  1        b      4
@@ -673,6 +686,7 @@ def _get_opacity_encoding(
 ) -> alt.OpacityValue | None:
     import altair as alt
 
+    # Opacity set to 0.7 for all area charts
     if color_column and chart_type == ChartType.AREA:
         return alt.OpacityValue(0.7)
 
@@ -759,7 +773,7 @@ def _get_axis_encodings(
         )
         stack_encoding = y_encoding
 
-    # Handle stacking - only relevant for bar charts
+    # Handle stacking - only relevant for bar & area charts
     _update_encoding_with_stack(stack, stack_encoding)
 
     return x_encoding, y_encoding

streamlit/elements/markdown.py

@@ -141,7 +141,7 @@ class MarkdownMixin:
         >>>
         >>> code = '''def hello():
         ...     print("Hello, Streamlit!")'''
-        >>> st.code(code, language='python')
+        >>> st.code(code, language="python")
 
         """
         code_proto = MarkdownProto()
@@ -206,8 +206,8 @@ class MarkdownMixin:
         --------
         >>> import streamlit as st
         >>>
-        >>> st.caption('This is a string that explains something above.')
-        >>> st.caption('A caption with _italics_ :blue[colors] and emojis :sunglasses:')
+        >>> st.caption("This is a string that explains something above.")
+        >>> st.caption("A caption with _italics_ :blue[colors] and emojis :sunglasses:")
 
         """
         caption_proto = MarkdownProto()