streamlit-nightly 1.38.1.dev20240917__py2.py3-none-any.whl → 1.38.1.dev20240919__py2.py3-none-any.whl

streamlit/commands/navigation.py

@@ -57,6 +57,7 @@ def navigation(
     pages: list[StreamlitPage] | dict[SectionHeader, list[StreamlitPage]],
     *,
     position: Literal["sidebar", "hidden"] = "sidebar",
+    expanded: bool = False,
 ) -> StreamlitPage:
     """
     Configure the available pages in a multipage app.
@@ -102,6 +103,12 @@ def navigation(
         If there is only one page in ``pages``, the navigation will be hidden
         for any value of ``position``.
 
+    expanded: bool
+        Whether the navigation menu should be expanded. If ``True``,
+        the navigation menu will always be expanded. If ``False``, the
+        navigation menu will be collapsed and will include a button
+        to view more options.
+
     Returns
     -------
     StreamlitPage
@@ -215,6 +222,8 @@ def navigation(
         msg.navigation.position = NavigationProto.Position.HIDDEN
     else:
         msg.navigation.position = NavigationProto.Position.SIDEBAR
+
+    msg.navigation.expanded = expanded
     msg.navigation.sections[:] = nav_sections.keys()
     for section_header in nav_sections:
         for page in nav_sections[section_header]:

streamlit/components/v1/custom_component.py

@@ -173,23 +173,19 @@ And if you're using Streamlit Cloud, add "pyarrow" to your requirements.txt."""
                 computed_id = compute_and_register_element_id(
                     "component_instance",
                     user_key=key,
-                    name=self.name,
                     form_id=current_form_id(dg),
+                    name=self.name,
                     url=self.url,
-                    key=key,
                     json_args=serialized_json_args,
                     special_args=special_args,
-                    page=ctx.active_script_hash if ctx else None,
                 )
             else:
                 computed_id = compute_and_register_element_id(
                     "component_instance",
                     user_key=key,
-                    name=self.name,
                     form_id=current_form_id(dg),
+                    name=self.name,
                     url=self.url,
-                    key=key,
-                    page=ctx.active_script_hash if ctx else None,
                 )
             element.component_instance.id = computed_id
 

streamlit/elements/arrow.py

@@ -568,17 +568,15 @@ class ArrowMixin:
             proto.id = compute_and_register_element_id(
                 "dataframe",
                 user_key=key,
+                form_id=proto.form_id,
                 data=proto.data,
                 width=width,
                 height=height,
                 use_container_width=use_container_width,
                 column_order=proto.column_order,
                 column_config=proto.columns,
-                key=key,
                 selection_mode=selection_mode,
                 is_selection_activated=is_selection_activated,
-                form_id=proto.form_id,
-                page=ctx.active_script_hash if ctx else None,
             )
 
             serde = DataframeSelectionSerde()

streamlit/elements/deck_gl_json_chart.py

@@ -39,6 +39,8 @@ class PydeckMixin:
         self,
         pydeck_obj: Deck | None = None,
         use_container_width: bool = False,
+        width: int | None = None,
+        height: int | None = None,
     ) -> DeltaGenerator:
         """Draw a chart using the PyDeck library.
 
@@ -68,7 +70,7 @@ class PydeckMixin:
 
         Parameters
         ----------
-        pydeck_obj: pydeck.Deck or None
+        pydeck_obj : pydeck.Deck or None
             Object specifying the PyDeck chart to draw.
         use_container_width : bool
             Whether to override the figure's native width with the width of
@@ -77,6 +79,19 @@ class PydeckMixin:
             according to the plotting library, up to the width of the parent
             container. If ``use_container_width`` is ``True``, Streamlit sets
             the width of the figure to match the width of the parent container.
+        width : int or None
+            Desired width of the chart expressed in pixels. If ``width`` is
+            ``None`` (default), Streamlit sets the width of the chart to fit
+            its contents according to the plotting library, up to the width of
+            the parent container. If ``width`` is greater than the width of the
+            parent container, Streamlit sets the chart width to match the width
+            of the parent container.
+
+            To use ``width``, you must set ``use_container_width=False``.
+        height : int or None
+            Desired height of the chart expressed in pixels. If ``height`` is
+            ``None`` (default), Streamlit sets the height of the chart to fit
+            its contents according to the plotting library.
 
         Example
         -------
@@ -134,7 +149,9 @@ class PydeckMixin:
 
         """
         pydeck_proto = PydeckProto()
-        marshall(pydeck_proto, pydeck_obj, use_container_width)
+        marshall(
+            pydeck_proto, pydeck_obj, use_container_width, width=width, height=height
+        )
         return self.dg._enqueue("deck_gl_json_chart", pydeck_proto)
 
     @property
@@ -165,6 +182,8 @@ def marshall(
     pydeck_proto: PydeckProto,
     pydeck_obj: Deck | None,
     use_container_width: bool,
+    width: int | None = None,
+    height: int | None = None,
 ) -> None:
     if pydeck_obj is None:
         spec = json.dumps(EMPTY_MAP)
@@ -174,6 +193,11 @@ def marshall(
     pydeck_proto.json = spec
     pydeck_proto.use_container_width = use_container_width
 
+    if width:
+        pydeck_proto.width = width
+    if height:
+        pydeck_proto.height = height
+
     pydeck_proto.id = ""
 
     tooltip = _get_pydeck_tooltip(pydeck_obj)

streamlit/elements/form.py

@@ -61,7 +61,12 @@ def _build_duplicate_form_message(user_key: str | None = None) -> str:
 class FormMixin:
     @gather_metrics("form")
     def form(
-        self, key: str, clear_on_submit: bool = False, *, border: bool = True
+        self,
+        key: str,
+        clear_on_submit: bool = False,
+        *,
+        enter_to_submit: bool = True,
+        border: bool = True,
     ) -> DeltaGenerator:
         """Create a form that batches elements together with a "Submit" button.
 
@@ -93,6 +98,9 @@ class FormMixin:
             values after the user presses the Submit button. Defaults to False.
             (Note that Custom Components are unaffected by this flag, and
             will not be reset to their defaults on form submission.)
+        enter_to_submit : bool
+            Whether to submit the form when a user presses Enter while
+            interacting with a widget inside the form. Defaults to True.
         border : bool
             Whether to show a border around the form. Defaults to True.
 
@@ -159,6 +167,7 @@ class FormMixin:
         block_proto = Block_pb2.Block()
         block_proto.form.form_id = form_id
         block_proto.form.clear_on_submit = clear_on_submit
+        block_proto.form.enter_to_submit = enter_to_submit
         block_proto.form.border = border
         block_dg = self.dg._block(block_proto)
 

streamlit/elements/layouts.py

@@ -162,8 +162,13 @@ class LayoutsMixin:
                 block_proto.vertical.border = True
 
         if key:
+            # At the moment, the ID is only used for extracting the
+            # key on the frontend and setting it as CSS class.
+            # There are plans to use the ID for other container features
+            # in the future. This might require including more container
+            # parameters in the ID calculation.
             block_proto.id = compute_and_register_element_id(
-                "container", user_key=key, height=height, border=border
+                "container", user_key=key, form_id=None
             )
 
         return self.dg._block(block_proto)

streamlit/elements/lib/utils.py

@@ -90,7 +90,9 @@ def to_key(key: Key | None) -> str | None:
     return None if key is None else str(key)
 
 
-def _register_element_id(element_type: str, element_id: str) -> None:
+def _register_element_id(
+    ctx: ScriptRunContext, element_type: str, element_id: str
+) -> None:
     """Register the element ID and key for the given element.
 
     If the element ID or key is not unique, an error is raised.
@@ -114,8 +116,8 @@ def _register_element_id(element_type: str, element_id: str) -> None:
         If the element ID is not unique.
 
     """
-    ctx = get_script_run_ctx()
-    if ctx is None or not element_id:
+
+    if not element_id:
         return
 
     if user_key := user_key_from_element_id(element_id):
@@ -148,6 +150,12 @@ def _compute_element_id(
     """
     h = hashlib.new("md5", **HASHLIB_KWARGS)
     h.update(element_type.encode("utf-8"))
+    if user_key:
+        # Adding this to the hash isn't necessary for uniqueness since the
+        # key is also appended to the ID as raw text. But since the hash and
+        # the appending of the key are two slightly different aspects, it
+        # still gets put into the hash.
+        h.update(user_key.encode("utf-8"))
     # This will iterate in a consistent order when the provided arguments have
     # consistent order; dicts are always in insertion order.
     for k, v in kwargs.items():
@@ -158,7 +166,9 @@ def _compute_element_id(
 
 def compute_and_register_element_id(
     element_type: str,
-    user_key: str | None = None,
+    *,
+    user_key: str | None,
+    form_id: str | None,
     **kwargs: SAFE_VALUES | Iterable[SAFE_VALUES],
 ) -> str:
     """Compute and register the ID for the given element.
@@ -175,9 +185,45 @@ def compute_and_register_element_id(
     The element ID gets registered to make sure that only one ID and user-specified
     key exists at the same time. If there are duplicated IDs or keys, an error
     is raised.
+
+    Parameters
+    ----------
+    element_type : str
+        The type (command name) of the element to register.
+
+    user_key : str | None
+        The user-specified key for the element. `None` if no key is provided
+        or if the element doesn't support a specifying a key.
+
+    form_id : str | None
+        The ID of the form that the element belongs to. `None` or empty string
+        if the element doesn't belong to a form or doesn't support forms.
+
+    kwargs : SAFE_VALUES | Iterable[SAFE_VALUES]
+        The arguments to use to compute the element ID.
+        The arguments must be stable, deterministic values.
+        Some common parameters like key, disabled,
+        format_func, label_visibility, args, kwargs, on_change, and
+        the active_script_hash are not supposed to be added here
     """
-    element_id = _compute_element_id(element_type, user_key, **kwargs)
-    _register_element_id(element_type, element_id)
+    ctx = get_script_run_ctx()
+
+    # If form_id is provided, add it to the kwargs.
+    kwargs_to_use = {"form_id": form_id, **kwargs} if form_id else kwargs
+
+    if ctx:
+        # Add the active script hash to give elements on different
+        # pages unique IDs.
+        kwargs_to_use["active_script_hash"] = ctx.active_script_hash
+
+    element_id = _compute_element_id(
+        element_type,
+        user_key,
+        **kwargs_to_use,
+    )
+
+    if ctx:
+        _register_element_id(ctx, element_type, element_id)
     return element_id
 
 

streamlit/elements/map.py

@@ -84,6 +84,8 @@ class MapMixin:
         size: None | str | float = None,
         zoom: int | None = None,
         use_container_width: bool = True,
+        width: int | None = None,
+        height: int | None = None,
     ) -> DeltaGenerator:
         """Display a map with a scatterplot overlaid onto it.
 
@@ -162,6 +164,21 @@ class MapMixin:
             Streamlit sets the width of the chart to fit its contents according
             to the plotting library, up to the width of the parent container.
 
+        width : int or None
+            Desired width of the chart expressed in pixels. If ``width`` is
+            ``None`` (default), Streamlit sets the width of the chart to fit
+            its contents according to the plotting library, up to the width of
+            the parent container. If ``width`` is greater than the width of the
+            parent container, Streamlit sets the chart width to match the width
+            of the parent container.
+
+            To use ``width``, you must set ``use_container_width=False``.
+
+        height : int or None
+            Desired height of the chart expressed in pixels. If ``height`` is
+            ``None`` (default), Streamlit sets the height of the chart to fit
+            its contents according to the plotting library.
+
         Examples
         --------
         >>> import streamlit as st
@@ -223,7 +240,9 @@ class MapMixin:
         deck_gl_json = to_deckgl_json(
             data, latitude, longitude, size, color, map_style, zoom
         )
-        marshall(map_proto, deck_gl_json, use_container_width)
+        marshall(
+            map_proto, deck_gl_json, use_container_width, width=width, height=height
+        )
         return self.dg._enqueue("deck_gl_json_chart", map_proto)
 
     @property
@@ -471,8 +490,15 @@ def marshall(
     pydeck_proto: DeckGlJsonChartProto,
     pydeck_json: str,
     use_container_width: bool,
+    height: int | None = None,
+    width: int | None = None,
 ) -> None:
     pydeck_proto.json = pydeck_json
     pydeck_proto.use_container_width = use_container_width
 
+    if width:
+        pydeck_proto.width = width
+    if height:
+        pydeck_proto.height = height
+
     pydeck_proto.id = ""

streamlit/elements/media.py

@@ -23,6 +23,7 @@ from typing import TYPE_CHECKING, Dict, Final, Union, cast
 from typing_extensions import TypeAlias
 
 from streamlit import runtime, type_util, url_util
+from streamlit.elements.lib.form_utils import current_form_id
 from streamlit.elements.lib.subtitle_utils import process_subtitle_data
 from streamlit.elements.lib.utils import compute_and_register_element_id
 from streamlit.errors import StreamlitAPIException
@@ -30,7 +31,6 @@ from streamlit.proto.Audio_pb2 import Audio as AudioProto
 from streamlit.proto.Video_pb2 import Video as VideoProto
 from streamlit.runtime import caching
 from streamlit.runtime.metrics_util import gather_metrics
-from streamlit.runtime.scriptrunner_utils.script_run_context import get_script_run_ctx
 from streamlit.time_util import time_to_seconds
 from streamlit.type_util import NumpyShape
 
@@ -191,6 +191,7 @@ class MediaMixin:
             end_time,
             loop,
             autoplay,
+            form_id=current_form_id(self.dg),
         )
         return self.dg._enqueue("audio", audio_proto)
 
@@ -349,6 +350,7 @@ class MediaMixin:
             loop,
             autoplay,
             muted,
+            form_id=current_form_id(self.dg),
         )
         return self.dg._enqueue("video", video_proto)
 
@@ -457,6 +459,7 @@ def marshall_video(
     loop: bool = False,
     autoplay: bool = False,
     muted: bool = False,
+    form_id: str | None = None,
 ) -> None:
     """Marshalls a video proto, using url processors as needed.
 
@@ -499,6 +502,9 @@ def marshall_video(
     muted: bool
         Whether the video should play with the audio silenced. This can be used to
         enable autoplay without user interaction. Defaults to False.
+    form_id: str | None
+        The ID of the form that this element is placed in. Provide None if
+        the element is not placed in a form.
     """
 
     if start_time < 0 or (end_time is not None and end_time <= start_time):
@@ -565,10 +571,12 @@ def marshall_video(
                 ) from original_err
 
     if autoplay:
-        ctx = get_script_run_ctx()
         proto.autoplay = autoplay
         proto.id = compute_and_register_element_id(
             "video",
+            # video does not yet allow setting a user-defined key
+            user_key=None,
+            form_id=form_id,
             url=proto.url,
             mimetype=mimetype,
             start_time=start_time,
@@ -576,7 +584,6 @@ def marshall_video(
             loop=loop,
             autoplay=autoplay,
             muted=muted,
-            page=ctx.active_script_hash if ctx else None,
         )
 
 
@@ -696,6 +703,7 @@ def marshall_audio(
     end_time: int | None = None,
     loop: bool = False,
     autoplay: bool = False,
+    form_id: str | None = None,
 ) -> None:
     """Marshalls an audio proto, using data and url processors as needed.
 
@@ -722,6 +730,9 @@ def marshall_audio(
     autoplay : bool
         Whether the audio should start playing automatically.
         Browsers will not autoplay audio files if the user has not interacted with the page yet.
+    form_id: str | None
+        The ID of the form that this element is placed in. Provide None if
+        the element is not placed in a form.
     """
 
     proto.start_time = start_time
@@ -739,10 +750,11 @@ def marshall_audio(
         _marshall_av_media(coordinates, proto, data, mimetype)
 
     if autoplay:
-        ctx = get_script_run_ctx()
         proto.autoplay = autoplay
         proto.id = compute_and_register_element_id(
             "audio",
+            user_key=None,
+            form_id=form_id,
             url=proto.url,
             mimetype=mimetype,
             start_time=start_time,
@@ -750,5 +762,4 @@ def marshall_audio(
             end_time=end_time,
             loop=loop,
             autoplay=autoplay,
-            page=ctx.active_script_hash if ctx else None,
         )

streamlit/elements/plotly_chart.py

@@ -506,15 +506,13 @@ class PlotlyMixin:
         plotly_chart_proto.id = compute_and_register_element_id(
             "plotly_chart",
             user_key=key,
-            key=key,
+            form_id=plotly_chart_proto.form_id,
             plotly_spec=plotly_chart_proto.spec,
             plotly_config=plotly_chart_proto.config,
             selection_mode=selection_mode,
             is_selection_activated=is_selection_activated,
             theme=theme,
-            form_id=plotly_chart_proto.form_id,
             use_container_width=use_container_width,
-            page=ctx.active_script_hash if ctx else None,
         )
 
         if is_selection_activated:

streamlit/elements/vega_charts.py

@@ -1894,7 +1894,7 @@ class VegaChartsMixin:
             vega_lite_proto.id = compute_and_register_element_id(
                 "arrow_vega_lite_chart",
                 user_key=key,
-                key=key,
+                form_id=vega_lite_proto.form_id,
                 vega_lite_spec=vega_lite_proto.spec,
                 # The data is either in vega_lite_proto.data.data
                 # or in a named dataset in vega_lite_proto.datasets
@@ -1905,8 +1905,6 @@ class VegaChartsMixin:
                 theme=theme,
                 use_container_width=use_container_width,
                 selection_mode=parsed_selection_modes,
-                form_id=vega_lite_proto.form_id,
-                page=ctx.active_script_hash if ctx else None,
             )
 
             serde = VegaLiteStateSerde(parsed_selection_modes)

streamlit/elements/widgets/button.py

@@ -673,15 +673,15 @@ class ButtonMixin:
         element_id = compute_and_register_element_id(
             "download_button",
             user_key=key,
+            # download_button is not allowed to be used in a form.
+            form_id=None,
             label=label,
             icon=icon,
             file_name=file_name,
             mime=mime,
-            key=key,
             help=help,
             type=type,
             use_container_width=use_container_width,
-            page=ctx.active_script_hash if ctx else None,
         )
 
         if is_in_form(self.dg):
@@ -853,17 +853,19 @@ class ButtonMixin:
             enable_check_callback_rules=not is_form_submitter,
         )
 
+        # Only the form submitter button needs a form ID at the moment.
+        form_id = current_form_id(self.dg) if is_form_submitter else ""
         element_id = compute_and_register_element_id(
             "button",
             user_key=key,
+            # Only the
+            form_id=form_id,
             label=label,
             icon=icon,
-            key=key,
             help=help,
             is_form_submitter=is_form_submitter,
             type=type,
             use_container_width=use_container_width,
-            page=ctx.active_script_hash if ctx else None,
         )
 
         # It doesn't make sense to create a button inside a form (except
@@ -886,7 +888,7 @@ class ButtonMixin:
         button_proto.label = label
         button_proto.default = False
         button_proto.is_form_submitter = is_form_submitter
-        button_proto.form_id = current_form_id(self.dg)
+        button_proto.form_id = form_id
         button_proto.type = type
         button_proto.use_container_width = use_container_width
         button_proto.disabled = disabled

streamlit/elements/widgets/button_group.py

@@ -399,12 +399,10 @@ class ButtonGroupMixin:
         element_id = compute_and_register_element_id(
             widget_name,
             user_key=key,
-            key=key,
+            form_id=form_id,
             options=formatted_options,
             default=default,
-            form_id=form_id,
             click_mode=click_mode,
-            page=ctx.active_script_hash if ctx else None,
         )
 
         proto = _build_proto(

streamlit/elements/widgets/camera_input.py

@@ -206,11 +206,9 @@ class CameraInputMixin:
         element_id = compute_and_register_element_id(
             "camera_input",
             user_key=key,
+            form_id=current_form_id(self.dg),
             label=label,
-            key=key,
             help=help,
-            form_id=current_form_id(self.dg),
-            page=ctx.active_script_hash if ctx else None,
         )
 
         camera_input_proto = CameraInputProto()

streamlit/elements/widgets/chat.py

@@ -330,10 +330,10 @@ class ChatMixin:
         element_id = compute_and_register_element_id(
             "chat_input",
             user_key=key,
-            key=key,
+            # chat_input is not allowed to be used in a form.
+            form_id=None,
             placeholder=placeholder,
             max_chars=max_chars,
-            page=ctx.active_script_hash if ctx else None,
         )
 
         # It doesn't make sense to create a chat input inside a form.

streamlit/elements/widgets/checkbox.py

@@ -294,12 +294,10 @@ class CheckboxMixin:
         element_id = compute_and_register_element_id(
             "toggle" if type == CheckboxProto.StyleType.TOGGLE else "checkbox",
             user_key=key,
+            form_id=current_form_id(self.dg),
             label=label,
             value=bool(value),
-            key=key,
             help=help,
-            form_id=current_form_id(self.dg),
-            page=ctx.active_script_hash if ctx else None,
         )
 
         checkbox_proto = CheckboxProto()

streamlit/elements/widgets/color_picker.py

@@ -189,12 +189,10 @@ class ColorPickerMixin:
         element_id = compute_and_register_element_id(
             "color_picker",
             user_key=key,
+            form_id=current_form_id(self.dg),
             label=label,
             value=str(value),
-            key=key,
             help=help,
-            form_id=current_form_id(self.dg),
-            page=ctx.active_script_hash if ctx else None,
         )
 
         # set value default

streamlit/elements/widgets/data_editor.py

@@ -887,6 +887,7 @@ class DataEditorMixin:
         element_id = compute_and_register_element_id(
             "data_editor",
             user_key=key,
+            form_id=current_form_id(self.dg),
             data=arrow_bytes,
             width=width,
             height=height,
@@ -894,9 +895,6 @@ class DataEditorMixin:
             column_order=column_order,
             column_config_mapping=str(column_config_mapping),
             num_rows=num_rows,
-            key=key,
-            form_id=current_form_id(self.dg),
-            page=ctx.active_script_hash if ctx else None,
         )
 
         proto = ArrowProto()

streamlit/elements/widgets/file_uploader.py

@@ -408,13 +408,11 @@ class FileUploaderMixin:
         element_id = compute_and_register_element_id(
             "file_uploader",
             user_key=key,
+            form_id=current_form_id(self.dg),
             label=label,
             type=type,
             accept_multiple_files=accept_multiple_files,
-            key=key,
             help=help,
-            form_id=current_form_id(self.dg),
-            page=ctx.active_script_hash if ctx else None,
         )
 
         if type:

streamlit/elements/widgets/multiselect.py

@@ -274,15 +274,13 @@ class MultiSelectMixin:
         element_id = compute_and_register_element_id(
             widget_name,
             user_key=key,
+            form_id=form_id,
             label=label,
             options=formatted_options,
             default=default_values,
-            key=key,
             help=help,
             max_selections=max_selections,
             placeholder=placeholder,
-            form_id=form_id,
-            page=ctx.active_script_hash if ctx else None,
         )
 
         proto = MultiSelectProto()