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

streamlit/elements/html.py

@@ -0,0 +1,189 @@
+# 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
+
+import os
+import re
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, cast
+
+from streamlit.delta_generator_singletons import get_dg_singleton_instance
+from streamlit.elements.lib.layout_utils import (
+    LayoutConfig,
+    Width,
+    validate_width,
+)
+from streamlit.errors import StreamlitAPIException
+from streamlit.proto.Html_pb2 import Html as HtmlProto
+from streamlit.runtime.metrics_util import gather_metrics
+from streamlit.string_util import clean_text
+from streamlit.type_util import SupportsReprHtml, SupportsStr, has_callable_attr
+
+if TYPE_CHECKING:
+    from streamlit.delta_generator import DeltaGenerator
+
+
+class HtmlMixin:
+    @gather_metrics("html")
+    def html(
+        self,
+        body: str | Path | SupportsStr | SupportsReprHtml,
+        *,  # keyword-only arguments:
+        width: Width = "stretch",
+        unsafe_allow_javascript: bool = False,
+    ) -> DeltaGenerator:
+        """Insert HTML into your app.
+
+        Adding custom HTML to your app impacts safety, styling, and
+        maintainability. We sanitize HTML with `DOMPurify
+        <https://github.com/cure53/DOMPurify>`_, but inserting HTML remains a
+        developer risk. Passing untrusted code to ``st.html`` or dynamically
+        loading external code can increase the risk of vulnerabilities in your
+        app.
+
+        ``st.html`` content is **not** iframed. By default, JavaScript is
+        ignored. To execute JavaScript contained in your HTML, set
+        ``unsafe_allow_javascript=True``. Use this with caution and never pass
+        untrusted input.
+
+        Parameters
+        ----------
+        body : any
+            The HTML code to insert. This can be one of the following:
+
+            - A string of HTML code.
+            - A path to a local file with HTML code. The path can be a ``str``
+              or ``Path`` object. Paths can be absolute or relative to the
+              working directory (where you execute ``streamlit run``).
+            - Any object. If ``body`` is not a string or path, Streamlit will
+              convert the object to a string. ``body._repr_html_()`` takes
+              precedence over ``str(body)`` when available.
+
+            If the resulting HTML content is empty, Streamlit will raise an
+            error.
+
+            If ``body`` is a path to a CSS file, Streamlit will wrap the CSS
+            content in ``<style>`` tags automatically. When the resulting HTML
+            content only contains style tags, Streamlit will send the content
+            to the event container instead of the main container to avoid
+            taking up space in the app.
+
+        width : "stretch", "content", or int
+            The width of the HTML element. This can be one of the following:
+
+            - ``"stretch"`` (default): The width of the element matches the
+              width of the parent container.
+            - ``"content"``: The width of the element matches the width of its
+              content, but doesn't exceed the width of the parent container.
+            - An integer specifying the width in pixels: The element has a
+              fixed width. If the specified width is greater than the width of
+              the parent container, the width of the element matches the width
+              of the parent container.
+
+        unsafe_allow_javascript : bool
+            Whether to execute JavaScript contained in your HTML. If this is
+            ``False`` (default), JavaScript is ignored. If this is ``True``,
+            JavaScript is executed. Use this with caution and never pass
+            untrusted input.
+
+        Example
+        -------
+        >>> import streamlit as st
+        >>>
+        >>> st.html(
+        ...     "<p><span style='text-decoration: line-through double red;'>Oops</span>!</p>"
+        ... )
+
+        .. output::
+           https://doc-html.streamlit.app/
+           height: 300px
+
+        """
+        html_proto = HtmlProto()
+
+        # If body supports _repr_html_, use that.
+        if has_callable_attr(body, "_repr_html_"):
+            html_content = cast("SupportsReprHtml", body)._repr_html_()
+
+        # Check if the body is a file path. May include filesystem lookup.
+        elif isinstance(body, Path) or _is_file(body):
+            file_path = str(body)
+            with open(file_path, encoding="utf-8") as f:
+                html_content = f.read()
+
+            # If it's a CSS file, wrap the content in style tags
+            if Path(file_path).suffix.lower() == ".css":
+                html_content = f"<style>{html_content}</style>"
+
+        # OK, let's just try converting to string and hope for the best.
+        else:
+            html_content = clean_text(cast("SupportsStr", body))
+
+        # Raise an error if the body is empty
+        if html_content == "":
+            raise StreamlitAPIException("`st.html` body cannot be empty")
+
+        validate_width(width, allow_content=True)
+        layout_config = LayoutConfig(width=width)
+
+        # Handle the case where there are only style tags - issue #9388
+        # Use event container for style tags so they don't take up space in the app content
+        if _html_only_style_tags(html_content):
+            # If true, there are only style tags - send html to the event container
+            html_proto.body = html_content
+            return self._event_dg._enqueue("html", html_proto)
+        # Otherwise, send the html to the main container as normal
+        # Only set the unsafe JS flag for non-style-only HTML content
+        html_proto.unsafe_allow_javascript = unsafe_allow_javascript
+        html_proto.body = html_content
+        return self.dg._enqueue("html", html_proto, layout_config=layout_config)
+
+    @property
+    def dg(self) -> DeltaGenerator:
+        """Get our DeltaGenerator."""
+        return cast("DeltaGenerator", self)
+
+    @property
+    def _event_dg(self) -> DeltaGenerator:
+        """Get the event delta generator."""
+        return get_dg_singleton_instance().event_dg
+
+
+def _html_only_style_tags(html_content: str) -> bool:
+    """Check if the HTML content is only style tags."""
+    # Pattern to match HTML comments
+    comment_pattern = r"<!--.*?-->"
+    # Pattern to match style tags and their contents (case-insensitive)
+    style_pattern = r"<style[^>]*>.*?</style>"
+
+    # Remove style tags and comments
+    html_without_comments = re.sub(comment_pattern, "", html_content, flags=re.DOTALL)
+    html_without_styles_and_comments = re.sub(
+        style_pattern, "", html_without_comments, flags=re.DOTALL | re.IGNORECASE
+    )
+
+    # Return whether html content is empty after removing style tags and comments
+    return html_without_styles_and_comments.strip() == ""
+
+
+def _is_file(obj: Any) -> bool:
+    """Checks if obj is a file, and doesn't throw if not.
+
+    The "not throwing" part is important!
+    """
+    try:
+        return os.path.isfile(obj)
+    except TypeError:
+        return False

streamlit/elements/iframe.py

@@ -0,0 +1,245 @@
+# 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 typing import TYPE_CHECKING, cast
+
+from streamlit.elements.lib.layout_utils import LayoutConfig
+from streamlit.errors import StreamlitAPIException
+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,
+        *,
+        tab_index: int | None = None,
+    ) -> 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.
+
+        tab_index : int or None
+            Specifies how and if the iframe is sequentially focusable.
+            Users typically use the ``Tab`` key for sequential focus
+            navigation.
+
+            This can be one of the following values:
+
+            - ``None`` (default): Uses the browser's default behavior.
+            - ``-1``: Removes the iframe from sequential navigation, but still
+              allows it to be focused programmatically.
+            - ``0``: Includes the iframe in sequential navigation in the order
+              it appears in the document but after all elements with a positive
+              ``tab_index``.
+            - Positive integer: Includes the iframe in sequential navigation.
+              Elements are navigated in ascending order of their positive
+              ``tab_index``.
+
+            For more information, see the `tabindex
+            <https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex>`_
+            documentation on MDN.
+
+        Example
+        -------
+
+        >>> import streamlit.components.v1 as components
+        >>>
+        >>> components.iframe("https://example.com", height=500)
+
+        """
+        iframe_proto = IFrameProto()
+        marshall(
+            iframe_proto,
+            src=src,
+            scrolling=scrolling,
+            tab_index=tab_index,
+        )
+        layout_config = LayoutConfig(
+            width=width if width is not None else "stretch",
+            height=height if height is not None else 150,
+        )
+        return self.dg._enqueue("iframe", iframe_proto, layout_config=layout_config)
+
+    @gather_metrics("_html")
+    def _html(
+        self,
+        html: str,
+        width: int | None = None,
+        height: int | None = None,
+        scrolling: bool = False,
+        *,
+        tab_index: int | None = None,
+    ) -> 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.
+
+        tab_index : int or None
+            Specifies how and if the iframe is sequentially focusable.
+            Users typically use the ``Tab`` key for sequential focus
+            navigation.
+
+            This can be one of the following values:
+
+            - ``None`` (default): Uses the browser's default behavior.
+            - ``-1``: Removes the iframe from sequential navigation, but still
+              allows it to be focused programmatically.
+            - ``0``: Includes the iframe in sequential navigation in the order
+              it appears in the document but after all elements with a positive
+              ``tab_index``.
+            - Positive integer: Includes the iframe in sequential navigation.
+              Elements are navigated in ascending order of their positive
+              ``tab_index``.
+
+            For more information, see the `tabindex
+            <https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex>`_
+            documentation on MDN.
+
+        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,
+            scrolling=scrolling,
+            tab_index=tab_index,
+        )
+        layout_config = LayoutConfig(
+            width=width if width is not None else "stretch",
+            height=height if height is not None else 150,
+        )
+        return self.dg._enqueue("iframe", iframe_proto, layout_config=layout_config)
+
+    @property
+    def dg(self) -> DeltaGenerator:
+        """Get our DeltaGenerator."""
+        return cast("DeltaGenerator", self)
+
+
+def marshall(
+    proto: IFrameProto,
+    src: str | None = None,
+    srcdoc: str | None = None,
+    scrolling: bool = False,
+    tab_index: int | None = None,
+) -> 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.
+    scrolling : bool
+        If true, show a scrollbar when the content is larger than the iframe.
+        Otherwise, never show a scrollbar.
+    tab_index : int, optional
+        Specifies the tab order of the iframe.
+
+    """
+    if src is not None:
+        proto.src = src
+
+    if srcdoc is not None:
+        proto.srcdoc = srcdoc
+
+    proto.scrolling = scrolling
+
+    if tab_index is not None:
+        # Validate tab_index according to web specifications
+        if not (
+            isinstance(tab_index, int)
+            and not isinstance(tab_index, bool)
+            and tab_index >= -1
+        ):
+            raise StreamlitAPIException(
+                "tab_index must be None, -1, or a non-negative integer."
+            )
+
+        proto.tab_index = tab_index

streamlit/elements/image.py

@@ -0,0 +1,221 @@
+# 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.
+
+# 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, TypeAlias, cast
+
+from streamlit.deprecation_util import (
+    make_deprecated_name_warning,
+    show_deprecation_warning,
+)
+from streamlit.elements.lib.image_utils import (
+    Channels,
+    ImageFormatOrAuto,
+    ImageOrImageList,
+    marshall_images,
+)
+from streamlit.elements.lib.layout_utils import LayoutConfig, Width, validate_width
+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 = 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: Width = "content",
+        use_column_width: UseColumnWith = None,
+        clamp: bool = False,
+        channels: Channels = "RGB",
+        output_format: ImageFormatOrAuto = "auto",
+        *,
+        use_container_width: bool | None = None,
+    ) -> 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 : "content", "stretch", or int
+            The width of the image element. This can be one of the following:
+
+            - ``"content"`` (default): The width of the element matches the
+              width of its content, but doesn't exceed the width of the parent
+              container.
+            - ``"stretch"``: The width of the element matches the width of the
+              parent container.
+            - An integer specifying the width in pixels: The element has a
+              fixed width. If the specified width is greater than the width of
+              the parent container, the width of the element matches the width
+              of the parent container.
+
+            When using an SVG image without a default width, use ``"stretch"``
+            or an integer.
+        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.
+
+            .. 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
+            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_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
+        -------
+        >>> import streamlit as st
+        >>> st.image("sunrise.jpg", caption="Sunrise by the mountains")
+
+        .. output::
+           https://doc-image.streamlit.app/
+           height: 710px
+
+        """
+
+        if use_column_width is not None:
+            if use_container_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.",
+                )
+
+            show_deprecation_warning(
+                "The `use_column_width` parameter has been deprecated and will be removed "
+                "in a future release. Please utilize the `width` parameter instead."
+            )
+            if use_column_width in {"auto", "never"} or use_column_width is False:
+                width = "content"
+            elif use_column_width == "always" or use_column_width is True:
+                width = "stretch"
+
+        if use_container_width is not None:
+            show_deprecation_warning(
+                make_deprecated_name_warning(
+                    "use_container_width",
+                    "width",
+                    "2025-12-31",
+                    "For `use_container_width=True`, use `width='stretch'`. "
+                    "For `use_container_width=False`, use `width='content'`.",
+                    include_st_prefix=False,
+                ),
+                show_in_browser=False,
+            )
+            if use_container_width is True:
+                width = "stretch"
+            elif isinstance(width, int):
+                # Preserve the existing behavior with respect to use_container_width=False
+                # and width=int.
+                pass
+            else:
+                width = "content"
+
+        validate_width(width, allow_content=True)
+        layout_config = LayoutConfig(width=width)
+
+        image_list_proto = ImageListProto()
+        marshall_images(
+            self.dg._get_delta_path_str(),
+            image,
+            caption,
+            layout_config,
+            image_list_proto,
+            clamp,
+            channels,
+            output_format,
+        )
+        return self.dg._enqueue("imgs", image_list_proto, layout_config=layout_config)
+
+    @property
+    def dg(self) -> DeltaGenerator:
+        """Get our DeltaGenerator."""
+        return cast("DeltaGenerator", self)