streamlit-nightly 1.39.1.dev20241031__tar.gz → 1.39.1.dev20241102__tar.gz

{streamlit_nightly-1.39.1.dev20241031 → streamlit_nightly-1.39.1.dev20241102}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: streamlit-nightly
-Version: 1.39.1.dev20241031
+Version: 1.39.1.dev20241102
 Summary: A faster way to build and share data apps
 Home-page: https://streamlit.io
 Author: Snowflake Inc

{streamlit_nightly-1.39.1.dev20241031 → streamlit_nightly-1.39.1.dev20241102}/setup.py

@@ -21,7 +21,7 @@ from setuptools.command.install import install
 
 THIS_DIRECTORY = Path(__file__).parent
 
-VERSION = "1.39.1.dev20241031"  # PEP-440
+VERSION = "1.39.1.dev20241102"  # PEP-440
 
 # IMPORTANT: We should try very hard *not* to add dependencies to Streamlit.
 # And if you do add one, make the required version as general as possible:

{streamlit_nightly-1.39.1.dev20241031 → streamlit_nightly-1.39.1.dev20241102}/streamlit/commands/execution_control.py

@@ -16,6 +16,7 @@ from __future__ import annotations
 
 import os
 from itertools import dropwhile
+from pathlib import Path
 from typing import Literal, NoReturn
 
 import streamlit as st
@@ -146,7 +147,7 @@ def rerun(  # type: ignore[misc]
 
 
 @gather_metrics("switch_page")
-def switch_page(page: str | StreamlitPage) -> NoReturn:  # type: ignore[misc]
+def switch_page(page: str | Path | StreamlitPage) -> NoReturn:  # type: ignore[misc]
     """Programmatically switch the current page in a multipage app.
 
     When ``st.switch_page`` is called, the current page execution stops and
@@ -157,7 +158,7 @@ def switch_page(page: str | StreamlitPage) -> NoReturn:  # type: ignore[misc]
 
     Parameters
     ----------
-    page: str or st.Page
+    page: str, Path, or st.Page
         The file path (relative to the main script) or an st.Page indicating
         the page to switch to.
 
@@ -197,6 +198,10 @@ def switch_page(page: str | StreamlitPage) -> NoReturn:  # type: ignore[misc]
     if isinstance(page, StreamlitPage):
         page_script_hash = page._script_hash
     else:
+        # Convert Path to string if necessary
+        if isinstance(page, Path):
+            page = str(page)
+
         main_script_directory = get_main_script_directory(ctx.main_script_path)
         requested_page = os.path.realpath(
             normalize_path_join(main_script_directory, page)

{streamlit_nightly-1.39.1.dev20241031 → streamlit_nightly-1.39.1.dev20241102}/streamlit/commands/logo.py

@@ -19,7 +19,7 @@ from __future__ import annotations
 from typing import Literal
 
 from streamlit import url_util
-from streamlit.elements.image import AtomicImage, WidthBehaviour, image_to_url
+from streamlit.elements.lib.image_utils import AtomicImage, WidthBehavior, image_to_url
 from streamlit.errors import StreamlitAPIException
 from streamlit.proto.ForwardMsg_pb2 import ForwardMsg
 from streamlit.runtime.metrics_util import gather_metrics
@@ -132,7 +132,7 @@ def logo(
     try:
         image_url = image_to_url(
             image,
-            width=WidthBehaviour.AUTO,
+            width=WidthBehavior.AUTO,
             clamp=False,
             channels="RGB",
             output_format="auto",
@@ -155,7 +155,7 @@ def logo(
         try:
             icon_image_url = image_to_url(
                 icon_image,
-                width=WidthBehaviour.AUTO,
+                width=WidthBehavior.AUTO,
                 clamp=False,
                 channels="RGB",
                 output_format="auto",

{streamlit_nightly-1.39.1.dev20241031 → streamlit_nightly-1.39.1.dev20241102}/streamlit/commands/navigation.py

@@ -126,15 +126,47 @@ def navigation(
     you pass to ``streamlit run``. Your entrypoint file manages your app's
     navigation and serves as a router between pages.
 
+    **Example 1: Use a callable or Python file as a page**
+
     You can declare pages from callables or file paths.
 
+    ``page_1.py`` (in the same directory as your entrypoint file):
+
+    >>> import streamlit as st
+    >>>
+    >>> st.title("Page 1")
+
+    Your entrypoint file:
+
     >>> import streamlit as st
-    >>> from page_functions import page1
     >>>
-    >>> pg = st.navigation([st.Page(page1), st.Page("page2.py")])
+    >>> def page_2():
+    ...     st.title("Page 2")
+    >>>
+    >>> pg = st.navigation([st.Page("page_1.py"), st.Page(page_2)])
     >>> pg.run()
 
-    Use a dictionary to create sections within your navigation menu.
+    .. output::
+        https://doc-navigation-example-1.streamlit.app/
+        height: 200px
+
+    **Example 2: Group pages into sections**
+
+    You can use a dictionary to create sections within your navigation menu. In
+    the following example, each page is similar to Page 1 in Example 1, and all
+    pages are in the same directory. However, you can use Python files from
+    anywhere in your repository. For more information, see |st.Page|_.
+
+    Directory structure:
+
+    >>> your_repository/
+    >>> ├── create_account.py
+    >>> ├── learn.py
+    >>> ├── manage_account.py
+    >>> ├── streamlit_app.py
+    >>> └── trial.py
+
+    ``streamlit_app.py``:
 
     >>> import streamlit as st
     >>>
@@ -152,6 +184,12 @@ def navigation(
     >>> pg = st.navigation(pages)
     >>> pg.run()
 
+    .. output::
+        https://doc-navigation-example-2.streamlit.app/
+        height: 300px
+
+    **Example 3: Stateful widgets across multiple pages**
+
     Call widget functions in your entrypoint file when you want a widget to be
     stateful across pages. Assign keys to your common widgets and access their
     values through Session State within your pages.
@@ -171,6 +209,13 @@ def navigation(
     >>> pg = st.navigation([st.Page(page1), st.Page(page2)])
     >>> pg.run()
 
+    .. output::
+        https://doc-navigation-multipage-widgets.streamlit.app/
+        height: 350px
+
+    .. |st.Page| replace:: ``st.Page``
+    .. _st.Page: https://docs.streamlit.io/develop/api-reference/navigation/st.page
+
     """
     nav_sections = {"": pages} if isinstance(pages, list) else pages
     page_list = pages_from_nav_sections(nav_sections)

{streamlit_nightly-1.39.1.dev20241031 → streamlit_nightly-1.39.1.dev20241102}/streamlit/commands/page_config.py

@@ -15,12 +15,13 @@
 from __future__ import annotations
 
 import random
+from pathlib import Path
 from textwrap import dedent
 from typing import TYPE_CHECKING, Any, Final, Literal, Mapping, Union, cast
 
 from typing_extensions import TypeAlias
 
-from streamlit.elements import image
+from streamlit.elements.lib.image_utils import AtomicImage, image_to_url
 from streamlit.errors import (
     StreamlitInvalidMenuItemKeyError,
     StreamlitInvalidPageLayoutError,
@@ -41,7 +42,7 @@ GET_HELP_KEY: Final = "get help"
 REPORT_A_BUG_KEY: Final = "report a bug"
 ABOUT_KEY: Final = "about"
 
-PageIcon: TypeAlias = Union[image.AtomicImage, str]
+PageIcon: TypeAlias = Union[AtomicImage, str]
 Layout: TypeAlias = Literal["centered", "wide"]
 InitialSideBarState: TypeAlias = Literal["auto", "expanded", "collapsed"]
 _GetHelp: TypeAlias = Literal["Get help", "Get Help", "get help"]
@@ -105,9 +106,13 @@ def _get_favicon_string(page_icon: PageIcon) -> str:
     if isinstance(page_icon, str) and page_icon.startswith(":material"):
         return validate_material_icon(page_icon)
 
+    # Convert Path to string if necessary
+    if isinstance(page_icon, Path):
+        page_icon = str(page_icon)
+
     # Fall back to image_to_url.
     try:
-        return image.image_to_url(
+        return image_to_url(
             page_icon,
             width=-1,  # Always use full width for favicons
             clamp=False,

{streamlit_nightly-1.39.1.dev20241031 → streamlit_nightly-1.39.1.dev20241102}/streamlit/elements/html.py

@@ -15,6 +15,7 @@
 from __future__ import annotations
 
 import os
+from pathlib import Path
 from typing import TYPE_CHECKING, cast
 
 from streamlit.proto.Html_pb2 import Html as HtmlProto
@@ -29,7 +30,7 @@ class HtmlMixin:
     @gather_metrics("html")
     def html(
         self,
-        body: str,
+        body: str | Path,
     ) -> DeltaGenerator:
         """Insert HTML into your app.
 
@@ -45,7 +46,7 @@ class HtmlMixin:
 
         Parameters
         ----------
-        body : str
+        body : str, Path
             The HTML code to insert, or path to an HTML code file which is
             loaded and inserted.
 
@@ -67,8 +68,9 @@ class HtmlMixin:
 
         """
         html_proto = HtmlProto()
-        # Check if the body is a file path
-        if os.path.isfile(body):
+
+        # Check if the body is a file path. If it's a Path object, open it directly.
+        if os.path.isfile(body) or isinstance(body, Path):
             with open(body, encoding="utf-8") as f:
                 html_proto.body = f.read()
         else:

streamlit_nightly-1.39.1.dev20241102/streamlit/elements/image.py

@@ -0,0 +1,176 @@
+# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2024)
+#
+# 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, [numpy.ndarray], BytesIO, str, [str], Path, or [Path]
+            Monochrome image of shape (w,h) or (w,h,1)
+            OR a color image of shape (w,h,3)
+            OR an RGBA image of shape (w,h,4)
+            OR a URL to fetch the image from
+            OR a path of a local image file (str or Path object)
+            OR an SVG XML string like `<svg xmlns=...</svg>`
+            OR a list of one of the above, to display multiple images.
+        caption : str or list of str
+            Image caption. If displaying multiple images, caption should be a
+            list of captions (one for each image).
+        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
+            Clamp image pixel values to a valid range ([0-255] per channel).
+            This is only meaningful for byte array images; the parameter is
+            ignored for image URLs. If this is not set, and an image has an
+            out-of-range value, an error will be thrown.
+        channels : "RGB" or "BGR"
+            If image is an nd.array, this parameter denotes the format used to
+            represent color information. Defaults to "RGB", meaning
+            `image[:, :, 0]` is the red channel, `image[:, :, 1]` is green, and
+            `image[:, :, 2]` is blue. For images coming from libraries like
+            OpenCV you should set this to "BGR", instead.
+        output_format : "JPEG", "PNG", or "auto"
+            This parameter specifies the format to use when transferring the
+            image data. Photos should use the JPEG format for lossy compression
+            while diagrams should use the PNG format for lossless compression.
+            Defaults to "auto" which identifies the compression type based
+            on the type and format of the image argument.
+        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_nightly-1.39.1.dev20241031 → streamlit_nightly-1.39.1.dev20241102}/streamlit/elements/layouts.py

@@ -369,7 +369,9 @@ class LayoutsMixin:
             Creates a tab for each string in the list. The first tab is selected
             by default. The string is used as the name of the tab and can
             optionally contain GitHub-flavored Markdown of the following types:
-            Bold, Italics, Strikethroughs, Inline Code, and Links.
+            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
@@ -476,7 +478,8 @@ class LayoutsMixin:
         label : str
             A string to use as the header for the expander. The label can optionally
             contain GitHub-flavored Markdown of the following types: Bold, Italics,
-            Strikethroughs, Inline Code, and Links.
+            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
@@ -595,8 +598,9 @@ class LayoutsMixin:
         label : str
             The label of the button that opens the popover container.
             The label can optionally contain GitHub-flavored Markdown of the
-            following types: Bold, Italics, Strikethroughs, Inline Code, and
-            Links.
+            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
@@ -631,8 +635,8 @@ class LayoutsMixin:
               font library.
 
         disabled : bool
-            An optional boolean, which disables the popover button if set to
-            True. The default is False.
+            An optional boolean that disables the popover button if set to
+            ``True``. The default is ``False``.
 
         use_container_width : bool
             Whether to expand the button's width to fill its parent container.
@@ -729,7 +733,8 @@ class LayoutsMixin:
         label : str
             The initial label of the status container. The label can optionally
             contain GitHub-flavored Markdown of the following types: Bold, Italics,
-            Strikethroughs, Inline Code, and Links.
+            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