streamlit-nightly 1.42.3.dev20250227__py2.py3-none-any.whl → 1.42.3.dev20250228__py2.py3-none-any.whl

streamlit/elements/arrow.py

@@ -331,10 +331,10 @@ class ArrowMixin:
 
         use_container_width : bool
             Whether to override ``width`` with the width of the parent
-            container. If ``use_container_width`` is ``False``, Streamlit
-            sets the dataframe's width according to ``width``. If
-            ``use_container_width`` is ``True`` (default), Streamlit sets the
-            width of the dataframe to match the width of the parent container.
+            container. If this is ``True`` (default), Streamlit sets the width
+            of the dataframe to match the width of the parent container. If
+            this is ``False``, Streamlit sets the dataframe's width according
+            to ``width``.
 
         hide_index : bool or None
             Whether to hide the index column(s). If ``hide_index`` is ``None``
@@ -421,7 +421,8 @@ class ArrowMixin:
 
         row_height : int or None
             The height of each row in the dataframe in pixels. If ``row_height``
-            is ``None`` (default), Streamlit will use a default row height.
+            is ``None`` (default), Streamlit will use a default row height,
+            which fits one line of text.
 
         Returns
         -------

streamlit/elements/lib/column_types.py

@@ -419,25 +419,28 @@ def NumberColumn(
 
     format:  str, "plain", "localized", "percent", "dollar", "euro", "accounting", "compact", "scientific", "engineering", or None
         A format string controlling how numbers are displayed.
-        Can be one of the following:
-
-        - ``"plain"``: Shows the full number without any formatting (1234.567)
-        - ``"localized"``: Shows the number in the default locale format (1,234.567)
-        - ``"percent"``: Shows the number as a percentage (123456.70%)
-        - ``"dollar"``: Shows the number as a dollar amount ($1,234.57)
-        - ``"euro"``: Shows the number as a euro amount (€1,234.57)
-        - ``"accounting"``: Shows the number in an accounting format (1,234.00)
-        - ``"compact"``: Shows the number in a compact format (1.2K)
-        - ``"scientific"``: Shows the number in a scientific notation (1.235E3)
-        - ``"engineering"``: Shows the number in an engineering notation (1.235E3)
-        - printf-style format string: The following formatters are valid:
-          ``%d``, ``%e``, ``%f``, ``%g``, ``%i``, ``%u``. You can also add
-          prefixes and suffixes, e.g. ``"$ %.2f"`` to show a dollar prefix.
-        - ``None`` (default): the numbers are formatted via a default formatter.
+        This can be one of the following values:
+
+        - ``None`` (default): Streamlit infers the formatting from the data.
+        - ``"plain"``: Show the full number without any formatting (e.g. "1234.567").
+        - ``"localized"``: Show the number in the default locale format (e.g. "1,234.567").
+        - ``"percent"``: Show the number as a percentage (e.g. "123456.70%").
+        - ``"dollar"``: Show the number as a dollar amount (e.g. "$1,234.57").
+        - ``"euro"``: Show the number as a euro amount (e.g. "€1,234.57").
+        - ``"accounting"``: Show the number in an accounting format (e.g. "1,234.00").
+        - ``"compact"``: Show the number in a compact format (e.g. "1.2K").
+        - ``"scientific"``: Show the number in scientific notation (e.g. "1.235E3").
+        - ``"engineering"``: Show the number in engineering notation (e.g. "1.235E3").
+        - printf-style format string: Format the number with a printf
+          specifier, like ``"%d"`` to show a signed integer (e.g. "1234") or
+          ``"%X"`` to show an unsigned hexidecimal integer (e.g. "4D2"). You
+          can also add prefixes and suffixes. To show British pounds, use
+          ``"£ %.2f"`` (e.g. "£ 1234.57"). For more information, see `sprint-js
+          <https://github.com/alexei/sprintf.js?tab=readme-ov-file#format-specification>`_.
 
-        Number formatting from ``column_config`` always takes precedence over
-        number formatting from ``pandas.Styler``. The number formatting does
-        not impact the return value when used in ``st.data_editor``.
+        Formatting from ``column_config`` always takes precedence over
+        formatting from ``pandas.Styler``. The formatting does not impact the
+        return value when used in ``st.data_editor``.
 
     min_value: int, float, or None
         The minimum value that can be entered. If this is ``None`` (default),
@@ -1571,18 +1574,25 @@ def DatetimeColumn(
 
     format: str, "localized", "distance", "calendar", "iso8601", or None
         A format string controlling how datetimes are displayed.
-        Can be one of the following:
-
-        - ``"localized"``: Shows the datetime in the default locale format.
-        - ``"distance"``: Shows the datetime in a relative format.
-        - ``"calendar"``: Shows the datetime in a calendar format.
-        - ``"iso8601"``: Shows the datetime in ISO 8601 format.
-        - A momentJS format string: See `momentJS docs <https://momentjs.com/docs/#/displaying/format/>`_
-        for available formats.
-        - ``None`` (default): uses ``YYYY-MM-DD HH:mm:ss`` as format.
+        This can be one of the following values:
+
+        - ``None`` (default): Show the datetime in ``"YYYY-MM-DD HH:mm:ss"``
+          format (e.g. "2025-03-04 20:00:00").
+        - ``"localized"``: Show the datetime in the default locale format (e.g.
+          "Mar 4, 2025, 12:00:00 PM" in the America/Los_Angeles timezone).
+        - ``"distance"``: Show the datetime in a relative format (e.g.
+          "a few seconds ago").
+        - ``"calendar"``: Show the datetime in a calendar format (e.g.
+          "Today at 8:00 PM").
+        - ``"iso8601"``: Show the datetime in ISO 8601 format (e.g.
+          "2025-03-04T20:00:00.000Z").
+        - A momentJS format string: Format the datetime with a string, like
+          ``"ddd ha"`` to show "Tue 8pm". For available formats, see
+          `momentJS <https://momentjs.com/docs/#/displaying/format/>`_.
 
         Formatting from ``column_config`` always takes precedence over
-        datetime formatting from ``pandas.Styler``.
+        formatting from ``pandas.Styler``. The formatting does not impact the
+        return value when used in ``st.data_editor``.
 
     min_value: datetime.datetime or None
         The minimum datetime that can be entered. If this is ``None``
@@ -1728,15 +1738,21 @@ def TimeColumn(
 
     format: str, "localized", "iso8601", or None
         A format string controlling how times are displayed.
-        Can be one of the following:
-        - ``"localized"``: Shows the time in the default locale format.
-        - ``"iso8601"``: Shows the time in ISO 8601 format.
-        - A momentJS format string: See `momentJS docs <https://momentjs.com/docs/#/displaying/format/>`_
-        for available formats.
-        - ``None`` (default): uses ``HH:mm:ss`` as format.
+        This can be one of the following values:
+
+        - ``None`` (default): Show the time in ``"HH:mm:ss"`` format (e.g.
+          "20:00:00").
+        - ``"localized"``: Show the time in the default locale format (e.g.
+          "12:00:00 PM" in the America/Los_Angeles timezone).
+        - ``"iso8601"``: Show the time in ISO 8601 format (e.g.
+          "20:00:00.000Z").
+        - A momentJS format string: Format the time with a string, like
+          ``"ha"`` to show "8pm". For available formats, see
+          `momentJS <https://momentjs.com/docs/#/displaying/format/>`_.
 
-        Time formatting from ``column_config`` always takes precedence over
-        time formatting from ``pandas.Styler``.
+        Formatting from ``column_config`` always takes precedence over
+        formatting from ``pandas.Styler``. The formatting does not impact the
+        return value when used in ``st.data_editor``.
 
     min_value: datetime.time or None
         The minimum time that can be entered. If this is ``None`` (default),
@@ -1876,17 +1892,24 @@ def DateColumn(
         the user. This defaults to ``None``.
 
     format: str, "localized", "distance", "iso8601", or None
-        A format string controlling how the dates are displayed.
-        Can be one of the following:
-        - ``"localized"``: Shows the date in the default locale format.
-        - ``"distance"``: Shows the date in a relative format (e.g. "1 day ago").
-        - ``"iso8601"``: Shows the date in ISO 8601 format.
-        - A momentJS format string: See `momentJS docs <https://momentjs.com/docs/#/displaying/format/>`_
-        for available formats.
-        - ``None`` (default): uses ``YYYY-MM-DD`` as format.
-
-        Date formatting from ``column_config`` always takes precedence over
-        date formatting from ``pandas.Styler``.
+        A format string controlling how dates are displayed.
+        This can be one of the following values:
+
+        - ``None`` (default): Show the date in ``"YYYY-MM-DD"`` format (e.g.
+          "2025-03-04").
+        - ``"localized"``: Show the date in the default locale format (e.g.
+          "Mar 4, 2025" in the America/Los_Angeles timezone).
+        - ``"distance"``: Show the date in a relative format (e.g.
+          "a few seconds ago").
+        - ``"iso8601"``: Show the date in ISO 8601 format (e.g.
+          "2025-03-04").
+        - A momentJS format string: Format the date with a string, like
+          ``"ddd, MMM Do"`` to show "Tue, Mar 4th". For available formats, see
+          `momentJS <https://momentjs.com/docs/#/displaying/format/>`_.
+
+        Formatting from ``column_config`` always takes precedence over
+        formatting from ``pandas.Styler``. The formatting does not impact the
+        return value when used in ``st.data_editor``.
 
     min_value: datetime.date or None
         The minimum date that can be entered. If this is ``None`` (default),
@@ -1996,25 +2019,29 @@ def ProgressColumn(
         ``st.markdown``.
 
     format: str, "plain", "localized", "percent", "dollar", "euro", "accounting", "compact", "scientific", "engineering", or None
-        A format string controlling how numbers are displayed.
-        Can be one of the following:
-
-        - ``"plain"``: Shows the full number without any formatting (1234.567)
-        - ``"localized"``: Shows the number in the default locale format (1,234.567)
-        - ``"percent"``: Shows the number as a percentage (123456.70%)
-        - ``"dollar"``: Shows the number as a dollar amount ($1,234.57)
-        - ``"euro"``: Shows the number as a euro amount (€1,234.57)
-        - ``"accounting"``: Shows the number in an accounting format (1,234.00)
-        - ``"compact"``: Shows the number in a compact format (1.2K)
-        - ``"scientific"``: Shows the number in a scientific notation (1.235E3)
-        - ``"engineering"``: Shows the number in an engineering notation (1.235E3)
-        - printf-style format string: The following formatters are valid:
-        ``%d``, ``%e``, ``%f``, ``%g``, ``%i``, ``%u``. You can also add
-        prefixes and suffixes, e.g. ``"$ %.2f"`` to show a dollar prefix.
-        - ``None`` (default): the numbers are formatted via a default formatter.
-
-        The number formatting does not impact the return value when used in
-        ``st.data_editor``.
+        A format string controlling how the numbers are displayed.
+        This can be one of the following values:
+
+        - ``None`` (default): Streamlit infers the formatting from the data.
+        - ``"plain"``: Show the full number without any formatting (e.g. "1234.567").
+        - ``"localized"``: Show the number in the default locale format (e.g. "1,234.567").
+        - ``"percent"``: Show the number as a percentage (e.g. "123456.70%").
+        - ``"dollar"``: Show the number as a dollar amount (e.g. "$1,234.57").
+        - ``"euro"``: Show the number as a euro amount (e.g. "€1,234.57").
+        - ``"accounting"``: Show the number in an accounting format (e.g. "1,234.00").
+        - ``"compact"``: Show the number in a compact format (e.g. "1.2K").
+        - ``"scientific"``: Show the number in scientific notation (e.g. "1.235E3").
+        - ``"engineering"``: Show the number in engineering notation (e.g. "1.235E3").
+        - printf-style format string: Format the number with a printf
+          specifier, like ``"%d"`` to show a signed integer (e.g. "1234") or
+          ``"%X"`` to show an unsigned hexidecimal integer (e.g. "4D2"). You
+          can also add prefixes and suffixes. To show British pounds, use
+          ``"£ %.2f"`` (e.g. "£ 1234.57"). For more information, see `sprint-js
+          <https://github.com/alexei/sprintf.js?tab=readme-ov-file#format-specification>`_.
+
+        Number formatting from ``column_config`` always takes precedence over
+        number formatting from ``pandas.Styler``. The number formatting does
+        not impact the return value when used in ``st.data_editor``.
 
     pinned: bool or None
         Whether the column is pinned. A pinned column will stay visible on the
@@ -2085,8 +2112,8 @@ def JsonColumn(
 ) -> ColumnConfig:
     """Configure a JSON column in ``st.dataframe`` or ``st.data_editor``.
 
-    Cells need to contain a JSON string or JSON-compatible objects.
-    JSON columns are not editable at the moment. This command needs to be used in the
+    Cells need to contain JSON strings or JSON-compatible objects. JSON 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``.
 
     Parameters
@@ -2106,8 +2133,12 @@ def JsonColumn(
         - ``"large"``: 400px wide
 
     help: str or None
-        An optional tooltip that gets displayed when hovering over the column
-        label. If this is ``None`` (default), no tooltip is displayed.
+        A tooltip that gets displayed when hovering over the column label. 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``.
 
     pinned: bool or None
         Whether the column is pinned. A pinned column will stay visible on the

streamlit/elements/widgets/button.py

@@ -335,8 +335,19 @@ class ButtonMixin:
             including the Markdown directives described in the ``body``
             parameter of ``st.markdown``.
 
-        on_click : callable
-            An optional callback invoked when this button is clicked.
+        on_click : callable, "rerun", "ignore", or None
+            How the button should respond to user interaction. This controls
+            whether or not the button triggers a rerun and if a callback
+            function is called. This can be one of the following values:
+
+            - ``"rerun"`` (default): The user downloads the file and the app
+              reruns. No callback function is called.
+            - ``"ignore"``: The user downloads the file and the app doesn't
+              rerun. No callback function is called.
+            - A ``callable``: The user downloads the file and app reruns. The
+              callable is called before the rest of the app.
+            - ``None``: This is same as ``on_click="rerun"``. This value exists
+              for backwards compatibility and shouldn't be used.
 
         args : tuple
             An optional tuple of args to pass to the callback.

streamlit/elements/widgets/data_editor.py

@@ -636,10 +636,10 @@ class DataEditorMixin:
 
         use_container_width : bool
             Whether to override ``width`` with the width of the parent
-            container. If ``use_container_width`` is ``False``, Streamlit
-            sets the data editor's width according to ``width``. If
-            ``use_container_width`` is ``True`` (default), Streamlit sets the
-            width of the data editor to match the width of the parent container.
+            container. If this is ``True`` (default), Streamlit sets the width
+            of the data editor to match the width of the parent container. If
+            this is ``False``, Streamlit sets the data editor's width according
+            to ``width``.
 
         hide_index : bool or None
             Whether to hide the index column(s). If ``hide_index`` is ``None``
@@ -697,7 +697,8 @@ class DataEditorMixin:
 
         row_height : int or None
             The height of each row in the data editor in pixels. If ``row_height``
-            is ``None`` (default), Streamlit will use a default row height.
+            is ``None`` (default), Streamlit will use a default row height,
+            which fits one line of text.
 
         Returns
         -------

streamlit/elements/widgets/number_input.py

@@ -240,8 +240,9 @@ class NumberInputMixin:
         format : str or None
             A printf-style format string controlling how the interface should
             display numbers. The output must be purely numeric. This does not
-            impact the return value of the widget. Formatting is handled by
-            `sprintf.js <https://github.com/alexei/sprintf.js>`_.
+            impact the return value of the widget. For more information about
+            the formatting specification, see `sprintf.js
+            <https://github.com/alexei/sprintf.js?tab=readme-ov-file#format-specification>`_.
 
             For example, ``format="%0.1f"`` adjusts the displayed decimal
             precision to only show one digit after the decimal.

streamlit/elements/widgets/slider.py

@@ -415,9 +415,17 @@ class SliderMixin:
         format : str or None
             A printf-style format string controlling how the interface should
             display numbers. This does not impact the return value.
-            Formatter for int/float supports: %d %e %f %g %i
-            Formatter for date/time/datetime uses Moment.js notation:
-            https://momentjs.com/docs/#/displaying/format/
+
+            For information about formatting integers and floats, see
+            `sprintf.js
+            <https://github.com/alexei/sprintf.js?tab=readme-ov-file#format-specification>`_.
+            For example, ``format="%0.1f"`` adjusts the displayed decimal
+            precision to only show one digit after the decimal.
+
+            For information about formatting datetimes, dates, and times, see
+            `momentJS <https://momentjs.com/docs/#/displaying/format/>`_.
+            For example, ``format="ddd ha"`` adjusts the displayed datetime to
+            show the day of the week and the hour ("Tue 8pm").
 
         key : str or int
             An optional string or integer to use as the unique key for the widget.

streamlit/runtime/context.py

@@ -146,6 +146,8 @@ class ContextProxy:
 
         Examples
         --------
+        **Example 1: Access all available headers**
+
         Show a dictionary of headers (with only the last instance of any
         repeated key):
 
@@ -153,6 +155,8 @@ class ContextProxy:
         >>>
         >>> st.context.headers
 
+        **Example 2: Access a specific header**
+
         Show the value of a specific header (or the last instance if it's
         repeated):
 
@@ -183,12 +187,16 @@ class ContextProxy:
 
         Examples
         --------
+        **Example 1: Access all available cookies**
+
         Show a dictionary of cookies:
 
         >>> import streamlit as st
         >>>
         >>> st.context.cookies
 
+        **Example 2: Access a specific cookie**
+
         Show the value of a specific cookie:
 
         >>> import streamlit as st
@@ -209,7 +217,26 @@ class ContextProxy:
     @property
     @gather_metrics("context.timezone")
     def timezone(self) -> str | None:
-        """The timezone of the user's browser, read-only."""
+        """The read-only timezone of the user's browser.
+
+        Example
+        -------
+        Access the user's timezone, and format a datetime to display locally:
+
+        >>> import streamlit as st
+        >>> from datetime import datetime, timezone
+        >>> import pytz
+        >>>
+        >>> tz = st.context.timezone
+        >>> tz_obj = pytz.timezone(tz)
+        >>>
+        >>> now = datetime.now(timezone.utc)
+        >>>
+        >>> f"The user's timezone is {tz}."
+        >>> f"The UTC time is {now}."
+        >>> f"The user's local time is {now.astimezone(tz_obj)}"
+
+        """
         ctx = get_script_run_ctx()
 
         if ctx is None or ctx.context_info is None:
@@ -219,7 +246,25 @@ class ContextProxy:
     @property
     @gather_metrics("context.timezone_offset")
     def timezone_offset(self) -> int | None:
-        """The timezone offset of the user's browser, read-only."""
+        """The read-only timezone offset of the user's browser.
+
+        Example
+        -------
+        Access the user's timezone offset, and format a datetime to display locally:
+
+        >>> import streamlit as st
+        >>> from datetime import datetime, timezone, timedelta
+        >>>
+        >>> tzoff = st.context.timezone_offset
+        >>> tz_obj = timezone(-timedelta(minutes=tzoff))
+        >>>
+        >>> now = datetime.now(timezone.utc)
+        >>>
+        >>> f"The user's timezone is {tz}."
+        >>> f"The UTC time is {now}."
+        >>> f"The user's local time is {now.astimezone(tz_obj)}"
+
+        """
         ctx = get_script_run_ctx()
         if ctx is None or ctx.context_info is None:
             return None

streamlit/static/index.html

@@ -51,7 +51,7 @@
     <script>
       window.prerenderReady = false
     </script>
-    <script type="module" crossorigin src="./static/js/index.DfNAkKAr.js"></script>
+    <script type="module" crossorigin src="./static/js/index.BUNYdCvS.js"></script>
     <link rel="stylesheet" crossorigin href="./static/css/index.DpJG_94W.css">
   </head>
   <body>

streamlit/static/static/js/{FileDownload.esm.rdZtCw5-.js → FileDownload.esm.BjRCwIvW.js}

@@ -1 +1 @@
-import{r as e,E as n,_ as a}from"./index.DfNAkKAr.js";var o=e.forwardRef(function(t,r){var l={fill:"currentColor",xmlns:"http://www.w3.org/2000/svg"};return e.createElement(n,a({iconAttrs:l,iconVerticalAlign:"middle",iconViewBox:"0 0 24 24"},t,{ref:r}),e.createElement("path",{fill:"none",d:"M0 0h24v24H0V0z"}),e.createElement("path",{d:"M16 9v10H8V9h8m-1.5-6h-5l-1 1H5v2h14V4h-3.5l-1-1zM18 7H6v12c0 1.1.9 2 2 2h8c1.1 0 2-.9 2-2V7z"}))});o.displayName="Delete";var i=e.forwardRef(function(t,r){var l={fill:"currentColor",xmlns:"http://www.w3.org/2000/svg"};return e.createElement(n,a({iconAttrs:l,iconVerticalAlign:"middle",iconViewBox:"0 0 24 24"},t,{ref:r}),e.createElement("rect",{width:24,height:24,fill:"none"}),e.createElement("path",{d:"M18 15v3H6v-3H4v3c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2v-3h-2zm-1-4l-1.41-1.41L13 12.17V4h-2v8.17L8.41 9.59 7 11l5 5 5-5z"}))});i.displayName="FileDownload";export{o as D,i as F};
+import{r as e,E as n,_ as a}from"./index.BUNYdCvS.js";var o=e.forwardRef(function(t,r){var l={fill:"currentColor",xmlns:"http://www.w3.org/2000/svg"};return e.createElement(n,a({iconAttrs:l,iconVerticalAlign:"middle",iconViewBox:"0 0 24 24"},t,{ref:r}),e.createElement("path",{fill:"none",d:"M0 0h24v24H0V0z"}),e.createElement("path",{d:"M16 9v10H8V9h8m-1.5-6h-5l-1 1H5v2h14V4h-3.5l-1-1zM18 7H6v12c0 1.1.9 2 2 2h8c1.1 0 2-.9 2-2V7z"}))});o.displayName="Delete";var i=e.forwardRef(function(t,r){var l={fill:"currentColor",xmlns:"http://www.w3.org/2000/svg"};return e.createElement(n,a({iconAttrs:l,iconVerticalAlign:"middle",iconViewBox:"0 0 24 24"},t,{ref:r}),e.createElement("rect",{width:24,height:24,fill:"none"}),e.createElement("path",{d:"M18 15v3H6v-3H4v3c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2v-3h-2zm-1-4l-1.41-1.41L13 12.17V4h-2v8.17L8.41 9.59 7 11l5 5 5-5z"}))});i.displayName="FileDownload";export{o as D,i as F};