streamlit-nightly 1.38.1.dev20240926__py2.py3-none-any.whl → 1.38.1.dev20240928__py2.py3-none-any.whl

streamlit/elements/lib/column_types.py

@@ -317,6 +317,9 @@ def NumberColumn(
         This does not impact the return value. Valid formatters: %d %e %f %g %i %u.
         You can also add prefixes and suffixes, e.g. ``"$ %.2f"`` to show a dollar prefix.
 
+        Number formatting from ``column_config`` always takes precedence over
+        number formatting from ``pandas.Styler``.
+
     min_value : int, float, or None
         The minimum value that can be entered.
         If None (default), there will be no minimum.
@@ -541,6 +544,8 @@ def LinkColumn(
         <https://pandas.pydata.org/docs/reference/api/pandas.io.formats.style.Styler.format.html>`_
         function on the underlying dataframe. Note that this makes the app slow,
         doesn't work with editable columns, and might be removed in the future.
+        Text formatting from ``column_config`` always takes precedence over
+        text formatting from ``pandas.Styler``.
 
     Examples
     --------
@@ -1213,6 +1218,9 @@ def DatetimeColumn(
         `momentJS docs <https://momentjs.com/docs/#/displaying/format/>`_ for available
         formats. If None (default), uses ``YYYY-MM-DD HH:mm:ss``.
 
+        Number formatting from ``column_config`` always takes precedence over
+        number formatting from ``pandas.Styler``.
+
     min_value: datetime.datetime or None
         The minimum datetime that can be entered.
         If None (default), there will be no minimum.
@@ -1332,6 +1340,9 @@ def TimeColumn(
         `momentJS docs <https://momentjs.com/docs/#/displaying/format/>`_ for available
         formats. If None (default), uses ``HH:mm:ss``.
 
+        Number formatting from ``column_config`` always takes precedence over
+        number formatting from ``pandas.Styler``.
+
     min_value: datetime.time or None
         The minimum time that can be entered.
         If None (default), there will be no minimum.
@@ -1446,6 +1457,9 @@ def DateColumn(
         `momentJS docs <https://momentjs.com/docs/#/displaying/format/>`_ for available
         formats. If None (default), uses ``YYYY-MM-DD``.
 
+        Number formatting from ``column_config`` always takes precedence over
+        number formatting from ``pandas.Styler``.
+
     min_value: datetime.date or None
         The minimum date that can be entered.
         If None (default), there will be no minimum.

streamlit/elements/plotly_chart.py

@@ -82,7 +82,7 @@ class PlotlySelectionState(TypedDict, total=False):
     """
     The schema for the Plotly chart selection state.
 
-    The selection state is stored in a dictionary-like object that suports both
+    The selection state is stored in a dictionary-like object that supports both
     key and attribute notation. Selection states cannot be programmatically
     changed or set through Session State.
 
@@ -170,7 +170,7 @@ class PlotlyState(TypedDict, total=False):
     """
     The schema for the Plotly chart event state.
 
-    The event state is stored in a dictionary-like object that suports both
+    The event state is stored in a dictionary-like object that supports both
     key and attribute notation. Event states cannot be programmatically
     changed or set through Session State.
 
@@ -179,7 +179,7 @@ class PlotlyState(TypedDict, total=False):
     Attributes
     ----------
     selection : dict
-        The state of the ``on_select`` event. This attribure returns a
+        The state of the ``on_select`` event. This attribute returns a
         dictionary-like object that supports both key and attribute notation.
         The attributes are described by the ``PlotlySelectionState`` dictionary
         schema.
@@ -396,8 +396,8 @@ class PlotlyMixin:
         Returns
         -------
         element or dict
-            If ``on_select`` is ``"ignore"`` (default), this method returns an
-            internal placeholder for the chart element. Otherwise, this method
+            If ``on_select`` is ``"ignore"`` (default), this command returns an
+            internal placeholder for the chart element. Otherwise, this command
             returns a dictionary-like object that supports both key and
             attribute notation. The attributes are described by the
             ``PlotlyState`` dictionary schema.
@@ -524,12 +524,12 @@ class PlotlyMixin:
             serde = PlotlyChartSelectionSerde()
 
             widget_state = register_widget(
-                "plotly_chart",
-                plotly_chart_proto,
+                plotly_chart_proto.id,
                 on_change_handler=on_select if callable(on_select) else None,
                 deserializer=serde.deserialize,
                 serializer=serde.serialize,
                 ctx=ctx,
+                value_type="string_value",
             )
 
             self.dg._enqueue("plotly_chart", plotly_chart_proto)

streamlit/elements/vega_charts.py

@@ -101,7 +101,7 @@ class VegaLiteState(TypedDict, total=False):
     """
     The schema for the Vega-Lite event state.
 
-    The event state is stored in a dictionary-like object that suports both
+    The event state is stored in a dictionary-like object that supports both
     key and attribute notation. Event states cannot be programmatically
     changed or set through Session State.
 
@@ -110,7 +110,7 @@ class VegaLiteState(TypedDict, total=False):
     Attributes
     ----------
     selection : dict
-        The state of the ``on_select`` event. This attribure returns a
+        The state of the ``on_select`` event. This attribute returns a
         dictionary-like object that supports both key and attribute notation.
         The name of each Vega-Lite selection parameter becomes an attribute in
         the ``selection`` dictionary. The format of the data within each
@@ -1570,9 +1570,9 @@ class VegaChartsMixin:
         Returns
         -------
         element or dict
-            If ``on_select`` is ``"ignore"`` (default), this method returns an
+            If ``on_select`` is ``"ignore"`` (default), this command returns an
             internal placeholder for the chart element that can be used with
-            the ``.add_rows()`` method. Otherwise, this method returns a
+            the ``.add_rows()`` method. Otherwise, this command returns a
             dictionary-like object that supports both key and attribute
             notation. The attributes are described by the ``VegaLiteState``
             dictionary schema.
@@ -1734,9 +1734,9 @@ class VegaChartsMixin:
         Returns
         -------
         element or dict
-            If ``on_select`` is ``"ignore"`` (default), this method returns an
+            If ``on_select`` is ``"ignore"`` (default), this command returns an
             internal placeholder for the chart element that can be used with
-            the ``.add_rows()`` method. Otherwise, this method returns a
+            the ``.add_rows()`` method. Otherwise, this command returns a
             dictionary-like object that supports both key and attribute
             notation. The attributes are described by the ``VegaLiteState``
             dictionary schema.
@@ -1910,12 +1910,12 @@ class VegaChartsMixin:
             serde = VegaLiteStateSerde(parsed_selection_modes)
 
             widget_state = register_widget(
-                "vega_lite_chart",
-                vega_lite_proto,
+                vega_lite_proto.id,
                 on_change_handler=on_select if callable(on_select) else None,
                 deserializer=serde.deserialize,
                 serializer=serde.serialize,
                 ctx=ctx,
+                value_type="string_value",
             )
 
             self.dg._enqueue(

streamlit/elements/widgets/audio_input.py

@@ -96,7 +96,7 @@ class AudioInputMixin:
         disabled: bool = False,
         label_visibility: LabelVisibility = "visible",
     ) -> UploadedFile | None:
-        r"""Display a widget that returns audio recording from the user's microphone.
+        r"""Display a widget that returns an audio recording from the user's microphone.
 
         Parameters
         ----------
@@ -124,14 +124,13 @@ class AudioInputMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             A tooltip that gets displayed next to the audio input.
 
         on_change : callable
-            An optional callback invoked when this audio_input's value
+            An optional callback invoked when this audio input's value
             changes.
 
         args : tuple
@@ -143,6 +142,7 @@ class AudioInputMixin:
         disabled : bool
             An optional boolean, which disables the audio input if set to
             True. Default is False.
+
         label_visibility : "visible", "hidden", or "collapsed"
             The visibility of the label. If "hidden", the label doesn't show but there
             is still empty space for it above the widget (equivalent to label="").
@@ -152,9 +152,9 @@ class AudioInputMixin:
         Returns
         -------
         None or UploadedFile
-            The UploadedFile class is a subclass of BytesIO, and therefore
-            it is "file-like". This means you can pass them anywhere where
-            a file is expected.
+            The UploadedFile class is a subclass of BytesIO, and therefore is
+            "file-like". This means you can pass an instance of it anywhere a
+            file is expected.
 
         Examples
         --------
@@ -165,6 +165,10 @@ class AudioInputMixin:
         >>> if audio_value:
         ...     st.audio(audio_value)
 
+        `View this example <https://doc-audio-input.streamlit.app/>`_ on
+        Community Cloud. ``st.experimental_audio_input`` is not yet fully
+        supported in embedded apps.
+
         """
         ctx = get_script_run_ctx()
         return self._audio_input(
@@ -226,14 +230,14 @@ class AudioInputMixin:
         serde = AudioInputSerde()
 
         audio_input_state = register_widget(
-            "audio_input",
-            audio_input_proto,
+            audio_input_proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="file_uploader_state_value",
         )
 
         self.dg._enqueue("audio_input", audio_input_proto)

streamlit/elements/widgets/button.py

@@ -122,9 +122,7 @@ class ButtonMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
-
+            based on its content. No two widgets may have the same key.
         help : str
             An optional tooltip that gets displayed when the button is
             hovered over.
@@ -179,8 +177,8 @@ class ButtonMixin:
             True if the button was clicked on the last run of the app,
             False otherwise.
 
-        Example
-        -------
+        Examples
+        --------
         >>> import streamlit as st
         >>>
         >>> st.button("Reset", type="primary")
@@ -193,6 +191,23 @@ class ButtonMixin:
            https://doc-buton.streamlit.app/
            height: 220px
 
+        Although you can add icons to your buttons through Markdown, the
+        ``icon`` parameter is a convenient and consistent alternative.
+
+        >>> import streamlit as st
+        >>>
+        >>> left, middle, right = st.columns(3)
+        >>> if left.button("Plain button", use_container_width=True):
+        ...     left.markdown("You clicked the plain button.")
+        >>> if middle.button("Emoji button", icon="😃", use_container_width=True):
+        ...     middle.markdown("You clicked the emoji button.")
+        >>> if right.button("Material button", icon=":material/mood:", use_container_width=True):
+        ...     right.markdown("You clicked the Material button.")
+
+        .. output::
+           https://doc-button-icons.streamlit.app/
+           height: 220px
+
         """
         key = to_key(key)
         ctx = get_script_run_ctx()
@@ -287,8 +302,7 @@ class ButtonMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             An optional tooltip that gets displayed when the button is
@@ -709,14 +723,14 @@ class ButtonMixin:
         serde = ButtonSerde()
 
         button_state = register_widget(
-            "download_button",
-            download_button_proto,
+            download_button_proto.id,
             on_change_handler=on_click,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="trigger_value",
         )
 
         self.dg._enqueue("download_button", download_button_proto)
@@ -902,14 +916,14 @@ class ButtonMixin:
         serde = ButtonSerde()
 
         button_state = register_widget(
-            "button",
-            button_proto,
+            button_proto.id,
             on_change_handler=on_click,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="trigger_value",
         )
 
         if ctx:

streamlit/elements/widgets/button_group.py

@@ -297,8 +297,7 @@ class ButtonGroupMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         disabled : bool
             An optional boolean, which disables the feedback widget if set
@@ -620,14 +619,14 @@ class ButtonGroupMixin:
         )
 
         widget_state = register_widget(
-            widget_name,
-            proto,
+            proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=deserializer,
             serializer=serializer,
             ctx=ctx,
+            value_type="int_array_value",
         )
 
         if widget_state.value_changed:

streamlit/elements/widgets/camera_input.py

@@ -124,8 +124,7 @@ class CameraInputMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             A tooltip that gets displayed next to the camera input.
@@ -152,19 +151,24 @@ class CameraInputMixin:
         Returns
         -------
         None or UploadedFile
-            The UploadedFile class is a subclass of BytesIO, and therefore
-            it is "file-like". This means you can pass them anywhere where
-            a file is expected.
+            The UploadedFile class is a subclass of BytesIO, and therefore is
+            "file-like". This means you can pass an instance of it anywhere a
+            file is expected.
 
         Examples
         --------
         >>> import streamlit as st
         >>>
-        >>> picture = st.camera_input("Take a picture")
+        >>> enable = st.checkbox("Enable camera")
+        >>> picture = st.camera_input("Take a picture", disabled=not enable)
         >>>
         >>> if picture:
         ...     st.image(picture)
 
+        .. output::
+           https://doc-camera-input.streamlit.app/
+           height: 600px
+
         """
         ctx = get_script_run_ctx()
         return self._camera_input(
@@ -226,14 +230,14 @@ class CameraInputMixin:
         serde = CameraInputSerde()
 
         camera_input_state = register_widget(
-            "camera_input",
-            camera_input_proto,
+            camera_input_proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="file_uploader_state_value",
         )
 
         self.dg._enqueue("camera_input", camera_input_proto)

streamlit/elements/widgets/chat.py

@@ -258,7 +258,7 @@ class ChatMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget based on
-            its content. Multiple widgets of the same type may not share the same key.
+            its content. No two widgets may have the same key.
 
         max_chars : int or None
             The maximum number of characters that can be entered. If ``None``
@@ -370,14 +370,14 @@ class ChatMixin:
 
         serde = ChatInputSerde()
         widget_state = register_widget(
-            "chat_input",
-            chat_input_proto,
+            chat_input_proto.id,
             on_change_handler=on_submit,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="string_trigger_value",
         )
 
         chat_input_proto.disabled = disabled

streamlit/elements/widgets/checkbox.py

@@ -102,8 +102,7 @@ class CheckboxMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             An optional tooltip that gets displayed next to the checkbox.
@@ -207,8 +206,7 @@ class CheckboxMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             An optional tooltip that gets displayed next to the toggle.
@@ -317,14 +315,14 @@ class CheckboxMixin:
         serde = CheckboxSerde(value)
 
         checkbox_state = register_widget(
-            "checkbox",
-            checkbox_proto,
+            checkbox_proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="bool_value",
         )
 
         if checkbox_state.value_changed:

streamlit/elements/widgets/color_picker.py

@@ -104,8 +104,7 @@ class ColorPickerMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             An optional tooltip that gets displayed next to the color picker.
@@ -237,14 +236,14 @@ class ColorPickerMixin:
         serde = ColorPickerSerde(value)
 
         widget_state = register_widget(
-            "color_picker",
-            color_picker_proto,
+            color_picker_proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="string_value",
         )
 
         if widget_state.value_changed:

streamlit/elements/widgets/data_editor.py

@@ -605,6 +605,8 @@ class DataEditorMixin:
 
             .. note::
                 - Styles from ``pandas.Styler`` will only be applied to non-editable columns.
+                - Text and number formatting from ``column_config`` always takes
+                  precedence over text and number formatting from ``pandas.Styler``.
                 - Mixing data types within a column can make the column uneditable.
                 - Additionally, the following data types are not yet supported for editing:
                   ``complex``, ``list``, ``tuple``, ``bytes``, ``bytearray``,
@@ -679,8 +681,7 @@ class DataEditorMixin:
         key : str
             An optional string to use as the unique key for this widget. If this
             is omitted, a key will be generated for the widget based on its
-            content. Multiple widgets of the same type may not share the same
-            key.
+            content. No two widgets may have the same key.
 
         on_change : callable
             An optional callback invoked when this data_editor's value changes.
@@ -943,14 +944,14 @@ class DataEditorMixin:
         serde = DataEditorSerde()
 
         widget_state = register_widget(
-            "data_editor",
-            proto,
+            proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="string_value",
         )
 
         _apply_dataframe_edits(data_df, widget_state.value, dataframe_schema)

streamlit/elements/widgets/file_uploader.py

@@ -281,8 +281,7 @@ class FileUploaderMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             A tooltip that gets displayed next to the file uploader.
@@ -317,9 +316,9 @@ class FileUploaderMixin:
               uploaded files as UploadedFile objects. If no files were
               uploaded, returns an empty list.
 
-            The UploadedFile class is a subclass of BytesIO, and therefore
-            it is "file-like". This means you can pass them anywhere where
-            a file is expected.
+            The UploadedFile class is a subclass of BytesIO, and therefore is
+            "file-like". This means you can pass an instance of it anywhere a
+            file is expected.
 
         Examples
         --------
@@ -457,14 +456,14 @@ class FileUploaderMixin:
         # representing the current set of files that this uploader should
         # know about.
         widget_state = register_widget(
-            "file_uploader",
-            file_uploader_proto,
+            file_uploader_proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="file_uploader_state_value",
         )
 
         self.dg._enqueue("file_uploader", file_uploader_proto)

streamlit/elements/widgets/multiselect.py

@@ -164,8 +164,7 @@ class MultiSelectMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             An optional tooltip that gets displayed next to the multiselect.
@@ -300,14 +299,14 @@ class MultiSelectMixin:
 
         serde = MultiSelectSerde(indexable_options, default_values)
         widget_state = register_widget(
-            "multiselect",
-            proto,
+            proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="int_array_value",
         )
 
         _check_max_selections(widget_state.value, max_selections)

streamlit/elements/widgets/number_input.py

@@ -248,8 +248,7 @@ class NumberInputMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             An optional tooltip that gets displayed next to the input.
@@ -507,14 +506,14 @@ class NumberInputMixin:
 
         serde = NumberInputSerde(value, data_type)
         widget_state = register_widget(
-            "number_input",
-            number_input_proto,
+            number_input_proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="double_value"
         )
 
         if widget_state.value_changed:

streamlit/elements/widgets/radio.py

@@ -185,8 +185,7 @@ class RadioMixin:
         key : str or int
             An optional string or integer to use as the unique key for the widget.
             If this is omitted, a key will be generated for the widget
-            based on its content. Multiple widgets of the same type may
-            not share the same key.
+            based on its content. No two widgets may have the same key.
 
         help : str
             An optional tooltip that gets displayed next to the radio.
@@ -370,14 +369,14 @@ class RadioMixin:
         serde = RadioSerde(opt, index)
 
         widget_state = register_widget(
-            "radio",
-            radio_proto,
+            radio_proto.id,
             on_change_handler=on_change,
             args=args,
             kwargs=kwargs,
             deserializer=serde.deserialize,
             serializer=serde.serialize,
             ctx=ctx,
+            value_type="int_value",
         )
         widget_state = maybe_coerce_enum(widget_state, options, opt)