streamlit 1.48.0__py3-none-any.whl → 1.49.0__py3-none-any.whl

streamlit/elements/lib/column_config_utils.py

@@ -104,6 +104,11 @@ _EDITING_COMPATIBILITY_MAPPING: Final[dict[ColumnType, list[ColumnDataKind]]] =
         ColumnDataKind.EMPTY,
     ],
     "link": [ColumnDataKind.STRING, ColumnDataKind.EMPTY],
+    "list": [
+        ColumnDataKind.LIST,
+        ColumnDataKind.STRING,
+        ColumnDataKind.EMPTY,
+    ],
 }
 
 
@@ -395,8 +400,14 @@ def determine_dataframe_schema(
 
 
 # A mapping of column names/IDs to column configs.
-ColumnConfigMapping: TypeAlias = dict[Union[IndexIdentifierType, str], ColumnConfig]
+ColumnConfigMapping: TypeAlias = dict[
+    Union[IndexIdentifierType, str, int], ColumnConfig
+]
 ColumnConfigMappingInput: TypeAlias = Mapping[
+    # TODO(lukasmasuch): This should also use int here to
+    # correctly type the support for positional index. However,
+    # allowing int here leads mypy to complain about simple dict[str, ...]
+    # as input -> which seems like a mypy bug.
     Union[IndexIdentifierType, str],
     Union[ColumnConfig, None, str],
 ]
@@ -440,7 +451,9 @@ def process_config_mapping(
 
 
 def update_column_config(
-    column_config_mapping: ColumnConfigMapping, column: str, column_config: ColumnConfig
+    column_config_mapping: ColumnConfigMapping,
+    column: str | int,
+    column_config: ColumnConfig,
 ) -> None:
     """Updates the column config value for a single column within the mapping.
 
@@ -449,8 +462,9 @@ def update_column_config(
     column_config_mapping : ColumnConfigMapping
         The column config mapping to update.
 
-    column : str
-        The column to update the config value for.
+    column : str | int
+        The column to update the config value for. This can be the column name or
+        the numerical position of the column.
 
     column_config : ColumnConfig
         The column config to update.

streamlit/elements/lib/column_types.py

@@ -18,7 +18,7 @@
 from __future__ import annotations
 
 import datetime
-from typing import TYPE_CHECKING, Literal, TypedDict, Union
+from typing import TYPE_CHECKING, Callable, Literal, TypedDict, Union
 
 from typing_extensions import NotRequired, TypeAlias
 
@@ -84,9 +84,17 @@ class CheckboxColumnConfig(TypedDict):
     type: Literal["checkbox"]
 
 
+SelectboxOptionValue: TypeAlias = Union[str, int, float, bool]
+
+
+class SelectboxOption(TypedDict):
+    value: SelectboxOptionValue
+    label: NotRequired[str | None]
+
+
 class SelectboxColumnConfig(TypedDict):
     type: Literal["selectbox"]
-    options: NotRequired[list[str | int | float] | None]
+    options: NotRequired[list[SelectboxOptionValue | SelectboxOption] | None]
 
 
 class LinkColumnConfig(TypedDict):
@@ -190,8 +198,7 @@ class ColumnConfig(TypedDict, total=False):
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.
@@ -227,7 +234,7 @@ class ColumnConfig(TypedDict, total=False):
     disabled: bool | None
     required: bool | None
     pinned: bool | None
-    default: str | bool | int | float | None
+    default: str | bool | int | float | list[str] | None
     alignment: Literal["left", "center", "right"] | None
     type_config: (
         NumberColumnConfig
@@ -295,8 +302,7 @@ def Column(
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.
@@ -400,8 +406,7 @@ def NumberColumn(
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.
@@ -563,8 +568,7 @@ def TextColumn(
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.
@@ -686,8 +690,7 @@ def LinkColumn(
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.
@@ -845,8 +848,7 @@ def CheckboxColumn(
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.
@@ -919,8 +921,9 @@ def SelectboxColumn(
     disabled: bool | None = None,
     required: bool | None = None,
     pinned: bool | None = None,
-    default: str | int | float | None = None,
-    options: Iterable[str | int | float] | None = None,
+    default: SelectboxOptionValue | None = None,
+    options: Iterable[SelectboxOptionValue] | None = None,
+    format_func: Callable[[SelectboxOptionValue], str] | None = None,
 ) -> ColumnConfig:
     """Configure a selectbox column in ``st.dataframe`` or ``st.data_editor``.
 
@@ -954,8 +957,7 @@ def SelectboxColumn(
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.
@@ -977,12 +979,19 @@ def SelectboxColumn(
         Specifies the default value in this column when a new row is added by
         the user. This defaults to ``None``.
 
-    options: Iterable of str or None
+    options: Iterable[str, int, float, bool] or None
         The options that can be selected during editing. If this is ``None``
         (default), the options will be inferred from the underlying dataframe
         column if its dtype is "category". For more information, see `Pandas docs
         <https://pandas.pydata.org/docs/user_guide/categorical.html>`_).
 
+    format_func: function or None
+        Function to modify the display of the options. It receives
+        the raw option defined in ``options`` as an argument and should output
+        the label to be shown for that option. If this is ``None`` (default),
+        the raw option is used as the label.
+
+
     Examples
     --------
     >>> import pandas as pd
@@ -1022,6 +1031,15 @@ def SelectboxColumn(
         height: 300px
     """
 
+    # Process options with format_func
+    processed_options: Iterable[str | int | float | SelectboxOption] | None = options
+    if options and format_func is not None:
+        processed_options = []
+        for option in options:
+            processed_options.append(
+                SelectboxOption(value=option, label=format_func(option))
+            )
+
     return ColumnConfig(
         label=label,
         width=width,
@@ -1031,7 +1049,8 @@ def SelectboxColumn(
         pinned=pinned,
         default=default,
         type_config=SelectboxColumnConfig(
-            type="selectbox", options=list(options) if options is not None else None
+            type="selectbox",
+            options=list(processed_options) if processed_options is not None else None,
         ),
     )
 
@@ -1427,12 +1446,20 @@ def ListColumn(
     width: ColumnWidth | None = None,
     help: str | None = None,
     pinned: bool | None = None,
+    disabled: bool | None = None,
+    required: bool | None = None,
+    default: Iterable[str] | None = None,
 ) -> ColumnConfig:
     """Configure a list column in ``st.dataframe`` or ``st.data_editor``.
 
-    This is the default column type for list-like values. List columns are not editable
-    at the moment. This command needs to be used in the ``column_config`` parameter of
-    ``st.dataframe`` or ``st.data_editor``.
+    This is the default column type for list-like values. This command needs to
+    be used in the ``column_config`` parameter of ``st.dataframe`` or
+    ``st.data_editor``.
+
+    .. Note::
+        Editing for non-string or mixed type lists can cause issues with Arrow
+        serialization. We recommend you disable editing for these columns or
+        convert of all list values to strings.
 
     Parameters
     ----------
@@ -1464,6 +1491,24 @@ def ListColumn(
         (default), Streamlit will decide: index columns are pinned, and data
         columns are not pinned.
 
+    disabled: bool or None
+        Whether editing should be disabled for this column. If this is ``None``
+        (default), Streamlit will enable editing wherever possible.
+
+        If a column has mixed types, it may become uneditable regardless of
+        ``disabled``.
+
+    required: bool or None
+        Whether edited cells in the column need to have a value. If this is
+        ``False`` (default), the user can submit empty values for this column.
+        If this is ``True``, an edited cell in this column can only be
+        submitted if its value is not ``None``, and a new row will only be
+        submitted after the user fills in this column.
+
+    default: Iterable of str or None
+        Specifies the default value in this column when a new row is added by
+        the user. This defaults to ``None``.
+
     Examples
     --------
     >>> import pandas as pd
@@ -1501,6 +1546,9 @@ def ListColumn(
         width=width,
         help=help,
         pinned=pinned,
+        disabled=disabled,
+        required=required,
+        default=None if default is None else list(default),
         type_config=ListColumnConfig(type="list"),
     )
 
@@ -1554,8 +1602,7 @@ def DatetimeColumn(
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.
@@ -1717,8 +1764,7 @@ def TimeColumn(
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.
@@ -1871,8 +1917,7 @@ def DateColumn(
 
     disabled: bool or None
         Whether editing should be disabled for this column. If this is ``None``
-        (default), Streamlit will decide: indices are disabled and data columns
-        are not.
+        (default), Streamlit will enable editing wherever possible.
 
         If a column has mixed types, it may become uneditable regardless of
         ``disabled``.

streamlit/elements/lib/dialog.py

@@ -35,7 +35,7 @@ if TYPE_CHECKING:
     from streamlit.cursor import Cursor
     from streamlit.runtime.state import WidgetCallback
 
-DialogWidth: TypeAlias = Literal["small", "large"]
+DialogWidth: TypeAlias = Literal["small", "large", "medium"]
 
 
 def _process_dialog_width_input(
@@ -47,6 +47,8 @@ def _process_dialog_width_input(
     """
     if width == "large":
         return BlockProto.Dialog.DialogWidth.LARGE
+    if width == "medium":
+        return BlockProto.Dialog.DialogWidth.MEDIUM
 
     return BlockProto.Dialog.DialogWidth.SMALL
 
@@ -110,8 +112,6 @@ class Dialog(DeltaGenerator):
             element_id = compute_and_register_element_id(
                 "dialog",
                 user_key=None,
-                # Dialogs within forms still trigger a normal rerun:
-                form_id="",
                 dg=parent,
                 title=title,
                 dismissible=dismissible,

streamlit/elements/lib/image_utils.py

@@ -34,6 +34,7 @@ if TYPE_CHECKING:
     import numpy.typing as npt
     from PIL import GifImagePlugin, Image, ImageFile
 
+    from streamlit.elements.lib.layout_utils import LayoutConfig
     from streamlit.proto.Image_pb2 import ImageList as ImageListProto
     from streamlit.type_util import NumpyShape
 
@@ -176,7 +177,7 @@ def _get_image_format_mimetype(image_format: ImageFormat) -> str:
 
 
 def _ensure_image_size_and_format(
-    image_data: bytes, width: int, image_format: ImageFormat
+    image_data: bytes, layout_config: LayoutConfig, image_format: ImageFormat
 ) -> bytes:
     """Resize an image if it exceeds the given width, or if exceeds
     MAXIMUM_CONTENT_WIDTH. Ensure the image's format corresponds to the given
@@ -187,17 +188,25 @@ def _ensure_image_size_and_format(
     pil_image: PILImage = Image.open(io.BytesIO(image_data))
     actual_width, actual_height = pil_image.size
 
-    if width < 0 and actual_width > MAXIMUM_CONTENT_WIDTH:
-        width = MAXIMUM_CONTENT_WIDTH
+    target_width = (
+        layout_config.width
+        if isinstance(layout_config.width, int)
+        else MAXIMUM_CONTENT_WIDTH
+    )
 
-    if width > 0 and actual_width > width:
+    # Resizing the image down if the embedded width is greater than
+    # the target width.
+    if target_width > 0 and actual_width > target_width:
         # We need to resize the image.
-        new_height = int(1.0 * actual_height * width / actual_width)
+        new_height = int(1.0 * actual_height * target_width / actual_width)
         # pillow reexports Image.Resampling.BILINEAR as Image.BILINEAR for backwards
         # compatibility reasons, so we use the reexport to support older pillow
         # versions. The types don't seem to reflect this, though, hence the type: ignore
         # below.
-        pil_image = pil_image.resize((width, new_height), resample=Image.BILINEAR)  # type: ignore[attr-defined]
+        pil_image = pil_image.resize(
+            (target_width, new_height),
+            resample=Image.BILINEAR,  # type: ignore[attr-defined]
+        )
         return _pil_to_bytes(pil_image, format=image_format, quality=90)
 
     if pil_image.format != image_format:
@@ -227,7 +236,7 @@ def _clip_image(image: npt.NDArray[Any], clamp: bool) -> npt.NDArray[Any]:
 
 def image_to_url(
     image: AtomicImage,
-    width: int,
+    layout_config: LayoutConfig,
     clamp: bool,
     channels: Channels,
     output_format: ImageFormatOrAuto,
@@ -327,7 +336,7 @@ def image_to_url(
 
     # Determine the image's format, resize it, and get its mimetype
     image_format = _validate_image_format_string(image_data, output_format)
-    image_data = _ensure_image_size_and_format(image_data, width, image_format)
+    image_data = _ensure_image_size_and_format(image_data, layout_config, image_format)
     mimetype = _get_image_format_mimetype(image_format)
 
     if runtime.exists():
@@ -346,7 +355,7 @@ def marshall_images(
     coordinates: str,
     image: ImageOrImageList,
     caption: str | npt.NDArray[Any] | list[str] | None,
-    width: int | WidthBehavior,
+    layout_config: LayoutConfig,
     proto_imgs: ImageListProto,
     clamp: bool,
     channels: Channels = "RGB",
@@ -423,7 +432,6 @@ def marshall_images(
             f"Cannot pair {len(captions)} captions with {len(images)} images."
         )
 
-    proto_imgs.width = int(width)
     # Each image in an image list needs to be kept track of at its own coordinates.
     for coord_suffix, (single_image, single_caption) in enumerate(
         zip(images, captions)
@@ -437,5 +445,5 @@ def marshall_images(
         image_id = f"{coordinates}-{coord_suffix}"
 
         proto_img.url = image_to_url(
-            single_image, width, clamp, channels, output_format, image_id
+            single_image, layout_config, clamp, channels, output_format, image_id
         )

streamlit/elements/lib/layout_utils.py

@@ -74,7 +74,12 @@ def validate_width(width: Width, allow_content: bool = False) -> None:
         raise StreamlitInvalidWidthError(width, allow_content)
 
 
-def validate_height(height: Height, allow_content: bool = False) -> None:
+def validate_height(
+    height: Height | Literal["auto"],
+    allow_content: bool = False,
+    allow_stretch: bool = True,
+    additional_allowed: list[str] | None = None,
+) -> None:
     """Validate the height parameter.
 
     Parameters
@@ -83,6 +88,10 @@ def validate_height(height: Height, allow_content: bool = False) -> None:
         The height value to validate.
     allow_content : bool
         Whether to allow "content" as a valid height value.
+    allow_stretch : bool
+        Whether to allow "stretch" as a valid height value.
+    additional_allowed : list[str] or None
+        Additional string values to allow beyond the base allowed values.
 
     Raises
     ------
@@ -93,9 +102,13 @@ def validate_height(height: Height, allow_content: bool = False) -> None:
         raise StreamlitInvalidHeightError(height, allow_content)
 
     if isinstance(height, str):
-        valid_strings = ["stretch"]
+        valid_strings = []
+        if allow_stretch:
+            valid_strings.append("stretch")
         if allow_content:
             valid_strings.append("content")
+        if additional_allowed:
+            valid_strings.extend(additional_allowed)
 
         if height not in valid_strings:
             raise StreamlitInvalidHeightError(height, allow_content)

streamlit/elements/lib/utils.py

@@ -28,10 +28,10 @@ from google.protobuf.message import Message
 from typing_extensions import TypeAlias
 
 from streamlit import config
+from streamlit.elements.lib.form_utils import current_form_id
 from streamlit.errors import StreamlitDuplicateElementId, StreamlitDuplicateElementKey
 from streamlit.proto.ChatInput_pb2 import ChatInput
 from streamlit.proto.LabelVisibilityMessage_pb2 import LabelVisibilityMessage
-from streamlit.proto.RootContainer_pb2 import RootContainer
 from streamlit.runtime.scriptrunner_utils.script_run_context import (
     ScriptRunContext,
     get_script_run_ctx,
@@ -82,7 +82,7 @@ def get_label_visibility_proto_value(
 
 
 def get_chat_input_accept_file_proto_value(
-    accept_file_value: bool | Literal["multiple"],
+    accept_file_value: Literal["multiple", "directory"] | bool,
 ) -> ChatInput.AcceptFile.ValueType:
     """Returns one of ChatInput.AcceptFile enum value based on string value."""
 
@@ -92,6 +92,8 @@ def get_chat_input_accept_file_proto_value(
         return ChatInput.AcceptFile.SINGLE
     if accept_file_value == "multiple":
         return ChatInput.AcceptFile.MULTIPLE
+    if accept_file_value == "directory":
+        return ChatInput.AcceptFile.DIRECTORY
 
     raise ValueError(f"Unknown accept file value: {accept_file_value}")
 
@@ -184,9 +186,8 @@ def compute_and_register_element_id(
     element_type: str,
     *,
     user_key: str | None,
-    form_id: str | None,
-    dg: DeltaGenerator | None = None,
-    style: str | None = None,
+    dg: DeltaGenerator | None,
+    key_as_main_identity: bool = False,
     **kwargs: SAFE_VALUES | Iterable[SAFE_VALUES],
 ) -> str:
     """Compute and register the ID for the given element.
@@ -213,65 +214,43 @@ def compute_and_register_element_id(
         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.
-
     dg : DeltaGenerator | None
         The DeltaGenerator of each element. `None` if the element is not a widget.
 
-    style: str | None
-        The style of the element, to provide more context to the user in the
-        error message. This should be `None` if the element does not support
-        the style parameter.
-
     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
+
+    key_as_main_identity : bool
+        If True, if a key is provided by the user, we don't include
+        command kwargs in the element ID computation.
     """
     ctx = get_script_run_ctx()
 
-    kwargs_to_use = {**kwargs}
-    if form_id:
-        kwargs_to_use["form_id"] = form_id
-    if style:
-        kwargs_to_use["style"] = style
-
-    # If style is provided, use it for the error message, to provide more
-    # context to the user.
-    if style == "borderless":
-        # The borderless style is used by st.feedback, but users expect to see
-        # "feedback" in errors
-        element_type_for_error = "feedback"
-    elif style:
-        element_type_for_error = style
-    else:
-        element_type_for_error = element_type
+    ignore_command_kwargs = key_as_main_identity and user_key
+
+    kwargs_to_use = {} if ignore_command_kwargs else {**kwargs}
 
     if ctx:
         # Add the active script hash to give elements on different
-        # pages unique IDs.
+        # pages unique IDs. This is added even if
+        # key_as_main_identity is specified.
         kwargs_to_use["active_script_hash"] = ctx.active_script_hash
 
-    if dg:
+    if dg and not ignore_command_kwargs:
+        kwargs_to_use["form_id"] = current_form_id(dg)
         # If no key is provided and the widget element is inside the sidebar area
         # add it to the kwargs
         # allowing the same widget to be both in main area and sidebar.
-        active_dg_root_container = dg._active_dg._root_container
-        if active_dg_root_container == RootContainer.SIDEBAR and user_key is None:
-            kwargs_to_use["active_dg_root_container"] = str(active_dg_root_container)
+        kwargs_to_use["active_dg_root_container"] = dg._active_dg._root_container
 
-    element_id = _compute_element_id(
-        element_type,
-        user_key,
-        **kwargs_to_use,
-    )
+    element_id = _compute_element_id(element_type, user_key, **kwargs_to_use)
 
     if ctx:
-        _register_element_id(ctx, element_type_for_error, element_id)
+        _register_element_id(ctx, element_type, element_id)
     return element_id
 
 

streamlit/elements/markdown.py

@@ -80,7 +80,7 @@ class MarkdownMixin:
             - Colored text and background colors for text, using the syntax
               ``:color[text to be colored]`` and ``:color-background[text to be colored]``,
               respectively. ``color`` must be replaced with any of the following
-              supported colors: blue, green, orange, red, violet, gray/grey,
+              supported colors: red, orange, yellow, green, blue, violet, gray/grey,
               rainbow, or primary. For example, you can use
               ``:orange[your text here]`` or ``:blue-background[your text here]``.
               If you use "primary" for color, Streamlit will use the default
@@ -89,7 +89,7 @@ class MarkdownMixin:
 
             - Colored badges, using the syntax ``:color-badge[text in the badge]``.
               ``color`` must be replaced with any of the following supported
-              colors: blue, green, orange, red, violet, gray/grey, or primary.
+              colors: red, orange, yellow, green, blue, violet, gray/grey, or primary.
               For example, you can use ``:orange-badge[your text here]`` or
               ``:blue-badge[your text here]``.
 
@@ -359,10 +359,11 @@ class MarkdownMixin:
         *,  # keyword-only arguments:
         icon: str | None = None,
         color: Literal[
+            "red",
+            "orange",
+            "yellow",
             "blue",
             "green",
-            "orange",
-            "red",
             "violet",
             "gray",
             "grey",
@@ -418,8 +419,8 @@ class MarkdownMixin:
         color : str
             The color to use for the badge. This defaults to ``"blue"``.
 
-            This can be one of the following supported colors: blue, green,
-            orange, red, violet, gray/grey, or primary. If you use
+            This can be one of the following supported colors: red, orange,
+            yellow, blue, green, violet, gray/grey, or primary. If you use
             ``"primary"``, Streamlit will use the default primary accent color
             unless you set the ``theme.primaryColor`` configuration option.