streamlit 1.45.1__py3-none-any.whl → 1.46.1__py3-none-any.whl

streamlit/elements/media.py

@@ -24,11 +24,13 @@ 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.layout_utils import WidthWithoutContent, validate_width
 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
 from streamlit.proto.Audio_pb2 import Audio as AudioProto
 from streamlit.proto.Video_pb2 import Video as VideoProto
+from streamlit.proto.WidthConfig_pb2 import WidthConfig
 from streamlit.runtime import caching
 from streamlit.runtime.metrics_util import gather_metrics
 from streamlit.time_util import time_to_seconds
@@ -80,6 +82,7 @@ class MediaMixin:
         end_time: MediaTime | None = None,
         loop: bool = False,
         autoplay: bool = False,
+        width: WidthWithoutContent = "stretch",
     ) -> DeltaGenerator:
         """Display an audio player.
 
@@ -106,7 +109,7 @@ class MediaMixin:
             For more information about MIME types, see
             https://www.iana.org/assignments/media-types/media-types.xhtml.
 
-        start_time: int, float, timedelta, str, or None
+        start_time : int, float, timedelta, str, or None
             The time from which the element should start playing. This can be
             one of the following:
 
@@ -119,10 +122,10 @@ class MediaMixin:
             - A ``timedelta`` object from `Python's built-in datetime library
               <https://docs.python.org/3/library/datetime.html#timedelta-objects>`_,
               e.g. ``timedelta(seconds=70)``.
-        sample_rate: int or None
+        sample_rate : int or None
             The sample rate of the audio data in samples per second. This is
             only required if ``data`` is a NumPy array.
-        end_time: int, float, timedelta, str, or None
+        end_time : int, float, timedelta, str, or None
             The time at which the element should stop playing. This can be
             one of the following:
 
@@ -135,12 +138,22 @@ class MediaMixin:
             - A ``timedelta`` object from `Python's built-in datetime library
               <https://docs.python.org/3/library/datetime.html#timedelta-objects>`_,
               e.g. ``timedelta(seconds=70)``.
-        loop: bool
+        loop : bool
             Whether the audio should loop playback.
-        autoplay: bool
+        autoplay : bool
             Whether the audio file should start playing automatically. This is
             ``False`` by default. Browsers will not autoplay audio files if the
             user has not interacted with the page by clicking somewhere.
+        width : "stretch" or int
+            The width of the audio player element. This can be one of the
+            following:
+
+            - ``"stretch"`` (default): The width of the element matches the
+              width of the parent container.
+            - An integer specifying the width in pixels: The element has a
+              fixed width. If the specified width is greater than the width of
+              the parent container, the width of the element matches the width
+              of the parent container.
 
         Examples
         --------
@@ -181,6 +194,7 @@ class MediaMixin:
 
         """
         start_time, end_time = _parse_start_time_end_time(start_time, end_time)
+        validate_width(width)
 
         audio_proto = AudioProto()
 
@@ -207,6 +221,7 @@ class MediaMixin:
             loop,
             autoplay,
             form_id=current_form_id(self.dg),
+            width=width,
         )
         return self.dg._enqueue("audio", audio_proto)
 
@@ -222,6 +237,7 @@ class MediaMixin:
         loop: bool = False,
         autoplay: bool = False,
         muted: bool = False,
+        width: WidthWithoutContent = "stretch",
     ) -> DeltaGenerator:
         """Display a video player.
 
@@ -242,7 +258,7 @@ class MediaMixin:
             For more information about MIME types, see
             https://www.iana.org/assignments/media-types/media-types.xhtml.
 
-        start_time: int, float, timedelta, str, or None
+        start_time : int, float, timedelta, str, or None
             The time from which the element should start playing. This can be
             one of the following:
 
@@ -255,7 +271,7 @@ class MediaMixin:
             - A ``timedelta`` object from `Python's built-in datetime library
               <https://docs.python.org/3/library/datetime.html#timedelta-objects>`_,
               e.g. ``timedelta(seconds=70)``.
-        subtitles: str, bytes, Path, io.BytesIO, or dict
+        subtitles : str, bytes, Path, io.BytesIO, or dict
             Optional subtitle data for the video, supporting several input types:
 
             - ``None`` (default): No subtitles.
@@ -281,7 +297,7 @@ class MediaMixin:
             in a dictrionary's first pair: ``{"None": "", "English": "path/to/english.vtt"}``
 
             Not supported for YouTube videos.
-        end_time: int, float, timedelta, str, or None
+        end_time : int, float, timedelta, str, or None
             The time at which the element should stop playing. This can be
             one of the following:
 
@@ -294,18 +310,28 @@ class MediaMixin:
             - A ``timedelta`` object from `Python's built-in datetime library
               <https://docs.python.org/3/library/datetime.html#timedelta-objects>`_,
               e.g. ``timedelta(seconds=70)``.
-        loop: bool
+        loop : bool
             Whether the video should loop playback.
-        autoplay: bool
+        autoplay : bool
             Whether the video should start playing automatically. This is
             ``False`` by default. Browsers will not autoplay unmuted videos
             if the user has not interacted with the page by clicking somewhere.
             To enable autoplay without user interaction, you must also set
             ``muted=True``.
-        muted: bool
+        muted : bool
             Whether the video should play with the audio silenced. This is
             ``False`` by default. Use this in conjunction with ``autoplay=True``
             to enable autoplay without user interaction.
+        width : "stretch" or int
+            The width of the video player element. This can be one of the
+            following:
+
+            - ``"stretch"`` (default): The width of the element matches the
+              width of the parent container.
+            - An integer specifying the width in pixels: The element has a
+              fixed width. If the specified width is greater than the width of
+              the parent container, the width of the element matches the width
+              of the parent container.
 
         Example
         -------
@@ -350,14 +376,16 @@ class MediaMixin:
         `video subtitles feature demo <https://doc-video-subtitle-inputs.streamlit.app/>`_.
 
         .. note::
-           Some videos may not display if they are encoded using MP4V (which is an export option in OpenCV), as this codec is
-           not widely supported by browsers. Converting your video to H.264 will allow the video to be displayed in Streamlit.
+           Some videos may not display if they are encoded using MP4V (which is an export option in OpenCV),
+           as this codec is not widely supported by browsers. Converting your video to H.264 will allow
+           the video to be displayed in Streamlit.
            See this `StackOverflow post <https://stackoverflow.com/a/49535220/2394542>`_ or this
            `Streamlit forum post <https://discuss.streamlit.io/t/st-video-doesnt-show-opencv-generated-mp4/3193/2>`_
            for more information.
 
         """
         start_time, end_time = _parse_start_time_end_time(start_time, end_time)
+        validate_width(width)
 
         video_proto = VideoProto()
         coordinates = self.dg._get_delta_path_str()
@@ -373,6 +401,7 @@ class MediaMixin:
             autoplay,
             muted,
             form_id=current_form_id(self.dg),
+            width=width,
         )
         return self.dg._enqueue("video", video_proto)
 
@@ -448,17 +477,16 @@ def _marshall_av_media(
     elif isinstance(data, io.BytesIO):
         data.seek(0)
         data_or_filename = data.getvalue()
-    elif isinstance(data, io.RawIOBase) or isinstance(data, io.BufferedReader):
+    elif isinstance(data, (io.RawIOBase, io.BufferedReader)):
         data.seek(0)
         read_data = data.read()
         if read_data is None:
             return
-        else:
-            data_or_filename = read_data
+        data_or_filename = read_data
     elif type_util.is_type(data, "numpy.ndarray"):
-        data_or_filename = data.tobytes()
+        data_or_filename = cast("npt.NDArray[Any]", data).tobytes()
     else:
-        raise RuntimeError("Invalid binary data format: %s" % type(data))
+        raise RuntimeError(f"Invalid binary data format: {type(data)}")
 
     if runtime.exists():
         file_url = runtime.get_instance().media_file_mgr.add(
@@ -484,6 +512,7 @@ def marshall_video(
     autoplay: bool = False,
     muted: bool = False,
     form_id: str | None = None,
+    width: WidthWithoutContent = "stretch",
 ) -> None:
     """Marshalls a video proto, using url processors as needed.
 
@@ -505,8 +534,9 @@ def marshall_video(
     subtitles: str, dict, or io.BytesIO
         Optional subtitle data for the video, supporting several input types:
         - None (default): No subtitles.
-        - A string: File path to a subtitle file in '.vtt' or '.srt' formats, or the raw content of subtitles conforming to these formats.
-            If providing raw content, the string must adhere to the WebVTT or SRT format specifications.
+        - A string: File path to a subtitle file in '.vtt' or '.srt' formats, or the raw content
+            of subtitles conforming to these formats. If providing raw content, the string must
+            adhere to the WebVTT or SRT format specifications.
         - A dictionary: Pairs of labels and file paths or raw subtitle content in '.vtt' or '.srt' formats.
             Enables multiple subtitle tracks. The label will be shown in the video player.
             Example: {'English': 'path/to/english.vtt', 'French': 'path/to/french.srt'}
@@ -529,6 +559,11 @@ def marshall_video(
     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.
+    width: int or "stretch"
+        The width of the video player. This can be one of the following:
+        - An int: The width in pixels, e.g. 200 for a width of 200 pixels.
+        - "stretch": The default value. The video player stretches to fill
+          available space in its container.
     """
 
     if start_time < 0 or (end_time is not None and end_time <= start_time):
@@ -541,6 +576,13 @@ def marshall_video(
         proto.end_time = end_time
     proto.loop = loop
 
+    width_config = WidthConfig()
+    if isinstance(width, int):
+        width_config.pixel_width = width
+    else:
+        width_config.use_stretch = True
+    proto.width_config.CopyFrom(width_config)
+
     # "type" distinguishes between YouTube and non-YouTube links
     proto.type = VideoProto.Type.NATIVE
 
@@ -610,6 +652,7 @@ def marshall_video(
             loop=loop,
             autoplay=autoplay,
             muted=muted,
+            width=width,
         )
 
 
@@ -621,7 +664,7 @@ def _parse_start_time_end_time(
     try:
         maybe_start_time = time_to_seconds(start_time, coerce_none_to_inf=False)
         if maybe_start_time is None:
-            raise ValueError
+            raise ValueError  # noqa: TRY301
         start_time = int(maybe_start_time)
     except (StreamlitAPIException, ValueError):
         error_msg = TIMEDELTA_PARSE_ERROR_MESSAGE.format(
@@ -731,6 +774,7 @@ def marshall_audio(
     loop: bool = False,
     autoplay: bool = False,
     form_id: str | None = None,
+    width: WidthWithoutContent = "stretch",
 ) -> None:
     """Marshalls an audio proto, using data and url processors as needed.
 
@@ -760,6 +804,11 @@ def marshall_audio(
     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.
+    width: int or "stretch"
+        The width of the audio player. This can be one of the following:
+        - An int: The width in pixels, e.g. 200 for a width of 200 pixels.
+        - "stretch": The default value. The audio player stretches to fill
+          available space in its container.
     """
 
     proto.start_time = start_time
@@ -767,6 +816,13 @@ def marshall_audio(
         proto.end_time = end_time
     proto.loop = loop
 
+    width_config = WidthConfig()
+    if isinstance(width, int):
+        width_config.pixel_width = width
+    else:
+        width_config.use_stretch = True
+    proto.width_config.CopyFrom(width_config)
+
     if isinstance(data, Path):
         data = str(data)  # Convert Path to string
 
@@ -791,4 +847,5 @@ def marshall_audio(
             end_time=end_time,
             loop=loop,
             autoplay=autoplay,
+            width=width,
         )

streamlit/elements/metric.py

@@ -20,6 +20,7 @@ from typing import TYPE_CHECKING, Any, Literal, Union, cast
 
 from typing_extensions import TypeAlias
 
+from streamlit.elements.lib.layout_utils import LayoutConfig, Width, validate_width
 from streamlit.elements.lib.policies import maybe_raise_label_warnings
 from streamlit.elements.lib.utils import (
     LabelVisibility,
@@ -58,6 +59,7 @@ class MetricMixin:
         help: str | None = None,
         label_visibility: LabelVisibility = "visible",
         border: bool = False,
+        width: Width = "stretch",
     ) -> DeltaGenerator:
         r"""Display a metric in big bold font, with an optional indicator of how the metric changed.
 
@@ -114,7 +116,7 @@ class MetricMixin:
         label_visibility : "visible", "hidden", or "collapsed"
             The visibility of the label. The default is ``"visible"``. If this
             is ``"hidden"``, Streamlit displays an empty spacer instead of the
-            label, which can help keep the widget alligned with other widgets.
+            label, which can help keep the widget aligned with other widgets.
             If this is ``"collapsed"``, Streamlit displays no label or spacer.
 
         border : bool
@@ -122,6 +124,18 @@ class MetricMixin:
             ``False`` (default), no border is shown. If this is ``True``, a
             border is shown.
 
+        width : "stretch", "content", or int
+            The width of the metric element. This can be one of the following:
+
+            - ``"stretch"`` (default): The width of the element matches the
+              width of the parent container.
+            - ``"content"``: The width of the element matches the width of its
+              content, but doesn't exceed the width of the parent container.
+            - An integer specifying the width in pixels: The element has a
+              fixed width. If the specified width is greater than the width of
+              the parent container, the width of the element matches the width
+              of the parent container.
+
         Examples
         --------
         **Example 1: Show a metric**
@@ -204,7 +218,10 @@ class MetricMixin:
             label_visibility
         )
 
-        return self.dg._enqueue("metric", metric_proto)
+        validate_width(width, allow_content=True)
+        layout_config = LayoutConfig(width=width)
+
+        return self.dg._enqueue("metric", metric_proto, layout_config=layout_config)
 
     @property
     def dg(self) -> DeltaGenerator:
@@ -214,7 +231,7 @@ class MetricMixin:
 def _parse_label(label: str) -> str:
     if not isinstance(label, str):
         raise TypeError(
-            f"'{str(label)}' is of type {str(type(label))}, which is not an accepted type."
+            f"'{label}' is of type {type(label)}, which is not an accepted type."
             " label only accepts: str. Please convert the label to an accepted type."
         )
     return label
@@ -223,20 +240,20 @@ def _parse_label(label: str) -> str:
 def _parse_value(value: Value) -> str:
     if value is None:
         return "—"
-    if isinstance(value, int) or isinstance(value, float) or isinstance(value, str):
+    if isinstance(value, (int, float, str)):
         return str(value)
-    elif hasattr(value, "item"):
+    if hasattr(value, "item"):
         # Add support for numpy values (e.g. int16, float64, etc.)
         try:
             # Item could also be just a variable, so we use try, except
-            if isinstance(value.item(), float) or isinstance(value.item(), int):
+            if isinstance(value.item(), (float, int)):
                 return str(value.item())
-        except Exception:
+        except Exception:  # noqa: S110
             # If the numpy item is not a valid value, the TypeError below will be raised.
             pass
 
     raise TypeError(
-        f"'{str(value)}' is of type {str(type(value))}, which is not an accepted type."
+        f"'{value}' is of type {type(value)}, which is not an accepted type."
         " value only accepts: int, float, str, or None."
         " Please convert the value to an accepted type."
     )
@@ -247,14 +264,13 @@ def _parse_delta(delta: Delta) -> str:
         return ""
     if isinstance(delta, str):
         return dedent(delta)
-    elif isinstance(delta, int) or isinstance(delta, float):
+    if isinstance(delta, (int, float)):
         return str(delta)
-    else:
-        raise TypeError(
-            f"'{str(delta)}' is of type {str(type(delta))}, which is not an accepted type."
-            " delta only accepts: int, float, str, or None."
-            " Please convert the value to an accepted type."
-        )
+    raise TypeError(
+        f"'{delta}' is of type {type(delta)}, which is not an accepted type."
+        " delta only accepts: int, float, str, or None."
+        " Please convert the value to an accepted type."
+    )
 
 
 def _determine_delta_color_and_direction(
@@ -263,7 +279,7 @@ def _determine_delta_color_and_direction(
 ) -> MetricColorAndDirection:
     if delta_color not in {"normal", "inverse", "off"}:
         raise StreamlitAPIException(
-            f"'{str(delta_color)}' is not an accepted value. delta_color only accepts: "
+            f"'{delta_color}' is not an accepted value. delta_color only accepts: "
             "'normal', 'inverse', or 'off'"
         )
 

streamlit/elements/plotly_chart.py

@@ -29,11 +29,10 @@ from typing import (
     overload,
 )
 
-from typing_extensions import TypeAlias
+from typing_extensions import Required, TypeAlias
 
 from streamlit import type_util
 from streamlit.deprecation_util import show_deprecation_warning
-from streamlit.elements.lib.event_utils import AttributeDictionary
 from streamlit.elements.lib.form_utils import current_form_id
 from streamlit.elements.lib.policies import check_widget_policies
 from streamlit.elements.lib.streamlit_plotly_theme import (
@@ -45,6 +44,7 @@ from streamlit.proto.PlotlyChart_pb2 import PlotlyChart as PlotlyChartProto
 from streamlit.runtime.metrics_util import gather_metrics
 from streamlit.runtime.scriptrunner_utils.script_run_context import get_script_run_ctx
 from streamlit.runtime.state import WidgetCallback, register_widget
+from streamlit.util import AttributeDictionary
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
@@ -159,10 +159,10 @@ class PlotlySelectionState(TypedDict, total=False):
 
     """
 
-    points: list[dict[str, Any]]
-    point_indices: list[int]
-    box: list[dict[str, Any]]
-    lasso: list[dict[str, Any]]
+    points: Required[list[dict[str, Any]]]
+    point_indices: Required[list[int]]
+    box: Required[list[dict[str, Any]]]
+    lasso: Required[list[dict[str, Any]]]
 
 
 class PlotlyState(TypedDict, total=False):
@@ -205,7 +205,7 @@ class PlotlyState(TypedDict, total=False):
 
     """
 
-    selection: PlotlySelectionState
+    selection: Required[PlotlySelectionState]
 
 
 @dataclass
@@ -214,7 +214,7 @@ class PlotlyChartSelectionSerde:
     selection state.
     """
 
-    def deserialize(self, ui_value: str | None, widget_id: str = "") -> PlotlyState:
+    def deserialize(self, ui_value: str | None) -> PlotlyState:
         empty_selection_state: PlotlyState = {
             "selection": {
                 "points": [],
@@ -231,7 +231,7 @@ class PlotlyChartSelectionSerde:
         )
 
         if "selection" not in selection_state:
-            selection_state = empty_selection_state
+            selection_state = empty_selection_state  # type: ignore[unreachable]
 
         return cast("PlotlyState", AttributeDictionary(selection_state))
 
@@ -257,12 +257,12 @@ def parse_selection_mode(
         )
 
     parsed_selection_modes = []
-    for selection_mode in selection_mode_set:
-        if selection_mode == "points":
+    for mode in selection_mode_set:
+        if mode == "points":
             parsed_selection_modes.append(PlotlyChartProto.SelectionMode.POINTS)
-        elif selection_mode == "lasso":
+        elif mode == "lasso":
             parsed_selection_modes.append(PlotlyChartProto.SelectionMode.LASSO)
-        elif selection_mode == "box":
+        elif mode == "box":
             parsed_selection_modes.append(PlotlyChartProto.SelectionMode.BOX)
     return set(parsed_selection_modes)
 
@@ -510,6 +510,7 @@ class PlotlyMixin:
             "plotly_chart",
             user_key=key,
             form_id=plotly_chart_proto.form_id,
+            dg=self.dg,
             plotly_spec=plotly_chart_proto.spec,
             plotly_config=plotly_chart_proto.config,
             selection_mode=selection_mode,
@@ -537,8 +538,7 @@ class PlotlyMixin:
 
             self.dg._enqueue("plotly_chart", plotly_chart_proto)
             return cast("PlotlyState", widget_state.value)
-        else:
-            return self.dg._enqueue("plotly_chart", plotly_chart_proto)
+        return self.dg._enqueue("plotly_chart", plotly_chart_proto)
 
     @property
     def dg(self) -> DeltaGenerator:

streamlit/elements/progress.py

@@ -19,12 +19,14 @@ from typing import TYPE_CHECKING, Union, cast
 
 from typing_extensions import TypeAlias
 
+from streamlit.elements.lib.layout_utils import LayoutConfig, validate_width
 from streamlit.errors import StreamlitAPIException
 from streamlit.proto.Progress_pb2 import Progress as ProgressProto
 from streamlit.string_util import clean_text
 
 if TYPE_CHECKING:
     from streamlit.delta_generator import DeltaGenerator
+    from streamlit.elements.lib.layout_utils import WidthWithoutContent
 
 
 # Currently, equates to just float, but we can't use `numbers.Real` due to
@@ -58,26 +60,23 @@ def _check_float_between(value: float, low: float = 0.0, high: float = 1.0) -> b
     )
 
 
-def _get_value(value):
+def _get_value(value: FloatOrInt) -> int:
     if isinstance(value, int):
         if 0 <= value <= 100:
             return value
-        else:
-            raise StreamlitAPIException(
-                "Progress Value has invalid value [0, 100]: %d" % value
-            )
+        raise StreamlitAPIException(
+            f"Progress Value has invalid value [0, 100]: {value}"
+        )
 
-    elif isinstance(value, float):
+    if isinstance(value, float):
         if _check_float_between(value, low=0.0, high=1.0):
             return int(value * 100)
-        else:
-            raise StreamlitAPIException(
-                "Progress Value has invalid value [0.0, 1.0]: %f" % value
-            )
-    else:
         raise StreamlitAPIException(
-            "Progress Value has invalid type: %s" % type(value).__name__
+            f"Progress Value has invalid value [0.0, 1.0]: {value}"
         )
+    raise StreamlitAPIException(
+        f"Progress Value has invalid type: {type(value).__name__}"
+    )
 
 
 def _get_text(text: str | None) -> str | None:
@@ -86,13 +85,18 @@ def _get_text(text: str | None) -> str | None:
     if isinstance(text, str):
         return clean_text(text)
     raise StreamlitAPIException(
-        f"Progress Text is of type {str(type(text))}, which is not an accepted type."
+        f"Progress Text is of type {type(text)}, which is not an accepted type."
         "Text only accepts: str. Please convert the text to an accepted type."
     )
 
 
 class ProgressMixin:
-    def progress(self, value: FloatOrInt, text: str | None = None) -> DeltaGenerator:
+    def progress(
+        self,
+        value: FloatOrInt,
+        text: str | None = None,
+        width: WidthWithoutContent = "stretch",
+    ) -> DeltaGenerator:
         r"""Display a progress bar.
 
         Parameters
@@ -119,6 +123,16 @@ class ProgressMixin:
             .. |st.markdown| replace:: ``st.markdown``
             .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown
 
+        width : "stretch" or int
+            The width of the progress element. This can be one of the following:
+
+            - ``"stretch"`` (default): The width of the element matches the
+              width of the parent container.
+            - An integer specifying the width in pixels: The element has a
+              fixed width. If the specified width is greater than the width of
+              the parent container, the width of the element matches the width
+              of the parent container.
+
         Example
         -------
         Here is an example of a progress bar increasing over time and disappearing when it reaches completion:
@@ -148,7 +162,11 @@ class ProgressMixin:
         text = _get_text(text)
         if text is not None:
             progress_proto.text = text
-        return self.dg._enqueue("progress", progress_proto)
+
+        validate_width(width)
+        layout_config = LayoutConfig(width=width)
+
+        return self.dg._enqueue("progress", progress_proto, layout_config=layout_config)
 
     @property
     def dg(self) -> DeltaGenerator: