streamlit 1.49.1__py3-none-any.whl → 1.50.0__py3-none-any.whl

streamlit/elements/arrow.py

@@ -16,15 +16,7 @@ from __future__ import annotations
 
 import json
 from dataclasses import dataclass
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    Final,
-    Literal,
-    TypedDict,
-    cast,
-    overload,
-)
+from typing import TYPE_CHECKING, Any, Final, Literal, TypedDict, cast, overload
 
 from typing_extensions import TypeAlias
 
@@ -51,7 +43,7 @@ from streamlit.elements.lib.layout_utils import (
 from streamlit.elements.lib.pandas_styler_utils import marshall_styler
 from streamlit.elements.lib.policies import check_widget_policies
 from streamlit.elements.lib.utils import Key, compute_and_register_element_id, to_key
-from streamlit.errors import StreamlitAPIException
+from streamlit.errors import StreamlitAPIException, StreamlitValueError
 from streamlit.proto.Arrow_pb2 import Arrow as ArrowProto
 from streamlit.proto.ForwardMsg_pb2 import ForwardMsg
 from streamlit.runtime.metrics_util import gather_metrics
@@ -270,6 +262,17 @@ def parse_selection_mode(
     return set(parsed_selection_modes)
 
 
+def parse_border_mode(
+    border: bool | Literal["horizontal"],
+) -> ArrowProto.BorderMode.ValueType:
+    """Parse and check the user provided border mode."""
+    if isinstance(border, bool):
+        return ArrowProto.BorderMode.ALL if border else ArrowProto.BorderMode.NONE
+    if border == "horizontal":
+        return ArrowProto.BorderMode.HORIZONTAL
+    raise StreamlitValueError("border", ["True", "False", "'horizontal'"])
+
+
 class ArrowMixin:
     @overload
     def dataframe(
@@ -396,6 +399,11 @@ class ArrowMixin:
             this is ``False``, Streamlit sets the dataframe's width according
             to ``width``.
 
+            .. deprecated::
+                ``use_container_width`` is deprecated and will be removed in a
+                future release. For ``use_container_width=True``, use
+                ``width="stretch"``.
+
         hide_index : bool or None
             Whether to hide the index column(s). If ``hide_index`` is ``None``
             (default), the visibility of index columns is automatically
@@ -487,11 +495,6 @@ class ArrowMixin:
             is ``None`` (default), Streamlit will use a default row height,
             which fits one line of text.
 
-        .. deprecated::
-            ``use_container_width`` is deprecated and will be removed in a
-            future release. For ``use_container_width=True``, use
-            ``width="stretch"``.
-
         Returns
         -------
         element or dict
@@ -725,6 +728,7 @@ class ArrowMixin:
             proto.id = compute_and_register_element_id(
                 "dataframe",
                 user_key=key,
+                key_as_main_identity=False,
                 dg=self.dg,
                 data=proto.data,
                 width=width,
@@ -751,7 +755,9 @@ class ArrowMixin:
         return self.dg._enqueue("arrow_data_frame", proto, layout_config=layout_config)
 
     @gather_metrics("table")
-    def table(self, data: Data = None) -> DeltaGenerator:
+    def table(
+        self, data: Data = None, *, border: bool | Literal["horizontal"] = True
+    ) -> DeltaGenerator:
         """Display a static table.
 
         While ``st.dataframe`` is geared towards large datasets and interactive
@@ -775,49 +781,60 @@ class ArrowMixin:
             .. |st.markdown| replace:: ``st.markdown``
             .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown
 
+        border : bool or "horizontal"
+            Whether to show borders around the table and between cells. This can be one
+            of the following:
+
+            - ``True`` (default): Show borders around the table and between cells.
+            - ``False``: Don't show any borders.
+            - ``"horizontal"``: Show only horizontal borders between rows.
+
         Examples
         --------
-        **Example 1: Display a simple dataframe as a static table**
+        **Example 1: Display a confusion matrix as a static table**
 
         >>> import pandas as pd
         >>> import streamlit as st
-        >>> from numpy.random import default_rng as rng
         >>>
-        >>> df = pd.DataFrame(
-        ...     rng(0).standard_normal(size=(10, 5)),
-        ...     columns=("col %d" % i for i in range(5)),
+        >>> confusion_matrix = pd.DataFrame(
+        ...     {
+        ...         "Predicted Cat": [85, 3, 2, 1],
+        ...         "Predicted Dog": [2, 78, 4, 0],
+        ...         "Predicted Bird": [1, 5, 72, 3],
+        ...         "Predicted Fish": [0, 2, 1, 89],
+        ...     },
+        ...     index=["Actual Cat", "Actual Dog", "Actual Bird", "Actual Fish"],
         ... )
-        >>>
-        >>> st.table(df)
+        >>> st.table(confusion_matrix)
 
         .. output::
-           https://doc-table.streamlit.app/
-           height: 480px
+           https://doc-table-confusion.streamlit.app/
+           height: 250px
 
-        **Example 2: Display a table of Markdown strings**
+        **Example 2: Display a product leaderboard with Markdown and horizontal borders**
 
-        >>> import pandas as pd
         >>> import streamlit as st
         >>>
-        >>> df = pd.DataFrame(
-        ...     {
-        ...         "Command": ["**st.table**", "*st.dataframe*"],
-        ...         "Type": ["`static`", "`interactive`"],
-        ...         "Docs": [
-        ...             "[:rainbow[docs]](https://docs.streamlit.io"
-        ...             "/develop/api-reference/data/st.dataframe)",
-        ...             "[:open_book:](https://docs.streamlit.io"
-        ...             "/develop/api-reference/data/st.table)",
-        ...         ],
-        ...     }
-        ... )
-        >>>
-        >>> st.table(df)
+        >>> product_data = {
+        ...     "Product": [
+        ...         ":material/devices: Widget Pro",
+        ...         ":material/smart_toy: Smart Device",
+        ...         ":material/inventory: Premium Kit",
+        ...     ],
+        ...     "Category": [":blue[Electronics]", ":green[IoT]", ":violet[Bundle]"],
+        ...     "Stock": ["🟢 Full", "🟡 Low", "🔴 Empty"],
+        ...     "Units sold": [1247, 892, 654],
+        ...     "Revenue": [125000, 89000, 98000],
+        ... }
+        >>> st.table(product_data, border="horizontal")
 
         .. output::
-           https://doc-table-markdown.streamlit.app/
+           https://doc-table-horizontal-border.streamlit.app/
            height: 200px
+
         """
+        # Parse border parameter to enum value
+        border_mode = parse_border_mode(border)
 
         # Check if data is uncollected, and collect it but with 100 rows max, instead of
         # 10k rows, which is done in all other cases.
@@ -843,6 +860,7 @@ class ArrowMixin:
 
         proto = ArrowProto()
         marshall(proto, data, default_uuid)
+        proto.border_mode = border_mode
         return self.dg._enqueue("arrow_table", proto, layout_config=layout_config)
 
     @gather_metrics("add_rows")
@@ -1034,8 +1052,10 @@ def _arrow_add_rows(
 
         if metadata.chart_command == "bar_chart":
             kwargs["horizontal"] = metadata.horizontal
+            kwargs["sort"] = metadata.sort
 
-        kwargs["use_container_width"] = metadata.use_container_width
+        if metadata.use_container_width is not None:
+            kwargs["use_container_width"] = metadata.use_container_width
 
         st_method(data, **kwargs)
         return None

streamlit/elements/deck_gl_json_chart.py

@@ -516,6 +516,7 @@ class PydeckMixin:
             pydeck_proto.id = compute_and_register_element_id(
                 "deck_gl_json_chart",
                 user_key=key,
+                key_as_main_identity=False,
                 dg=self.dg,
                 is_selection_activated=is_selection_activated,
                 selection_mode=selection_mode,

streamlit/elements/form.py

@@ -350,6 +350,12 @@ class FormMixin:
             In both cases, if the contents of the button are wider than the
             parent container, the contents will line wrap.
 
+            .. deprecated::
+                ``use_container_width`` is deprecated and will be removed in a
+                future release. For ``use_container_width=True``, use
+                ``width="stretch"``. For ``use_container_width=False``, use
+                ``width="content"``.
+
         width : "content", "stretch", or int
             The width of the button. This can be one of the following:
 
@@ -363,12 +369,6 @@ class FormMixin:
               the parent container, the width of the button matches the width
               of the parent container.
 
-        .. deprecated::
-            ``use_container_width`` is deprecated and will be removed in a
-            future release. For ``use_container_width=True``, use
-            ``width="stretch"``. For ``use_container_width=False``, use
-            ``width="content"``.
-
         Returns
         -------
         bool

streamlit/elements/graphviz_chart.py

@@ -26,8 +26,10 @@ from streamlit.deprecation_util import (
     show_deprecation_warning,
 )
 from streamlit.elements.lib.layout_utils import (
+    Height,
     LayoutConfig,
     Width,
+    validate_height,
     validate_width,
 )
 from streamlit.errors import StreamlitAPIException
@@ -53,6 +55,7 @@ class GraphvizMixin:
         use_container_width: bool | None = None,
         *,  # keyword-only arguments:
         width: Width = "content",
+        height: Height = "content",
     ) -> DeltaGenerator:
         """Display a graph using the dagre-d3 library.
 
@@ -78,6 +81,12 @@ class GraphvizMixin:
             container. If ``use_container_width`` is ``True``, Streamlit sets
             the width of the figure to match the width of the parent container.
 
+            .. deprecated::
+                ``use_container_width`` is deprecated and will be removed in a
+                future release. For ``use_container_width=True``, use
+                ``width="stretch"``. For ``use_container_width=False``, use
+                ``width="content"``.
+
         width : "content", "stretch", or int
             The width of the chart element. This can be one of the following:
 
@@ -91,11 +100,18 @@ class GraphvizMixin:
               the parent container, the width of the element matches the width
               of the parent container.
 
-        .. deprecated::
-            ``use_container_width`` is deprecated and will be removed in a
-            future release. For ``use_container_width=True``, use
-            ``width="stretch"``. For ``use_container_width=False``, use
-            ``width="content"``.
+        height : "content", "stretch", or int
+            The height of the chart element. This can be one of the following:
+
+            - ``"content"`` (default): The height of the element matches the
+              height of its content.
+            - ``"stretch"``: The height of the element matches the height of
+              its content or the height of the parent container, whichever is
+              larger. If the element is not in a parent container, the height
+              of the element matches the height of its content.
+            - An integer specifying the height in pixels: The element has a
+              fixed height. If the content is larger than the specified
+              height, scrolling is enabled.
 
         Example
         -------
@@ -170,7 +186,8 @@ class GraphvizMixin:
 
         # Validate and set layout configuration
         validate_width(width, allow_content=True)
-        layout_config = LayoutConfig(width=width)
+        validate_height(height, allow_content=True)
+        layout_config = LayoutConfig(width=width, height=height)
 
         return self.dg._enqueue(
             "graphviz_chart", graphviz_chart_proto, layout_config=layout_config

streamlit/elements/iframe.py

@@ -99,7 +99,6 @@ class IframeMixin:
             scrolling=scrolling,
             tab_index=tab_index,
         )
-        # When no width is specified, we want the iframe to stretch to fill the container.
         layout_config = LayoutConfig(
             width=width if width is not None else "stretch",
             height=height if height is not None else 150,
@@ -184,7 +183,6 @@ class IframeMixin:
             scrolling=scrolling,
             tab_index=tab_index,
         )
-        # When no width is specified, we want the html to stretch to fill the container.
         layout_config = LayoutConfig(
             width=width if width is not None else "stretch",
             height=height if height is not None else 150,

streamlit/elements/image.py

@@ -115,6 +115,11 @@ class ImageMixin:
             If "always" or True, set the image's width to the column width.
             If "never" or False, set the image's width to its natural size.
             Note: if set, `use_column_width` takes precedence over the `width` parameter.
+
+            .. deprecated::
+                ``use_column_width`` is deprecated and will be removed in a future
+                release. Please use the ``width`` parameter instead.
+
         clamp : bool
             Whether to clamp image pixel values to a valid range (0-255 per
             channel). This is only used for byte array images; the parameter is
@@ -142,15 +147,11 @@ class ImageMixin:
             ``use_container_width`` is ``True``, Streamlit sets the width of
             the image to match the width of the parent container.
 
-        .. deprecated::
-            ``use_container_width`` is deprecated and will be removed in a
-            future release. For ``use_container_width=True``, use
-            ``width="stretch"``. For ``use_container_width=False``, use
-            ``width="content"``.
-
-        .. deprecated::
-            ``use_column_width`` is deprecated and will be removed in a future
-            release. Please use the ``width`` parameter instead.
+            .. deprecated::
+                ``use_container_width`` is deprecated and will be removed in a
+                future release. For ``use_container_width=True``, use
+                ``width="stretch"``. For ``use_container_width=False``, use
+                ``width="content"``.
 
         Example
         -------

streamlit/elements/layouts.py

@@ -323,7 +323,7 @@ class LayoutsMixin:
             # in the future. This might require including more container
             # parameters in the ID calculation.
             block_proto.id = compute_and_register_element_id(
-                "container", user_key=key, dg=None
+                "container", user_key=key, dg=None, key_as_main_identity=False
             )
 
         return self.dg._block(block_proto)
@@ -559,6 +559,7 @@ class LayoutsMixin:
         tabs: Sequence[str],
         *,
         width: WidthWithoutContent = "stretch",
+        default: str | None = None,
     ) -> Sequence[DeltaGenerator]:
         r"""Insert containers separated into tabs.
 
@@ -568,7 +569,7 @@ class LayoutsMixin:
 
         To add elements to the returned containers, you can use the ``with`` notation
         (preferred) or just call methods directly on the returned object. See
-        examples below.
+        the examples below.
 
         .. note::
             All content within every tab is computed and sent to the frontend,
@@ -608,6 +609,12 @@ class LayoutsMixin:
               the parent container, the width of the container matches the width
               of the parent container.
 
+        default : str or None
+            The default tab to select. If this is ``None`` (default), the first
+            tab is selected. If this is a string, it must be one of the tab
+            labels. If two tabs have the same label as ``default``, the first
+            one is selected.
+
         Returns
         -------
         list of containers
@@ -615,7 +622,9 @@ class LayoutsMixin:
 
         Examples
         --------
-        You can use the ``with`` notation to insert any element into a tab:
+        *Example 1: Use context management*
+
+        You can use ``with`` notation to insert any element into a tab:
 
         >>> import streamlit as st
         >>>
@@ -635,7 +644,9 @@ class LayoutsMixin:
             https://doc-tabs1.streamlit.app/
             height: 620px
 
-        Or you can just call methods directly on the returned objects:
+        *Example 2: Call methods directly*
+
+        You can call methods directly on the returned objects:
 
         >>> import streamlit as st
         >>> from numpy.random import default_rng as rng
@@ -654,12 +665,42 @@ class LayoutsMixin:
             https://doc-tabs2.streamlit.app/
             height: 700px
 
+        *Example 3: Set the default tab and style the tab labels*
+
+        Use the ``default`` parameter to set the default tab. You can also use
+        Markdown in the tab labels.
+
+        >>> import streamlit as st
+        >>>
+        >>> tab1, tab2, tab3 = st.tabs(
+        ...     [":cat: Cat", ":dog: Dog", ":rainbow[Owl]"], default=":rainbow[Owl]"
+        ... )
+        >>>
+        >>> with tab1:
+        >>>     st.header("A cat")
+        >>>     st.image("https://static.streamlit.io/examples/cat.jpg", width=200)
+        >>> with tab2:
+        >>>     st.header("A dog")
+        >>>     st.image("https://static.streamlit.io/examples/dog.jpg", width=200)
+        >>> with tab3:
+        >>>     st.header("An owl")
+        >>>     st.image("https://static.streamlit.io/examples/owl.jpg", width=200)
+
+        .. output ::
+            https://doc-tabs3.streamlit.app/
+            height: 620px
+
         """
         if not tabs:
             raise StreamlitAPIException(
                 "The input argument to st.tabs must contain at least one tab label."
             )
 
+        if default and default not in tabs:
+            raise StreamlitAPIException(
+                f"The default tab '{default}' is not in the list of tabs."
+            )
+
         if any(not isinstance(tab, str) for tab in tabs):
             raise StreamlitAPIException(
                 "The tabs input list to st.tabs is only allowed to contain strings."
@@ -675,8 +716,14 @@ class LayoutsMixin:
         block_proto.tab_container.SetInParent()
         validate_width(width)
         block_proto.width_config.CopyFrom(get_width_config(width))
+
+        default_index = tabs.index(default) if default else 0
+
+        block_proto.tab_container.default_tab_index = default_index
+
         tab_container = self.dg._block(block_proto)
-        return tuple(tab_container._block(tab_proto(tab_label)) for tab_label in tabs)
+
+        return tuple(tab_container._block(tab_proto(tab)) for tab in tabs)
 
     @gather_metrics("expander")
     def expander(
@@ -899,6 +946,12 @@ class LayoutsMixin:
             button. The popover container may be wider than its button to fit
             the container's content.
 
+            .. deprecated::
+                ``use_container_width`` is deprecated and will be removed in a
+                future release. For ``use_container_width=True``, use
+                ``width="stretch"``. For ``use_container_width=False``, use
+                ``width="content"``.
+
         width : int, "stretch", or "content"
             The width of the button. This can be one of the following:
 
@@ -916,12 +969,6 @@ class LayoutsMixin:
             button. The popover container may be wider than its button to fit
             the container's contents.
 
-        .. deprecated::
-            ``use_container_width`` is deprecated and will be removed in a
-            future release. For ``use_container_width=True``, use
-            ``width="stretch"``. For ``use_container_width=False``, use
-            ``width="content"``.
-
         Examples
         --------
         You can use the ``with`` notation to insert any element into a popover: