321 lines
14 KiB
Python
321 lines
14 KiB
Python
# 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 random
|
|
from collections.abc import Mapping
|
|
from pathlib import Path
|
|
from textwrap import dedent
|
|
from typing import TYPE_CHECKING, Any, Final, Literal, Union, cast
|
|
|
|
from typing_extensions import TypeAlias
|
|
|
|
from streamlit.elements.lib.image_utils import AtomicImage, image_to_url
|
|
from streamlit.errors import (
|
|
StreamlitInvalidMenuItemKeyError,
|
|
StreamlitInvalidPageLayoutError,
|
|
StreamlitInvalidSidebarStateError,
|
|
StreamlitInvalidURLError,
|
|
)
|
|
from streamlit.proto.ForwardMsg_pb2 import ForwardMsg as ForwardProto
|
|
from streamlit.proto.PageConfig_pb2 import PageConfig as PageConfigProto
|
|
from streamlit.runtime.metrics_util import gather_metrics
|
|
from streamlit.runtime.scriptrunner_utils.script_run_context import get_script_run_ctx
|
|
from streamlit.string_util import is_emoji, validate_material_icon
|
|
from streamlit.url_util import is_url
|
|
|
|
if TYPE_CHECKING:
|
|
from typing_extensions import TypeGuard
|
|
|
|
GET_HELP_KEY: Final = "get help"
|
|
REPORT_A_BUG_KEY: Final = "report a bug"
|
|
ABOUT_KEY: Final = "about"
|
|
|
|
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"]
|
|
_ReportABug: TypeAlias = Literal["Report a bug", "report a bug"]
|
|
_About: TypeAlias = Literal["About", "about"]
|
|
MenuKey: TypeAlias = Literal[_GetHelp, _ReportABug, _About]
|
|
MenuItems: TypeAlias = Mapping[MenuKey, Union[str, None]]
|
|
|
|
RANDOM_EMOJIS: Final = list(
|
|
"🔥™🎉🚀🌌💣✨🌙🎆🎇💥🤩🤙🌛🤘⬆💡🤪🥂⚡💨🌠🎊🍿😛🔮🤟🌃🍃🍾💫▪🌴🎈🎬🌀🎄😝☔⛽🍂💃😎🍸🎨🥳☀😍🅱🌞😻🌟😜💦💅🦄😋😉👻🍁🤤👯🌻‼🌈👌🎃💛😚🔫🙌👽🍬🌅☁🍷👭☕🌚💁👅🥰🍜😌🎥🕺❕🧡☄💕🍻✅🌸🚬🤓🍹®☺💪😙☘🤠✊🤗🍵🤞😂💯😏📻🎂💗💜🌊❣🌝😘💆🤑🌿🦋😈⛄🚿😊🌹🥴😽💋😭🖤🙆👐⚪💟☃🙈🍭💻🥀🚗🤧🍝💎💓🤝💄💖🔞⁉⏰🕊🎧☠♥🌳🏾🙉⭐💊🍳🌎🙊💸❤🔪😆🌾✈📚💀🏠✌🏃🌵🚨💂🤫🤭😗😄🍒👏🙃🖖💞😅🎅🍄🆓👉💩🔊🤷⌚👸😇🚮💏👳🏽💘💿💉👠🎼🎶🎤👗❄🔐🎵🤒🍰👓🏄🌲🎮🙂📈🚙📍😵🗣❗🌺🙄👄🚘🥺🌍🏡♦💍🌱👑👙☑👾🍩🥶📣🏼🤣☯👵🍫➡🎀😃✋🍞🙇😹🙏👼🐝⚫🎁🍪🔨🌼👆👀😳🌏📖👃🎸👧💇🔒💙😞⛅🏻🍴😼🗿🍗♠🦁✔🤖☮🐢🐎💤😀🍺😁😴📺☹😲👍🎭💚🍆🍋🔵🏁🔴🔔🧐👰☎🏆🤡🐠📲🙋📌🐬✍🔑📱💰🐱💧🎓🍕👟🐣👫🍑😸🍦👁🆗🎯📢🚶🦅🐧💢🏀🚫💑🐟🌽🏊🍟💝💲🐍🍥🐸☝♣👊⚓❌🐯🏈📰🌧👿🐳💷🐺📞🆒🍀🤐🚲🍔👹🙍🌷🙎🐥💵🔝📸⚠❓🎩✂🍼😑⬇⚾🍎💔🐔⚽💭🏌🐷🍍✖🍇📝🍊🐙👋🤔🥊🗽🐑🐘🐰💐🐴♀🐦🍓✏👂🏴👇🆘😡🏉👩💌😺✝🐼🐒🐶👺🖕👬🍉🐻🐾⬅⏬▶👮🍌♂🔸👶🐮👪⛳🐐🎾🐕👴🐨🐊🔹©🎣👦👣👨👈💬⭕📹📷"
|
|
)
|
|
|
|
|
|
def _lower_clean_dict_keys(dict: MenuItems) -> dict[str, Any]:
|
|
return {str(k).lower().strip(): v for k, v in dict.items()}
|
|
|
|
|
|
def _get_favicon_string(page_icon: PageIcon) -> str:
|
|
"""Return the string to pass to the frontend to have it show
|
|
the given PageIcon.
|
|
|
|
If page_icon is a string that looks like an emoji (or an emoji shortcode),
|
|
we return it as-is. Otherwise we use `image_to_url` to return a URL.
|
|
|
|
(If `image_to_url` raises an error and page_icon is a string, return
|
|
the unmodified page_icon string instead of re-raising the error.)
|
|
"""
|
|
|
|
# Choose a random emoji.
|
|
if page_icon == "random":
|
|
return get_random_emoji()
|
|
|
|
# If page_icon is an emoji, return it as is.
|
|
if isinstance(page_icon, str) and is_emoji(page_icon):
|
|
return f"emoji:{page_icon}"
|
|
|
|
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_to_url(
|
|
page_icon,
|
|
width=-1, # Always use full width for favicons
|
|
clamp=False,
|
|
channels="RGB",
|
|
output_format="auto",
|
|
image_id="favicon",
|
|
)
|
|
except Exception:
|
|
if isinstance(page_icon, str):
|
|
# This fall-thru handles emoji shortcode strings (e.g. ":shark:"),
|
|
# which aren't valid filenames and so will cause an Exception from
|
|
# `image_to_url`.
|
|
return page_icon
|
|
raise
|
|
|
|
|
|
@gather_metrics("set_page_config")
|
|
def set_page_config(
|
|
page_title: str | None = None,
|
|
page_icon: PageIcon | None = None,
|
|
layout: Layout | None = None,
|
|
initial_sidebar_state: InitialSideBarState | None = None,
|
|
menu_items: MenuItems | None = None,
|
|
) -> None:
|
|
"""
|
|
Configure the default settings of the page.
|
|
|
|
This command can be called multiple times in a script run to dynamically
|
|
change the page configuration. The calls are additive, with each successive
|
|
call overriding only the parameters that are specified.
|
|
|
|
Parameters
|
|
----------
|
|
page_title: str or None
|
|
The page title, shown in the browser tab. If this is ``None``
|
|
(default), the page title is inherited from the previous call of
|
|
``st.set_page_config``. If this is ``None`` and no previous call
|
|
exists, the page title is inferred from the page source.
|
|
|
|
If a page source is a Python file, its inferred title is derived from
|
|
the filename. If a page source is a callable object, its inferred title
|
|
is derived from the callable's name.
|
|
|
|
page_icon : Anything supported by st.image (except list), str, or None
|
|
The page favicon. If ``page_icon`` is ``None`` (default), the page icon
|
|
is inherited from the previous call of ``st.set_page_config``. If this
|
|
is ``None`` and no previous call exists, the favicon is a monochrome
|
|
Streamlit logo.
|
|
|
|
In addition to the types supported by |st.image|_ (except list), the
|
|
following strings are valid:
|
|
|
|
- A single-character emoji. For example, you can set ``page_icon="🦈"``.
|
|
|
|
- An emoji short code. For example, you can set ``page_icon=":shark:"``.
|
|
For a list of all supported codes, see
|
|
https://share.streamlit.io/streamlit/emoji-shortcodes.
|
|
|
|
- The string literal, ``"random"``. You can set ``page_icon="random"``
|
|
to set a random emoji from the supported list above.
|
|
|
|
- An icon from the Material Symbols library (rounded style) in the
|
|
format ``":material/icon_name:"`` where "icon_name" is the name
|
|
of the icon in snake case.
|
|
|
|
For example, ``page_icon=":material/thumb_up:"`` will display the
|
|
Thumb Up icon. Find additional icons in the `Material Symbols \
|
|
<https://fonts.google.com/icons?icon.set=Material+Symbols&icon.style=Rounded>`_
|
|
font library.
|
|
|
|
.. note::
|
|
Colors are not supported for Material icons. When you use a
|
|
Material icon for favicon, it will be black, regardless of browser
|
|
theme.
|
|
|
|
.. |st.image| replace:: ``st.image``
|
|
.. _st.image: https://docs.streamlit.io/develop/api-reference/media/st.image
|
|
|
|
layout: "centered", "wide", or None
|
|
How the page content should be laid out. If this is ``None`` (default),
|
|
the page layout is inherited from the previous call of
|
|
``st.set_page_config``. If this is ``None`` and no previous call
|
|
exists, the page layout is ``"centered"``.
|
|
|
|
``"centered"`` constrains the elements into a centered column of fixed
|
|
width. ``"wide"`` uses the entire screen.
|
|
|
|
initial_sidebar_state: "auto", "expanded", "collapsed", or None
|
|
How the sidebar should start out. If this is ``None`` (default), the
|
|
sidebar state is inherited from the previous call of
|
|
``st.set_page_config``. If no previous call exists, the sidebar state
|
|
is ``"auto"``.
|
|
|
|
The folowing states are supported:
|
|
|
|
- ``"auto"``: The sidebar is hidden on small devices and shown otherwise.
|
|
- ``"expanded"``: The sidebar is shown initially.
|
|
- ``"collapsed"``: The sidebar is hidden initially.
|
|
|
|
In most cases, ``"auto"`` provides the best user experience across
|
|
devices of different sizes.
|
|
|
|
menu_items: dict
|
|
Configure the menu that appears on the top-right side of this app.
|
|
The keys in this dict denote the menu item you'd like to configure:
|
|
|
|
- "Get help": str or None
|
|
The URL this menu item should point to.
|
|
If None, hides this menu item.
|
|
- "Report a Bug": str or None
|
|
The URL this menu item should point to.
|
|
If None, hides this menu item.
|
|
- "About": str or None
|
|
A markdown string to show in the About dialog.
|
|
If None, only shows Streamlit's default About text.
|
|
|
|
The URL may also refer to an email address e.g. ``mailto:john@example.com``.
|
|
To remove an item that was specified in a previous call to
|
|
``st.set_page_config``, set its value to ``None`` in the dictionary.
|
|
|
|
Example
|
|
-------
|
|
>>> import streamlit as st
|
|
>>>
|
|
>>> st.set_page_config(
|
|
... page_title="Ex-stream-ly Cool App",
|
|
... page_icon="🧊",
|
|
... layout="wide",
|
|
... initial_sidebar_state="expanded",
|
|
... menu_items={
|
|
... 'Get Help': 'https://www.extremelycoolapp.com/help',
|
|
... 'Report a bug': "https://www.extremelycoolapp.com/bug",
|
|
... 'About': "# This is a header. This is an *extremely* cool app!"
|
|
... }
|
|
... )
|
|
"""
|
|
|
|
msg = ForwardProto()
|
|
|
|
if page_title is not None:
|
|
msg.page_config_changed.title = page_title
|
|
|
|
if page_icon is not None:
|
|
msg.page_config_changed.favicon = _get_favicon_string(page_icon)
|
|
|
|
pb_layout: PageConfigProto.Layout.ValueType
|
|
if layout == "centered":
|
|
pb_layout = PageConfigProto.CENTERED
|
|
elif layout == "wide":
|
|
pb_layout = PageConfigProto.WIDE
|
|
elif layout is None:
|
|
# Allows for multiple (additive) calls to set_page_config
|
|
pb_layout = PageConfigProto.LAYOUT_UNSET
|
|
else:
|
|
# Note: Pylance incorrectly notes this error as unreachable
|
|
raise StreamlitInvalidPageLayoutError(layout=layout)
|
|
|
|
msg.page_config_changed.layout = pb_layout
|
|
|
|
pb_sidebar_state: PageConfigProto.SidebarState.ValueType
|
|
if initial_sidebar_state == "auto":
|
|
pb_sidebar_state = PageConfigProto.AUTO
|
|
elif initial_sidebar_state == "expanded":
|
|
pb_sidebar_state = PageConfigProto.EXPANDED
|
|
elif initial_sidebar_state == "collapsed":
|
|
pb_sidebar_state = PageConfigProto.COLLAPSED
|
|
elif initial_sidebar_state is None:
|
|
# Allows for multiple (additive) calls to set_page_config
|
|
pb_sidebar_state = PageConfigProto.SIDEBAR_UNSET
|
|
else:
|
|
# Note: Pylance incorrectly notes this error as unreachable
|
|
raise StreamlitInvalidSidebarStateError(
|
|
initial_sidebar_state=initial_sidebar_state
|
|
)
|
|
|
|
msg.page_config_changed.initial_sidebar_state = pb_sidebar_state
|
|
|
|
if menu_items is not None:
|
|
lowercase_menu_items = cast("MenuItems", _lower_clean_dict_keys(menu_items))
|
|
validate_menu_items(lowercase_menu_items)
|
|
menu_items_proto = msg.page_config_changed.menu_items
|
|
set_menu_items_proto(lowercase_menu_items, menu_items_proto)
|
|
|
|
ctx = get_script_run_ctx()
|
|
if ctx is None:
|
|
return
|
|
ctx.enqueue(msg)
|
|
|
|
|
|
def get_random_emoji() -> str:
|
|
# TODO: fix the random seed with a hash of the user's app code, for stability?
|
|
return random.choice(RANDOM_EMOJIS) # noqa: S311
|
|
|
|
|
|
def set_menu_items_proto(
|
|
lowercase_menu_items: MenuItems, menu_items_proto: PageConfigProto.MenuItems
|
|
) -> None:
|
|
if GET_HELP_KEY in lowercase_menu_items:
|
|
if lowercase_menu_items[GET_HELP_KEY] is not None:
|
|
menu_items_proto.get_help_url = lowercase_menu_items[GET_HELP_KEY]
|
|
else:
|
|
menu_items_proto.hide_get_help = True
|
|
|
|
if REPORT_A_BUG_KEY in lowercase_menu_items:
|
|
if lowercase_menu_items[REPORT_A_BUG_KEY] is not None:
|
|
menu_items_proto.report_a_bug_url = lowercase_menu_items[REPORT_A_BUG_KEY]
|
|
else:
|
|
menu_items_proto.hide_report_a_bug = True
|
|
|
|
if ABOUT_KEY in lowercase_menu_items:
|
|
if lowercase_menu_items[ABOUT_KEY] is not None:
|
|
menu_items_proto.about_section_md = dedent(lowercase_menu_items[ABOUT_KEY])
|
|
else:
|
|
# For multiple calls to set_page_config, clears previously set about markdown
|
|
menu_items_proto.clear_about_md = True
|
|
|
|
|
|
def validate_menu_items(menu_items: MenuItems) -> None:
|
|
for k, v in menu_items.items():
|
|
if not valid_menu_item_key(k):
|
|
raise StreamlitInvalidMenuItemKeyError(key=k)
|
|
if v is not None and (
|
|
not is_url(v, ("http", "https", "mailto")) and k != ABOUT_KEY
|
|
):
|
|
raise StreamlitInvalidURLError(url=v)
|
|
|
|
|
|
def valid_menu_item_key(key: str) -> TypeGuard[MenuKey]:
|
|
return key in {GET_HELP_KEY, REPORT_A_BUG_KEY, ABOUT_KEY}
|