streamlit-nightly 1.41.2.dev20250201__py2.py3-none-any.whl → 1.42.1.dev20250204__py2.py3-none-any.whl

streamlit/elements/spinner.py

@@ -16,11 +16,14 @@ from __future__ import annotations
 
 import contextlib
 import threading
-from typing import Iterator
+from typing import TYPE_CHECKING
 
 import streamlit as st
 from streamlit.runtime.scriptrunner import add_script_run_ctx
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
 
 @contextlib.contextmanager
 def spinner(
@@ -34,9 +37,23 @@ def spinner(
     Parameters
     ----------
     text : str
-        The text to display next to the spinner. Defaults to "In progress...".
+        The text to display next to the spinner. This defaults to
+        ``"In progress..."``.
+
+        The text can optionally contain GitHub-flavored Markdown. Syntax
+        information can be found at: https://github.github.com/gfm.
+
+        See the ``body`` parameter of |st.markdown|_ for additional, supported
+        Markdown directives.
+
+        .. |st.markdown| replace:: ``st.markdown``
+        .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown
+
     show_time : bool
-        Whether to show the elapsed time next to the spinner text. Defaults to False.
+        Whether to show the elapsed time next to the spinner text. If this is
+        ``False`` (default), no time is displayed. If this is ``True``,
+        elapsed time is displayed with a precision of 0.1 seconds. The time
+        format is not configurable.
 
     Example
     -------
@@ -46,6 +63,11 @@ def spinner(
     >>> with st.spinner("Wait for it...", show_time=True):
     >>>     time.sleep(5)
     >>> st.success("Done!")
+    >>> st.button("Rerun")
+
+    .. output ::
+        https://doc-spinner.streamlit.app/
+        height: 210px
 
     """
     from streamlit.proto.Spinner_pb2 import Spinner as SpinnerProto

streamlit/elements/text.py

@@ -45,8 +45,13 @@ class TextMixin:
         body : str
             The string to display.
 
-        help : str
-            An optional tooltip that gets displayed next to the text.
+        help : str or None
+            A tooltip that gets displayed next to the text. If this is ``None``
+            (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         Example
         -------

streamlit/elements/vega_charts.py

@@ -25,9 +25,7 @@ from typing import (
     TYPE_CHECKING,
     Any,
     Final,
-    Iterable,
     Literal,
-    Sequence,
     TypedDict,
     Union,
     cast,
@@ -59,6 +57,8 @@ from streamlit.runtime.state import WidgetCallback, register_widget
 from streamlit.util import HASHLIB_KWARGS
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable, Sequence
+
     import altair as alt
 
     from streamlit.dataframe_util import Data
@@ -1523,16 +1523,18 @@ class VegaChartsMixin:
             descriptions.
 
         use_container_width : bool or None
-            Whether to override the figure's native width with the width of
-            the parent container. If ``use_container_width`` is None (default),
-            Streamlit will set it to True for all charts except for facet,
-            horizontal concatenation, and repeat charts (note that for these chart
-            types, ``use_container_width=True`` doesn't work properly). If
-            ``use_container_width`` is ``True``, Streamlit sets the width of the
-            figure to match the width of the parent container. If ``use_container_width``
-            is ``False``, Streamlit sets the width of the chart to fit its contents
-            according to the plotting library, up to the width of the parent
-            container.
+            Whether to override the chart's native width with the width of
+            the parent container. This can be one of the following:
+
+            - ``None`` (default): Streamlit will use the parent container's
+              width for all charts except those with known incompatibility
+              (``altair.Facet``, ``altair.HConcatChart``, and
+              ``altair.RepeatChart``).
+            - ``True``: Streamlit sets the width of the chart to match the
+              width of the parent container.
+            - ``False``: Streamlit sets the width of the chart to fit its
+              contents according to the plotting library, up to the width of
+              the parent container.
 
         theme : "streamlit" or None
             The theme of the chart. If ``theme`` is ``"streamlit"`` (default),
@@ -1689,16 +1691,18 @@ class VegaChartsMixin:
             https://vega.github.io/vega-lite/docs/ for more info.
 
         use_container_width : bool or None
-            Whether to override the figure's native width with the width of
-            the parent container. If ``use_container_width`` is None (default),
-            Streamlit will set it to True for all charts except for facet,
-            horizontal concatenation, and repeat charts (note that for these chart
-            types, ``use_container_width=True`` doesn't work properly). If
-            ``use_container_width`` is ``True``, Streamlit sets the width of the
-            figure to match the width of the parent container. If ``use_container_width``
-            is ``False``, Streamlit sets the width of the chart to fit its contents
-            according to the plotting library, up to the width of the parent
-            container.
+            Whether to override the chart's native width with the width of
+            the parent container. This can be one of the following:
+
+            - ``None`` (default): Streamlit will use the parent container's
+              width for all charts except those with known incompatibility
+              (``altair.Facet``, ``altair.HConcatChart``, and
+              ``altair.RepeatChart``).
+            - ``True``: Streamlit sets the width of the chart to match the
+              width of the parent container.
+            - ``False``: Streamlit sets the width of the chart to fit its
+              contents according to the plotting library, up to the width of
+              the parent container.
 
         theme : "streamlit" or None
             The theme of the chart. If ``theme`` is ``"streamlit"`` (default),

streamlit/elements/widgets/audio_input.py

@@ -131,10 +131,14 @@ class AudioInputMixin:
             If this is omitted, a key will be generated for the widget
             based on its content. No two widgets may have the same key.
 
-        help : str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help : str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change : callable
             An optional callback invoked when this audio input's value

streamlit/elements/widgets/button.py

@@ -125,9 +125,14 @@ class ButtonMixin:
             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. No two widgets may have the same key.
-        help : str
-            An optional tooltip that gets displayed when the button is
-            hovered over.
+
+        help : str or None
+            A tooltip that gets displayed when the button is hovered over. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_click : callable
             An optional callback invoked when this button is clicked.
@@ -321,9 +326,13 @@ class ButtonMixin:
             If this is omitted, a key will be generated for the widget
             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.
+        help : str or None
+            A tooltip that gets displayed when the button is hovered over. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_click : callable
             An optional callback invoked when this button is clicked.
@@ -498,9 +507,13 @@ class ButtonMixin:
         url : str
             The url to be opened on user click
 
-        help : str
-            An optional tooltip that gets displayed when the button is
-            hovered over.
+        help : str or None
+            A tooltip that gets displayed when the button is hovered over. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         type : "primary", "secondary", or "tertiary"
             An optional string that specifies the button type. This can be one
@@ -634,9 +647,13 @@ class ButtonMixin:
               <https://fonts.google.com/icons?icon.set=Material+Symbols&icon.style=Rounded>`_
               font library.
 
-        help : str
-            An optional tooltip that gets displayed when the link is
-            hovered over.
+        help : str or None
+            A tooltip that gets displayed when the link is hovered over. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         disabled : bool
             An optional boolean that disables the page link if set to ``True``.

streamlit/elements/widgets/button_group.py

@@ -14,6 +14,7 @@
 
 from __future__ import annotations
 
+from collections.abc import Sequence
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -21,7 +22,6 @@ from typing import (
     Final,
     Generic,
     Literal,
-    Sequence,
     TypeVar,
     cast,
     overload,
@@ -471,7 +471,9 @@ class ButtonGroupMixin:
             Labels for the select options in an ``Iterable``. This can be a
             ``list``, ``set``, or anything supported by ``st.dataframe``. If
             ``options`` is dataframe-like, the first column will be used. Each
-            label will be cast to ``str`` internally by default.
+            label will be cast to ``str`` internally by default and can
+            optionally contain GitHub-flavored Markdown, including the Markdown
+            directives described in the ``body`` parameter of ``st.markdown``.
 
         selection_mode: "single" or "multi"
             The selection mode for the widget. If this is ``"single"``
@@ -488,7 +490,9 @@ class ButtonGroupMixin:
             Function to modify the display of the options. It receives
             the raw option as an argument and should output the label to be
             shown for that option. This has no impact on the return value of
-            the command.
+            the command. The output can optionally contain GitHub-flavored
+            Markdown, including the Markdown directives described in the
+            ``body`` parameter of ``st.markdown``.
 
         key: str or int
             An optional string or integer to use as the unique key for the widget.
@@ -496,10 +500,14 @@ class ButtonGroupMixin:
             based on its content. Multiple widgets of the same type may
             not share the same key.
 
-        help: str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help: str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change: callable
             An optional callback invoked when this widget's value changes.
@@ -673,7 +681,9 @@ class ButtonGroupMixin:
             Labels for the select options in an ``Iterable``. This can be a
             ``list``, ``set``, or anything supported by ``st.dataframe``. If
             ``options`` is dataframe-like, the first column will be used. Each
-            label will be cast to ``str`` internally by default.
+            label will be cast to ``str`` internally by default and can
+            optionally contain GitHub-flavored Markdown, including the Markdown
+            directives described in the ``body`` parameter of ``st.markdown``.
 
         selection_mode: "single" or "multi"
             The selection mode for the widget. If this is ``"single"``
@@ -690,7 +700,9 @@ class ButtonGroupMixin:
             Function to modify the display of the options. It receives
             the raw option as an argument and should output the label to be
             shown for that option. This has no impact on the return value of
-            the command.
+            the command. The output can optionally contain GitHub-flavored
+            Markdown, including the Markdown directives described in the
+            ``body`` parameter of ``st.markdown``.
 
         key: str or int
             An optional string or integer to use as the unique key for the widget.
@@ -698,10 +710,14 @@ class ButtonGroupMixin:
             based on its content. Multiple widgets of the same type may
             not share the same key.
 
-        help: str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help: str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change: callable
             An optional callback invoked when this widget's value changes.

streamlit/elements/widgets/camera_input.py

@@ -127,10 +127,14 @@ class CameraInputMixin:
             If this is omitted, a key will be generated for the widget
             based on its content. No two widgets may have the same key.
 
-        help : str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help : str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change : callable
             An optional callback invoked when this camera_input's value

streamlit/elements/widgets/chat.py

@@ -14,15 +14,13 @@
 
 from __future__ import annotations
 
+from collections.abc import Iterator, MutableMapping, Sequence
 from dataclasses import dataclass
 from enum import Enum
 from typing import (
     TYPE_CHECKING,
     Any,
-    Iterator,
     Literal,
-    MutableMapping,
-    Sequence,
     cast,
     overload,
 )

streamlit/elements/widgets/checkbox.py

@@ -105,10 +105,14 @@ class CheckboxMixin:
             If this is omitted, a key will be generated for the widget
             based on its content. No two widgets may have the same key.
 
-        help : str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help : str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change : callable
             An optional callback invoked when this checkbox's value changes.
@@ -212,10 +216,14 @@ class CheckboxMixin:
             If this is omitted, a key will be generated for the widget
             based on its content. No two widgets may have the same key.
 
-        help : str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help : str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change : callable
             An optional callback invoked when this toggle's value changes.

streamlit/elements/widgets/color_picker.py

@@ -107,10 +107,14 @@ class ColorPickerMixin:
             If this is omitted, a key will be generated for the widget
             based on its content. No two widgets may have the same key.
 
-        help : str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help : str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change : callable
             An optional callback invoked when this color_picker's value

streamlit/elements/widgets/data_editor.py

@@ -20,14 +20,8 @@ from decimal import Decimal
 from typing import (
     TYPE_CHECKING,
     Any,
-    Dict,
     Final,
-    Iterable,
-    List,
     Literal,
-    Mapping,
-    Set,
-    Tuple,
     TypedDict,
     TypeVar,
     Union,
@@ -70,6 +64,8 @@ from streamlit.type_util import is_type
 from streamlit.util import calc_md5
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable, Mapping
+
     import numpy as np
     import pandas as pd
     import pyarrow as pa
@@ -85,10 +81,10 @@ EditableData = TypeVar(
     "EditableData",
     bound=Union[
         dataframe_util.DataFrameGenericAlias[Any],  # covers DataFrame and Series
-        Tuple[Any],
-        List[Any],
-        Set[Any],
-        Dict[str, Any],
+        tuple[Any],
+        list[Any],
+        set[Any],
+        dict[str, Any],
         # TODO(lukasmasuch): Add support for np.ndarray
         # but it is not possible with np.ndarray.
         # NDArray[Any] works, but is only available in numpy>1.20.
@@ -106,10 +102,10 @@ DataTypes: TypeAlias = Union[
     "Styler",
     "pa.Table",
     "np.ndarray[Any, np.dtype[np.float64]]",
-    Tuple[Any],
-    List[Any],
-    Set[Any],
-    Dict[str, Any],
+    tuple[Any],
+    list[Any],
+    set[Any],
+    dict[str, Any],
 ]
 
 

streamlit/elements/widgets/file_uploader.py

@@ -16,7 +16,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from textwrap import dedent
-from typing import TYPE_CHECKING, List, Literal, Sequence, Union, cast, overload
+from typing import TYPE_CHECKING, Literal, Union, cast, overload
 
 from typing_extensions import TypeAlias
 
@@ -48,12 +48,14 @@ from streamlit.runtime.state import (
 from streamlit.runtime.uploaded_file_manager import DeletedFile, UploadedFile
 
 if TYPE_CHECKING:
+    from collections.abc import Sequence
+
     from streamlit.delta_generator import DeltaGenerator
 
 SomeUploadedFiles: TypeAlias = Union[
     UploadedFile,
     DeletedFile,
-    List[Union[UploadedFile, DeletedFile]],
+    list[Union[UploadedFile, DeletedFile]],
     None,
 ]
 
@@ -276,10 +278,14 @@ class FileUploaderMixin:
             If this is omitted, a key will be generated for the widget
             based on its content. No two widgets may have the same key.
 
-        help : str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help : str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change : callable
             An optional callback invoked when this file_uploader's value

streamlit/elements/widgets/multiselect.py

@@ -14,9 +14,10 @@
 
 from __future__ import annotations
 
+from collections.abc import Sequence
 from dataclasses import dataclass, field
 from textwrap import dedent
-from typing import TYPE_CHECKING, Any, Callable, Generic, Sequence, cast
+from typing import TYPE_CHECKING, Any, Callable, Generic, cast
 
 from streamlit.dataframe_util import OptionSequence
 from streamlit.elements.lib.form_utils import current_form_id
@@ -167,10 +168,14 @@ class MultiSelectMixin:
             If this is omitted, a key will be generated for the widget
             based on its content. No two widgets may have the same key.
 
-        help: str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help: str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change: callable
             An optional callback invoked when this widget's value changes.

streamlit/elements/widgets/number_input.py

@@ -251,10 +251,14 @@ class NumberInputMixin:
             If this is omitted, a key will be generated for the widget
             based on its content. No two widgets may have the same key.
 
-        help : str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help : str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change : callable
             An optional callback invoked when this number_input's value changes.

streamlit/elements/widgets/radio.py

@@ -16,7 +16,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from textwrap import dedent
-from typing import TYPE_CHECKING, Any, Callable, Generic, Sequence, cast, overload
+from typing import TYPE_CHECKING, Any, Callable, Generic, cast, overload
 
 from streamlit.dataframe_util import OptionSequence, convert_anything_to_list
 from streamlit.elements.lib.form_utils import current_form_id
@@ -50,6 +50,8 @@ from streamlit.type_util import (
 )
 
 if TYPE_CHECKING:
+    from collections.abc import Sequence
+
     from streamlit.delta_generator import DeltaGenerator
 
 
@@ -188,10 +190,14 @@ class RadioMixin:
             If this is omitted, a key will be generated for the widget
             based on its content. No two widgets may have the same key.
 
-        help : str
-            An optional tooltip that gets displayed next to the widget label.
-            Streamlit only displays the tooltip when
-            ``label_visibility="visible"``.
+        help : str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. If
+            this is ``None`` (default), no tooltip is displayed.
+
+            The tooltip can optionally contain GitHub-flavored Markdown,
+            including the Markdown directives described in the ``body``
+            parameter of ``st.markdown``.
 
         on_change : callable
             An optional callback invoked when this radio's value changes.