streamlit-data-editor-plus 0.1.0__py3-none-any.whl

streamlit/elements/widgets/select_slider.py

@@ -0,0 +1,568 @@
+# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+from textwrap import dedent
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Generic,
+    TypeGuard,
+    TypeVar,
+    cast,
+    overload,
+)
+
+from streamlit.dataframe_util import OptionSequence, convert_anything_to_list
+from streamlit.elements.lib.form_utils import current_form_id
+from streamlit.elements.lib.layout_utils import LayoutConfig, validate_width
+from streamlit.elements.lib.options_selector_utils import (
+    create_mappings,
+    index_,
+    maybe_coerce_enum,
+    maybe_coerce_enum_sequence,
+    validate_and_sync_range_value_with_options,
+    validate_and_sync_value_with_options,
+)
+from streamlit.elements.lib.policies import (
+    check_widget_policies,
+    maybe_raise_label_warnings,
+)
+from streamlit.elements.lib.utils import (
+    Key,
+    LabelVisibility,
+    compute_and_register_element_id,
+    get_label_visibility_proto_value,
+    save_for_app_testing,
+    to_key,
+)
+from streamlit.errors import StreamlitAPIException
+from streamlit.proto.Slider_pb2 import Slider as SliderProto
+from streamlit.runtime.metrics_util import gather_metrics
+from streamlit.runtime.scriptrunner import ScriptRunContext, get_script_run_ctx
+from streamlit.runtime.state import (
+    BindOption,
+    WidgetArgs,
+    WidgetCallback,
+    WidgetKwargs,
+    register_widget,
+)
+from streamlit.type_util import check_python_comparable
+
+if TYPE_CHECKING:
+    from collections.abc import Callable, Sequence
+
+    from streamlit.delta_generator import DeltaGenerator
+    from streamlit.elements.lib.layout_utils import WidthWithoutContent
+    from streamlit.runtime.state.common import RegisterWidgetResult
+
+T = TypeVar("T")
+
+
+def _is_range_value(value: T | Sequence[T]) -> TypeGuard[Sequence[T]]:
+    return isinstance(value, (list, tuple))
+
+
+class SelectSliderSerde(Generic[T]):
+    """Serializer/deserializer for select_slider widget values.
+
+    Uses formatted option strings for robust handling of dynamic option changes.
+    """
+
+    def __init__(
+        self,
+        options: Sequence[T],
+        *,
+        formatted_option_to_index: dict[str, int],
+        default_indices: list[int],
+        format_func: Callable[[Any], str] = str,
+    ) -> None:
+        self.options = options
+        self.formatted_option_to_index = formatted_option_to_index
+        self.default_indices = default_indices
+        self.format_func = format_func
+
+    def _get_default(self, is_range: bool) -> T | tuple[T, T]:
+        """Return the default value based on default_indices."""
+        if is_range or len(self.default_indices) >= 2:
+            end_idx = (
+                self.default_indices[1]
+                if len(self.default_indices) > 1
+                else len(self.options) - 1
+            )
+            return (self.options[self.default_indices[0]], self.options[end_idx])
+        return self.options[self.default_indices[0]]
+
+    def serialize(self, v: T | tuple[T, T] | list[T]) -> list[str]:
+        """Convert option value(s) to formatted string list."""
+        # Check if v is a single option (handles options that are tuples/lists)
+        try:
+            formatted = self.format_func(v)
+            if formatted in self.formatted_option_to_index:
+                return [formatted]
+        except Exception:  # noqa: S110
+            pass
+
+        # Handle as range/sequence
+        if isinstance(v, (tuple, list)):
+            return [self.format_func(x) for x in v]
+
+        return [self.format_func(v)]
+
+    def deserialize(self, ui_value: list[str] | None) -> T | tuple[T, T]:
+        """Convert formatted string list back to option value(s)."""
+        is_range = len(self.default_indices) >= 2
+
+        if not ui_value:
+            return self._get_default(is_range=is_range)
+
+        expected_len = 2 if is_range else 1
+        if len(ui_value) != expected_len:
+            # Wrong number of values (e.g. single URL param for a range
+            # select_slider); fall back to default so the URL param is cleared.
+            return self._get_default(is_range=is_range)
+
+        # Look up each string value
+        results: list[tuple[int, T]] = []
+        for i, s in enumerate(ui_value):
+            idx = self.formatted_option_to_index.get(s)
+            if idx is not None and idx < len(self.options):
+                results.append((idx, self.options[idx]))
+            else:
+                # Fallback to default for this position
+                default_idx = self.default_indices[
+                    min(i, len(self.default_indices) - 1)
+                ]
+                results.append((default_idx, self.options[default_idx]))
+
+        if is_range:
+            # Ensure start <= end by returning deserialized range value in ascending order
+            if results[0][0] > results[1][0]:
+                return (results[1][1], results[0][1])
+            return (results[0][1], results[1][1])
+
+        return results[0][1]
+
+
+class SelectSliderMixin:
+    @overload
+    def select_slider(
+        self,
+        label: str,
+        options: OptionSequence[T],
+        value: tuple[T, T] | list[T],
+        format_func: Callable[[Any], Any] = str,
+        key: Key | None = None,
+        help: str | None = None,
+        on_change: WidgetCallback | None = None,
+        args: WidgetArgs | None = None,
+        kwargs: WidgetKwargs | None = None,
+        *,  # keyword-only arguments:
+        disabled: bool = False,
+        label_visibility: LabelVisibility = "visible",
+        width: WidthWithoutContent = "stretch",
+        bind: BindOption = None,
+    ) -> tuple[T, T]: ...
+
+    @overload
+    def select_slider(
+        self,
+        label: str,
+        options: OptionSequence[T] = (),
+        value: T | None = None,
+        format_func: Callable[[Any], Any] = str,
+        key: Key | None = None,
+        help: str | None = None,
+        on_change: WidgetCallback | None = None,
+        args: WidgetArgs | None = None,
+        kwargs: WidgetKwargs | None = None,
+        *,  # keyword-only arguments:
+        disabled: bool = False,
+        label_visibility: LabelVisibility = "visible",
+        width: WidthWithoutContent = "stretch",
+        bind: BindOption = None,
+    ) -> T: ...
+
+    @gather_metrics("select_slider")
+    def select_slider(
+        self,
+        label: str,
+        options: OptionSequence[T] = (),
+        value: T | Sequence[T] | None = None,
+        format_func: Callable[[Any], Any] = str,
+        key: Key | None = None,
+        help: str | None = None,
+        on_change: WidgetCallback | None = None,
+        args: WidgetArgs | None = None,
+        kwargs: WidgetKwargs | None = None,
+        *,  # keyword-only arguments:
+        disabled: bool = False,
+        label_visibility: LabelVisibility = "visible",
+        width: WidthWithoutContent = "stretch",
+        bind: BindOption = None,
+    ) -> T | tuple[T, T]:
+        r"""
+        Display a slider widget to select items from a list.
+
+        This also allows you to render a range slider by passing a two-element
+        tuple or list as the ``value``.
+
+        The difference between ``st.select_slider`` and ``st.slider`` is that
+        ``select_slider`` accepts any datatype and takes an iterable set of
+        options, while ``st.slider`` only accepts numerical or date/time data and
+        takes a range as input.
+
+        Parameters
+        ----------
+        label : str
+            A short label explaining to the user what this slider is for.
+            The label can optionally contain GitHub-flavored Markdown of the
+            following types: Bold, Italics, Strikethroughs, Inline Code, Links,
+            and Images. Images display like icons, with a max height equal to
+            the font height.
+
+            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"``.
+
+            See the ``body`` parameter of |st.markdown|_ for additional,
+            supported Markdown directives.
+
+            For accessibility reasons, you should never set an empty label, but
+            you can hide it with ``label_visibility`` if needed. In the future,
+            we may disallow empty labels by raising an exception.
+
+            .. |st.markdown| replace:: ``st.markdown``
+            .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown
+
+        options : Iterable
+            Labels for the select options in an ``Iterable``. This can be a
+            ``list``, ``set``, or anything supported by ``st.dataframe``. If
+            ``options`` is dataframe-like, the first column will be used. Each
+            label will be cast to ``str`` internally by default.
+
+            Each item in the iterable can optionally contain GitHub-flavored
+            Markdown, subject to the same limitations described in the
+            ``label`` parameter.
+
+        value : a supported type or a tuple/list of supported types or None
+            The value of the slider when it first renders. If a tuple/list
+            of two values is passed here, then a range slider with those lower
+            and upper bounds is rendered. For example, if set to `(1, 10)` the
+            slider will have a selectable range between 1 and 10.
+            Defaults to first option.
+
+        format_func : function
+            Function to modify the display of the labels from the options.
+            argument. It receives the option as an argument and its output
+            will be cast to str.
+
+        key : str or int
+            An optional string or integer to use as the unique key for the widget.
+            If this is omitted, a key will be generated for the widget
+            based on its content. No two widgets may have the same key.
+
+        help : str or None
+            A tooltip that gets displayed next to the widget label. Streamlit
+            only displays the tooltip when ``label_visibility="visible"``. 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``.
+
+        on_change : callable
+            An optional callback invoked when this select_slider's value changes.
+
+        args : list or tuple
+            An optional list or tuple of args to pass to the callback.
+
+        kwargs : dict
+            An optional dict of kwargs to pass to the callback.
+
+        disabled : bool
+            An optional boolean that disables the select slider if set to
+            ``True``. The default is ``False``.
+
+        label_visibility : "visible", "hidden", or "collapsed"
+            The visibility of the label. The default is ``"visible"``. If this
+            is ``"hidden"``, Streamlit displays an empty spacer instead of the
+            label, which can help keep the widget aligned with other widgets.
+            If this is ``"collapsed"``, Streamlit displays no label or spacer.
+
+        width : "stretch" or int
+            The width of the slider widget. This can be one of the
+            following:
+
+            - ``"stretch"`` (default): The width of the widget matches the
+              width of the parent container.
+            - An integer specifying the width in pixels: The widget has a
+              fixed width. If the specified width is greater than the width of
+              the parent container, the width of the widget matches the width
+              of the parent container.
+
+        bind : "query-params" or None
+            If set to ``"query-params"``, the widget's value will be synced
+            with a URL query parameter. When the widget value changes, the URL
+            is updated; when the page loads with a query parameter, the widget
+            is initialized from it. Invalid URL options are auto-corrected to
+            the closest valid state. Range select sliders use repeated
+            parameters (e.g., ``?key=red&key=blue``). Requires a ``key`` to
+            be set, which will be used as the query parameter name. The
+            default is ``None``.
+
+        Returns
+        -------
+        any value or tuple of any value
+            The current value of the slider widget. The return type will match
+            the data type of the value parameter.
+
+            This contains copies of the selected options, not the originals.
+
+        Examples
+        --------
+        >>> import streamlit as st
+        >>>
+        >>> color = st.select_slider(
+        ...     "Select a color of the rainbow",
+        ...     options=[
+        ...         "red",
+        ...         "orange",
+        ...         "yellow",
+        ...         "green",
+        ...         "blue",
+        ...         "indigo",
+        ...         "violet",
+        ...     ],
+        ... )
+        >>> st.write("My favorite color is", color)
+
+        And here's an example of a range select slider:
+
+        >>> import streamlit as st
+        >>>
+        >>> start_color, end_color = st.select_slider(
+        ...     "Select a range of color wavelength",
+        ...     options=[
+        ...         "red",
+        ...         "orange",
+        ...         "yellow",
+        ...         "green",
+        ...         "blue",
+        ...         "indigo",
+        ...         "violet",
+        ...     ],
+        ...     value=("red", "blue"),
+        ... )
+        >>> st.write("You selected wavelengths between", start_color, "and", end_color)
+
+        .. output::
+           https://doc-select-slider.streamlit.app/
+           height: 450px
+
+        """
+        ctx = get_script_run_ctx()
+        return self._select_slider(
+            label=label,
+            options=options,
+            value=value,
+            format_func=format_func,
+            key=key,
+            help=help,
+            on_change=on_change,
+            args=args,
+            kwargs=kwargs,
+            disabled=disabled,
+            label_visibility=label_visibility,
+            ctx=ctx,
+            width=width,
+            bind=bind,
+        )
+
+    def _select_slider(
+        self,
+        label: str,
+        options: OptionSequence[T] = (),
+        value: T | Sequence[T] | None = None,
+        format_func: Callable[[Any], Any] = str,
+        key: Key | None = None,
+        help: str | None = None,
+        on_change: WidgetCallback | None = None,
+        args: WidgetArgs | None = None,
+        kwargs: WidgetKwargs | None = None,
+        disabled: bool = False,
+        label_visibility: LabelVisibility = "visible",
+        ctx: ScriptRunContext | None = None,
+        width: WidthWithoutContent = "stretch",
+        bind: BindOption = None,
+    ) -> T | tuple[T, T]:
+        key = to_key(key)
+
+        check_widget_policies(
+            self.dg,
+            key,
+            on_change,
+            default_value=value,
+        )
+        maybe_raise_label_warnings(label, label_visibility)
+
+        opt = convert_anything_to_list(options)
+        check_python_comparable(opt)
+
+        if len(opt) == 0:
+            raise StreamlitAPIException("The `options` argument needs to be non-empty")
+
+        def as_index_list(v: Any) -> list[int]:
+            if _is_range_value(v):
+                slider_value = [index_(opt, val) for val in v]
+                start, end = slider_value
+                if start > end:
+                    slider_value = [end, start]
+                return slider_value
+            # Simplify future logic by always making value a list
+            try:
+                return [index_(opt, v)]
+            except ValueError:
+                if value is not None:
+                    raise
+
+                return [0]
+
+        # Convert element to index of the elements
+        slider_value = as_index_list(value)
+
+        # Create formatted options and mapping for string-based storage
+        formatted_options, formatted_option_to_option_index = create_mappings(
+            opt, format_func
+        )
+
+        element_id = compute_and_register_element_id(
+            "select_slider",
+            user_key=key,
+            key_as_main_identity=True,
+            dg=self.dg,
+            label=label,
+            options=formatted_options,
+            value=slider_value,
+            help=help,
+            width=width,
+        )
+
+        slider_proto = SliderProto()
+        slider_proto.id = element_id
+        slider_proto.type = SliderProto.Type.SELECT_SLIDER
+        slider_proto.label = label
+        slider_proto.format = "%s"
+        slider_proto.default[:] = slider_value
+        slider_proto.min = 0
+        slider_proto.max = len(opt) - 1
+        slider_proto.step = 1  # default for index changes
+        slider_proto.data_type = SliderProto.INT
+        slider_proto.options[:] = formatted_options
+        slider_proto.form_id = current_form_id(self.dg)
+        slider_proto.disabled = disabled
+        slider_proto.label_visibility.value = get_label_visibility_proto_value(
+            label_visibility
+        )
+        if help is not None:
+            slider_proto.help = dedent(help)
+
+        if bind and key:
+            slider_proto.query_param_key = str(key)
+
+        validate_width(width)
+        layout_config = LayoutConfig(width=width)
+
+        serde = SelectSliderSerde(
+            opt,
+            formatted_option_to_index=formatted_option_to_option_index,
+            default_indices=slider_value,
+            format_func=format_func,
+        )
+
+        widget_state = register_widget(
+            slider_proto.id,
+            on_change_handler=on_change,
+            args=args,
+            kwargs=kwargs,
+            deserializer=serde.deserialize,
+            serializer=serde.serialize,
+            ctx=ctx,
+            value_type="string_array_value",
+            bind=bind,
+            # Select sliders always have a value (no empty/cleared state in
+            # the UI), so disallow empty URL params (e.g., ?key=).
+            clearable=False,
+            # Skip URL dedup: ?color=red&color=red is a valid zero-width
+            # range. Single-mode duplicates are handled by validation.
+            allow_url_duplicates=True,
+        )
+        if isinstance(widget_state.value, tuple):
+            widget_state = maybe_coerce_enum_sequence(
+                cast("RegisterWidgetResult[tuple[T, T]]", widget_state), options, opt
+            )
+        else:
+            widget_state = maybe_coerce_enum(widget_state, options, opt)
+
+        # Validate the current value against the new options.
+        # If the value is no longer valid (not in options), reset to default.
+        # This handles the case where options change dynamically and the
+        # previously selected value is no longer available.
+        # Determine if we're dealing with a range value based on the actual
+        # widget state value, not just the value parameter (range can come from
+        # session state even when value param is None).
+        actual_is_range = isinstance(widget_state.value, tuple)
+        if actual_is_range:
+            # Range value: validate using range-specific function.
+            range_value = cast("tuple[T, T]", widget_state.value)
+            validated_range, value_needs_reset = (
+                validate_and_sync_range_value_with_options(
+                    range_value,
+                    opt,
+                    slider_value,
+                    key,
+                    format_func,
+                )
+            )
+            current_value: T | tuple[T, T] = validated_range
+        else:
+            # Single value: use the standard validation function.
+            validated_single, value_needs_reset = validate_and_sync_value_with_options(
+                widget_state.value,
+                opt,
+                slider_value[0],
+                key,
+                format_func,
+            )
+            # validated_single is guaranteed to be T (not None) because
+            # deserialize() always returns a default value, never None.
+            current_value = cast("T", validated_single)
+
+        if value_needs_reset or widget_state.value_changed:
+            serialized_value = serde.serialize(current_value)
+            slider_proto.raw_value[:] = serialized_value
+            slider_proto.set_value = True
+
+        if ctx:
+            save_for_app_testing(ctx, element_id, format_func)
+
+        self.dg._enqueue("slider", slider_proto, layout_config=layout_config)
+        return current_value
+
+    @property
+    def dg(self) -> DeltaGenerator:
+        """Get our DeltaGenerator."""
+        return cast("DeltaGenerator", self)