streamlit-nightly 1.43.2.dev20250307__py3-none-any.whl

streamlit/elements/iframe.py

@@ -0,0 +1,191 @@
+# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
+#
+# 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 typing import TYPE_CHECKING, cast
+
+from streamlit.proto.IFrame_pb2 import IFrame as IFrameProto
+from streamlit.runtime.metrics_util import gather_metrics
+
+if TYPE_CHECKING:
+    from streamlit.delta_generator import DeltaGenerator
+
+
+class IframeMixin:
+    @gather_metrics("_iframe")
+    def _iframe(
+        self,
+        src: str,
+        width: int | None = None,
+        height: int | None = None,
+        scrolling: bool = False,
+    ) -> DeltaGenerator:
+        """Load a remote URL in an iframe.
+
+        To use this function, import it from the ``streamlit.components.v1``
+        module.
+
+        .. warning::
+            Using ``st.components.v1.iframe`` directly (instead of importing
+            its module) is deprecated and will be disallowed in a later version.
+
+        Parameters
+        ----------
+        src : str
+            The URL of the page to embed.
+
+        width : int
+            The width of the iframe in CSS pixels. By default, this is the
+            app's default element width.
+
+        height : int
+            The height of the frame in CSS pixels. By default, this is ``150``.
+
+        scrolling : bool
+            Whether to allow scrolling in the iframe. If this ``False``
+            (default), Streamlit crops any content larger than the iframe and
+            does not show a scrollbar. If this is ``True``, Streamlit shows a
+            scrollbar when the content is larger than the iframe.
+
+        Example
+        -------
+
+        >>> import streamlit.components.v1 as components
+        >>>
+        >>> components.iframe("https://example.com", height=500)
+
+        """
+        iframe_proto = IFrameProto()
+        marshall(
+            iframe_proto,
+            src=src,
+            width=width,
+            height=height,
+            scrolling=scrolling,
+        )
+        return self.dg._enqueue("iframe", iframe_proto)
+
+    @gather_metrics("_html")
+    def _html(
+        self,
+        html: str,
+        width: int | None = None,
+        height: int | None = None,
+        scrolling: bool = False,
+    ) -> DeltaGenerator:
+        """Display an HTML string in an iframe.
+
+        To use this function, import it from the ``streamlit.components.v1``
+        module.
+
+        If you want to insert HTML text into your app without an iframe, try
+        ``st.html`` instead.
+
+        .. warning::
+            Using ``st.components.v1.html`` directly (instead of importing
+            its module) is deprecated and will be disallowed in a later version.
+
+        Parameters
+        ----------
+        html : str
+            The HTML string to embed in the iframe.
+
+        width : int
+            The width of the iframe in CSS pixels. By default, this is the
+            app's default element width.
+
+        height : int
+            The height of the frame in CSS pixels. By default, this is ``150``.
+
+        scrolling : bool
+            Whether to allow scrolling in the iframe. If this ``False``
+            (default), Streamlit crops any content larger than the iframe and
+            does not show a scrollbar. If this is ``True``, Streamlit shows a
+            scrollbar when the content is larger than the iframe.
+
+        Example
+        -------
+
+        >>> import streamlit.components.v1 as components
+        >>>
+        >>> components.html(
+        >>>     "<p><span style='text-decoration: line-through double red;'>Oops</span>!</p>"
+        >>> )
+
+        """
+        iframe_proto = IFrameProto()
+        marshall(
+            iframe_proto,
+            srcdoc=html,
+            width=width,
+            height=height,
+            scrolling=scrolling,
+        )
+        return self.dg._enqueue("iframe", iframe_proto)
+
+    @property
+    def dg(self) -> DeltaGenerator:
+        """Get our DeltaGenerator."""
+        return cast("DeltaGenerator", self)
+
+
+def marshall(
+    proto: IFrameProto,
+    src: str | None = None,
+    srcdoc: str | None = None,
+    width: int | None = None,
+    height: int | None = None,
+    scrolling: bool = False,
+) -> None:
+    """Marshalls data into an IFrame proto.
+
+    These parameters correspond directly to <iframe> attributes, which are
+    described in more detail at
+    https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe.
+
+    Parameters
+    ----------
+    proto : IFrame protobuf
+        The protobuf object to marshall data into.
+    src : str
+        The URL of the page to embed.
+    srcdoc : str
+        Inline HTML to embed. Overrides src.
+    width : int
+        The width of the frame in CSS pixels. Defaults to the app's
+        default element width.
+    height : int
+        The height of the frame in CSS pixels. Defaults to 150.
+    scrolling : bool
+        If true, show a scrollbar when the content is larger than the iframe.
+        Otherwise, never show a scrollbar.
+
+    """
+    if src is not None:
+        proto.src = src
+
+    if srcdoc is not None:
+        proto.srcdoc = srcdoc
+
+    if width is not None:
+        proto.width = width
+        proto.has_width = True
+
+    if height is not None:
+        proto.height = height
+    else:
+        proto.height = 150
+
+    proto.scrolling = scrolling

streamlit/elements/image.py

@@ -0,0 +1,196 @@
+# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
+#
+# 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.
+
+# Some casts in this file are only occasionally necessary depending on the
+# user's Python version, and mypy doesn't have a good way of toggling this
+# specific config option at a per-line level.
+# mypy: no-warn-unused-ignores
+
+"""Image marshalling."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Literal, Union, cast
+
+from typing_extensions import TypeAlias
+
+from streamlit.deprecation_util import show_deprecation_warning
+from streamlit.elements.lib.image_utils import (
+    Channels,
+    ImageFormatOrAuto,
+    ImageOrImageList,
+    WidthBehavior,
+    marshall_images,
+)
+from streamlit.errors import StreamlitAPIException
+from streamlit.proto.Image_pb2 import ImageList as ImageListProto
+from streamlit.runtime.metrics_util import gather_metrics
+
+if TYPE_CHECKING:
+    from streamlit.delta_generator import DeltaGenerator
+
+UseColumnWith: TypeAlias = Union[Literal["auto", "always", "never"], bool, None]
+
+
+class ImageMixin:
+    @gather_metrics("image")
+    def image(
+        self,
+        image: ImageOrImageList,
+        # TODO: Narrow type of caption, dependent on type of image,
+        #  by way of overload
+        caption: str | list[str] | None = None,
+        width: int | None = None,
+        use_column_width: UseColumnWith = None,
+        clamp: bool = False,
+        channels: Channels = "RGB",
+        output_format: ImageFormatOrAuto = "auto",
+        *,
+        use_container_width: bool = False,
+    ) -> DeltaGenerator:
+        """Display an image or list of images.
+
+        Parameters
+        ----------
+        image : numpy.ndarray, BytesIO, str, Path, or list of these
+            The image to display. This can be one of the following:
+
+            - A URL (string) for a hosted image.
+            - A path to a local image file. The path can be a ``str``
+              or ``Path`` object. Paths can be absolute or relative to the
+              working directory (where you execute ``streamlit run``).
+            - An SVG string like ``<svg xmlns=...</svg>``.
+            - A byte array defining an image. This includes monochrome images of
+              shape (w,h) or (w,h,1), color images of shape (w,h,3), or RGBA
+              images of shape (w,h,4), where w and h are the image width and
+              height, respectively.
+            - A list of any of the above. Streamlit displays the list as a
+              row of images that overflow to additional rows as needed.
+        caption : str or list of str
+            Image caption(s). If this is ``None`` (default), no caption is
+            displayed. If ``image`` is a list of multiple images, ``caption``
+            must be a list of captions (one caption for each image) or
+            ``None``.
+
+            Captions can optionally contain GitHub-flavored Markdown. Syntax
+            information can be found at: https://github.github.com/gfm.
+
+            See the ``body`` parameter of |st.markdown|_ for additional,
+            supported Markdown directives.
+
+            .. |st.markdown| replace:: ``st.markdown``
+            .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown
+        width : int or None
+            Image width. If this is ``None`` (default), Streamlit will use the
+            image's native width, up to the width of the parent container.
+            When using an SVG image without a default width, you should declare
+            ``width`` or use ``use_container_width=True``.
+        use_column_width : "auto", "always", "never", or bool
+            If "auto", set the image's width to its natural size,
+            but do not exceed the width of the column.
+            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.
+        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
+            ignored for image URLs and files. If this is ``False`` (default)
+            and an image has an out-of-range value, a ``RuntimeError`` will be
+            raised.
+        channels : "RGB" or "BGR"
+            The color format when ``image`` is an ``nd.array``. This is ignored
+            for other image types. If this is ``"RGB"`` (default),
+            ``image[:, :, 0]`` is the red channel, ``image[:, :, 1]`` is the
+            green channel, and ``image[:, :, 2]`` is the blue channel. For
+            images coming from libraries like OpenCV, you should set this to
+            ``"BGR"`` instead.
+        output_format : "JPEG", "PNG", or "auto"
+            The output format to use when transferring the image data. If this
+            is ``"auto"`` (default), Streamlit identifies the compression type
+            based on the type and format of the image. Photos should use the
+            ``"JPEG"`` format for lossy compression while diagrams should use
+            the ``"PNG"`` format for lossless compression.
+
+        use_container_width : bool
+            Whether to override ``width`` with the width of the parent
+            container. If ``use_container_width`` is ``False`` (default),
+            Streamlit sets the image's width according to ``width``. If
+            ``use_container_width`` is ``True``, Streamlit sets the width of
+            the image to match the width of the parent container.
+
+        .. deprecated::
+            ``use_column_width`` is deprecated and will be removed in a future
+            release. Please use the ``use_container_width`` parameter instead.
+
+        Example
+        -------
+        >>> import streamlit as st
+        >>> st.image("sunrise.jpg", caption="Sunrise by the mountains")
+
+        .. output::
+           https://doc-image.streamlit.app/
+           height: 710px
+
+        """
+
+        if use_container_width is True and use_column_width is not None:
+            raise StreamlitAPIException(
+                "`use_container_width` and `use_column_width` cannot be set at the same time.",
+                "Please utilize `use_container_width` since `use_column_width` is deprecated.",
+            )
+
+        image_width: int = (
+            WidthBehavior.ORIGINAL if (width is None or width <= 0) else width
+        )
+
+        if use_column_width is not None:
+            show_deprecation_warning(
+                "The `use_column_width` parameter has been deprecated and will be removed "
+                "in a future release. Please utilize the `use_container_width` parameter instead."
+            )
+
+            if use_column_width == "auto":
+                image_width = WidthBehavior.AUTO
+            elif use_column_width == "always" or use_column_width is True:
+                image_width = WidthBehavior.COLUMN
+            elif use_column_width == "never" or use_column_width is False:
+                image_width = WidthBehavior.ORIGINAL
+
+        else:
+            if use_container_width is True:
+                image_width = WidthBehavior.MAX_IMAGE_OR_CONTAINER
+            elif image_width is not None and image_width > 0:
+                # Use the given width. It will be capped on the frontend if it
+                # exceeds the container width.
+                pass
+            elif use_container_width is False:
+                image_width = WidthBehavior.MIN_IMAGE_OR_CONTAINER
+
+        image_list_proto = ImageListProto()
+        marshall_images(
+            self.dg._get_delta_path_str(),
+            image,
+            caption,
+            image_width,
+            image_list_proto,
+            clamp,
+            channels,
+            output_format,
+        )
+        return self.dg._enqueue("imgs", image_list_proto)
+
+    @property
+    def dg(self) -> DeltaGenerator:
+        """Get our DeltaGenerator."""
+        return cast("DeltaGenerator", self)

streamlit/elements/json.py

@@ -0,0 +1,139 @@
+# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
+#
+# 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
+
+import json
+import types
+from collections import ChainMap, UserDict
+from typing import TYPE_CHECKING, Any, cast
+
+from streamlit.proto.Json_pb2 import Json as JsonProto
+from streamlit.runtime.metrics_util import gather_metrics
+from streamlit.type_util import (
+    is_custom_dict,
+    is_list_like,
+    is_namedtuple,
+    is_pydantic_model,
+)
+
+if TYPE_CHECKING:
+    from streamlit.delta_generator import DeltaGenerator
+
+
+def _ensure_serialization(o: object) -> str | list[Any]:
+    """A repr function for json.dumps default arg, which tries to serialize sets
+    as lists."""
+    return list(o) if isinstance(o, set) else repr(o)
+
+
+class JsonMixin:
+    @gather_metrics("json")
+    def json(
+        self,
+        body: object,
+        *,  # keyword-only arguments:
+        expanded: bool | int = True,
+    ) -> DeltaGenerator:
+        """Display an object or string as a pretty-printed, interactive JSON string.
+
+        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
+            contains serialized JSON.
+
+        expanded : bool or int
+            The initial expansion state of the JSON element. This can be one
+            of the following:
+
+            - ``True`` (default): The element is fully expanded.
+            - ``False``: The element is fully collapsed.
+            - An integer: The element is expanded to the depth specified. The
+              integer must be non-negative. ``expanded=0`` is equivalent to
+              ``expanded=False``.
+
+            Regardless of the initial expansion state, users can collapse or
+            expand any key-value pair to show or hide any part of the object.
+
+        Example
+        -------
+        >>> import streamlit as st
+        >>>
+        >>> st.json(
+        ...     {
+        ...         "foo": "bar",
+        ...         "stuff": [
+        ...             "stuff 1",
+        ...             "stuff 2",
+        ...             "stuff 3",
+        ...         ],
+        ...         "level1": {"level2": {"level3": {"a": "b"}}},
+        ...     },
+        ...     expanded=2,
+        ... )
+
+        .. output::
+           https://doc-json.streamlit.app/
+           height: 385px
+
+        """
+
+        if is_custom_dict(body):
+            body = body.to_dict()
+
+        if is_namedtuple(body):
+            body = body._asdict()
+
+        if isinstance(
+            body, (ChainMap, types.MappingProxyType, UserDict)
+        ) or is_pydantic_model(body):
+            body = dict(body)  # type: ignore
+
+        if is_list_like(body):
+            body = list(body)
+
+        if not isinstance(body, str):
+            try:
+                # Serialize body to string and try to interpret sets as lists
+                body = json.dumps(body, default=_ensure_serialization)
+            except TypeError as err:
+                self.dg.warning(
+                    "Warning: this data structure was not fully serializable as "
+                    f"JSON due to one or more unexpected keys.  (Error was: {err})"
+                )
+                body = json.dumps(body, skipkeys=True, default=_ensure_serialization)
+
+        json_proto = JsonProto()
+        json_proto.body = body
+
+        if isinstance(expanded, bool):
+            json_proto.expanded = expanded
+        elif isinstance(expanded, int):
+            json_proto.expanded = True
+            json_proto.max_expand_depth = expanded
+        else:
+            raise TypeError(
+                f"The type {str(type(expanded))} of `expanded` is not supported"
+                ", must be bool or int."
+            )
+
+        return self.dg._enqueue("json", json_proto)
+
+    @property
+    def dg(self) -> DeltaGenerator:
+        """Get our DeltaGenerator."""
+        return cast("DeltaGenerator", self)