streamlit-nightly 1.43.3.dev20250311__py3-none-any.whl → 1.43.3.dev20250313__py3-none-any.whl

streamlit/__init__.py

@@ -166,6 +166,7 @@ altair_chart = _main.altair_chart
 area_chart = _main.area_chart
 audio = _main.audio
 audio_input = _main.audio_input
+badge = _main.badge
 balloons = _main.balloons
 bar_chart = _main.bar_chart
 bokeh_chart = _main.bokeh_chart

streamlit/auth_util.py

@@ -146,7 +146,8 @@ def generate_default_provider_section(auth_section) -> dict[str, Any]:
 
 def validate_auth_credentials(provider: str) -> None:
     """Validate the general auth credentials and auth credentials for the given
-    provider."""
+    provider.
+    """
     if not secrets_singleton.load_if_toml_exists():
         raise StreamlitAuthError(
             """To use authentication features you need to configure credentials for at

streamlit/commands/experimental_query_params.py

@@ -109,7 +109,7 @@ def set_query_params(**query_params: Any) -> None:
 def _exclude_keys_in_dict(
     d: dict[str, Any], keys_to_exclude: list[str]
 ) -> dict[str, Any]:
-    """Returns new object but without keys defined in keys_to_exclude"""
+    """Returns new object but without keys defined in keys_to_exclude."""
     return {
         key: value for key, value in d.items() if key.lower() not in keys_to_exclude
     }

streamlit/commands/logo.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Handle App logos"""
+"""Handle App logos."""
 
 from __future__ import annotations
 
@@ -38,7 +38,7 @@ def logo(
     link: str | None = None,
     icon_image: AtomicImage | None = None,
 ) -> None:
-    """
+    r"""
     Renders a logo in the upper-left corner of your app and its sidebar.
 
     If ``st.logo`` is called multiple times within a page, Streamlit will
@@ -75,7 +75,7 @@ def logo(
 
     link : str or None
         The external URL to open when a user clicks on the logo. The URL must
-        start with "\\http://" or "\\https://". If ``link`` is ``None`` (default),
+        start with "\http://" or "\https://". If ``link`` is ``None`` (default),
         the logo will not include a hyperlink.
     icon_image: Anything supported by st.image (except list) or None
         An optional, typically smaller image to replace ``image`` in the

streamlit/components/v1/__init__.py

@@ -12,9 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""
-This directory contains the files and modules for the exposed API.
-"""
+"""Contains the files and modules for the exposed API."""
 
 import streamlit
 from streamlit.components.v1.component_registry import declare_component

streamlit/config.py

@@ -455,8 +455,9 @@ def _logger_log_level() -> str:
 @_create_option("logger.messageFormat", type_=str)
 def _logger_message_format() -> str:
     """String format for logging messages. If logger.datetimeFormat is set,
-    logger messages will default to `%(asctime)s.%(msecs)03d %(message)s`. See
-    Python's documentation for available attributes:
+    logger messages will default to `%(asctime)s.%(msecs)03d %(message)s`.
+
+    See Python's documentation for available attributes:
     https://docs.python.org/3/library/logging.html#formatter-objects
 
     Default: "%(asctime)s %(message)s"

streamlit/config_option.py

@@ -299,9 +299,7 @@ class ConfigOption:
 
     @property
     def env_var(self):
-        """
-        Get the name of the environment variable that can be used to set the option.
-        """
+        """Get the name of the environment variable that can be used to set the option."""
         name = self.key.replace(".", "_")
         return f"STREAMLIT_{to_snake_case(name).upper()}"
 

streamlit/connections/snowflake_connection.py

@@ -81,7 +81,6 @@ class SnowflakeConnection(BaseConnection["InternalSnowflakeConnection"]):
 
     Examples
     --------
-
     **Example 1: Configuration with Streamlit secrets**
 
     You can configure your Snowflake connection using Streamlit's

streamlit/connections/sql_connection.py

@@ -101,7 +101,6 @@ class SQLConnection(BaseConnection["Engine"]):
 
     Examples
     --------
-
     **Example 1: Configuration with URL**
 
     You can configure your SQL connection using Streamlit's

streamlit/dataframe_util.py

@@ -319,7 +319,7 @@ def is_dataframe_like(obj: object) -> bool:
 
 
 def is_unevaluated_data_object(obj: object) -> bool:
-    """True if the object is one of the supported unevaluated data objects:
+    """True if the object is one of the supported unevaluated data objects.
 
     Currently supported objects are:
     - Snowpark DataFrame / Table
@@ -372,7 +372,7 @@ def is_snowpark_row_list(obj: object) -> bool:
 
 
 def is_pyspark_data_object(obj: object) -> bool:
-    """True if obj is a PySpark or PySpark Connect dataframe"""
+    """True if obj is a PySpark or PySpark Connect dataframe."""
     return (
         is_type(obj, _PYSPARK_DF_TYPE_STR) or is_type(obj, _PYSPARK_CONNECT_DF_TYPE_STR)
     ) and has_callable_attr(obj, "toPandas")
@@ -391,7 +391,7 @@ def is_dask_object(obj: object) -> bool:
 
 
 def is_modin_data_object(obj: object) -> bool:
-    """True if obj is of Modin Dataframe or Series"""
+    """True if obj is of Modin Dataframe or Series."""
     return is_type(obj, _MODIN_DF_TYPE_STR) or is_type(obj, _MODIN_SERIES_TYPE_STR)
 
 
@@ -857,7 +857,8 @@ def convert_arrow_bytes_to_pandas_df(source: bytes) -> DataFrame:
 
 def _show_data_information(msg: str) -> None:
     """Show a message to the user with important information
-    about the processed dataset."""
+    about the processed dataset.
+    """
     from streamlit.delta_generator_singletons import get_dg_singleton_instance
 
     get_dg_singleton_instance().main_dg.caption(msg)
@@ -910,7 +911,6 @@ def convert_anything_to_list(obj: OptionSequence[V_co]) -> list[V_co]:
 
     Parameters
     ----------
-
     obj : dataframe-, array-, or collections-like object
         The object to convert to a list.
 
@@ -1035,7 +1035,8 @@ def _maybe_truncate_table(
 
 def is_colum_type_arrow_incompatible(column: Series[Any] | Index) -> bool:
     """Return True if the column type is known to cause issues during
-    Arrow conversion."""
+    Arrow conversion.
+    """
     from pandas.api.types import infer_dtype, is_dict_like, is_list_like
 
     if column.dtype.kind in [

streamlit/delta_generator_singletons.py

@@ -57,7 +57,6 @@ class DeltaGeneratorSingleton:
 
         Parameters
         ----------
-
         delta_generator_cls : type[DeltaGenerator]
             The main DeltaGenerator class.
         status_container_cls : type[StatusContainer]
@@ -179,7 +178,8 @@ context_dg_stack: ContextVarWithLazyDefault[tuple[DeltaGenerator, ...]] = (
 
 def get_default_dg_stack_value() -> tuple[DeltaGenerator, ...]:
     """Get the default dg_stack value with which the dg_stack should
-    be initialized and reset if needed."""
+    be initialized and reset if needed.
+    """
     instance = get_dg_singleton_instance()
     if instance._main_dg is None:
         raise RuntimeError("main_dg is not set")

streamlit/elements/arrow.py

@@ -436,7 +436,6 @@ class ArrowMixin:
 
         Examples
         --------
-
         **Example 1: Display a dataframe**
 
         >>> import streamlit as st

streamlit/elements/exception.py

@@ -180,7 +180,9 @@ Traceback:
 
 def _format_syntax_error_message(exception: SyntaxError) -> str:
     """Returns a nicely formatted SyntaxError message that emulates
-    what the Python interpreter outputs, e.g.:
+    what the Python interpreter outputs.
+
+    For example:
 
     > File "raven.py", line 3
     >   st.write('Hello world!!'))

streamlit/elements/form.py

@@ -202,7 +202,7 @@ class FormMixin:
         disabled: bool = False,
         use_container_width: bool = False,
     ) -> bool:
-        """Display a form submit button.
+        r"""Display a form submit button.
 
         When this button is clicked, all widget values inside the form will be
         sent from the user's browser to your Streamlit server in a batch.
@@ -225,7 +225,7 @@ class FormMixin:
             Unsupported Markdown elements are unwrapped so only their children
             (text contents) render. Display unsupported elements as literal
             characters by backslash-escaping them. E.g.,
-            ``"1\\. Not an ordered list"``.
+            ``"1\. Not an ordered list"``.
 
             See the ``body`` parameter of |st.markdown|_ for additional,
             supported Markdown directives.
@@ -269,7 +269,7 @@ class FormMixin:
               of the icon in snake case.
 
               For example, ``icon=":material/thumb_up:"`` will display the
-              Thumb Up icon. Find additional icons in the `Material Symbols \
+              Thumb Up icon. Find additional icons in the `Material Symbols
               <https://fonts.google.com/icons?icon.set=Material+Symbols&icon.style=Rounded>`_
               font library.
         disabled : bool

streamlit/elements/json.py

@@ -34,7 +34,8 @@ if TYPE_CHECKING:
 
 def _ensure_serialization(o: object) -> str | list[Any]:
     """A repr function for json.dumps default arg, which tries to serialize sets
-    as lists."""
+    as lists.
+    """
     return list(o) if isinstance(o, set) else repr(o)
 
 
@@ -50,7 +51,6 @@ class JsonMixin:
 
         Parameters
         ----------
-
         body : object or str
             The object to print as JSON. All referenced objects should be
             serializable to JSON as well. If object is a string, we assume it

streamlit/elements/layouts.py

@@ -60,7 +60,6 @@ class LayoutsMixin:
 
         Parameters
         ----------
-
         height : int or None
             Desired height of the container expressed in pixels. If ``None`` (default)
             the container grows to fit its content. If a fixed height, scrolling is
@@ -230,7 +229,6 @@ class LayoutsMixin:
 
         Examples
         --------
-
         **Example 1: Use context management**
 
         You can use the ``with`` statement to insert any element into a column:
@@ -768,7 +766,6 @@ class LayoutsMixin:
 
         Parameters
         ----------
-
         label : str
             The initial label of the status container. The label can optionally
             contain GitHub-flavored Markdown of the following types: Bold, Italics,
@@ -802,14 +799,12 @@ class LayoutsMixin:
 
         Returns
         -------
-
         StatusContainer
             A mutable status container that can hold multiple elements. The label, state,
             and expanded state can be updated after creation via ``.update()``.
 
         Examples
         --------
-
         You can use the ``with`` notation to insert any element into an status container:
 
         >>> import time

streamlit/elements/lib/built_in_chart_utils.py

@@ -331,7 +331,7 @@ def _infer_vegalite_type(
 ) -> VegaLiteType:
     """
     From an array-like input, infer the correct vega typecode
-    ('ordinal', 'nominal', 'quantitative', or 'temporal')
+    ('ordinal', 'nominal', 'quantitative', or 'temporal').
 
     Parameters
     ----------
@@ -503,7 +503,6 @@ def _melt_data(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> df = pd.DataFrame(
     ...     {

streamlit/elements/lib/column_config_utils.py

@@ -142,7 +142,6 @@ def _determine_data_kind_via_arrow(field: pa.Field) -> ColumnDataKind:
 
     Parameters
     ----------
-
     field : pa.Field
         The arrow field from the arrow table schema.
 
@@ -375,7 +374,6 @@ def determine_dataframe_schema(
 
     Returns
     -------
-
     DataframeSchema
         A mapping that contains the detected data type for the index and columns.
         The key is the column name in the underlying dataframe or ``_index`` for index columns.
@@ -448,7 +446,6 @@ def update_column_config(
 
     Parameters
     ----------
-
     column_config_mapping : ColumnConfigMapping
         The column config mapping to update.
 

streamlit/elements/lib/column_types.py

@@ -159,7 +159,6 @@ class ColumnConfig(TypedDict, total=False):
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -264,7 +263,6 @@ def Column(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -309,7 +307,6 @@ def Column(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -370,7 +367,6 @@ def NumberColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -459,7 +455,6 @@ def NumberColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -528,7 +523,6 @@ def TextColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -586,7 +580,6 @@ def TextColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -643,7 +636,7 @@ def LinkColumn(
     validate: str | None = None,
     display_text: str | None = None,
 ) -> ColumnConfig:
-    """Configure a link column in ``st.dataframe`` or ``st.data_editor``.
+    r"""Configure a link column in ``st.dataframe`` or ``st.data_editor``.
 
     The cell values need to be string and will be shown as clickable links.
     This command needs to be used in the column_config parameter of ``st.dataframe``
@@ -652,7 +645,6 @@ def LinkColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -716,12 +708,12 @@ def LinkColumn(
         - A string that is displayed in every cell, e.g. ``"Open link"``.
         - A JS-flavored regular expression (detected by usage of parentheses)
           to extract a part of the URL via a capture group. For example, use
-          ``"https://(.*?)\\.example\\.com"`` to extract the display text
-          "foo" from the URL "\\https://foo.example.com".
+          ``"https://(.*?)\.example\.com"`` to extract the display text
+          "foo" from the URL "\https://foo.example.com".
 
         .. Comment: The backslash in front of foo.example.com prevents a hyperlink in docs.
 
-        For more complex cases, you may use `Pandas Styler's format \
+        For more complex cases, you may use `Pandas Styler's format
         <https://pandas.pydata.org/docs/reference/api/pandas.io.formats.style.Styler.format.html>`_
         function on the underlying dataframe. Note that this makes the app slow,
         doesn't work with editable columns, and might be removed in the future.
@@ -730,7 +722,6 @@ def LinkColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -757,9 +748,9 @@ def LinkColumn(
     >>>         "apps": st.column_config.LinkColumn(
     >>>             "Trending apps",
     >>>             help="The top trending Streamlit apps",
-    >>>             validate=r"^https://[a-z]+\\.streamlit\\.app$",
+    >>>             validate=r"^https://[a-z]+\.streamlit\.app$",
     >>>             max_chars=100,
-    >>>             display_text=r"https://(.*?)\\.streamlit\\.app"
+    >>>             display_text=r"https://(.*?)\.streamlit\.app"
     >>>         ),
     >>>         "creator": st.column_config.LinkColumn(
     >>>             "App Creator", display_text="Open profile"
@@ -809,7 +800,6 @@ def CheckboxColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -858,7 +848,6 @@ def CheckboxColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -919,7 +908,6 @@ def SelectboxColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -974,7 +962,6 @@ def SelectboxColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -1044,7 +1031,6 @@ def BarChartColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -1082,7 +1068,6 @@ def BarChartColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -1142,7 +1127,6 @@ def LineChartColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -1180,7 +1164,6 @@ def LineChartColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -1241,7 +1224,6 @@ def AreaChartColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -1279,7 +1261,6 @@ def AreaChartColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -1346,7 +1327,6 @@ def ImageColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -1376,7 +1356,6 @@ def ImageColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -1430,7 +1409,6 @@ def ListColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -1460,7 +1438,6 @@ def ListColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -1525,7 +1502,6 @@ def DatetimeColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -1612,7 +1588,6 @@ def DatetimeColumn(
 
     Examples
     --------
-
     >>> from datetime import datetime
     >>> import pandas as pd
     >>> import streamlit as st
@@ -1689,7 +1664,6 @@ def TimeColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -1768,7 +1742,6 @@ def TimeColumn(
 
     Examples
     --------
-
     >>> from datetime import time
     >>> import pandas as pd
     >>> import streamlit as st
@@ -1844,7 +1817,6 @@ def DateColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -1925,7 +1897,6 @@ def DateColumn(
 
     Examples
     --------
-
     >>> from datetime import date
     >>> import pandas as pd
     >>> import streamlit as st
@@ -1996,7 +1967,6 @@ def ProgressColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -2059,7 +2029,6 @@ def ProgressColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>
@@ -2118,7 +2087,6 @@ def JsonColumn(
 
     Parameters
     ----------
-
     label: str or None
         The label shown at the top of the column. If this is ``None``
         (default), the column name is used.
@@ -2148,7 +2116,6 @@ def JsonColumn(
 
     Examples
     --------
-
     >>> import pandas as pd
     >>> import streamlit as st
     >>>

streamlit/elements/lib/image_utils.py

@@ -241,7 +241,7 @@ def image_to_url(
     If `image` is already a URL, return it unmodified.
     Otherwise, add the image to the MediaFileManager and return the URL.
     (When running in "raw" mode, we won't actually load data into the
-    MediaFileManager, and we'll return an empty URL.)
+    MediaFileManager, and we'll return an empty URL).
     """
     import numpy as np
     from PIL import Image, ImageFile
@@ -359,6 +359,7 @@ def marshall_images(
 ) -> None:
     """Fill an ImageListProto with a list of images and their captions.
     The images will be resized and reformatted as necessary.
+
     Parameters
     ----------
     coordinates

streamlit/elements/lib/options_selector_utils.py

@@ -155,7 +155,8 @@ def _coerce_enum(from_enum_value: E1, to_enum_class: type[E2]) -> E1 | E2:
 
 def _extract_common_class_from_iter(iterable: Iterable[Any]) -> Any:
     """Return the common class of all elements in a iterable if they share one.
-    Otherwise, return None."""
+    Otherwise, return None.
+    """
     try:
         inner_iter = iter(iterable)
         first_class = type(next(inner_iter))
@@ -185,7 +186,8 @@ def maybe_coerce_enum(
 def maybe_coerce_enum(register_widget_result, options, opt_sequence):
     """Maybe Coerce a RegisterWidgetResult with an Enum member value to
     RegisterWidgetResult[option] if option is an EnumType, otherwise just return
-    the original RegisterWidgetResult."""
+    the original RegisterWidgetResult.
+    """
 
     # If the value is not a Enum, return early
     if not isinstance(register_widget_result.value, Enum):
@@ -226,7 +228,8 @@ def maybe_coerce_enum_sequence(
 def maybe_coerce_enum_sequence(register_widget_result, options, opt_sequence):
     """Maybe Coerce a RegisterWidgetResult with a sequence of Enum members as value
     to RegisterWidgetResult[Sequence[option]] if option is an EnumType, otherwise just return
-    the original RegisterWidgetResult."""
+    the original RegisterWidgetResult.
+    """
 
     # If not all widget values are Enums, return early
     if not all(isinstance(val, Enum) for val in register_widget_result.value):

streamlit/elements/lib/subtitle_utils.py

@@ -73,10 +73,12 @@ def _srt_to_vtt(srt_data: str | bytes) -> bytes:
     Convert subtitles from SubRip (.srt) format to WebVTT (.vtt) format.
     This function accepts the content of the .srt file either as a string
     or as a BytesIO stream.
+
     Parameters
     ----------
     srt_data : str or bytes
         The content of the .srt file as a string or a bytes stream.
+
     Returns
     -------
     bytes