g UddlmZddlmZddlmZmZmZmZddl m Z ddl m Z ddl mZmZmZddlmZmZmZmZddlmZdd lmZdd lmZerdd lmZdd lm Z dd l!m"Z"ee#eee#e$ffZ%de&d<GddZ'y)) annotations)Sequence) TYPE_CHECKINGLiteralUnioncast) TypeAlias)get_dg_singleton_instance)Keycompute_and_register_element_idto_key)StreamlitAPIExceptionStreamlitInvalidColumnGapErrorStreamlitInvalidColumnSpecError&StreamlitInvalidVerticalAlignmentError)Block)gather_metrics)validate_icon_or_emoji)DeltaGenerator)Dialog)StatusContainerr SpecTypecteZdZeddddd ddZeddddd  dd Zed dd Zed  ddd ddZedddddd d dZedddd d!dZ ddd d"dZ e d#dZ y)$ LayoutsMixin containerN)heightborderkeyct|}t}d|_|xsd|j_|r+d|_||j_|d|j_|rt d|d|_|jj|S)a4 Insert a multi-element container. Inserts an invisible container into your app that can be used to hold multiple elements. This allows you to, for example, insert multiple elements into your app out of order. To add elements to the returned container, you can use the ``with`` notation (preferred) or just call methods directly on the returned object. See examples below. Parameters ---------- height : int or None Desired height of the container expressed in pixels. If ``None`` (default) the container grows to fit its content. If a fixed height, scrolling is enabled for large content and a grey border is shown around the container to visually separate its scroll surface from the rest of the app. .. note:: Use containers with scroll sparingly. If you do, try to keep the height small (below 500 pixels). Otherwise, the scroll surface of the container might cover the majority of the screen on mobile devices, which makes it hard to scroll the rest of the app. border : bool or None Whether to show a border around the container. If ``None`` (default), a border is shown if the container is set to a fixed height and not shown otherwise. key : str or None An optional string to give this container a stable identity. Additionally, if ``key`` is provided, it will be used as CSS class name prefixed with ``st-key-``. Examples -------- Inserting elements using ``with`` notation: >>> import streamlit as st >>> >>> with st.container(): ... st.write("This is inside the container") ... ... # You can call any Streamlit command, including custom components: ... st.bar_chart(np.random.randn(50, 3)) >>> >>> st.write("This is outside the container") .. output :: https://doc-container1.streamlit.app/ height: 520px Inserting elements out of order: >>> import streamlit as st >>> >>> container = st.container(border=True) >>> container.write("This is inside the container") >>> st.write("This is outside the container") >>> >>> # Now insert some more in the container >>> container.write("This is inside too") .. output :: https://doc-container2.streamlit.app/ height: 300px Using ``height`` to make a grid: >>> import streamlit as st >>> >>> row1 = st.columns(3) >>> row2 = st.columns(3) >>> >>> for col in row1 + row2: >>> tile = col.container(height=120) >>> tile.title(":balloon:") .. output :: https://doc-container3.streamlit.app/ height: 350px Using ``height`` to create a scrolling container for long content: >>> import streamlit as st >>> >>> long_text = "Lorem ipsum. " * 1000 >>> >>> with st.container(height=300): >>> st.markdown(long_text) .. output :: https://doc-container4.streamlit.app/ height: 400px FTNr)user_keyform_id) r BlockProto allow_emptyverticalrrr iddg_block)selfrrr block_protos O/var/www/openai/venv/lib/python3.12/site-packages/streamlit/elements/layouts.pyrzLayoutsMixin.container+sVSk l "' &,o # &*K #*0K '~/3 $$+  =c4KNww~~k**columnssmalltopF)gapvertical_alignmentrc  |}t|trd|z}t|dk(std|Dr t t j jjt j jjt j jjd  vr td}|| d  fd }t } |j_ |jj|} t!|} |D cgc]} | j|| | z c} Scc} w) aInsert containers laid out as side-by-side columns. Inserts a number of multi-element containers laid out side-by-side and returns a list of container objects. To add elements to the returned containers, you can use the ``with`` notation (preferred) or just call methods directly on the returned object. See examples below. Columns can only be placed inside other columns up to one level of nesting. .. warning:: Columns cannot be placed inside other columns in the sidebar. This is only possible in the main area of the app. Parameters ---------- spec : int or Iterable of numbers Controls the number and width of columns to insert. Can be one of: - An integer that specifies the number of columns. All columns have equal width in this case. - An Iterable of numbers (int or float) that specify the relative width of each column. E.g. ``[0.7, 0.3]`` creates two columns where the first one takes up 70% of the available with and the second one takes up 30%. Or ``[1, 2, 3]`` creates three columns where the second one is two times the width of the first one, and the third one is three times that width. gap : "small", "medium", or "large" The size of the gap between the columns. The default is ``"small"``. vertical_alignment : "top", "center", or "bottom" The vertical alignment of the content inside the columns. The default is ``"top"``. border : bool Whether to show a border around the column containers. If this is ``False`` (default), no border is shown. If this is ``True``, a border is shown around each column. Returns ------- list of containers A list of container objects. Examples -------- **Example 1: Use context management** You can use the ``with`` statement to insert any element into a column: >>> import streamlit as st >>> >>> col1, col2, col3 = st.columns(3) >>> >>> with col1: ... st.header("A cat") ... st.image("https://static.streamlit.io/examples/cat.jpg") >>> >>> with col2: ... st.header("A dog") ... st.image("https://static.streamlit.io/examples/dog.jpg") >>> >>> with col3: ... st.header("An owl") ... st.image("https://static.streamlit.io/examples/owl.jpg") .. output :: https://doc-columns1.streamlit.app/ height: 620px **Example 2: Use commands as container methods** You can just call methods directly on the returned objects: >>> import streamlit as st >>> import numpy as np >>> >>> col1, col2 = st.columns([3, 1]) >>> data = np.random.randn(10, 1) >>> >>> col1.subheader("A wide column with a chart") >>> col1.line_chart(data) >>> >>> col2.subheader("A narrow column with the data") >>> col2.write(data) .. output :: https://doc-columns2.streamlit.app/ height: 550px **Example 3: Align widgets** Use ``vertical_alignment="bottom"`` to align widgets. >>> import streamlit as st >>> >>> left, middle, right = st.columns(3, vertical_alignment="bottom") >>> >>> left.text_input("Write something") >>> middle.button("Click me", use_container_width=True) >>> right.checkbox("Check me") .. output :: https://doc-columns-bottom-widgets.streamlit.app/ height: 200px **Example 4: Use vertical alignment to create grids** Adjust vertical alignment to customize your grid layouts. >>> import streamlit as st >>> import numpy as np >>> >>> vertical_alignment = st.selectbox( >>> "Vertical alignment", ["top", "center", "bottom"], index=2 >>> ) >>> >>> left, middle, right = st.columns(3, vertical_alignment=vertical_alignment) >>> left.image("https://static.streamlit.io/examples/cat.jpg") >>> middle.image("https://static.streamlit.io/examples/dog.jpg") >>> right.image("https://static.streamlit.io/examples/owl.jpg") .. output :: https://doc-columns-vertical-alignment.streamlit.app/ height: 600px **Example 5: Add borders** Add borders to your columns instead of nested containers for consistent heights. >>> import streamlit as st >>> >>> left, middle, right = st.columns(3, border=True) >>> >>> left.markdown("Lorem ipsum " * 10) >>> middle.markdown("Lorem ipsum " * 5) >>> right.markdown("Lorem ipsum ") .. output :: https://doc-columns-borders.streamlit.app/ height: 250px )rc3&K|] }|dk yw)rN).0weights r* z'LayoutsMixin.columns..Ts#FgFFaKgs)r.centerbottom)r0cnt|tr|j}gd}||vr|St|)N)r-mediumlarge)r/) isinstancestrlowerr)r/gap_size valid_sizess r* column_gapz(LayoutsMixin.columns..column_gapds4#s#99;: {*#O0S9 9r+ct}||j_|j_|j_|j_d|_|SNT)r"columnr6r/r0 show_borderr#)normalized_weight col_protorr@r0vertical_alignment_mappings r* column_protoz*LayoutsMixin.columns..column_protopsZ" I&7I   ##+I   2L"3I   /,2I   ($(I ! r+)rGfloatreturnr")r=intlenanyrr"ColumnVerticalAlignmentTOPCENTERBOTTOMr horizontalr/r&r'sum)r(specr/r0rweightsrBrJr)row total_weightwr@rIs `` @@r*r,zLayoutsMixin.columnssx gs #WnG w<1 #Fg#F F13 3 $$66:: ''99@@ ''99@@  # %? ?8#5  :c?  !l %- "ggnn[)7| DKLGq <L(89:GLLLs!D?tabsc |s tdtd|Dr tdddt}|jj |j j |tfd|DS)u Insert containers separated into tabs. Inserts a number of multi-element containers as tabs. Tabs are a navigational element that allows users to easily move between groups of related content. To add elements to the returned containers, you can use the ``with`` notation (preferred) or just call methods directly on the returned object. See examples below. .. warning:: All the content of every tab is always sent to and rendered on the frontend. Conditional rendering is currently not supported. Parameters ---------- tabs : list of str 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, 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. .. |st.markdown| replace:: ``st.markdown`` .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown Returns ------- list of containers A list of container objects. Examples -------- You can use the ``with`` notation to insert any element into a tab: >>> import streamlit as st >>> >>> tab1, tab2, tab3 = st.tabs(["Cat", "Dog", "Owl"]) >>> >>> with tab1: ... st.header("A cat") ... st.image("https://static.streamlit.io/examples/cat.jpg", width=200) >>> with tab2: ... st.header("A dog") ... st.image("https://static.streamlit.io/examples/dog.jpg", width=200) >>> with tab3: ... st.header("An owl") ... st.image("https://static.streamlit.io/examples/owl.jpg", width=200) .. output :: https://doc-tabs1.streamlit.app/ height: 620px Or you can just call methods directly on the returned objects: >>> import streamlit as st >>> import numpy as np >>> >>> tab1, tab2 = st.tabs(["📈 Chart", "🗃 Data"]) >>> data = np.random.randn(10, 1) >>> >>> tab1.subheader("A tab with a chart") >>> tab1.line_chart(data) >>> >>> tab2.subheader("A tab with the data") >>> tab2.write(data) .. output :: https://doc-tabs2.streamlit.app/ height: 700px zBThe input argument to st.tabs must contain at least one tab label.c3>K|]}t|t ywN)r=r>)r5tabs r*r7z$LayoutsMixin.tabs..s84C:c3''4szBThe tabs input list to st.tabs is only allowed to contain strings.cJt}||j_d|_|SrD)r"r`labelr#)rb tab_protos r*rcz$LayoutsMixin.tabs..tab_protos#" I"'IMM $(I ! r+c3LK|]}j|ywr_)r')r5 tab_label tab_containerrcs r*r7z$LayoutsMixin.tabs..s$VQUI])))I*>?QUs!$)rbr>rLr")rrOr"rf SetInParentr&r'tuple)r(r\r)rfrcs @@r*r\zLayoutsMixin.tabss}h'T  848 8'T   !l !!--/{3 VQUVVVr+expander)iconc| tdtj}||_||_|t ||_t}d|_|jj||jj|S)uInsert a multi-element container that can be expanded/collapsed. Inserts a container into your app that can be used to hold multiple elements and can be expanded or collapsed by the user. When collapsed, all that is visible is the provided label. To add elements to the returned container, you can use the ``with`` notation (preferred) or just call methods directly on the returned object. See examples below. .. warning:: Currently, you may not put expanders inside another expander. Parameters ---------- 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, 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. .. |st.markdown| replace:: ``st.markdown`` .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown expanded : bool If True, initializes the expander in "expanded" state. Defaults to False (collapsed). icon : str, None An optional emoji or icon to display next to the expander label. If ``icon`` is ``None`` (default), no icon is displayed. If ``icon`` is a string, the following options are valid: - A single-character emoji. For example, you can set ``icon="🚨"`` or ``icon="🔥"``. Emoji short codes are not supported. - 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, ``icon=":material/thumb_up:"`` will display the Thumb Up icon. Find additional icons in the `Material Symbols \ `_ font library. Examples -------- You can use the ``with`` notation to insert any element into an expander >>> import streamlit as st >>> >>> st.bar_chart({"data": [1, 5, 2, 6, 2, 1]}) >>> >>> with st.expander("See explanation"): ... st.write(''' ... The chart above shows some numbers I picked for you. ... I rolled actual dice for these, so they're *guaranteed* to ... be random. ... ''') ... st.image("https://static.streamlit.io/examples/dice.jpg") .. output :: https://doc-expander.streamlit.app/ height: 750px Or you can just call methods directly on the returned objects: >>> import streamlit as st >>> >>> st.bar_chart({"data": [1, 5, 2, 6, 2, 1]}) >>> >>> expander = st.expander("See explanation") >>> expander.write(''' ... The chart above shows some numbers I picked for you. ... I rolled actual dice for these, so they're *guaranteed* to ... be random. ... ''') >>> expander.image("https://static.streamlit.io/examples/dice.jpg") .. output :: https://doc-expander.streamlit.app/ height: 750px z#A label is required for an expanderFr)) rr" Expandableexpandedrbrrjr# expandableCopyFromr&r')r(rbrnrjexpandable_protor)s r*rizLayoutsMixin.expandersH ='(MN N%002$,!!&  $:4$@  ! l "' ''(89ww~~+~66r+popover)helprjdisableduse_container_widthcF| tdtj}||_||_||_|rt ||_|t||_ t}d|_ |jj||jj|S)uDInsert a popover container. Inserts a multi-element container as a popover. It consists of a button-like element and a container that opens when the button is clicked. Opening and closing the popover will not trigger a rerun. Interacting with widgets inside of an open popover will rerun the app while keeping the popover open. Clicking outside of the popover will close it. To add elements to the returned container, you can use the "with" notation (preferred) or just call methods directly on the returned object. See examples below. .. warning:: You may not put a popover inside another popover. Parameters ---------- 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, 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. .. |st.markdown| replace:: ``st.markdown`` .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown help : str or None A tooltip that gets displayed when the popover button is hovered over. 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``. icon : str An optional emoji or icon to display next to the button label. If ``icon`` is ``None`` (default), no icon is displayed. If ``icon`` is a string, the following options are valid: - A single-character emoji. For example, you can set ``icon="🚨"`` or ``icon="🔥"``. Emoji short codes are not supported. - 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, ``icon=":material/thumb_up:"`` will display the Thumb Up icon. Find additional icons in the `Material Symbols \ `_ font library. disabled : bool 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. If ``use_container_width`` is ``False`` (default), Streamlit sizes the button to fit its contents. If ``use_container_width`` is ``True``, the width of the button matches its parent container. In both cases, if the contents of the button are wider than the parent container, the contents will line wrap. The popover containter's minimimun width matches the width of its button. The popover container may be wider than its button to fit the container's contents. Examples -------- You can use the ``with`` notation to insert any element into a popover: >>> import streamlit as st >>> >>> with st.popover("Open popover"): >>> st.markdown("Hello World 👋") >>> name = st.text_input("What's your name?") >>> >>> st.write("Your name:", name) .. output :: https://doc-popover.streamlit.app/ height: 400px Or you can just call methods directly on the returned objects: >>> import streamlit as st >>> >>> popover = st.popover("Filter items") >>> red = popover.checkbox("Show red items.", True) >>> blue = popover.checkbox("Show blue items.", True) >>> >>> if red: ... st.write(":red[This is a red item.]") >>> if blue: ... st.write(":blue[This is a blue item.]") .. output :: https://doc-popover2.streamlit.app/ height: 400px z!A label is required for a popoverTrl)rr"Popoverrbrurtr>rsrrjr#rrrpr&r')r(rbrsrjrtru popover_protor)s r*rrzLayoutsMixin.popover]st ='(KL L"**, # ,? )!)  !$TM   !7!=M  l "& $$]3ww~~+~66r+statusrunningrnstatecdtjj|j|||S)a)Insert a status container to display output from long-running tasks. Inserts a container into your app that is typically used to show the status and details of a process or task. The container can hold multiple elements and can be expanded or collapsed by the user similar to ``st.expander``. When collapsed, all that is visible is the status icon and label. The label, state, and expanded state can all be updated by calling ``.update()`` on the returned object. To add elements to the returned container, you can use ``with`` notation (preferred) or just call methods directly on the returned object. By default, ``st.status()`` initializes in the "running" state. When called using ``with`` notation, it automatically updates to the "complete" state at the end of the "with" block. See examples below for more details. Parameters ---------- 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, 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. .. |st.markdown| replace:: ``st.markdown`` .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown expanded : bool If True, initializes the status container in "expanded" state. Defaults to False (collapsed). state : "running", "complete", or "error" The initial state of the status container which determines which icon is shown: - ``running`` (default): A spinner icon is shown. - ``complete``: A checkmark icon is shown. - ``error``: An error icon is shown. Returns ------- StatusContainer A mutable status container that can hold multiple elements. The label, state, and expanded state can be updated after creation via ``.update()``. Examples -------- You can use the ``with`` notation to insert any element into an status container: >>> import time >>> import streamlit as st >>> >>> with st.status("Downloading data..."): ... st.write("Searching for data...") ... time.sleep(2) ... st.write("Found URL.") ... time.sleep(1) ... st.write("Downloading data...") ... time.sleep(1) >>> >>> st.button("Rerun") .. output :: https://doc-status.streamlit.app/ height: 300px You can also use ``.update()`` on the container to change the label, state, or expanded state: >>> import time >>> import streamlit as st >>> >>> with st.status("Downloading data...", expanded=True) as status: ... st.write("Searching for data...") ... time.sleep(2) ... st.write("Found URL.") ... time.sleep(1) ... st.write("Downloading data...") ... time.sleep(1) ... status.update( ... label="Download complete!", state="complete", expanded=False ... ) >>> >>> st.button("Rerun") .. output :: https://doc-status-update.streamlit.app/ height: 300px r{)r status_container_cls_creater&)r(rbrnr|s r*ryzLayoutsMixin.statuss4^)*??GG GGUXUH  r+T dismissiblewidthcdtjj|j|||S)zInserts the dialog container. Marked as internal because it is used by the dialog_decorator and is not supposed to be used directly. The dialog_decorator also has a more descriptive docstring since it is user-facing. r)r dialog_container_clsrr&)r(titlerrs r*_dialogzLayoutsMixin._dialog\s3)*??GG GGU 5H  r+ctd|S)zGet our DeltaGenerator.r)r)r(s r*r&zLayoutsMixin.dgls$d++r+)rz int | Nonerz bool | Nonerz Key | NonerLr) rWrr/z#Literal['small', 'medium', 'large']r0z"Literal['top', 'center', 'bottom']rboolrLzlist[DeltaGenerator])r\z Sequence[str]rLzSequence[DeltaGenerator])F)rbr>rnrrj str | NonerLr) rbr>rsrrjrrtrrurrLr)rbr>rnrr|z'Literal['running', 'complete', 'error']rLr)rr>rrrzLiteral['small', 'large']rLr)rLr) __name__ __module__ __qualname__rrr,r\rirrryrpropertyr&r4r+r*rr*s)K "" C+C+ C+  C+  C+!C+JI 4;AF MMMM1 MM ? MM  MM MMMM^FfWfWPJp7  p7p7p7  p7  p7 p7dI  $)I7I7 I7  I7  I7"I7 I7I7VH 9B p p  p 7 p  p p l!+2     )    ,,r+rN)( __future__rcollections.abcrtypingrrrrtyping_extensionsr $streamlit.delta_generator_singletonsr streamlit.elements.lib.utilsr r r streamlit.errorsrrrrstreamlit.proto.Block_pb2rr"streamlit.runtime.metrics_utilrstreamlit.string_utilrstreamlit.delta_generatorrstreamlit.elements.lib.dialogr/streamlit.elements.lib.mutable_status_containerrrMrKr__annotations__rr4r+r*rsn#$66'JUU :9884OC%U *;!<<=)=E ,E ,r+