From 12ec72bdddf413347a61129a574aabe3fd13a383 Mon Sep 17 00:00:00 2001 From: Debbie Matthews Date: Thu, 25 Jul 2024 16:31:32 -0700 Subject: [PATCH] Release 1.37.0 (#1122) * API pages and docstrings (#1117) * Update generate.py * Update streamlit.json * Add st.feedback page * fragment and dialog GA * Update generate.py * Update streamlit.json * Add st.context page * Update streamlit.json * Update streamlit.json * API reference cards * Release notes * Cheat sheet * Remove commented code Reference usage of components is available in style-guide.js * What's new * Remove curly quotes * Update streamlit version * Add workaround for context properties * Existing app updates (#1120) * Update config-toml.md (#1123) --- content/develop/api-reference/_index.md | 55 +- .../configuration/config-toml.md | 87 +- .../api-reference/control-flow/dialog.md | 2 +- .../api-reference/control-flow/fragment.md | 2 +- .../api-reference/custom-components/_index.md | 9 +- .../develop/api-reference/utilities/_index.md | 33 +- .../api-reference/utilities/context.md | 11 + .../develop/api-reference/widgets/_index.md | 14 + .../develop/api-reference/widgets/feedback.md | 7 + .../quick-references/api-cheat-sheet.md | 15 +- .../develop/quick-references/release-notes.md | 44 + content/menu.md | 6 + pages/index.js | 76 +- public/images/api/feedback.jpg | Bin 0 -> 94549 bytes .../charts.video3/requirements.txt | 2 +- .../guides/requirements.txt | 2 +- .../hello/requirements.txt | 2 +- .../mpa-hello/requirements.txt | 2 +- python/api-examples-source/requirements.txt | 2 +- .../requirements.txt | 2 +- python/api-examples-source/text.header.py | 7 +- python/api-examples-source/text.subheader.py | 7 +- .../theming/requirements.txt | 2 +- .../custom-navigation/requirements.txt | 2 +- .../elements/charts/requirements.txt | 2 +- .../elements/dataframes/requirements.txt | 2 +- .../tutorials/requirements.txt | 2 +- .../utilities.switch_page/requirements.txt | 2 +- .../widget.page_link/requirements.txt | 2 +- python/generate.py | 21 +- python/streamlit.json | 9796 +++++++++++++++++ .../llm-18-lines-of-code/requirements.txt | 2 +- 32 files changed, 10038 insertions(+), 182 deletions(-) create mode 100644 content/develop/api-reference/utilities/context.md create mode 100644 content/develop/api-reference/widgets/feedback.md create mode 100644 public/images/api/feedback.jpg diff --git a/content/develop/api-reference/_index.md b/content/develop/api-reference/_index.md index c69e62784..cb617e324 100644 --- a/content/develop/api-reference/_index.md +++ b/content/develop/api-reference/_index.md @@ -779,6 +779,19 @@ Display a download button widget. st.download_button("Download file", file) ``` + + + +screenshot + +

Feedback

+ +Display a rating or sentiment button group. + +```python +st.feedback("stars") +``` + @@ -2277,7 +2290,8 @@ st.write(user_info) Create and register a custom component. ```python -st.components.v1.declare_component( +from st.components.v1 import declare_component +declare_component( "custom_slider", "/frontend", ) @@ -2292,7 +2306,8 @@ st.components.v1.declare_component( Display an HTML string in an iframe. ```python -st.components.v1.html( +from st.components.v1 import html +html( "

Foo bar.

" ) ``` @@ -2306,7 +2321,8 @@ st.components.v1.html( Load a remote URL in an iframe. ```python -st.components.v1.iframe( +from st.components.v1 import iframe +iframe( "docs.streamlit.io" ) ``` @@ -2320,17 +2336,15 @@ st.components.v1.iframe(
- + -

User info

+

Context

-`st.experimental_user` returns information about the logged-in user of private apps on Streamlit Community Cloud. +`st.context` provides a read-only interface to access cookies and headers. ```python -if st.experimental_user.email == "foo@corp.com": - st.write("Welcome back, ", st.experimental_user.email) -else: - st.write("You are not authorized to view this page.") +st.context.cookies +st.context.headers ``` @@ -2353,12 +2367,21 @@ st.help(pd.DataFrame) Renders HTML strings to your app. ```python -css = """ - -""" -st.html(css) +st.html("

Foo bar.

") +``` + + + + +

User info

+ +`st.experimental_user` returns information about the logged-in user of private apps on Streamlit Community Cloud. + +```python +if st.experimental_user.email == "foo@corp.com": + st.write("Welcome back, ", st.experimental_user.email) +else: + st.write("You are not authorized to view this page.") ``` diff --git a/content/develop/api-reference/configuration/config-toml.md b/content/develop/api-reference/configuration/config-toml.md index 5190eabd5..64c9d80ef 100644 --- a/content/develop/api-reference/configuration/config-toml.md +++ b/content/develop/api-reference/configuration/config-toml.md @@ -41,18 +41,6 @@ streamlit config show ```toml [global] -# ***DEPRECATED*** -# global.disableWatchdogWarning has been deprecated and will be removed in a -# future version. This option will be removed on or after 2024-01-20. -# **************** -# By default, Streamlit checks if the Python watchdog module is available -# and, if not, prints a warning asking for you to install it. The watchdog -# module is not required, but highly recommended. It improves Streamlit's -# ability to detect changes to files in your filesystem. -# If you'd like to turn off this warning, set this to True. -# Default: false -disableWatchdogWarning = false - # By default, Streamlit displays a warning when a user sets both a widget # default value in the function defining the widget and a widget value via # the widget's key in `st.session_state`. @@ -78,7 +66,7 @@ level = "info" # String format for logging messages. If logger.datetimeFormat is set, # logger messages will default to `%(asctime)s.%(msecs)03d %(message)s`. See # Python's documentation for available attributes: -# https://docs.python.org/2.6/develop/logging.html#formatter-objects +# https://docs.python.org/2.6/library/logging.html#formatter-objects # Default: "%(asctime)s %(message)s" messageFormat = "%(asctime)s %(message)s" ``` @@ -88,28 +76,10 @@ messageFormat = "%(asctime)s %(message)s" ```toml [client] -# ***DEPRECATED*** -# client.caching has been deprecated and is not required anymore for our new -# caching commands. This option will be removed on or after 2024-01-20. -# **************** -# Whether to enable st.cache. This does not affect st.cache_data or -# st.cache_resource. -# Default: true -caching = true - -# ***DEPRECATED*** -# client.displayEnabled has been deprecated and will be removed in a future -# version. This option will be removed on or after 2024-01-20. -# **************** -# If false, makes your Streamlit script not draw to a Streamlit app. -# Default: true -displayEnabled = true - # Controls whether uncaught app exceptions and deprecation warnings # are displayed in the browser. By default, this is set to True and # Streamlit displays app exceptions and associated tracebacks, and # deprecation warnings, in the browser. -# # If set to False, deprecation warnings and full exception messages # will print to the console only. Exceptions will still display in the # browser with a generic error message. For now, the exception type and @@ -132,8 +102,9 @@ showErrorDetails = true # Default: "auto" toolbarMode = "auto" -# Controls whether the default sidebar page navigation in a multipage app is -# displayed. +# Controls whether to display the default sidebar page navigation in a +# multi-page app. This only applies when app's pages are defined by the +# `pages/` directory. # Default: true showSidebarNavigation = true ``` @@ -148,25 +119,6 @@ showSidebarNavigation = true # Default: true magicEnabled = true -# ***DEPRECATED*** -# runner.installTracer has been deprecated and will be removed in a future -# version. This option will be removed on or after 2024-01-20. -# **************** -# Install a Python tracer to allow you to stop or pause your script at -# any point and introspect it. As a side-effect, this slows down your -# script's execution. -# Default: false -installTracer = false - -# ***DEPRECATED*** -# runner.fixMatplotlib has been deprecated and will be removed in a future -# version. This option will be removed on or after 2024-01-20. -# **************** -# Sets the MPLBACKEND environment variable to Agg inside Streamlit to -# prevent Python crashing. -# Default: true -fixMatplotlib = true - # Handle script rerun requests immediately, rather than waiting for script # execution to reach a yield point. This makes Streamlit much more # responsive to user interaction, but it can lead to race conditions in @@ -186,7 +138,6 @@ enforceSerializableSessionState = false # multiselect coerce Enum members when the Enum class gets # re-defined during a script re-run. For more information, check out the docs: # https://docs.streamlit.io/develop/concepts/design/custom-classes#enums -# # Allowed values: # * "off" : Disables Enum coercion. # * "nameOnly" : Enum classes can be coerced if their member names match. @@ -201,8 +152,7 @@ enumCoercion = "nameOnly" ```toml [server] -# List of folders that should not be watched for changes. This -# impacts both "Run on Save" and @st.cache. +# List of folders that should not be watched for changes. # Relative paths will be taken as relative to the current working directory. # Example: ['/home/user1/env', 'relative/path/to/folder'] # Default: [] @@ -290,7 +240,7 @@ enableStaticServing = false # security audits or performance tests. For the production environment, we # recommend performing SSL termination by the load balancer or the reverse # proxy.'] -# sslCertFile = +sslCertFile = # Cryptographic key file for connecting via HTTPS. # Must be set at the same time as "server.sslCertFile". @@ -298,7 +248,7 @@ enableStaticServing = false # security audits or performance tests. For the production environment, we # recommend performing SSL termination by the load balancer or the reverse # proxy.'] -# sslKeyFile = +sslKeyFile = ``` #### Browser @@ -345,17 +295,6 @@ serverPort = 8501 token = "" ``` -#### Deprecation - -```toml -[deprecation] - -# Set to false to disable the deprecation warning for using the global pyplot -# instance. -# Default: true -showPyplotGlobalUse = true -``` - #### Theme ```toml @@ -363,21 +302,21 @@ showPyplotGlobalUse = true # The preset Streamlit theme that your custom theme inherits from. # One of "light" or "dark". -# base = +base = # Primary accent color for interactive elements. -# primaryColor = +primaryColor = # Background color for the main content area. -# backgroundColor = +backgroundColor = # Background color used for the sidebar and most interactive widgets. -# secondaryBackgroundColor = +secondaryBackgroundColor = # Color used for almost all text. -# textColor = +textColor = # Font family for all text in the app, except code blocks. One of "sans serif", # "serif", or "monospace". -# font = +font = ``` diff --git a/content/develop/api-reference/control-flow/dialog.md b/content/develop/api-reference/control-flow/dialog.md index 57431017b..251e9db75 100644 --- a/content/develop/api-reference/control-flow/dialog.md +++ b/content/develop/api-reference/control-flow/dialog.md @@ -4,4 +4,4 @@ slug: /develop/api-reference/execution-flow/st.dialog description: st.experimental_dialog opens a multi-element modal overlay --- - + diff --git a/content/develop/api-reference/control-flow/fragment.md b/content/develop/api-reference/control-flow/fragment.md index 1b9769c39..05caca306 100644 --- a/content/develop/api-reference/control-flow/fragment.md +++ b/content/develop/api-reference/control-flow/fragment.md @@ -4,4 +4,4 @@ slug: /develop/api-reference/execution-flow/st.fragment description: st.fragment is a decorator that allows a function to rerun independently --- - + diff --git a/content/develop/api-reference/custom-components/_index.md b/content/develop/api-reference/custom-components/_index.md index ff2d009d4..d1ad9c292 100644 --- a/content/develop/api-reference/custom-components/_index.md +++ b/content/develop/api-reference/custom-components/_index.md @@ -14,7 +14,8 @@ slug: /develop/api-reference/custom-components Create and register a custom component. ```python -st.components.v1.declare_component( +from st.components.v1 import declare_component +declare_component( "custom_slider", "/frontend", ) @@ -29,7 +30,8 @@ st.components.v1.declare_component( Display an HTML string in an iframe. ```python -st.components.v1.html( +from st.components.v1 import html +html( "

Foo bar.

" ) ``` @@ -43,7 +45,8 @@ st.components.v1.html( Load a remote URL in an iframe. ```python -st.components.v1.iframe( +from st.components.v1 import iframe +iframe( "docs.streamlit.io" ) ``` diff --git a/content/develop/api-reference/utilities/_index.md b/content/develop/api-reference/utilities/_index.md index dacf65392..04e8b038a 100644 --- a/content/develop/api-reference/utilities/_index.md +++ b/content/develop/api-reference/utilities/_index.md @@ -9,17 +9,15 @@ There are a handful of methods that allow you to create placeholders in your app, provide help using doc strings, get and modify configuration options and query parameters. - + -

User info

+

Context

-`st.experimental_user` returns information about the logged-in user of private apps on Streamlit Community Cloud. +`st.context` provides a read-only interface to access cookies and headers. ```python -if st.experimental_user.email == "foo@corp.com": - st.write("Welcome back, ", st.experimental_user.email) -else: - st.write("You are not authorized to view this page.") +st.context.cookies +st.context.headers ``` @@ -42,12 +40,21 @@ st.help(pd.DataFrame) Renders HTML strings to your app. ```python -css = """ - -""" -st.html(css) +st.html("

Foo bar.

") +``` + + + + +

User info

+ +`st.experimental_user` returns information about the logged-in user of private apps on Streamlit Community Cloud. + +```python +if st.experimental_user.email == "foo@corp.com": + st.write("Welcome back, ", st.experimental_user.email) +else: + st.write("You are not authorized to view this page.") ``` diff --git a/content/develop/api-reference/utilities/context.md b/content/develop/api-reference/utilities/context.md new file mode 100644 index 000000000..c811e7b4f --- /dev/null +++ b/content/develop/api-reference/utilities/context.md @@ -0,0 +1,11 @@ +--- +title: st.context +slug: /develop/api-reference/utilities/st.context +description: st.context displays a read-only dict of cookies and headers +--- + + + + + + diff --git a/content/develop/api-reference/widgets/_index.md b/content/develop/api-reference/widgets/_index.md index 115cb3dea..7fc643804 100644 --- a/content/develop/api-reference/widgets/_index.md +++ b/content/develop/api-reference/widgets/_index.md @@ -38,6 +38,20 @@ st.download_button("Download file", file) + + +screenshot + +

Feedback

+ +Display a rating or sentiment button group. + +```python +st.feedback("stars") +``` + + + screenshot diff --git a/content/develop/api-reference/widgets/feedback.md b/content/develop/api-reference/widgets/feedback.md new file mode 100644 index 000000000..4531b7988 --- /dev/null +++ b/content/develop/api-reference/widgets/feedback.md @@ -0,0 +1,7 @@ +--- +title: st.feedback +slug: /develop/api-reference/widgets/st.feedback +description: Collect user feedback or ratings with st.feedback +--- + + diff --git a/content/develop/quick-references/api-cheat-sheet.md b/content/develop/quick-references/api-cheat-sheet.md index 789fea019..33b637c2e 100644 --- a/content/develop/quick-references/api-cheat-sheet.md +++ b/content/develop/quick-references/api-cheat-sheet.md @@ -5,7 +5,7 @@ slug: /develop/quick-reference/cheat-sheet # Streamlit API cheat sheet -This is a summary of the docs, as of [Streamlit v1.35.0](https://pypi.org/project/streamlit/1.36.0/). +This is a summary of the docs, as of [Streamlit v1.37.0](https://pypi.org/project/streamlit/1.37.0/). @@ -259,14 +259,14 @@ with st.form(key="my_form"): st.form_submit_button("Login") # Define a dialog function -@st.experimental_dialog("Welcome!") +@st.dialog("Welcome!") def modal_dialog(): st.write("Hello") modal_dialog() # Define a fragment -@st.experimental_fragment +@st.fragment def fragment_function(): df = get_data() st.line_chart(df) @@ -284,6 +284,7 @@ fragment_function() ```python st.button("Click me") st.download_button("Download file", data) +st.feedback("thumbs") st.link_button("Go to gallery", url) st.page_link("app.py", label="Home") st.data_editor("Edit data", data) @@ -507,12 +508,16 @@ st.exception(e) ```python # Show different content based on the user's email address. -if st.user.email == "jane@email.com": +if st.experimental_user.email == "jane@examples.com": display_jane_content() -elif st.user.email == "adam@foocorp.io": +elif st.experimental_user.email == "adam@example.com": display_adam_content() else: st.write("Please contact us to get access!") + +# Get dictionaries of cookies and headers +st.context.cookies +st.context.headers ``` diff --git a/content/develop/quick-references/release-notes.md b/content/develop/quick-references/release-notes.md index a0d514061..e8362c528 100644 --- a/content/develop/quick-references/release-notes.md +++ b/content/develop/quick-references/release-notes.md @@ -19,6 +19,50 @@ pip install --upgrade streamlit +## **Version 1.37.0** + +_Release date: July 25, 2024_ + +**Highlights** + +- 🍪 Introducing [`st.context`](/develop/api-reference/utilities/st.context) to read headers and cookies! +- ⭐ Introducing [`st.feedback`](/develop/api-reference/widgets/st.feedback) to collect ratings and sentiment from your users! +- 👟 Announcing the general availability of [`st.fragment`](/develop/api-reference/execution-flow/st.fragment), a decorator that lets you rerun functions independently of the whole page. +- 🍿 Announcing the general availability of [`st.dialog`](/develop/api-reference/execution-flow/st.dialog), a decorator that lets you create modal dialogs. + +**Notable Changes** + +- ℹ️ You can use icons from the Material Symbols library in [Markdown](/develop/api-reference/text/st.markdown)! +- 📈 You can pass `graphviz.Source` objects to [`st.graphviz_chart`](/develop/api-reference/charts/st.graphviz_chart). +- 📊 You can modify the stacking behavior for [`st.bar_chart`](/develop/api-reference/charts/st.bar_chart) and [`st.area_chart`](/develop/api-reference/charts/st.area_chart). +- 🔭 Within a fragment, you can scope [`st.rerun`](/develop/api-reference/execution-flow/st.rerun) to the fragment. +- 🪺 Streamlit supports nested fragments ([#8931](https://github.com/streamlit/streamlit/pull/8931), [#8635](https://github.com/streamlit/streamlit/issues/8635)). +- 📞 Fragments can be used in callback functions ([#8916](https://github.com/streamlit/streamlit/pull/8916), [#8591](https://github.com/streamlit/streamlit/issues/8591)). + +**Other Changes** + +- ⭕ Material Symbols are rounded instead of outlined ([#8998](https://github.com/streamlit/streamlit/pull/8998)). +- 2️⃣ Streamlit supports Numpy version 2.0 ([#8940](https://github.com/streamlit/streamlit/pull/8940)). +- 😄 We've updated emoji validation for new emojis ([#8923](https://github.com/streamlit/streamlit/pull/8923)). +- 👻 We've removed several experimental commands with new, generally available versions ([#8943](https://github.com/streamlit/streamlit/pull/8943)). +- ☠️ We've removed deprecated configuration options per their announced expiration date ([#9005](https://github.com/streamlit/streamlit/pull/9005), [#9013](https://github.com/streamlit/streamlit/pull/9013), [#9018](https://github.com/streamlit/streamlit/pull/9018)). +- 🦎 Bug fix: Nested fragments rerun correctly when a child fragment precedes a widget in the parent fragment ([#9114](https://github.com/streamlit/streamlit/pull/9114)). +- 🐌 Bug fix: Streamlit validates file paths before performing additional checks when using static file serving for improved security ([#8990](https://github.com/streamlit/streamlit/pull/8990)). +- 🕸️ Bug fix: [`st.map`](http://st.map) displays at the correct width inside `st.expander` ([#9070](https://github.com/streamlit/streamlit/pull/9070), [#8004](https://github.com/streamlit/streamlit/issues/8004)). +- 🦗 Bug fix: Streamlit displays the correct (Windows) path for `secrets.toml` in an error message ([#9061](https://github.com/streamlit/streamlit/pull/9061), [#6147](https://github.com/streamlit/streamlit/issues/6147)). +- 🦂 Bug fix: `st.switch_page` correctly clears non-embed query parameters when the user switches pages ([#9059](https://github.com/streamlit/streamlit/pull/9059), [#9050](https://github.com/streamlit/streamlit/issues/9050)). +- 🦟 Bug fix: Custom themes display correctly for multipage elements like `st.page_link` ([#8994](https://github.com/streamlit/streamlit/pull/8994), [#8978](https://github.com/streamlit/streamlit/issues/8978)). +- 🦠 Bug fix: `st.snow` and `st.balloons` don't show in prints ([#9053](https://github.com/streamlit/streamlit/pull/9053), [#7790](https://github.com/streamlit/streamlit/issues/7790)). +- 🪰 Bug fix: We've improved the default formatting for `st.number_input` ([#9035](https://github.com/streamlit/streamlit/pull/9035), [#7163](https://github.com/streamlit/streamlit/issues/7163)). +- 🪳 Bug fix: An `st.navigation` example was corrected ([#9027](https://github.com/streamlit/streamlit/pull/9027), [#9026](https://github.com/streamlit/streamlit/issues/9026)). Thanks, [mahotd](https://github.com/mahotd)! +- 🕷️ Bug fix: Dialogs no longer have a brief delay when closing ([#9023](https://github.com/streamlit/streamlit/pull/9023), [#8747](https://github.com/streamlit/streamlit/issues/8747)). +- 🦀 Bug fix: Streamlit correctly raises a `KeyError` when encountered in a fragment instead of a misleading, fragment-related error ([#9011](https://github.com/streamlit/streamlit/pull/9011), [#8494](https://github.com/streamlit/streamlit/issues/8494)). +- 🐞 Bug fix: Streamlit doesn't clear `MediaFileManager` on fragment reruns to prevent invalid references ([#9010](https://github.com/streamlit/streamlit/pull/9010), [#8932](https://github.com/streamlit/streamlit/issues/8932)). +- 🐝 Bug fix: Custom themes are correctly removed when deleted ([#8989](https://github.com/streamlit/streamlit/pull/8989), [#8962](https://github.com/streamlit/streamlit/issues/8962)). +- 🐜 Bug fix: Streamlit supports non-unix style paths for correct multipage routing in Windows ([#8988](https://github.com/streamlit/streamlit/pull/8988), [#8958](https://github.com/streamlit/streamlit/issues/8958)). +- 🪲 Bug fix: Using `st.rerun` in a fragment will not cause the app's main body content to render in the fragment in rare events ([#8798](https://github.com/streamlit/streamlit/pull/8798)). +- 🐛 Bug fix: When an exception is raised within a fragment, Streamlit shows the error message within the fragment ([#8868](https://github.com/streamlit/streamlit/pull/8868)). + ## **Version 1.36.0** _Release date: June 20, 2024_ diff --git a/content/menu.md b/content/menu.md index 27c242808..7d00c6056 100644 --- a/content/menu.md +++ b/content/menu.md @@ -288,6 +288,9 @@ site_menu: - category: Develop / API reference / Input widgets / st.download_button url: /develop/api-reference/widgets/st.download_button isVersioned: true + - category: Develop / API reference / Input widgets / st.feedback + url: /develop/api-reference/widgets/st.feedback + isVersioned: true - category: Develop / API reference / Input widgets / st.form_submit_button url: https://docs.streamlit.io/develop/api-reference/execution-flow/st.form_submit_button isVersioned: true @@ -570,6 +573,9 @@ site_menu: isVersioned: true - category: Develop / API reference / Utilities url: /develop/api-reference/utilities + - category: Develop / API reference / Utilities / st.context + url: /develop/api-reference/utilities/st.context + isVersioned: true - category: Develop / API reference / Utilities / st.experimental_user url: /develop/api-reference/utilities/st.experimental_user isVersioned: true diff --git a/pages/index.js b/pages/index.js index 0bf6aace4..3670eceae 100644 --- a/pages/index.js +++ b/pages/index.js @@ -192,82 +192,70 @@ export default function Home({ window, menu }) { - auto_stories -

Multipage apps v2

+ cookie +

User session context

- Introducing st.navigation and{" "} - st.Page, the new, preferred way to declare - multipage apps! + Introducing st.context, a read-only interface to + access headers and cookies!

- align_horizontal_left -

Horizontal bar charts

+ star +

User feedback

- Create horizontal bar charts with st.bar_chart. + Introducing st.feedback to collect user ratings + and sentiment.

- info -

Icons for expanders

+ bolt +

Fragments and dialogs

- Add icons to your st.expander labels. + We've polished st.fragment and + st.dialog with multiple bug fixes and + improvements. They're no longer experimental!

- align_vertical_bottom -

Vertical alignment

+ location_searching +

Rerun scope

- Set the vertical alignment for st.columns. + st.rerun can be scoped to a fragment.

- show_chart -

Axis labels

+ bar_chart +

Chart stacking

- st.area_chart, st.bar_chart,{" "} - st.line_chart, and st.scatter_chart{" "} - let you set axis labels. + st.area_chart and st.bar_chart + have a new parameter to set stacking behavior.

- call -

Custom component callbacks

-

Custom components now support callback functions.

+ info +

Icons in Markdown

+

+ Streamlit supports icons from the Google Material Symbols + library in Markdown. +

- {/* */} - {/* Preserve above comment for syntax reference */}

Latest blog posts

diff --git a/public/images/api/feedback.jpg b/public/images/api/feedback.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f2639cc90cf90b81275db89952aa9354cd697ca3 GIT binary patch literal 94549 zcmeFYcU05gw=EhJL_|coG*M|HO{FOUQIY<|2q-N=R740dMx}+8C*=I&N=svH^zPM{`bZ=8H|jy4_SM!z2};9&3*9aU3 z+}O+*z;TEJV9LG&4hR540LTC3?eB~HUtWTP#P< zkkv!(b1#H1zmCf|Dtoh}QN+5BBB$}_WiZb%QL$6v67mX)=anvKYH90SxvFb;%gETo z)Xd!G?mb&Odk06C$F5J@+@T(xUfw>wNI(COH=$wSZzCe(6Fwv+C4c;s@-;InJ16&B zUVdp=c|~Pabxmzkb4zPm`_GPF{R4wT!y|u2$4KPqnc2Ddg~cW6#^%=c&Ms|l|L?ds z0EhoIWd9b}{}LB_5I7ETavtX7{yQ#?L%!_4!vdUKXD=NQykW)t@P*L1%dd|L-;B#B zY2=aBu%?JSdf9hOR8Es5PyIWz{~6i;Szy8cpCbELVE-A{7~uF}4))|7761SNEY^9z zmqV|P0seXTX9)huf`1mmKYPJH+u=Wm@DCdPgNFa0;Xi2j4;uc1hX0`9KWO+58vcWZ z|DfSNX!!qUG`v8B*e@peI>u!C!E&KH7cIO4&_OTwveVKEk3LSBTUsJb2TvY#vGseB z*ng$Z;u;rcU$smMS`t5%e*h>$G!de@Bpb^-@Zx$V9;>{$A@4-fg~Gh9JWg%XeWhIm zeJ5N)Sq*=ydY_Tw_2AD!m_%0L#24Hy9pBw@HG2-_L+fGjUZN83rFc<*&9Pyqliw5G z-Y!l*L-i>+B6(G;GoR*b@jg)!{JYowrTNrU^speWpV_{HdI#(AX2Z`-AT0pB>N|&^ zBbw8y+Y=7}N6q*ASUcznz44s`fJ3YYHou>>J1MoXp>NWNrZ`|@bno{n#;_y;wW&dG zT%LAiRK3-cDFk)MkL|!MTE-l|a{@}-U*z$IYzl6x^Kh4E)ju6s+zU=!itWP$%TVsF zkLHqFcKmfB5f$no4f3_F5pdjdcu$x@wM&an!{t(!oW@f!8^jiEmb5WC{^E+Ak5Kd7 zm;xeXg1AOptMP#D`D3zts%)!6*G>dd)PZaizgPp+LQF1z>n@v5!yO<`V;*sg@b;sUV6#C8l|J_k!uh zdZ4TCIrr7mH|!E_oIabR*kti6+-HImo~Pokj>z!M+c@88@4UeSXe0JuKWM)JD! zP#iP}Wxh%K@)3JTiv}{JO&6!H{VUnFiX}4OOEEL^3V8eD0sfNHYVY^=5aBGQO7fD) zwUyZOK#J`FU~J{5%qr%@&DXK#k@A71L1wxc$+BbDug=^HvQ6G?H~`Q%dSv@>((M11 zM5AY09zqU~)|+L-{>VN-ul&?ABn83lwGt{~gs06jD>wL`y4_P+%=$w@YMcUt05#H_bki1c9Q9--5f43gBq8 zY46G-NfUz9=i`cDdD1RWtSW1LqsAP%CzF%%EH`J_F(|z#b4gUUGWi?0-S=T0wCXto zx;tEU9{KF)y6WSk$+^jUXERg8PwQA8E0G#87}FPbUHV_k2oCW?k+eS-&a3=xxsd;@ zQ{&PP0KiOc>I8eLf*9WHUz^1Gjpt&|6kN~HlWNjBoJvl(LGw}dw&1nM{`J-yBx3o3 zKYX?FXOZ-8$DqlgZ=>R3{920b;8&$ljcpq z{5UOI^6;FAdgQwI`l%(46Sq7w7pvH7F4C%b&wA9kMRHc*9%t3fCX-cjP=6=m=X{W$ z9vnYabO5Lz=vL!sFC#TRjx?UhbfdR!nPCVYxQx69Ayy9(08C`e_5@P(RWU;U>RniGqCd#LKQ9 z077IacKoB8WWLs%II4`rNW%%3j=I#%&3mp?^^kX^@O!pY(L^}no5PX!X`4&wr%MJ_ zr&|)1j%EBJ>8VT?!nI~I>6nFIHlQH>L4985UWQecJ&YwW?1ew+?wG~vowKZ~$}G;y zUK0In>aeoDlAS(0ckad^Q&;ctqun>VI|l%=)A1>WrslhHm@YZ# z(I7n3AbUR$O3Tjvw7Q0pWbj8ex9Oxj$>6!9l^lTsD`Y&JLY%k{9*>*vSN5Oj>Rl`|#;!$9;~=o#%mJ_s%gNjf_vDTls90?_#D< zov2PU#q$8L;z{*jH8*3*O$E5S2f?JWaNB>^41| z!xi&GN5ZMTIv~x^zAXCGi2VJ^a<#=@T7rv|&NW}q0pJk+@qL)lS`Au+85p~OC(XBD z!ttUE*(~G%fP{!m2sZFZpux2kz@g#H27tl zP`lL6g@(Y)^E%>2Z5CbwmO*nJx%s}%CNS&&z7PNXED%Cn-`QuT0^K@_x6p#f7Ft1@ zZJ6mS1@!7`NQ>iaQH!5#)ljkR62Y)H*JMn-Vpt2Nf5Qs*v+#*kG_!LXqQ$ojrK9ahhI8K=bz53&mI8W zJ&sn>*Z8G*d1NZInSzkCj`<*gDNl6ceIP6k^3o|#r^;y-R~;zqp#7P(t|Nilcq+|7 zoO^zGW+rvNNPRu%06^jDQJ2l55E-J%J1PD1+z?88Q>^f4`P=?>wbxkp-2#buFP|!Z zw}|*L!9C6n&z#BCGw?f?kNw-a1#RBwX2jMsoIC(DK596QES@9&MXQ*?3NVywKg9!A z>kXz^Lb1GUX3ZA523k` z>x~!z1`tZdav*bWQp3a5OI0gk`8|AUv!i}yIGUb@Imn%KGOV{H_rDMsD#NHDU7p|d zyi#3frb*X&v>p^w`u@K{<^Mim{|Tf2{XOn5Rxhwzrx`I?_CqIKpB9(TOc@tf^-?|7 z)0qmP+J2Y4Y?S40t1gEMT)DVwXN|Mf^{&ye+dX-c0~UJqu21B4kl-4-h$!2GGxN~! z^>^rs(?#A#>hiisknl_6h`t61cbzhY2+kK~wPW*;>U&kGtrE2)X{`6D;r_`7U0I8@ zk4&jmnYZ65trpgHtZ%F`J$`>q)eD~@t}Ie>r+2=Mxiz7~_lc2j1m9w}k<(Ei%H)R@ z<-{R9v%F5XuYWpcbyAYzC!+{&xK}C%8cvQc-8{At@9YHmI&P*@vhO#gPCK{WGGRTY zjCp$iIHe~uwdiDRn2U6|F{B57aoSvnt7~X=J!JLl$3vv_p^8%?Lq2-HTCf_e?JJFV z+vL6Ej=2B_Hb5yMB_AH1ZjaLI!d;>`$JqE>kv~!?`OJ?n=O*>6M+*o>|7_T0-RPJ@ zB4Q5!Q}1L%G@~4zHAn?IQV`Kuk=pN}4YGaSz{8W>&2r!|ON1YJ!ocC<1C``t$H&KC zI*|cSrlX>0Uq@1)2Y}=ysaW=Yf>LMouzzyHp=I8$413Cn8j|>&kA)=tn@e4$XBn8=glG6J866*W1&LB5?^5@y4qj|<6 zVo>yDW&pPRw}+*_4=|7aHRQB`6symGW1!(ILu**fs(c=bvLjF`Cz+TYZ&)ba|Dzuxp;DCgl0 zmL>y6^QCbAaLjE1MflJ78-(VPCEZV|>{r(1cS^;&Wi05Twi2v{uz`7c-vr{%pN$Dv zUR>3rgX^jG#pAr&KX|bsd zf{bIdI_iL;p2yTIRqmq(CAQd^`TnIJ<|AGL z_yilxrb269l7J#CnPmfss&vSOW~Y1McPR}yGa475EV=${TwiXr`{1wPBdc1cWY3I` z{Qn0nCGpcJ3t5 zVD#IxWBgKq`h%dz3GPx^k zZIaNHcl+*ar+UJ|Nb+_@zOS9Zt8b_ND+BS{ZIy|1=Avm#rMZ#CTHvUG<_57|(xw_# z%?w)nOy=B(@2Wdg@gbATPcs>__&@i_P|7^(=m0erQWdsNHfcd~ zGOjtizdBG}aP0sfy=+@}7jt3b{4>34UzNkgvPNOM)TuJ=Yd7(FCC?$pUDd(z8xyRf z?5zB=FDgSjmmGZSQdDfLvr_!jxroQ%jk}eo4z@ouenhg!&@?!xs2Eo zn>+ygMD_Gg^a|S8uxx~u90hm1pe#=#!U7GiT*m3Tz0*_AL*C(ZeiTKwGaba)m;Iie zo!oc&aE+Sw)&a5J}AjtIw$8(KbtqPk@&ux*gh z@D>3N2tUJ6lO>tH=r+RODD2dqf1`Ip{8)nK82TfAbS%|4|LpKqPWj;1OYKr+_eb}J zJuiI7unOpOjt66x%Q(mW&Pv2iF%3??N0Vg6Pl;h4=sram=z-(S>Eu_ zUn+*yeF%xGw-bs9&C>N7CUQ20uHOigi#zGw=GHkY+fH(ou&tnxxe9Gd%^-b;cmGwY z)?*jXZNM-{*#V##Bo_F9);_H&`2%=Dk1yM-5XlDIl{v|4l6N0R9z7eWm9%a(xGh=p zV4yrm=5|%xkawE((!gK+D{Jd(MXNL4Zr+p2;G9*uCWkMotB)UwC{HAm0@*OcI>v@I zE(&dv{=@@yj%GzS@Gy|2@zF2tRi%I(7VXxv85Xp%ocNutfN5rcMAwM+Pzr zIw7}V0iWOuP#!WZwDb?X`swlWW8SK|b-V9mcJ1t#^BbmfX?CijaSRBSahPf{6~02J z*6k!v>oLu-ukgG$C>7F{Tqo`YJmQ}0U!G*!bLQ=mZr6;v=IUXS&_6*1jw9-tOoc8_ z`H7WFc@GJ??{iN>e_eE%S>5$TS=eZ%`k1eImeBW56k>ZweA zi`5Q!cshfMZkKp?A*&sovml0&qF9(-wv+H}vAl5^SN*e?XU@wd>#T0N|4sFETmvoh zo-xQLnS21~q#A4u;HL)oLtp$MC=}7%7}x6tljOycb$y%oPe6w?K(T47g~fr0ydJm! z&_~IeH`i+TN#SXj+6NcJRXoc`WJPQfSWUr4vQr<5ZMi0C(b@Bw{TszXa8?2JW9`ic z0AbdtWrL$t_OC#yYI+VNkRWYu{!`DVWDvLGt?G9V!rUxkU@}!k*ee~t#%~9J#hYF- zW%}L1~VRxWA>g-#te@irFK(PsbsBu331bM|Cw8j)Ks<@FUasfOuVFEU(ab2|)E9IG|BAr$ zLLi)Oz_^L;*Q_g8hGE6n#XwfgP=k2j^{Q7##|B!{gT# zW?Yeda?rM8=mqL*p72C@JS}tK0APu^EAZj#7FsQKpWd@flVv#VI;Mq`8=jcGeuJR_1}cs@L$o~eg>0NK_n2P5JFt)6|Et*9Lm&g&uLSdsp_VoclKP<`m0;m5Zh<|%pd)Kw zoaiFwm_1uEQRuAVdwF5Fe(O6mIveQkRI9#;4xe*XBEn;TBe-ZnZA3wwA&i7(D^L(> za)kPyatToQ7NOpjIpSZKe7PMi6~=2HRd9cD{9_Tk_mi4JG{?iAee1>F;AFk9{QEVh$5HL+uH7O)^2u+ za8YvA^^>QuQ;s3a8C%R)hJay{5=?LjB7-yW^cUV6u&43=Ra)WGb3_>yE9fEER{i7b z+N|8>`zwVk_Uy!=ryvyW6$YDFhf~8D0v3*u;`0>l_GmTMbZi+k{UXI_GLC1@Z*#j# z3_Ls|jtU0yOXqtg$#NC4_ja`6z9#qBKJf}qctm%PXMPpQ>meo8r^mARf6ZK}sF_1^vWGw> z3RpH0`G^W>>JcR_h#A|TD99?S7zx)ifgetybHDYv3R!VXE0Z;oFkO`1PEOf`Rwdbi z)dX{ob~&0eG56T{ioIxA6uZQ|qsgqsanbGF`Ex(6GGwVPhGh;6iz$a<++bbh%{Vi% z%(45HrA{D2KPRr=$8+!W&L>@Sx^BT)DUqHze=qX_2J#V^4uv0%h0wK5W`ub=* zWbb2BX*!tG@$KZ1wkzIzVx&WV^?X^l)1ihbWEdxnSz^!K|K_lTKbrNkw?RKA&#w#?Rl@p7MuX#& zp*KZ*F&KpFS9eEa3|tcA>3QY`R}s#=Kz?X-W<{LPRa^ThE$cl+duELQXArdhQ24{} zmH3qbsxR4cq$!rYIt2^a(qKz+tjn|7XC=@a*t}&VEZQ8%*5E3&_n%eBCzcC2)sEgb zRV)0OvJ28l^4S$?eVJ)}Y3{?*`ggHAa71<(b96= z(>07MqpZxznT~Lwo3#y*;wyy}2LJ)EePB!U z1rID{ims$TPAd-LAY*xuisbN6HO5u)D*p{CHiTjLBrNEfO=ZPUdD_ikWJ}VB&&sX1 z^?P15-v?FYETa7M3JR3pX4}t-=aAP@Eq(eDYZybQNjwFl3fl1wz(&gOidl`Ycqb;# zEs6T_%kNZCme$s+q(sNk+K3ufl&+Swq_HP8YR}*bNUtvFOih53#oev*BR0FPt_Eqs z_^G|1HtXmLFv_G8QfjhlL|z|-kdrXe(h?SR2LK+Ac*jNJ$v|1DFJNRsbCd04pOLbP z0Ic?U5^UlKqa49C^2tpTKUy1>$+>?oC*Qcoo6^w3z*yUqF?v>n8d<8813+w`GHG3c zW@8m@OCd&j1@QUa8hp@`?3?RhOC2Ye-uq59mwhisF&BmTC7CMRO47M8TTUJe$aUM$ z(KWyR9}9>hiVPBPPd`avRgtlROSWUcaNN~w$g=-r0g|rj#Z>>RGJa!!%?E%{<3&Dx zA8PAEs1W&_pOgTXD<+gWKR};hLosO8iHsh@k`ve87Q5CDG{`InIYIF!0u@!VjItKm zjO>QgznHj7w&?CAh|FQ1ACEpNI(A>9(=8W#X@;Uxn}nqtl*?o!87#{oy$YqZ;0i)fAODW-%KfBC|N;r*VsBGR~-WV3!9 z51xR4OgG2c+_iQGmcS+|D7kB|x@~_8m=k*_5J<6W=06UdK+wy(W`5tC&0YirT!pT!DSR3;od0$E_6EFaC?y*n)AYA|#1TOT z@gW1+Bu;0Oup$fob`g5|g<$=hyst1H(Xn*4{%^o*=7W zIXlg~9WMeuqY29_o@Sj!7#uV$)5r^31(EJQ8!@;*`4DgU%>&PGYcg+DTAlE_c1Z8^ zyGDhi*}1{;lhziC>*bqT+p*rq7&~uRYOz`P4%QQPhMD}pm)WffO`}Is$zicnvBnWW zi>L8ME@V6(ZuN8;nRvWI4}s2vs7VW27tAjvv%sA>9+wCcZKdZrISGR~`9`e_%w75c z;FHqmIIE@M6vKp4)k*{)ZOC@PSQL?jIpw~y-|$I;%Yo$JYvTPdKu|C0NOtyQt7p!V zZIcOIi<$jflF&IGSYy<7Tit7w>7SY#bbBr9U)^D)C5h0Ogoi=-9=<;NsMMU%arO($ znGOWh)y0i>+-YJ0q^$BBOaQmb4Rpy~FcH+K(S1;VBt}*(soG?Hg|&?y z5`PF*?J4f?mol?M9+JG^aayNc{odolalcc`gU(J3WZtU|x=p4JWSZH;`souF zaLMG~kJlJU?KkLrtR@2mX1;eDyLyqwQ>q$+4l%&XsI#v{^=(>qdspKTCy;-Q8>t-e zGQN?&e7RLW=Y9NF6|v;v%KQS`yF*E30cufQtf+6sI$OYR>S4fRsM8EdN?L3%N&;zP zMoA7=5%C#aOd`qSs*jd*eDkR47i$>Wwg@$%-_Fjv@8sN5aVz0+{)N4b4>{`!1XjcJ z-S|IS7ve(MNtITxun&5x*|{p@)W5}q84syumkySvIsPJ84S4fj9eF%lRjKo$3+9cu z5MOGj2a=2tH_gya8z@_=I=n|=HlU|c-ZOv$+n8ub*>IYtdPw1L5U7oK;v5vK7O3jM zYvGMW-obzJ^d@yao>0rp{JlA`@IrZVw9_D_l(4`Yd?7U)YEt~miGjgjY_1yS(_=ej zUZW*(o^*YNSuaWfdH4>@$@PQyrhm(ZW!&pGxjy*o4@< zDxb=sE!A7b=0!UR-;DG>|HjvTHcs~Gk}qlz#3x?4V%ECFurq#|Hq>L6_b;`9)6j$Kfp?1#kek0-~uYGDN_ROkBfN zNZ)0e~S0 zA!8WA1!SYHm0jJ~X5whw5C7~e8DW&N>eu?Ai2*q~w;w=$SzH)c+OAz}=dzLhP*;nu zgh@zwXF(9`e%KnUp7#coi(F#WY)lj}Q}+SVz3S9k>&0x}-ssw~@ZDEmHe`wbUDrpI zcY>JF4dRPLo&$gzI&5Ez&53x&dpgN zd_wmJyqIprLo3Bz6LzLUPgl34HEag34+8=^`EE9CTrEO8Enc08=S>BF%nn96k&|?c zUC+U<;Z?q=! z$k-6kO9fpXDzZY(OL)Gom%);nNgz&n>?jb*QgU9B*$tKW(?*#p(@Td+GkYo3GI zJDHo1Sr)|CWzU@X8R(9W0+xoiAvgn(G(~a%<{0BTMd4fWeo#Lm0W_rYm^oZP!k=6u zn@$fgbjZA-secWZ=lwD9cDuHR;QIaizTwhfuEh5b3RrPve;-(xlX&DawPi1K9`}j> z-91o`S$_a{0^&gR0r}rUi;A1IBc?G&EnX(uO>)qpzM3FpA_HZEE{AH!7mkSTCq)Ix z*=~5S#D_F3U5nr+GIs1yPwK_*GW>Dtf0l;o#ZOv5)VpOszwh~T1!!F56sm%-f$_B5e zoDNw)ah}r!QBP6^Oe#KAndB_S3C1mtGItgpD()i)$b+P9}>JCZzqiD zGl=iM79RjK_H$|CbUlV5GfhvC{|!nE={#ccIy0OOxnFHx%m9&L-(JfgsG^mRV&?CB zE;FSNUY|&NAcyqolvI9n_O#cMc_uE6t`^lNk(Jb5dG|P5y*WA;#xB!>k(ntxnaC$$ zj~&h>DG6t>Ef8U5vT>&}GlL7W3J&oIbI?A~z0r-A%AL@+hf!*%t`uQiorqPzX&b6e zQbGE=ZvvyIjc00%} zeePxWyp|G|yJ7td7np z9rU7C&s5^dQ^>zIcpjwKr&eUk4cJ+Vub?6LQuS5kFRVcfw-@5AZs2q1q-+^_Mdmcp zUs07APOiIhHhxvL`P$F1+quHumr^vlyW83pRddmmW6mZr$+oGvI;T@}C(syAueIVJ z;D6V({*SD93`w?F(8lT&yClQK>el5V#qdT2px**d>P499@XSv*&+P9oeH zSyxp!e)fJ4^PJ7nox@4&kexu*H5OACJvjwY2|Ir zfnIcS{$u2+BHAAf{3{arpyFfGdtlnp+61eHQva&mGTW8Z6|_1;>;M46k7e%Qhg~R6 z-PuJDsQ*xJtOd=I(rJbdv8aDQCkF>fChN}5O8ZPiGavQy*14}q9JSs5-TwSRc=tv^cf8l!&~{WGwlSs1E+3ePAb9RTF*^|2 zd=XN+Rn3*6U4N8n*W5`DgQkP{h~psf{^Dn*%$*F<^1?H()EuA9wKKt;Hi@!M=4XN= zwDhxtmdcZ{==1|XxS^6V@F&xZo$R`(UZJI0#dmB(v_$QgHwkPHv?5u}CKn-;B2X~&oTrLlS>^);1jjUr6L-pqU zBOz1k{7?f4%37*x2GX-R#VIE-3+iK4R3GyxdvSP?tD;=#vz#`?IMcJlC3xf7)h7mE zc;#f#+EbJ_jmSENrz_Dk+B|8-ycj8D(`4HYn9roO;bgDo@;WcL=kTey0C2sDQ~&yQ zfc>m3sB%#PzMB0DoAywDhF=O>+kDSsUtM9FAym~B*Ny9GXgD2sivnpybGxS-(1Ng| z$kZm(*-E-?a)JG)L#Fww$9Hx`H?!<)b%uQfI$%M$lZ{-fiG$XJi5tRwrN`yPM5pDS zR2k(4S&j7{=5Lu)V6)y3Jzyac+v;B*_L|hgzqqTLQ&G6&nOzZ+_7Ex_ACMY>d6l1e zEK ztpq155GSy}$fA|ofjtHYKDmk=^+yFnOSX)u=x7f> zYj?vdn3oiSkCBi_RJ7i z$N1=~M)b>pPgD5$#w_@oW!_$#K&JixM|GS|l1Sd~Ned!E}FOv&X|9B`eePu}kB zQm&I3ReT-DPeO+^@Ke@bF~qV63n)=aaWXv1ea!XyHPu!4$a<&j6N}WkPmUIK%N?U@ z2&`K*t~MSVF&l@=(@~h2AoxBdx=axx(UiOR(EyTfG*<8Uu7L)%buQtXSq`kW{dKt$ zTkT;b`f-LyRv*dCU#`70TE-=9a*334^Et+op9l!KN#4y^k2aM$J|N@sVUr*z?)P<0`0M>RGg7?`XoRh|@#zw5`nBM?NUY|njb%gV-}#c@j$7oj-=wlMFZ%RRF_tYcuhk^`#;D5lB)Pt{*rf$*{}RAv;o5Bn@e0guzt$4qCa zVqqCawZYJpXRF)rV?wiE9h}A&E8q6Hm+Jdp@&8O=cXqu{uuP^5aj?y*Y{RV#-FOD? z&cl$WS~$^oiY7bQZr1e{0yxdHskc*ULq*S%MCY!li{X4E8^sco;d8uS^!rtE%KG)b z)oEj>nLuPHIj1Tnw(kItz-Z?#s>AeiJ(pl}@_)0`qS#Ki#uj$%&1NnuC3ODrK(?_Z zf6R^j(pZ7@AlqhVr#+%TwC*>ManR^{cSP#T8f1E`oyDJd=Cp5p{kwfo>Xjo|(#$dK1+G z5z?~|{iI!_2hxfS)4S?|FeoDTh%Q}fyEpTl(jHc*W$A$wNP_j06h)W73cd-{*ABTD zf6ljX|GP1{S0|gI)R9$-S;Eq_S>0?>cmQx!4~FnJa0E*CX7=iFQPvGZOb5<3X|W2B z7WZMN`xowZf%k#+>53W3nl7!Mt$R`q@T8-AbMOOr?p3 zxsrS-P!$M+(5`Ura5Cdqsvblx@6H221V)sBAX(mDaMpu_pu~H%B-Z(A%PssN|fNAKsRO@1Ht_cC*$d-9hZMYtEerJ3_OO6>_7jc zo-z`p2lUSi`ns%Lav$7%F7a_WzO=exNHeO-#2i=FfJrI3@WHLaT05XPuXu4AGN5+Z z+U~FYCuQQ+ELOWk32t!vTBqeT%Yh;_^=-bJEHb-8%qw}tnY^~KvBoyQ5BCorok=H? z{RB^)HA%9&Yx@B4b%@>JdS#%;hN>iXIp=(gmZ#I4dadW(FtZT@^c4(cZ-QEdW=ElldsJg1A!NqaUmDEB^-n6@19 z+WSO)Vs*~Q6Y2}~6yDKI`h?~x&d&C*9r1sb3x%SgFW_Rrr1NG?&^9X{=oYJ1D|13Z zA*FUmrV-DOddRln5c+|xu`!N1tCp0I>y|Q8*j4GGr5DItqk%61(9>MBiP`(hj`i8^ ztiBrNvZ3VU)=wc>#;kTC0tPF#LukpJ-8Z)q>*lRi zUrbn0)_e)o<*Q#PuYDI=3KL8D>&=EpWyT5rNV>@+S~a<>sV>I5^LC5Ch(`34sy>0dLfup9JNh;V73isE0!RhE!dtv-~*(`{;; z=)AQKWAZtvu+m?@#?CYHy1H+Jd}(S?Gfxu}qkAHOVg{0dqLlJUO{9_x{?}I9; z4MW`fMkPsta&j5xubF8c0E$xjf}tz^MW!use;-BQkV|+4n284gI64%w0fAklb%OHF z11h8iLA%S6p>>ihLG6}73dx8ZLuT%2%r}o07Y%cv28tL^R8ws$BOaqLIbbo2Ra2Yi z<0|z0t1!gG{A;X6NELdhsDIP_{;!>yt)V9xd+Z%PxD546)PR#JAHFI+<#Y+Ir$1eP zcM&4sMK^6CKpV8HBVnoP0w%{{mAq(?8wju3RJgsJa|Qjcc>T$SlfI;UPsQ6H`-1j? zs?OZxj1SXr6nhNkK{N%(DhIF;F$TOznad84bLOEn%41$@(S1J@6*biOKDTT1A22qJ z?Jgglm$2xOy+Bw@S<6+D`DPHKy=%tY&k$ zn1jTEA(l$h?Nv+zo?-?GO-kosew3vSCS_>#L^&%CZ4**+?g^#wHdpx?i1j|TIN>-Z zzM@rRP4w-mbNtBc|MKEdw*Tk)bMbriki}hz8&K5zqEB6hd&BuYZ_o*3toip5P3dP% z^A^LJLDs{P6W6QLALPCZ%+5;Cg_vBpbQaSeJ$h&q9-?w;|31qD1m2T*x<7a*0Zw5+7F%mVYs zRhno~ZP=8GgL2!hf|f=FvwJ;5fSaKyg3@QejTnly7`=)Em^Eq2=pSlsb}cTb+^@AwriZfOlaXG^68}8vOBlF z|1ie3h*7}S9%J{S()HQf@ggP^Q=a<+9sTqS4MGJq8K?~E<$PX9s(o8ZmADyIYldm| z&$owla6XW^>@)C2iE;Z%;q2|_Y)2~wRPU}iFq%pfU`yp^X!X+hfwyV!DWYUW#F1ai zExID1I~h;D#JiLarVD%nU!O@(IXRxCf$p>?9{S*Rg>f0y$4WhHwiavHUtX_aIH1WC zGagvkN|QA!tsE$?SHE2u*4=!2U?syMz(QHs!YhUs2DX=tIdvvf@cdV!TlelA%C4)c z2M@htu|ZE6^->^mYj)vvn-6--*-a9L=rGx{|*{`O$7<;5+$#m9fMZa4+%Inc$kNoVPj@riO2i%u|t~mXi{+mrU|WdZ}Al7 z4?ja_`WDqU9PiQ-?2m~4imMtn4$UWm2_787YlP-8Y(z!9P1Aex_zN9^>S0*TOvK?= zy^iG`r-yH*(k}%X zrjqPdc_;zxCEf6;-oPNzbbj^w*1GG1SeJf16Q1Y4gh3gQrHg4T?ev~WWrbP&A=xgT zcAQhaFC-$~2Z|Z1_fsJK$7ws6U)&54F|zQaE)$DGWy{Q|pmL z@wHV$568)RH_H00nmD_l%7l#3(dGSxs)w6?jyV|x3yaSsV>NDuBTTxl)WA;p-0zwH zN-tz>e5rC<;ckTkTl}k<)+2Q7LbBpz#5_MRD$cU?l(kHFMu+gs>*Eo5 z9UdJ@XN-Sbl@;lfR5GgnkjPZWPJu`FWtzKI6X#O>*e(LmDs7z|F^y4({p1b#iixz@ z!XmD&q9NR`1n@ZccdT&luLwD7S=s#3_xhfP_eI!qrLurhEu;BS3!Dbe)`vIx6C(qa z;G{6jZ}7Exgy}#<7WG~?M)G}8<>YR&PqMGoSu?h7^XJ#&@9|e?FW{axyv>MxV?^wB z!}n24#r97JstiLIa*OJNr%N$hzEd9CRY|<__X)}Ku&qVDpS(|VGo>0w<auG88z-TK~{buT;G6IMsb9vtJaR(o}wSLSJ zI|jGyfc6E~oy)i@-)XC#y@pRGMhBZOvVEOZl+1QJ{Be{514xU=Ee~F9biPDckBF0f z8T~>uF5hu-e6;My%}4c>k+7@1rG@W%PX| zOCMW0S`42v{E)&k?eH*>U)({~)%(hffb-QF{r{k}=yU`_ia@PhCIcD5<}#su&Ke8& zvfU_qC64@)pt-))j)~I#mLnHOylM7gf{d)sx~Fvov-UrXJ4( zt<<$vj?J!z23oq2qN-Q)EPP3;9)#wR{`Vyg%L$8Bm!LW?FU8y`ArR|v-G5oX`eqi* zTHFvR##Rh5)$@AMv6xuKrD-4+a=z{KNm_LFvaVt*LxT+WG^7^Ck%iOseQ#55f6BW* z2CGb|9Z$m0jit?%Kh*g-jG2Y}blOD#9mK?q)l{#Pe|8+rDX&V5;dkm;Cb0OlDd8=3 z0qX?b_Lq(xJ4Ej7YwBUAMXPX_o>;?Sl&t%%f#Q&2xaEna$z>bLZrJwQ?qZ6pnHz$v zFRdnRG*MfXm~w?Rr|VhlHurU?}J`F?1!5u!mK|Vw6qpNp8S~>ipeN?5SrTKXbF-A49Wvi1a&wSL0jN zy_vG4$}%eON0xD{FMo`I$aU7W-Y)|)??bDqM{Y;FAUWiWXVQVr^%0{ki9hF?26yZu ztruo8)hV45Xz%rn3$PSbKPUf82ChK{Nrcc`r-__w4@)-Nahdt!v?^sjI`FE0tQ;I# zOat4OjcBI6qTpU)6VNW4pCWI)hwnLoIfGQbW{VrG$_;FJ{GKM*FoRf<$Z2z08fEzh zP_SHm?@-`Pid|^ni%b;Nl`U=9MQJMYp+U^0hwLu@t--TQ@+<6aa&+PEe&9iuwsmI`mX>>C&{9-o*L{WT|>X3eNCd+X>TFY!~LGNK@ z#F5x9?$*j8e5I&tdk*58=nN(A4@Dam48rBqA+^?Znyg(@C+H-@krqvLv8oVKZ^jB7t1UD8<#Yfjj@rHi?_ilW(;Tpl(eyZNios-%VokOOFI99u{RHg zy6yjmRZ5abb} zQHQ~fa^)0~kp^fTcGk9f>w}POc#rXWdT+YUy%qlKAMcwa1pI>!0G-aU2H!!t8NgS; z_x$%V>Wtta4n92n^%QySJAj0;LRwyDp8ev_Z*hM*&L(|GIB)mq>xT6Avr2z+Y`sQi;*G2Yk;U987uhqwska9m*OPe5I9&oE7fEAGkrl|R^t z`&;((pVWf?7V7?gKRGTYnld7FewXPd3;E?oI~zBky54(^9k&<{P|lRs^AW@F$*T_= zEVcBC*4^CDM>{ToYX^Q!8pi7$y~Vr4>-n!`68T;>$Yc1o{aViqSfg&w2cSOc<8en5 zONt9-3>gRo-1cimP40e}q#jf1GZwKtrW0jX>jVIlEqn$>eq{7K%mGSMK2%z*Dq2=` z#0Xl%hf6L$a(FcAmG2+5XFyh5L4E}rHuwcfP>d?VS{}W>`Lnccm>6#|+TuzaeY+wP zV6wbIr#Jg;{V@H5+a}4q0Mw?l1Q<1=0U}6%XUy=B^Xf!l+Vkj`y*;WF38bMDv{_$q ztx8djbJbmqH{DOCHr^2Xe8#SPOZugMZm{ppbal$|>R_;^L3}X7g}@FhFcS*uS7;Y) zpZKcG6Z|J}4q@iuKmY3JgZjO3q1ZVz)tPC@8!Y3r+dxm6CBf41rcEFp5-b^16R>{s zP_`SVJmUMS0e{wYxGNZcUPH*uVy|%qlzsj2q@9}{q8@)fFsLA{&uR2(O|nsxf70z; zEwwATPpxx}g%_<4r^QFI8}by%%Mz;Y2q(}eGIRRZ$G$?K zB6lMxXgoM-QTW)9Ji#)5RMaV{1rUM{M<1t~i+D!+z^lI8m^wbZO!@e9`}*ay#p4YH z>*gR5X7)od8Lzc}maM(dojVUcy~3MXuk0@(@l#I5St~k@G;UU(C-9K!`di!SP7Kd- z>!TfHO5AiXYFaUH@qeoQj-GCz$wWiaQkRU*mPOviUrZ$B#7)nVHw%lOn<+}A>RV0f znW+{o4pV7%oo0nRgzMp_I09CX=CfquBUxcl>Mhy@#JM2}^2VofHQ95{V^~{~u$^tE zpJT|dz<^YZ1bHqfeYXN^MiX-fMS@(%v_Vp|0jk(hI?&^_!$blxbLdDvIc}S2#ogT< zE_YS!#G3qqcqXxA{HsmH zr=9M!qGjuISx*c81S6sn3zyB`Si-Z-GvQuOOP0r!1}n|S{FTfq-&uh4xT$}#3ri{b31R-~kS&n^M&Wsvv`4R) zXJt}?*-KMxrqJT2hi4dH4_p!~di-I>v3z_nrhj1f1r$|w*g_iKJV+zZ?#-KIwkx5z z%WJi$VdoTIjwoC{eX4;vitr5Z>e-y7@JY_}j9vOWYWoz^MJATJEKj5^=kXkxz)jqd zbuK;Ax18C8$J+*CK`Lg5WRBN_?TCX^ zts-)r%ko!IO7qtw)r$PHm3Ky8h)(_8TKn4xH)U*h90>p3aLilP9hPS*xh9_S zYfpMjU!w#Y(6Xz_9`}!I8p(@q$X)OHi)mf^@cxvo!L|WjNJGM!#V7UBFx{!r(z+Y` zD{73u?;u>5sOz>{hCGL&iSCQCwCuX<0HP1(+949)F1Fu{=JQ^kt#(Ip`sq{WH9YKY zkNZBwU)f=2A5N^FW1&5TBn#N5NzxH zcbfh8S-b97YrG~eMbW`Tc8&++fkRY|~+d_B3wh+J}g1#0dT&{-=?=w+rGFSudLCyfnQ%uYEe^h2+OGADB)$ z%E!@A#oE<$1zL20@x8XnK%uT?oA2K$D|quixbddmwAkloewQk=aJ!B4-nN);qLlV( z0@Yy~!lH82N(TfrBjIO4MMh*7;MJQ9Ub+UhIqQcVG#kcMAMonsLKKz`z7#J>fHT`00<04d;tvyfZ=T6@< z8A1C*{wh<}9_x!KO4^05TvlJI9fL^`+RItMd6uS#L zMtjx4CnA+JHgkLZNpdH;ywcoT8_o}PEsPB)jYaD}A1=Gr)0ilyEw;Y(N%nkNi+5{tkz6lD;5(MoNmmAaMgNE0(dr zIPg;1d)S)o-ZvQ^Usjy8^>#r;#n{+1q;aD=)u7i(_z0+(!OH4>z+D0`q7iO%16rYS zH$))(E0S#&B4WE@>MoexUqcazC04nc<(cQLnow9?Crc>Y1}AzP)1a5C=^@_Z$9^` zc=_OJbiprcxV1)Nkrfo)Y@S|XsVQ8Qlv}b)_3nT>I5;7=&8Zm~KfAoVnBm+vi(Jc9 zCJ~L(lcSiHunGGWg0EnAdfBq_Wx>hE!ZEPD@N* zeFj@A@RL5g~0=40Inxg~4T6UYLO9`7jD%Bpa9-gDwQNZc;Y~ld*iRYVDmPl-&R{4~B z&9b1Q_4G8>KhwI?pSP@hiqMfPNtl0V896mZLBM1MuDTAp5(JA9ll8sBwP#W@ zCZ`Z4yJ;~r_IOy)Fjr$JOxM_|TLQ|q{4^v-@tyZIOvcSi#J17^ciV}bKc|W>$txoG zbjH_ypsJTuof}H)KN*jyHbhnzJ3GI`wB2mP#<@PI`OLu`sodT1oHM8-2ddPnaJ+vs zF@60#!EYhAY6j(f!g|Vb8rpH^J@rQ(bh6)FQl0Bd@0NmWqL9S5$4S?jroqO;JMmHo zWrLc!VTIM(ok|&kVU@h*<~0#|afGpnD-oyL#9qfKKGeVDqjUK3`3rC~INtiPHD4Db zHe2khAUlY}k+Ad8>fT3Jpc*>AVxCg-c>gi?Yfip}6EC}^e#K+$54*r$+BS|Lt0x$& z>p|YgL%~p%ycP3|`{eFY=gK89=<Eb| zzRP>=$N&&Pa$K0-ASx6Ej?iZeJ0UixTeS^V2eX^wyMIH#g1{E=fib8W-Nx|(L{6Z= z9)_s_9(aB^Id$=p>B+D5t;6a!5pHRLedcv3dV!^f;-gWK+?4dZF{3abP(x+i!4G>! zBWQY^9hUP4ue`Z|$#=0@>ooBUgAf)uRh){`(mQSjg&I6*cLP%mgOB_mn{sTbNh5X z41`dXX#MJG{H5axtryxGuO*dD9HQg&mA4SU>riL>on+7QCoX?V)p zz0EC@Ajlkj?e%PhYzSg~p8exc<{&vx6Ue`3&eQ&4qSSRfl8*EBio@Nhd;N`DU#1`s z^~hZ)>a;;}{X{(<(}^!{&Z%0Ujb=E*=0UyucV;U9w;1gzD6WcbbSOZ-5up+~i9Rz; z>u7I|nX0t^Tt{(6msxe*J2Z$`UUo5#0C z-1OH5YNf73ywI>YYE(C4d4+VGO(u+Xc260SCt>6ru8Q*WVe_Xg+Ev{mrY>B~uZHT@ zrCr^WK5lttD6Z8~Zc}2<{oo7~tVLV>=^KyYbZ?e@<(MeGh^c@Rw2R=0TQ(~eZzjIP zw{KcF8+0 zeg2N0D%;zC!w1LcZj4Edi#hH1hSK$u#XoALrb3M=5;2eUxNpAd8i$cHpf`T${h}U> zK+a2eC%*Y?Aze6HuxY??SQbVIkK&p>K()@2^+DW|tFyI6c`>OQpUIF;4*oyNoEawz zZ11^)dA_viN^uut5;;u zUoC9MXB?3odW;{lJ9Z2$)xBA5q;sWX7{zn+2rLpc^-4=Go2k=TcW4^#q!}Y8e@=8GUGY4cbIC7|0(2|yn;1b*2Zzv1 z+m+^?%Qz9?5z*oN$jJphKE5p|baLsH`lqB_-_fO$GbZ#-YIp+UYP!{g$uVdDGvzAM z-=8rF_lh0+8$RlzE0cHfxM%@$a%T+j{p5iNx(snSv>)e^Rq)4O)qQhfYjfHo0I~1$ z-aC%+d-J-+I=(fR&7r>N-(V5Tej;#F1YlYH=0G$_%sLEy%ZLiQ5csOiPHoubosPz+ z`#d1LJU6zHcUeez1JMwl`^Y!}H^Fb^<<#eRboG?YFKavfE_%`Ug0uI?&~pYxkC6i~ z%%cM_W7dG!4@}7<*4gZ5_jI5M@|L5&8)YM_u;BUG?BHtAs-HtM*Q@*)N|OBvNvFJvE_vV2J}yFE35Y(`P)u6pMZO=uLN9*I`$Ue zoH?JLRtI{y2o+|(vJ?H`3W0}4G!t?N3Ew5`jI4u$*l~ii)gD6CKz5B#m|7cyZ&Y0? zJ5nNWe_A^eS zQ{^a*dR9NfAZFxM#4fAnlW*kvPj(fzMi=_+>RU!~TUBzCepTp5^@i(?o2C4x;6(ui zuO<060kjV2mJGDt=+1Mn1#)!yFSJJnBIwF+qK<20>I3_w4!+ZdkzO|)nLJKIilYLG zGF`-Jv%5D@U3(y4cW>jtKJxMg_Re{)hzFmW2k8z(Ja^^E=zf6L;hooqJ3z4h`b0%9+$CAcM^T>j`WFlqf;L4CCg#IM0c1DOgcCx&06tCFLtpCtW(+g+nz zqOjmHA$Z;IDK=r~qx$A8al(uZ&LZQ`cK!L8try=bx7-%`b+7iZ}T$!h>Xq`f(Z zVF=5eKyFb{b*L=}faW59^8p(Nh&%+Y!yNJ9BW7v7SO6aEBisQ<|5PLm(1BiR-oOFh zAS&f37yqY~4)og{#dBT^yZ`4F5&gg4BiRM~8^t&d_#9wGAWnEt5uu z#<&Qz3gLV0i$Z-;eek#H%Dfo!O))-BgV*XlTB6-6T2h=oCXMqK9^xB@*5n%0mQx8m z#&u12?B|q-o|9GY<-ENW5&|E`@lQ`DAA6k5#NZ3HsKUo$ACX{OhKoUYm&SKA=VPR-)8`?l(Hs?TlRmPx&hc9Ifn5yQ>DXMDjw#h)`GdQAw;ol3u*;+R96Nkj9z zx#kDsz0(utz;CA%v-_46mE%197n8=y)~eblidMA;KM?96+C`71zxg+3bNqk&cmEwD z^dC9OKTn?6R|1OEY`WNIK&WULIQcMcs^~Qi6~jJvBfKuW19^HE6oIVWYad`0 zFy7lcs;s3|y{h7H?SWib0E10}GWKHy$rL`IDl?Zc|KKw$2B(rFaLmv>wo2A_fMq#A z=$!VzuZ`VYyTvgZZcNM1jZwWkrBhrW?pc}z;GPrTdp*;)7z&(O%xIb+xD!bzy-Sg% zcH6QLmD0)r=S|apzB^Y=)`%s>YhC&RMXw|D{o);eI3{Z~-M%gqH-16Z8sV3Q=?kF2 zx38Yr{K+V<=>IQmlnrolRnD@?s-HYGHkz*pd7jMyz>^&CnJbvA$Ca!k_ETfy9eGzi znFh+gt{YO!`YOgd&X@mHBuUU_WIwoV^7k&Rd|$xGeI;a*e!gYCxH^#p1J)p6nshHu zmTex-ELO{G<+pyd*8^)-a<5W9WAow9s-1q*(?8`h5yXB2of%vIZdpE)?Bxx-E@mFt zdX6Lih-I8LpMC^fWgYNb{>+uM&S0SS0KH&bLfs$oRoPJRipkR$^t5J&nvY%bIaf&Z zVqdv&tG{G97|?76k5#yc1rT!S0YD%96K+1-Te^`uW2rTWQ?ga=owj$&PsKAdAXwMsUXxfnZypOlA zY{s=2LHAl*-rIYjF)e8ksq7VJSTGTc-)fSS*%#g60unJZUv`yC|HUK{Y9T%sdq1sf zuJwwLd5)*R(CBW{f?hnm?}D9LGDe{+dl{*QIzCqFJ$Sx@Pz^~)K)WBl)o zCJvMPm-m)wMG~j5KgOxRej5=@LlGe{^`O^CL3Palbg0PS^OvppJeQ3A)5@&pF$ z7H2!C7BL+3Zof@slSoKEh%V|bT3*$8_9)QOwy8C$i`l;>*!WT zmEl77soi0GU-%L!YOptj3eTXld(e<7e*J{&d>WEDck8e9uwUHbs{Z&bSgJ4MZA;%Y z><-{rNa69vZ67S5Z~Xe7Ew={vIXXkdK9hTTI9Tb{^%zlIS}xJGzW<)zy?Zoto4t$% z(b;>eln|=oN8GHfc)I8=M73?_m70xApPQ$nA-d=#pX*g#Q%E`&%X}3&B3w4GaPCJ- zV8($(SFQ$OuOnIg<>mNp9ADg)>ssNA+45vXtTJO1>^vq`h%#IIPw)W>C zG;zN50KPc7=24bA5hi5WUp{Ly8CZsODfuQ@wt6U|4+{agKv9DIabSi0=ErE7Jv-nk=aIzBi3*pKwWd#0ix$XRux+C^po+a zws>w0Fil)yJ#`~yhJ*ax;CuN{@BHjJ?gXx50q1S?FFyv!pPmo+qGpoAgt96I&cr!s z74b<5xG;GlhZqo}!4`Uo=0tAkvOWmR=@dCfURiF=t2&$3=jxI{-PreCSB1Wt`nwNXF|V5p-I;iTGZ}*(GBu?TGf+rs2&qs zQ-hs4(A`GD28qN=Swx!hWmxd%EPfXm66Keuk!$OXmrdKT{Zx*bWEE#MS z?c>+Si*W1Wf3g&c;a2N18etqe>S(4F@Q)q_+vuS@10WD;1L)k~PFRC|V0_mw4Kfc& zRM?E2J;}JaoZ0-=0(XvL5xrhN_ICu^HhIiA*K_&z3 zQWAFRRI%!3KZ9>%WBFGrC<4YzYV~M!AC^(>jZzNqr4P)2XjhT+i?(F8`OMc?WpWR7 zoFWoW7M*X*MZk*;DWc}dhw^iqoxS$jad-UZp^4{E|!{Yr~L@ zPgOt{j5@~ng(O?b{nDb|ByUvs%zGu;@zY*Xjt{Y=4>36CSH={QMMCe6>|RTM?XQ}M zOAb>?oBQhchVvjf(eKWwaYvtct*`*WiQd+W;=%pa=Wed5$XXU}j~+;+Nv0%2aeWp? z!KgOAb;O}%_$Zic1)4n3Ugl1O9zC+7$X0+}gdd}yA-~@f%t)R?aF}2(2w83{#tlhT z-6PsFCTXwc*G*@QA}l?`M&vBC$c>RD%gx{>gLG+OKL5&0Mg7)`sNEua^tR__wrRRP z;&-OkY6W=6i)unMA|V06Rh`@ya0Ek`c?3F$sS2m1mwo8XQr9bn9uP%}+RCDBA_v4SlSiT~6jH_X{pld;l z9{Nf)wPJ+&*zGaHvIQBt%(GYT)8(TtyGdT9fmYSHO*FY5Y6@zdy;=0IOYn8lwZexf zJ%ZQH#Kasg|9I>%6Vq{=<+|8^5XE*h4X6a#4dZi_iMriK8dF$n8_Zu!>~x6aW#>2{ zDzGzhXMH>B^KFXn92@#ZGr6;#pouXk54n*_%b%Trr5&AJY($FA0n;n4B72~)2vq&p zD|oe?IO;X-+JtgPt7p*f^Mqe3g1OUG1ChJ>@jQvlg1ZgXIWnEqDb|*5dwX2MAKg9f zt1P#8fr7&E(Z3(qqRN2i{A>^84ZyvMn#ciQ@pIt{tFuBsS41w;0w@-b;&$9qrKXf4 z=|x<;-GRcTWYX8Z1pUK~Uh{hpQU=NbRy3-U=4{p1~J$y(ofd<%)uP&`PDY}F& zE%^Cz0{R>lO(N_JExt!YbTCwuC?j$RqsYZHu!Tu!57z&Bu$Q^FXDk|Z`r(sfsdiRH zjuA6FsX@P!_je@8$6VMGJq=75gZ{{x<&!q@@z!UmMZ;f_vSlQ8~Ih=ugY6m zx)FAdx<7q%J&@<*pc<$91&J3|mY!Ol&j#AnSL;ZZ_-_@8robTr@yf^yccz$|tHT&) zjDYfFu4k>6G_5*A)*@}jjqQQYVdW4PUwVcQR7}4}0)C4DqS|gyM-CuJ|pH5z1(i!qlURC$AXQAs*hidX~FN)>S#`dTVbF-^xT6B;(mXSH-OX`oG7i1$dOE!p-8j= zDB}d~8ab-!Tt$iT$^di1OJZ{k?zMvRyz$6danrD$lCRt)#n>^OhW5@Y9Y1q8cFhou;P{;jsni)AcM)1n8<+SYirQwZ)=TolP zwcT&rGPL}E$ssn^D(TH{7mRJtzYi3TJe!3ie8YtQlXbEmLajL}3q5}*MOVa9kTE5g zkZ^SiA;3O9Eam0m&KcKd z{OR>+kF^h&dW?1)|449(!F6rd)Y_Y#8%w)@2Ap~MD6917J?_K=K2|ys-RTwUV;$Jh zZKBVY8BlbWnxn2lghqVPUv#w&9fpLleN-aMR8`)MBqgZ`{Xjn=Kp;`7avGaU`(o}q zPKyJ$)#DNW01q0VBRt?r%seXAIPOL;k8~04>4coFae(z)60b_`8e>C(~>iegm zh9yB6H99}uC^dK$3_M@uDRUx3LR{4Fk;`&}bQJNqV>R{w)H@rgZbCvvi`@80hY~9$ zTTgW1&W+0`B4jBKd;Ch>4$OwW#Vca_qF5Dlgj&?z5w4Tut*1IE`eH6aaD9bcBdd37 zNIOt1%lgx~SwbDL0UcA{giyc>yS}lu0wl6eGLIzgjS1eud)CHTz&F&DE7eV>{$M7H zk1;pB|!HpjvJ`t4d^!paq2Un4=JETuh6G+%oLub zI0aPXLEbB_irJ~@zA&%Sz~oN$a%07Q4oLGGl{!J~_u2I(UGC+E;`m8X+#t!3_$|HI zT?Mvf3;Ld?9kR0)-q3T=TPNjy>_w9T;L%6D`9!A2_qC6ioWE;k229>zVyd?9`3ay9 z03I%apL>gB*SJBqhsB1AP!fQRedkW_fsAg?4ErEm#Vg=k6>=#kJ0qXiGP^FNhCDaD z>fXQATjJ*b$&CwAu6+W#Wv%?+=B?K%){E{$#QN&YEcx`amezqru&Z41>^ZO#IPwCm zqbu{w<>AW0L97r_Pd4+=rOUdtp}ecqHT%hDxU=JZz276dD(0>`lgt^^-`_~LUA}Rq zTUq&y;^GGw$BZUy7s6GZ;jY<5`gjdG_fP^p3`uf+0d#ci7(9 z`IXU-0u51r$e)#`>E)TMo@S$7r@!1SdENvnex$tk9oo`#1bA!OkitrTNy6gS}JD>UohxX;G%{cyB4g znPoTUkTd+(jNnl@PUNnftaLp-K9A>9pAY*zuJ>>4 z8|c7jkm>Y+`6cQL+B^w}6_6m6#^SEiemukwrrSG;mmhu|Z~(GStTK{y$c)_25(i2s z4`hgP=Ecmtp&7RTHfqJhM60Fdqqw-`mW_it-i?j$ePo*i*x3*r1wPv#m&lN*QJRsV zVO-q#qSmXQ+?-wpom($CG%NaUBb|be-^>txTENtEHSH;JH9c(GP|(}n&BrhWAxsAv z%M)JEY)vZ|{&#rO`1Pm%$Ok~cUE8Jwb{IGpK8>o??LtiqL*1o>9XbiO$25d#aR*9) zbP0-bM*;yAvAZqiy2m+@XbfJ<4J4E`HIaW*RsGW8m=rMn75pR8as(;?m!%-N4jb&? z7p`q@T9aCrLe#2%WFh=JW=v-R+?@ zPGq|pNk7}KuJ&g`)k)|Q<(xf{q38ek;2(lmEO*ozZ&n zhm5%OIl2A(N?1

caP@l5%S;``~SW7XXVYCetqK(s=@OMm!aI@s4ubGrgWf_Oax7 z^y_9^uF~ThAz}AAdbSDQ-rbfK<9}lE;%VH9<(iZQwPH!2bnkiA-yEeJ3IF||hZ+K4 zvo3$TH)nYo3|TegG|5X;5AyqD?(C$(c@ExXJ2i^^gkJgg1LfBm7h&#W76E@?>`zG? zJTxPn-hk=C(?d4p&bI?gd;3jx^lzhcQqA|TnieXzW&(;R(StqUS_0{B;$Wu%ngnmO z;$}zgt<4_1Ktt9s#ihx5O{5mwGzBwvna58#lS=5~< z*}I&94FzM0U>_!x>t)U-MFM=Gl^(+c$Kv2YPiIBb-IUwt;i^LwIxegP1BvH z>-+8DQq{VL5!m8A*>zm3pOaESPKYQSIOyjJU>Hazgmw+Gu1MNUw!5ugA9g+k$Qx<- zf`{`dAvthD%K;WXu680xW~{65BpHZF-i(^p^2Y2H`WOQ!tUCUWpoVjP8p{>Yz8<-i03|_&x8rdo! z`9bH^kC9N3cB&L`$AAEQ3!u%&QJ?$@R~k$G2Q&aM*e?Kn-Rw|1@~9~a2+hYP1X*M# z^Nv4EyZ9ASC2(C_yxeW|fd1XOF?y#MsNa4cVd{aOn|+vZfvz=L@M<3Ns=li+%6-BN zM3RX1{o}7yZKd{pDlpo(KJh~5*xmX)4H#XFm$<&6c-j}Q(JG?b&$9uhr&D*<_XKq; z1~NF0m^3hb`E0(9hj+Q{nJX-@Ezx+*=-TOX-?#EzX!+ z(L7es?AyO>F8u9*pC}mUKoQs&rxRWCFr7RPYxQrtkp0b(k=v7WSP^8wJn32Q@~e2Z`s< zFN|!)aq_MjQsg2U*i^L6MkSFrxNglQ6=(|O@7wa!N;$<8F=l5_`xp9Tdn)O-fLqIm zF{+{1iqW_^OqVB@YTGA!BS}Ufkg;9JrN;5YbJ0Y@T-)Ln&22UW;JeXI{Ia;rDv)Il zuR=@wuEgzmwa-5ckKWK-t2*Qe6*)@xFxrbolmOulhLc+G%1~_zGbfPLr_cOOe))j? zt+OGFeVMD~lp$0(`+#yEUhbA1*XDV7zRcQ8Ay~J_VimwA^%}TaLr})Fy&l|o+EXHX zKu@^pxHMLc2xI>Rr0x=`c5<#niM98fy_wJ#5E3A-3xE35Ep-Mq(|@wKNZ!WiBI3RM z?-BdznXgsJzYVE9M`en@sf#8}ZzfbbG!4-O3UrlX$=eh*i331W$s7SRXpv)|4k3Zn zU%EWrxY=>hY}vmv-|4Ia)zT`uGQQ6tqWCjlY|Go7RxWV5{)N|v>P8Y8k|iVKm3Zxg zqb^Oq!{iwPN#TF7jsJV};Q#w2j6m>Q5vt}~J`rJIca)Di^C#6V5d1iM$&!{fH!b-~ zVdgwOJz<<7IaoO-v_S6PNfe)HaAAHhBit-M`+?D(Z8oS@v%B&3>aMl+-c~pgRlWc1 zj>UI+B~6CXL$X){Snm)J2sn$G2_g+1%zTYM@bJOi^_xZdvI+>~1Ak68Yeer|Yvl=V zgk(?9Q*RgK$<`4d5ZJlNu^P{_n8n&q4ld-F=wO`5B}!rAa zqgz7_2r1hd%&4ys1Tv=3_jL?vq-)UHI3g`u@Z?OdR}frmY`gnQ1e!ach*PtzIs~d) zDE;%p*?tG;Aofn_l-mIVUE&&SRv;j|d&izJ{$O~$@S#;6iAuFZcDs8m7(cV`y$Ya%+IZ#o0@W(ZzS+Z zn`Q1+Y|A5B2gdQVtC+PDA7|ZyS=NOpb=ny{`ol$-v2b3R#AD2aPo-VS)f!4;tIMtZ z41!tOS_`@V^`EqrO!rd_l0C(3_KHb1+F{FWn?*& zI|c*h!=4XcXhCN!jl2=J=3c#9cp7oX{a^D!slm7UgYTM-_{pg0)qWmna6goh1CEiB zX8effhuYf4SRHFy}h17dL>o*N1MX*jX%PK^gP-U9kD8rTI{1PtjyFyv{J z^Q6X4^qmG5EdY5j&|{_eD2wp!=+3Bw()EIz0IBup8WWF9^U<0fzC)$WNd;d_z5 zWHLj96@7v3OFN{fQR68M14#^t)q(OAX|z`{JmcF~GfUJ?`{A%YnUT4uFC3YAQ9wA) zeRBC_^9Wi_P8iTyawaOeRs?JuS*0O1!ruZmWc(9hU6RtLe0nggub|I~JgfJ)aTLo& zL>SLH;yD$if|whFyYt~UrqqQT6yWMN2l!zZj6X@nD%}6f__>6JrQg;(9MA_ZZ0*up z{Xcdev^EE!26z7}bM0^35y;u(E~K8o(PFO_A8OLM2eUW3e?nPtS7@R}FO7QQ5z=!# zba6p;>=VVF*mao#y#`xZ@gQLI3%7;RHNT3WCu0ZX-F*aWt481YZ+eSHUe5i(FkpeP zllhYA2y$V!AS4mXf?l!X2Er<;6UGFKU&T~kdgH9J?pd{{i)pF*Y(yPDKZH(r>rFmsVw-AO#jlcPZAa zrUA7mM_fI$m>p3;^RcKItM462c*R4_@%BMTfTrK3%%<4%D*)_8-OtwkgS!?jE%h~x z*;@xIGv9tpoW<~2_~;@K%!YeK*+E%XV)u}eAz${$wtvj`93%^EDetBH3MTHSN)>ksT8%Zhia}%%N}TQ5GkGFKdp0Q> zd;2nsL%Cc3n)v)4AiAlUw6a6vz<#VPMZ%J+1HRNo#IwN*pk8Nb7LcsbykXtp87oMx z(${`!X^_m1(vMh^u<~UhrXgY$mwS8I9GHv=-M$6vSq;d!JXDQR6=mFZh#?#Lc*xUt zGlC$zV!NCj_S=a0FQyBAY62ZHk(JL+z6sPJ1X5RnKfvTn9n>GdOx^`NJH~Z&FullqjcTF#-j;v%`Ag3 zbClPjSOe2;pOYJtLq5{wDZU*ZY$2pgc30|n@Ic3r z{la&z03Tq6od!p?a|_O&9FDrE#5Qk#Yoe>^;a(wL)IW8{OJB~sc(rLzun+EfScTdL z4exb;<7dx=E6_Y=yFsTl!~-vok|RCS1v$=#f+^0Cq$2@(*UU#h_EQH8f{J(UPyH(o zUf*h#k~+5d?ZT`2`D?f#BXH-00u_GX7A&s!ZO_8LQE7O_ZfbI3g3!4=HEnAo+}eP> zSq29pF0-!0T^r#I5_8giXvlezDO@p}fG69cf5}lbh7}QV4`}hF;e#OF^{1bcAv6cF zg~c#k-%F%eG#7m!d_*}wNn{W7zKXxO$5on1lD;iT1@zv1Q;eg$x4tV1qWT>6&-Dgd!DIbDZ#F#WF~yT|qcQu!pu zQDho5g?tdINAq$=ASk8n!QL3d2a|+03Y#WIM$%OobF1D&vwHck7rn7DbE;Pc>;xdPfFX@nmsW2jQl}V>L{u049Nj$a?!o4(PEWy@lmx@tJmzMf!28aM}kb7v+i@b0WqA@LB}CzQpXR=8}^?UnVuK$9Z+6TI20C;%-;XO@X9$e#966tkX9}%IbMTh8 zwvqJ~Z}`^XePKa7@gmQ~q+9XzX^?))meM*k11-Ug6wzMMO7HHif%cLF1#+PB0|{o zCEqrW$^I;#gC-sWbuaFBG%MH|KY9QaM}6%FL~kvzR~E@->fx$$i}8L8@WNQ5jE+R9IYX z(@>;%z1oN`idt%)5gk(ps|0R;`c5!fD2g2R@vxt;?O}Et_D;Zwp~@lK=a&H+!6>YL zDRTkYp+!ebzF%VSCMSl@b|cr(x04;N-YE~u1^ zJtcH0S`Z0zq1%Pi*4>041Ud^xZ)Gq>C>kFSzG|oLd)?5yvo-yoynSZIMd(bfo@U69 zVIR8JlU2DE913=x!rWL zkB2%PWoz7~A0Kh5r4^I6VdPyPCL9_VE0a`Al+nw$B3~MaGCnj;^cJg#Jy~em^YLDF zydT`_^39}Qk6$wcBo^upF-K759n2na}*A`l`VJ)wq{=ewUh-gEYI&bQAP=l%YE`zIqX z$bH?{wbr`knrlu7mhGkm(;g|Iu4j>|gG;>~H{DU;X!N|8RLKpnpfpi8GO#-(8oor| zxUN4QRB{Q1y-zk|YcSf8;Si;mW5c>ljOg^TF=oTalIrcRPm*2XNgLLwgI~M@I^9O6 z_x9S(MdnR64F*s|p&W%Mp2JMa%LSkN*7p&X->iFLee* zHAIuUQxDZcl{x?)oJhrMp&}RVQ)wy$BiwmUfoStVCV6~^RPTiHgvFbOTdWV;q|R8A zS;udMXufPP{CdkITfZD|hE7ktSo-)gk^5M6cYPb6@!!b90jf1VD3;JM=^TgTc3r12 zOXCaqiEwi$omw-PGq&M8{=H3Z?~KR&wo0uIcr-S{J`UQjz_k#!R@mHj0Vv4Js1qT|Me3*t-So#McttV-FF}sZ5-_2Z(Jw zfl88-QR>x_^3rC_q7oL=H4h?-MFJJ$4q?To63;&tw27bY6Mmla1_P6Mdv4Z*EZm9l z=P^vyPjePPjP>K_$Y6CO!T!%HS3=s*XMM%RmaoJ=$;Y*ICbabRfxGPq)3HAA4%8r_EG-it_j4^PV?wfC6Le3INbBf- z6N}E=ubzp4qRe!eoU54FmK<|5&?O8u2F+8xZDeKjZW_&q4ISl+QCRB6Ch?cK_0q1Q ztDuWZ{m>IY`?;=R;_#f@(Pi63&~>H0uC~50(YmRjzTquL*y7wGr&>`Mwc5u-14;w^ ztNkrSPJaVP{@Nmn_fX4aK!klJ0@!X7)ARufFT)P;dg%Cm7ia2)8jhH9cQh*Wk$L}p zGe-q}g6YpH#fDux?)~uBot($2b|w1leaRI2D%2?&tk~3!Z|V+Fnldjj zN+rNw)KOs4e50I0#QSMk>85`f_!EaHs}FW`dv&Ya)TeTnM&YtcZIlz^gFqe(p}3j=$HNXaL+yVewS-W7PbDVmd1W zoNxHwAbz!4|DpTkTHRR(#p!`2P_3aa;?}YbH1`~mE;KGn0cWR#F?t1&i(tY8-td~O z0^r3RXDNekXKOK1^Q4Gv7}gg3Rg%j22QOuDYuS{|-M)O8U}_8-u1{cJ$;;hu3E@(O zGXmPStLLiFT8is{YLX6iDPDmuM~(6jd7a>_H)E!gw4%fRWY}qcg!J=wpD$ld=Ng-Q z;TxG>kzBnCy2X!qz|=Dm>-56=kdU8CsW)=RxGyQTREcDOuE)*(VLRA|3qxQ_Ms6AE zRh3N7D>f zV^t^P2Yp5Fgj#eICP?HTj}fBAImwvm ztQ_m6T>yRfsv{0NDr2n%{(U&Smu)pfo=s=yYqqkY<@!Mbe(#w166i`e`*LAdHK3A1wRJ9pyUVADter51__HcI)SV)ZQ)>-W)M@coFt={^3_nA4!Dz z@2Q#h$##vG*&pXSPMrI~u({`lq-`)tD>-yg^8N5r zNz^7=K<;&{Qn(a_@w#gOv`~6m>y`xfJLwxc~id^e(WG>XZ7_#w46&Tzt03jrR=&f*ff$ zEC9^=^}`|1DCYqvO>K8Us}XR9J+hCweE8q{4gW16{@3mFx1V@7O)aylj2AWn`|@oO zkgSyV?h-p11gPKfy{p^VirdRiq6JP-Q^LoEDmBm)!wO|%k z?bGz4#a4H+x+k-YZH~5DyBj0*|Em4tKt*1Y^GhNYOP`@-Xdho)$W*fyZ(0}ou z?O2qKHGlwHxt7}$k`By+_bEDT<+m_?Zl0fKbKF=&Y)QhhVaoy+kprwt@$&v%g`cCh zW0#-AxE)fwWhF1zym`Q0*t1aq{W<=knCvBVRCi{K(=gFg>bVu~?tY_t$oQ5)(C|h5 zMWuqlk29ps#I{7Pfa?>@nz{*}bD2yg&ASS7Oiu)ijdlT9CAXBW8=4oQJ#odKE0H0V zm3D)F1DyU7Sr@Q0ncbAC`>{!zIWujfTQ4o;|4!N4*_#{)xbxqT)ML$<;uHpBkEb6f zGA5QJwh)bdXX0vF5WMr#v+3CqI%U_L6p?81rgd0M08 z&np0kj<+lgsrMPO%)Yhx>%a`=XoJdEJoi%krBfU2-doU*J0RWyC<-?!2@qev+LrjW z;O@-c2S?^%JVnpaeIl3Xg1X!JSha*A3lwFA!y*cJ-bz4ss;N%A(d-Y(xDtCc18c1? zy2)7T!j;>3bhGEXqZ4e`f@KLoxTZhCyHR&8$d>n_L+KlBj)}}T=_ns7vfm!ES54LG z^KTAzcX7V@AYOTO{<^2+D4&M*ep(vf<$6B*QQf8Lx1aArpm*_KFOFCLxOye*)>qK| zfE%nI;;x*I_Ak})Y!Bh(Aa3mtoaPtCjLZJ_Zjxp~w2BnY(l;%7=ddQYc?e_4Ud!y% zYP-LxExTBYkf}t4dfbv>tx!Q zZ0dE`K9fKYU4dk_(AXk*W^1dl1!vCVcfFJ;9OBu}%jx#B;;l4@bU1Vzyjw!-jz6`% z@vZNf{zi9`i?Xb}=HAD7Aa%&JOJ67m8-H_oe8e|}R9A{*RG7}^iOuk}%%_-uTA`VT zV#RuMMp;ya(9_<=GLuDeN1l{$9x{V;TX1Tr@?=6WnY8R^CRl$`mP_$9E;{b8kO>;3 zjTesR=!hz&5-S-j_jHxe{=Q&p-dDMqHvcV|Dbha?#~J%85}Sg8Eo)1Cy?Bl>hsQSu zR;jPHG%$=v;3*S9hE$X)mA`Fp#)B{O)h2o{p46M*Perm5g@R6F<%W?OzC5_oX`O_x z-XKGRkoTlpqH_R*MT@+1iOTaSp=~@Vdc&`4vXYltz@anP^ zFo*4Eb@wQyU7=NL1ckW8-hzrE|61vKNT|Mf4qeS(ZVeD#jdxigd28@0l@9VYotJ2h z&)Rs3wxnD?l(CfM7LPsXjVem`_S?E<(ra7F=ot+gB(l_uN{=ET-`v%Sxj7>$iScn1 zW7X}n9v+jYp~>BrOlu&$w*{~9>9q?~<#NW5$zqW5ix(T6rm2xKlO@F}R2|Z~ldh8q zE9IRkqc3ngiS@7;1?GA@cbuJOz@lbQuGyQ9Yu#seQI2)Zw?=ZmgS`5F_u4gOGQ6=8 zcf5>7TTyzkQ8(*c?`;QdJtL1THzJSkvPtJi81iP87Mb>-FV*&j@9>q6S803XCb|d( z%R~1o+G|b~9(@&Ekjyb0#9t(p%Jfz7PgZZ(JU$ZH-WvDP%@WMBBU3KHfT_Y!LQA$* zfzY@Ar4{qHWrh0pS|tUtp~;7YxDMwN{Y~1M=xR;OeyTd$&ChM?rEZeep&2l7fd1Nd z9sl{GpGjRn2}zc9+TVvNNxn;vP9EBq%T^JIg@&_4CRrN^cVqcp@xBr}oh(;Lbg`Ez zyJ*cyFbTbxsH!9rS6^!ByY;D0 zFOpw0pA(}kmRw)XpP~WQ4a?R0wWGiitTfiiNeJ=%`G~tw)Lg!x2)>XmEk&2|QO(9L zAw83iJyq6qmx^4_HOhERy(syRjqE}n0N3fDrp%h}(3BAw%myz|5`*}p+}_pfNPeHq z!9;biTYjLV<8-MNc^rI*aS{$u$_VuR4aPMWMtLp>WP{q6_&0M8cw3GlhzKPjVWH$HYr`D#K456P$ zv2f%KN(p+B$G6z((u!?1HFD)c6*Idil zFHtNC$D7ByYcdbtT5GnoX+glgX43<1CrhuhyzGSak}l&>?(VmUGvd%_v^&PE@JjGg z+(;p7gC}Og7kaew#OS-}3KK(vE0X~&qyB28NVSmAkpOvz99<*b@dGpSrIIG@5rnQ! z<=!w|>5j9)C@iyx!D{k+|MUO&Apgr6uM4jlBY44w`RUN(zkW%lI zDx*PX=!@u*A64ZYa$aXBAQeE1EZNpb{8lk+g)#P_coPKii% z=;=;Nk_B(=fRDFcwq@nX_b!ZrN}uvLxqDHHNBmJCa}Cwiej?kCXZ6i>IIVK95*w*w zwudBDRl(!>ZTM}RWy+QWsW&CH$>#E?t=ate*yd#fx$fMgAb*Q~mPQeQ9!Kj&JNZ~M zdbEx2uf}-=4H~%{hIpUzKqtO-Oka@s3v+ZntNuMW{H3i)ZFx#)f-`kuuBu_29b@29 zo%gE+xm)-FP?@$e{05Cjn}-B}zr7-)Jxo~r*l%4vj&_jI@Ne_(SuT#~Q_2gly=C`f zFlqnOXm9)LuN`GI^_pIlJ@WVnOiRv0<4=UUEee+Gl(%RfQcz39F0bx@$o%Q8^ zU5?(_vC^;mepsbyGRbxS$A+JgY2-qlo$Jn{fK`4nro4~$V`TmL5vhM51>{FOm}OJf zW{J)wFNeI$+Zb{H

V{ArtsMXN0d|So*fBUYLKmG`;F#s;V|QnbqSy;6q36718%` z#!ip-4C}Glbb)iAac%INXj>r1K4~xO!*;w;OhX~1RoZct?aSs4-vwi()RujrcLl)+ z;~R$G*Hfs~o){6N`+@<8#8P0CP$v%CX*q_(eRF!2Jt!0CTcL<}wK1^yd-?NV(u1(T z3JD0j=CUr`u3jv-?s^6$Yu7`@NuNW&WHO!Oe6ZGP)U-I?1TazXQh0Zn5e&J^T5(nF zYVvli$8+91&^C0>kW7^0@qbQwRckkodvSKCBeC8|Z0geWkOxnGPM09=cBS8F^^2z) z19tz@h~+B4WaKNB%ix>P`qaC|0Pc}X^-tflYnId1`gYOO#~i;EpiKuVCZ8VM47#JI zY4XZbPdA}->imvgH2d=8*Jt*3ML)-uk9zE`ue)tIeQ2B^FMWl+?X*E|LVys zb&RjC(^#)nWfZU3zFO^KFHWAdj1P#Cs(<_gbdRx9oGzx~6oSDuJAtb#8&t=s%ay!y zH|QH7Dj6@7P4#)Z4Fn9!Z|j%$TI!X9HSR|knP_M!3vXY<;P>LHL9Q#8K|K?D*Y!G6 zcGzJZ?rQk3Rg7L&DL(n! zV#uOOo?*?{7MIB;QWOn0=o|FS&}h_lAx>ew6%;&8wVO3iFvK-OD<+brJS9bpXpA~4 zjPli0PCUaC+#QQ&741bBVcqiBEZos#o5UX7AB|27pHsGIZPX8EWo2&qI3uo9h;z;u ze#v`?Tp~sTrC~)Ur#{Bq73PqRpJtS~#Wy&);XoiUqD@sR5)8${lfd5Fcr2A|@H}e(&Xfly69p~Vy%i)$Gh;B>L zG$PG<_@J8QoP{*nUs`w5G>=}vJY`GaQLf>n>n@E!=|t(o*w8I1*3w&EdYY9T>jxYA zhNtfbeiBJDLkHQIgkcU#$*6lo?#kNgl+rEHjZVQZ`Tm_yikYk97s`~eu$duO_`*QB zao?9ula($d9HL?Tm9iM#qs9V+0fBf;dszG&)Y#J0-q_S$pCgcK*3910*c>^n=Fn6i z`4^(DZo-}^Wds1~uU~z6=R6?I^RHvu|1v%CUdN*5(0zq=6B6#%=CooPq%GWy4M6ea zCagkIi%&Gy#WFY?Q%EBXoO!irtY_rVd~Ih0|!;! z?kOWDeSCJhD1AR|dXXLl_vyK-budZH}rJxx;CB{l?tHmSi!*N`-2Dx%H}c z#-0PS{`7BxDQY)ln2n^U><{+US0%I5W< z?3(c55TomO%O`J}QPI#gA=i~!=83z>`ssPJJQQSJwjO$^Q{et(cud!HW9MM|PWhUH ztOfHHfB&j+e2}0YW9dD6_N@gh5#ekGGfEP)F$fw?HFk{gfMfjqT6P^?hOLk<~6QLw3K=z6Jcv)+Gg zWicYk@YB&UN>67NGjFQN5|{8Hr!)D7bq6AKQM^h8QkHUhVzpXx$qo74+Ohi$$TnC*kdn1mCa6~PK*&9~YYL!>#c zDx3#v==pIydWp|-)=PEKv(sfuLK@(FSxYg;U;WFU>}3QkuT!xGD~MB=-8Gf7nw^d) z;-TGxC~M|CSQOLH)DJ}w+%0PH3U5oG(K;@(TZ|zM7aSh;@uP{RngO@4BaK-h?P!8s z;^e--kwP6;#!E92|AJ1}q4^{u)Jp~|`Ts=tM zkpzUqR6(Sdk3x)`g?tSI-W z&jyzT?)}i%Rdprv2FNdCW$n%Y6O*mm_yQ{aas~nIBs10h_{7iXvBlgd0~+n^ z%0GPLYY@omV{4%S&CHvAoBeh_a`7)l1#~P~Hn<<#wA^V8FBC+`Oz9IO1KmqD4B@xm zg>X^ZStbf<-To1XGvKx1(=Rs7Ye>{Ec(pMZkp)rG78xi+D%`{?Hzk6&il903j*L|i z;DzVW?2Bihu1}`x02{K{vKREQz~rTrg43T@{DY;jAf6cWyJ&Ok@Lvhum9@Zyj?q0w z=EY!^6q7_3_q^+?14fxVIj?C?IK$kyDqiQl9gUaZy6B+O&vsUJ54fy=Tr=Rj$=Kw+ zh*{Sz)_neJ<{1Ln1p3dZ*1re5>&w851zZ0!oaV7D-rUq~Y4*YlFPV$!k7{p`GVh{o za`p(;tWcqjeF-5l#p}i~efoMXj0hW z&l3z=se`?jcib_13GD{UIuGWVv|wGthg0pch%e7bG%s0?0U`95&*0y8`2{X$CxSeB~I+Q4_FxAs@ow zd*k#+jMt=l$>r+SRLI%I@T=Vp2}Kowe~QBVUt+WrX&0{NdXNI<8DAlCCET~1y<>~X zV`;gJzE2Wc4(*L8Ma_T_^yiM$m0PPu3Fe?iB1CDdZ%j;MsfU&QQld7LYQ=m$ir^l; zi5EGR5~s{uIS97&Wk!(cv4kV|0k?BCj@H%E_O zgm*JrLb9yA@1UiUtd3gs@zkH|KfBWyO7Qn;=T?D@6F?CCbjCC|y}>WA23QXqb`XS| zTkmx*tbrP#r-_A5h2Zx7nZbg7#VCP&bN2~k;-=O4lQ5_e`31_NXN_*RV z*aF#0bOpK1>)~e>(g{zs<@Y*+IocD>FLnd#gCAn#4A%=>WB$B?{4uDDBHrr$enA0f z<;69i7`FT^AL2>Aw@vO&-};rpo^&hqi6i)yP1G#|n<$Ay(!n@sHA|zPoJqqMn7(%B z9^jX0#p9rG#+uVUIeI5wr|v{SNqXIG>kZ83Lr3dRD%6hPNPf?DNSF6yhQ@>!!mwoZ z8+B9H)8=dRi4t;d&Ht`Mmm7y5NK@%^%~d z#aewCavsUu>k2F$eE~^5_A;&XInZ{!1jHoTrc_3+GC1!)xz)?7$-(f_DgRVB+` zt{9rudD06;5ge5R*rd(63YhbM-szY9c&=T2uioh6S-xz@K`2}ca&EOKOmgy8sBEL9 z3iMQ{QC>~GKDYgx?;Whe%KGhDfc^bdldPy_xpQv-s-(eX?qYQ)Q?TxoU!R%$P%K9gEer3nfjPrpG)F;l$2kK#DP zg!b1Z-v_A2G;eIYWmjO}$mWVu+};CVyRRS%j9t$xji4dL4_p4#mI9N+V|SV?duoVo zm7G{UpGEeV<`Iis=gM z-n&dNWut{k6T+&ZitY&X8Wylxp%Gy1PFCuUN>^~6?M^P7chJ1njeKwy<&30O2<^ql zUt2myIkil>iyrNl)Qn;pQ8ay*a)gmmAOSS9MLllYzw~Fw!S2ivyQ|HH*WJuc*{oE% zTs}%2pN`n-p=wH_ieTE%6(K_2>dcNFUJ9$Ag^Jwvp4grzR}{B)#Uk8+xcxXCCf*CO z#wy;2?imvo@LVg4R`HH5SjXkKIeOPu5LOxMC>s6e53~fUx`a5Zx7BT}Mwx?vnLR>Q zp#sOswvXs(PS^LL4UJ6JBr1yNE=;MR&*#I(ha9(kmMdnErlzvmRZeMnc_pJA17ddlg3IO7+`w6ak4VN;DC5*QGLiA}9v>(yaqj&TYy>*B zaHTPK7b}g%%z&yL5uk$*!M$c!@H*+`n08J3C}*ctZar{QZeDOcfl&}s7I~qrDb~%- z(RIv?W$NKovB=0S`)mtlC-e}Vsd2({J|l2(Y$D_PxD4kYF0)KY{>gN(w?nT(CmU|* zKGw-z=8QfD%io>HKaI9=P@dHPP(G3VVRECTFVFU#n`Uz#-(r8UY3OvQV*Ite=eYd2 zq{__Js`{#}Ovd&aif+n7$+HpCjsBHLCRG-6J7rSbqCU=K@m_t01M_hQ4Zu#p%oHnF zHid(vpR~$cti^|LnUNZjkAbLpP9`1xI^3IN$xTq&kH-mMW$IiFnfhW+IlX%$nj4!9-aV80YTho+ z(H(i!eVdIGWD8*O3|@B(J<~9rCic<-z0XMVUK3^~5N0H%4bnywhMDY%q$r5#Y^LUalg1&;>!c~G=%v!RB-8R3=RcMOHye1RMNA}@{xt{CM z5-Y_rG9%`5fd--N!Jqy~C1R5b*19aNM_zS4VP%*&Bx`?GZY=l=oY6ot;Znt2K%Fmy z1%wua768@Z`eoG{p5muAMj2esiO=!T8<13}Z7+Q%#bC1yihAwTg;#K{{lM6c!H<+O zrbvfMhg_q?gCWDkHPDBDJd=yx*h$|(??=UyfL_&YSUIjR^2Z3r5X8PYuaCi=?*96b zv7kV&QI&SysrSuc~e}@$tfCrTb>Sur9wOtsrn84?`$^Jrnvm)Cz?avEd$H~3`i>hN2dwBae(^c2#-th)-+Fv5k$P$WJOFBCm zv3qpiJlK95^c#K)EzVx87sbJ2d-RI6+lmdf3%E1*<054T6XnKADq1saNx)SmI@kju z31*kGSCu8(dh60n!aDl+NAUCCvU+g7L1w)9Sv7`En@}tXJfS^}0ve-|NoxX5@1Qz+-ox7V3#jfGGl!x1F=nPfV^WGag!d?%#5OyTFUGgGo2q}tqssN^bj&ZeX@-HE<_ zh#%pbKi5PDH_22LUYo~VkKydnJg43ik z*b|}jxLm2!eW)27E_(4O2K|iEGEtnF|!PjTWG&+y-Jl&c#mOZ(a`-+qL8O@I%Q zvfVvFrf!G;U_?{&c@xr>TIyw&wI@Ur1#tt#obkQ%r4!HM@5sz@Tk^{%ORp+hUylNa zfFvIX>rzYGB9T^Phl{}6QUeMjG9CL1>;B_H`9tKFK7Z1I8@PKnx5)0*rXAK^GBEGe zf{Fq3KCF>A6PWY05s(F?0LfWuZJw!y+2pTi!+cQlXGu*=JRCxt?mUAEo+A)z2rS?X zwXY`oD>xiKbo`z$b*^gp+aE=D@tVj3%o9K)Z+sVGANSFsMQbqD)XBx0&HfJbE2J8N z`kX%!JYf$wo_`+C{&A2D!7utWykif>s*84rhytUj}KYD)9Tog`JzCl$#d+yu$vW0c8u! zj)i@>AXB(csKFE_$w|ITeoiQcSI4iIJW8hQ!ou#%_1+L)czjJF#2>9`ckFYeed0G` zLr+9o>L~e>-mX2Czh)75PCw*K1I`BG2TRLVJF0l}v3r`i;;mr&MW#l)zzgnG4l9CSu7IW) zT@>tfz7d*uw-)EKbRQIg++f4KQ%LtM{VtJDu9UjF);)Lvo}|;Bs^)1$wbgc-X^G8^ z(RVor^-lf#sA(_URQz;GYbld&-nkK=Zrcf4i67_~0dI0F*!4ZdHe1Bf?ZfGXo_tFy z+O1be+?&S0_2{qG7h26x+wm6Uz;4bO96EdrJoJ9P1MxQY+}tV5+S(Jhgf4L21vn2R z4d{7c?^=e(5+lTDhLkhP7Q0 zl14Wf`L{}CIDd4MyO(bl6m&=GMA{y3(w!LoiGF%bnL2CK$5pqQ1etQ&hEg=vi+r-* zH@v&Mv^Fc$)N;ae@jztx5By2ruJkzQ9F;CpK;P@9Bn_aJAHDd9U29Ft zs*Cpf6A`vn#UIjhoYpd+N*isRJvm#RsM0x204K^HT+d3`VpP4L4ae4#pqfHygSjTN zu816ip=jk-&;h?Tyl{I}N&yW=*TePeH!UBqaEas>{tnMSR{c%74b<->{NG`aC01B> zC0_cC8GwH69=83|L{H2*ulF$W#3W_7xl3x&9MpFRpQuk-*Jvgx&5<%Db_|zhV1j=0 zB;6ABKt%h@h-Ha&wwfSzrWQU8p7|=ibk6(y&t3h$MPVpLP)SQSj;wBPn!*z#WPVKs zi?1j|@uO~yj zGR)`0#a+-e*|r#sd(aX39_-d&hm-N3r`F^kmt|!p#pAd}R$=-VFfO(4Jy;kV1j25! zdPa7?&WT;_e*NW0008DEuJ8s=mjjh6=9qSEb{rde1I<*(;dF1ufd6 z*Nt&hIVhKIJD1q#wKU)#KCj<+s^OiP67R6F2XHl_%5nYOsM!ZUtBw($ELb#+T4KcJ z$(y3+X{W!*7)dqOD1AyDL~!m)Ow=mXa#F%-Ew4kBb-EUB6T7RDqU`eRp|kdX1sWEb$2{^88>N2 zN21{>*V!k@qdQ$a;c0--b{)L$Cb3+krQs%Aa%qZkQIPp3*@WUP%8?>0usXNGnN<uQ0lD!uQut6+>?k$M2TB2MwsU&N7 z#6OGVGZ?PDv&0ZP0!VCg{fRg?w*+J5LW<`LUDT0QeeumNUY>4m%s|EYh*j zhwf1eLE*jDk3rHvYu?8Qd{y40-j-b%9~uzMQBNvJqQ$VF)3%>=o-0;aTuzrdwV<~e0w!qPU+*i4sG!99;^sVIkp z(!>=@4rD~%dMa89C!<&aM(B`aTJvx**l^@ndCrGaaeNvd5rlekj%Np1!~f`=j=%(aJ& zUaXzzU$WG-YrE$`5nc5aYt1e$kQG8PdoigV+gn65TCd1RdZ@ft*7mU^-^)msP)5EL zkBp9L{+z1te1kWa=V%3mu8D4pjDu9VM+0vQc*wKPNkTvcK-^@^pXX=rkEJg->bvS8 z?wNu;5cEJ8p*K3+58eD{Gn%B0ocyQZ@x1ngtFQ=ik6SayOw+i)IX<>T#&{+1s=e*@ z<12z{S5kgvtOg|czkju#SA0G0TOFvo10)Q*>0*$I08LEA&TV~&9yssUiJxJDUV2WP zt8Hu#2Is@SQe#k#!5u#0&p;UDM9O)@wWY6er)uK;GW7*O=0bZ66gf6jMh!PB@&j|yC79b2}@Fd4~6uL{l}jqCmMiXb7j zFTEMT5RG1j3^Lf8@h^5)J;xd`7$P|xV$xab%Xudf9Q9I<^QyfOLwptb9mgnm^2py> zIv2V?jgd|4W)&e6RW62(Dc)Kx>|y0-`o8UQ;lHfL0r9mk9evs$H5~|eYo}Zdx>T8e z5l8;y@~Y~b`@`C>5KeO|2Epn;+)=twU1l6{YbP{$eP&NQ&%NTbaFnXJXOB5%Y=B8j zovB<^RmmV_>W!V#XI=}J8HVRN78>*oSFIDB(#onol(JUusjjsJ zWKb8Hi60^U(lL?>9nQ2)LSkVFrs!R8ktB)?QgcONzxLVkY{{#ISFzubpuDj5Q5wCE zai`K}Szp^n$CATPBp0N(>zLg%!0>%IayU7vKK6*bUiw7kT(7fpN`$MUqjM6O;3@fY zvQ~}VNc1BbLefye$I{WRiv+Fn4Gfy0zL!*1Is^w1$bdQW<9CE0U);=!a%VAjqyil7 zEH#rOxgf7(XZQ?nbW&Eyp=eSg7_t{cCdiY9>Y(d(%HQ$!* z1UXrt{Id{12^)>Jf8wl;9cQ*LD3?bQbKpIwnEQiFJw#?!+KDO`kbon;t}h1#aOs|U zy>m{ZB3J&PTxM?G?=;Y5% zyWxJ~KwaE7yYx=&=5iS*F9vwbdHQbEqWEZ>iW+M9`> zVX0Az&dFsnod?lrJXJ_&RKsL4)XClo1O z0mjq+yb{e;=l&LkvAhtgLDi3OP3`$^Z6%r>I>|M{5ld)iSNWaG-(jt$4tO7+NF1)GmAPER;fr)qrtK^VjNcPX+Gng42?c0Qc@xj=C4VehTB(r(t2 z2M=y(p&BPE-Rp;DAGVm84Fw^LzovZ1;EXJ5%8`9oU_7hj_5hspo3XV{QOY-&z@fUm zYd=nEWm=i?J}m*Z5+@gP=fJoAnBN66&T+v3FBtF*3e<`Z0_f1rDI|3pES{ z9IfD8BC}2_L)}Cc!fGY-WW{v|?H#oI79%go{@o|`jZYh%wGFazQ;U6fg`I1nzNTyu zusfmOwQsEX+}zZWRhFSXIn|{izk3v_F?Y5Q%h~$#SW)o{=bNjX@2*_uO#5=>o;uHm zs#wJjA_Q)$Z5AxWb!fcGWeHK(bQIH}v7|Xkibh^H?;dl0S%xYbEi;D}_SC3HjepCL zKU%HMD*9SDN4kRyDHjSiGn@PAX(Pa$FSCX05YF+jLP#V8qM9!UtHuBLzc0FPsxy15 z;5A|e!NsbAVE%S5l}&@OvA0HmrE$hvL-5lZj3ZV21{?ZCmicm%&U*R$lTO`|dr1A}tOgqFnA7;dJo zaCY_(z)=WD%u(@>^}&Ku0mEC(;n%VO!u5`Qrp`}?)ZxM#RRK~qnqChZ{=6dH`3|Mb zm~A!FywtsLSL4)uPt;_T6jRKfvAU zQKj1U3gxPzw~?PSelb_98yT8XoRn4@>6$L8{TvMK!T%) z>3rm@`+JeCVbRETY3Un-phTO!3sdfFcjI@D#TUG+E34@xlr4tyXLM1W^mwbdyr-HE zF~L-yu-lvVCIyeQ3rx~ptqU8)e-q^w`=vd8Odkl~E9O{!sFNhK!w|-kf^s!a{7vQ) zv8tg^M-1+JeT__Oxz+5;vboN!f|4A#x+H&U96-e=Q@q|#2{i9S;`lpb5&dG zJNoHHi0h8?fZ5zkDmd-Ln$c$x(myV6RJZy!=#BR(V0!!qkb5~EhIidyy~XjVWIWX~ zRa;16!bnS=5%PP&RN~~u90YFPpygKR6KsWtANxMIME1fc1iOd+diAtTFKI2Sgr*}I zakahy5~WP9Pf>N<%}FCV2iOhr!HUe)stOKFlTz6umL_ZX0G)zc!V-$3>5DtcJJ zPDoHFoFsLhh;LGYyzhT1*<$wdd zFRRVUynWS*V!d9#1%->%EJc{l z^$U*H8$abT931R?>6PU&xNdvqVb4tdvM-A!(r>i6Ds3`eE@-q?w@Ey;&n;#$)BDIEN zFy~j+kb!C&cv2+@*z(Wh%kd}gBkAyEcD?Tr)9!aO$8w>dRw}nVX^jTIO2mq}MZQWp z1kS6Qz`=KL)*HGQ?D)^@`WGc@Uj&E;D=f}Cp#nIXdcV1@CC_p~;KLNt&8i`F?=s{N zOXJ6WA)%%r_uyIRMQ%s;9zhS-7y4*C#Z2=&T98GMJM^+lKnCN)PyIMxvLWBaUYE@; zlR_%Dee2cU9bsF6$Z=E_)_<3@6kf%yEvdD2JPm6WoKbl;!Z{{k_RRPxI;)J8GC& zg^e5oXpA|N2WNmr3xLJ^3xDAKER1tcQ9Mj#NHgpTwM0#XusPpAQs z_?`cj*?pd8cfNVw*`0TnVPFCY%Pjb46(lNllc6@m7i4*WB0yqiS1KwilCKF z)4D-&+4`tq`2!DFRVbiR)EVFJ@z(8uwC4mmBHw~uotmmfs-V==UCLJ8?XrA@s=PUs zwzsCx&g*c);SVI}(5i5oQ!c{imMlRM9p~M7)>#pTKBx4dQClZec1dtZ2wv36EY75# zHE&~Kbx2KR7W$h0M(r$^ZgH1qssEg!Jy0~wWI)o=^~a1+Qk;m=)w+_pe)l^jxuLDY z20FF;O}RRNsMsn@vJ zPi64iGH&SUrop7@H^+~oNukQu|ESeeeTO|f8|O*w(#`LHlWE2s3d(R%x#*3qX?83moJirh)Dp9 zyGQNZ#hz&q+BkAFM`1oDc7d#TUtC0dyW*8;ysE^&&B&y#mN4hNk%~C!%?x|>Lqh*R-2X2(tB7Y9HYH!`Git*mD81;TGA3tf)WJT-*2 zs1i43#ywB{08_I4S+hm>Bb9}O_DQA8ot2e_!`bJ(XG%lAG*?9KlH(FcRDf3bW$LNs z8_s77+kmE*m+%fxH_ptAjumpYIrkMxWA5T_S6k>*h*uU&m)w%|w>v8DXuk92TqgP2 zW`kbc1p7{dt`!xPhE9OZ(-S0A`0)H^O8K|*p|!rp!%fCGicT3ex`@La+sUJ^@H|bG$$A*%jkY%*$TIm?#)&d3y?VB|TNJ&^Ptf5Py=GNE9ZuEnszQ z=mIZBXyIWv_XQoCZkN-Y_$}=*z!4+pYoN^iTQ6xpbq6(4Xb;LmV6y8nv^WZEGB=B`ymQ3Xd~j$PZ{!NJbeJGg|K zqcKA*pzE)qwfc6$IaY>eSj@UTXj|0+-z3}dT&MOo)5{!&-Q8W87T4G$1?o=LvBDd6{}A-`-jYs2(!;z9BOM6#Ndld9cvrX@|S4T zesYSpo++19i{>@({TP)pUx;)!5M&cvj@IUR+V)wMh)o;pD+s#`3bvv0MVb)K#XCu! zf)=XvggGI6Zg;i-RjvijFILgC>;>K79JoXI_LPqc-0(P)sB1Vb&c6(Mu)6y8KEO#@ zcT9ismz<&oEBA=aHV?4!Cq|nY;rlD^%yV&{8|9(} zH5feYWZdvTz9Tc$>+dc*YQjO9Vn zA^iA1`60#fROfjg^d2m&A58BNNaNBcHRyvyZvz7y9k1z*;On*teG=KU-E<$?Uf%n)4UasCr3IUZvAwBeAv~G8)<+%FH7H@& zVH8e&ulPN z)^M@8XB_;&pj$xq$OO?b*zzAvImHURd$x~yD4HZp8mg^DhEHN92W{PMs2<0xiRaWtkk4z%dp&=RWEulRz!DKXGb5_m*FkeUy%fcS z*&JORq!eLW)l=*VEM_9H823CMp>3gVhK|F&?t(-*AU+)sHo0ef*Ji~rQGg)eE60&S z4ij1O*p`T@_>L_O`wzt=NDAZ>&_@l6Zpe}`nH*LI zM1@TXtpyo-d|)GGXuDDG zerz&%hDqBUXJ z;PxFcG>;`U|KfF6M#d!X0a0%gz6H)15QcPy6#pSJBKbF;-Aw2Ue4b8t<&#cSUql_& zbGa?Tqq#4j+{7>7;Y%mmiI}^DM{bKKc6?zAH=8o6qTV#V8$FcJ#8+aq(R{0Nf}n8i zTOLGC>AQwrND z``GF_X4{`MKZ$8uHA>*SlZ2Zk>y;!W2VJT>wR`pUq=h1p8Wm!v)g^kI#HAyF+>;E<{Bm3t?MScp9V?x?pf;oQ>^9Zuv zoY?Hs!DWt6n!_kX<5F|;+4iE%2ifJt&fXix88sdHyeARQhTRV9MY2~lp2?g=g^MN@ z8Lq!HJa((yUfyoB2=K2K+}l^M!SgV;{~_A}$G~oqc!$W67FvU^juE6CgumVqHSB6Y z&OG^EDbJu@05R1=dPQrt2O3Xb%6a{~-drN#t<7@!DXQgGjVo~m--;VTo3_|o>%j~~ zH{Ty^63+j!VSBkh&a-sO^zH>2bEYWAYUhm3U%v~UZoAoAIQG;v1_ZoLdX0(YlXV36 zSA3htYH|7XE@;^%h}9ke|N>2=|asfJKLSMUTg|9&E^B};?G%=&G|roOb3bH z0>>}VD}suhGAw6EaO@U<6Y}qzC~wO65^>C5<3L+kuwm-;WQwV@)XYWy_d=(e2-GP; zEwaCgmnBIte)tyMUAyh~6_#Y?=Bp(1`VZIPy57;t9wELRdr!z+# z?vXpstVK$H5*3{?{xK$9?)n_!_YBqiG_0fc>~%KxlzZ8Z!{^C`b8{!#=-b}S?%Q_) ztNf=CNgLm$_8QJ(3mXW!4}c>95kLSkCi6IbGSJ17EC3X~Kz9T%S$o5;Z#DDR)nHdb zF6!v7jO+%gZ7y=%vRm>f>C_w_B{_-LyPW>Ijrs=q28#wU2eStY=t;kVEp(*xzt7YB-6%wymKT(JBZtGTKx$vyjta}Zlr?HNJj%Gt4$n`po8 z2M~Ag4bm_d(3K9&MXSdm78riD=}QaW?N9Sxjqv2(shwF3gM4((u&mH0MAX+>1azon z^agyA5cCfHy2CrQOyueZE-p@zM6I=W!EOou!G>XHu?-*5cD5JdBcEt&WC^h_j4>PS z@3?O55~*ld^iAGiUMIU~s8%l3ADeXIz%?L!FhY8w?MhM)2lBZ)M<_a{g&K^br2>%mug{tW_Bnj-(@B+BN#5#pxrT|nC3kP@$Iv&sY{whr&*XLG5JPi3yR-_ zRW~#znIesAQ3_P-goI75rX{_9*arULZvK~>`ftCH3tLUR8b)Z_TEMt;67v@}y+S;$ z`N~wy-CrZ-(35i{dC0>VqP$BuWZOTVT*tT_1;+6AA4G5J^o;g-7~_)T{*e7(6BC-L z9X0>8-S^$QUjol@S>gPdyEsi~SPc+khVx)OgKJA}ogGL&hB=*8ja~aRj1!${nu8Os z_wHb4LOmQy%^VGn?|kK1R}x<#z#3T|-C>;GY0`WruVk`VTz)(&k1$Q_(agF#R;ZR` z?-{%&wn9i%3I zsJ+R#@AUg;F&7rV2#r3n#W-oR^5*27kYIg?^YKCEzVa&kFqRbb_a{1JbCq4#BC{`o zes<=ObpJkA)HQlURsFG%n(bkQtGgr}z_f-CtW>oC(!XifE9W1;gmJvkyheS6$|D7q zlh0-dH%X<^UoAGz6EuuIH!SA6s=mgbh@UQZ_IB~_Dlhx(u)|iHA5^THoV>bVrR5`_ zgx${oB(Nb7@*SQ`&}`2uVt>fYha?00WIL=5K;X}|Kqsj52(hJMNm^-ndHY?jCfWV2LRNb5Ny=|D8Ft`ty?vrC!8S3i!16 z-tthM!&Jf!{Oj5cr~~eV!DB!(D+Ll0aXT)b>9F|IYnGqAu{TKIqSd#l7Kd^C4IB8q z*m@}P=l*t=L=%?vL#_Y;Au*nj2}ahoqnEaL4zHlb4NvR-wk*GUfs*XTQ?iR10%RA) zlYh~!COZrEYV#($Azvp=)Xqoom4aVro{3tF@QoAvaTRreT9~~XTeC6zrRAHZ9~}hT z%8&-^PrKgEGQv~Y*6@0!cs>j_eY4n7vpB}x@4?#zdi!4lN&o%DQd{RH8or>nj*Ami z63tEDO+iR64%E3YUvJfx`E$i9OkuhYhI8rM#LXtwk`G*0GIwEx0DtBXo)EuQ=5Mq8 zU6&xm^r?P{L_c%`2h(x{+!OtwxGYa@~AwTR9-+ux8z%tZVltrLD!ltBlEcDE1 z=)ew72bA8N#2o12XB(^mT|A7l`O+4*^Y;e)9!~2iAexUfZK_XbUmB@#R3Y7NrF8tjfaN2#CbtZv0pu66r)OS>4>2L!(NtKpl zJ`T@XMhL=j#{FKK`lLV;ChpEW=tBVWcORHT{j8oj3qW{ncOh#1|0P>`+yry>;jHHm z(mxl%N4Ylha7z7Dgwe03A8Tedn>1EYmb8#|YmfaRb4P9CpE90O40lInYhkwc&68Jh zIs=tHuM8K=<%;-PZC95m>B_fLzv~x#1Udz@j%zB9vc+B~*SD3jvdq7=2hmv@0Jj(Y zz=vXPb(0^IAgowA=&8$p%+4oCLEX3`xv|wyXJ|Z^NW875{k+12BB_S{RbdO50WW|q z3`LKVL?CNj%nhsg7(lS~5|kDXR{x+m2AJo}bZa70-D`FXn2;0TRIpv;n1~%JYQ@Ux z+Ob5Zrt+jy&y0kLhWp$uk!jx6psH$qt<#1+m>-b-#VkaN2Rh&c0HLW^MXg|HP_YZM zwxsG+d&li<(U0m51x~|EcV@N6%6D8vQ&L0br7^X!wv3K>>FGyBnawLhVGB$o9s)DY z7#<4@DjQ9)5s{+4xmHfen0eAKIp6OShZ~bt3T9)k?M%{j#{nNP&I#Uor-@yg`78tG z8q!49v%vQ5`1La;XPruN#p*Le=Q}CDdR$}W1bic$g z7XXJR3j)Iw7nHxx2=_Yp+Bj0?m-SG$Ou8}yjfdZ@{c^B$fEG#ThK1a+(7BAXNrJRs zMeiRnU({FC>D=?{aFJhs7hK4`(k&~HsDyFkBqr{i_qgC)*4RldrimTJ3ojaDM95n+ zf|}z>+F%MLA24^NKSx&#b2;!C_n8(yRz&2k);AMP(YCA#J;ZL6^Si+_zCi5_YTJvd z4Zeo;hs0nOI^6s;pGyaM5>S+QzxHO%F?U1F`nuYh3?*HQ@l3;gr>*qaPJm&Bu$#V4AqDu(KBr|W$Z zP5bOR(DdA~!MLHlV1344w!hZgt-PlGBVsT?G3n`<8hr@DKs3`w7_XE)-BV>nYj9IN6mpYHj5j)(%ySs|>^qZO-sA;C( z?b008sOV>KvE7BvP#B5K`RRkh(t>3*M&q1iTzgum`mvwkG^~L!8lGX?4u%=xb4~@>TlQsVn<#YGijRF@ z&$&?GLl8C85y%`#@=nb|PPv4K!?!02=Bn*Klv~k|cL?|{lRw}pE)x9RO6z&+?sHC| z?u@J{NTYwbDJJwwhQsk^YmK_U8D0D*?VNw7we_z(i3?~H!WuCn+xEqWhtGb}VeIhv zCtr)w{OomZClOJ1%vs&mFfivNipWJ+nw58-VS6NU>GhKAxqaHasqxOTc zZmDP|JG@!z>&oi)ZPy8~06DtrRHC^V42nf;)nDwn4KN7WP z5#N)(nn$L6Dce=;s>pH+jf2}wJvk#ukdU@pyAirx}Bv}UJ!SNbi@CNxK#MqiDNp6ck^me%R4@>1~aA)H>vD~SmY z#JZ8O$0th~%}>rOPM!0NJUt*MgC>8|Qu*;1H$#sP%hsGY;bY6HALnXt?C$Ha-NB95 z*tzX;B22-n^G)A0wNgywPc4^R(Hwg!B-6dG<|HsKVBI!-6=XgXCIP^l5UqP~ z@$IH(M=80ZFf?f^MyblB_EIYm_s8Gy&_=#ProHF*F9E)+CEnZ@M4}7awe_TX_z-t+{<~unB-Pu9C3fSJfb8y zl|!4-sC_D|M88;0THt(;{9da)0Q~PqF{-nMmB6XS`3tX1;(R9=;&vW*>t}H{%5|>$ zN3?J{A#|hXnFAAP3#A8RJaX|rcWO*s>4hZcUEZ_+f+ zJ=;#2KjkiFBn`oS=KP&@9hW|?-Q0}=Z4>Lh#H-~~5O+tkNyeu%@=Y;ScBkm>YO?$# z*VABEQw-?o?w#~&c;W84O#@GOY%i0ldOBtm!(qbBSArq+6^3`4mJYm`s&29Y2_7qR zFEZJ7o^rDCqSbHWs+%WU472YGRy0lAZIhWkaLFI)1#(`7gl(Ql5@#R_E}_GTr>?Sw z)Hm#h0bh64@8SGR^~>jb%u1#~*2{Mmffji&E5GL~Zcq}3+Mu~>+>lC>G+{9SkoyWd zgjnhDRCCkJSEP=$b588L8&Go)_{2@F=%rg&*zc}!11DqYV~>2MZD-@0@(~>&Dgg|X^lmQc+D4U7WWE= z_}7Ap*B@_A9-AbU-j{BoYq6EW#a|&`(NbI9^o!mp&HY9=B0vx>%Y1Gsd7yXnQKbOOS8{z4KbwShu@ zvPu^6Saf#3!>o=@ELAvbCzi5IvPvqt_ui-}nj{`XQ^oOzY|CsdT-t*mo!OUNW6jY4 zBtfNh8(V_v7Yu~*U6T;A>7sYLnk@#lHw<&qM-57v`@#avyB348sUw#RCE7|K%ZEud zqf}kLK#(l9w-8O4;dg$Irfl_&DBs4>h1cv+IU8&!-x=LK{PLLV8MFS*4gRML7XA5O z8<4NAYQ;G5y~p}K^>87qV6v}ctSJY!mMx8wZL6M*hF7)Q3VM|wPP1$y+e|-Xv$Ka~ z#u(wAYu0=}5;+y>9b7=I)K^$#y?hzhC-KJflhcktY{il=KiY(L;_ie-g|o3ORbsMbvuc{Bd4K1G)y4oiI>t$1>6)GPjCg%D5+ ztgT-8HRGflZ}1gp+JmJIU5U2vlS?F-zpo<~Nq1ee(R&fu5)-+6_Q+xIw_48$vAx{$ z%ULiib?K+9bK2bUV234fdabZPp{3u)f9*=l;nhNN@?9r|@%>Iv`xinR<;6=9DMAX; zdDf*qhn9Tr%wPH)%d!)AJOTI02+XGXe#8aWVg5-j!kQ=}kxTpGE4T-X252wk!{HvqgF2S_8ZV=EF+YHzmSXrOB9=mfm!ap0MFPXzHvD7BK3g~ z%q`rrAJ70xayI=~dJ0+_c-yc17k4y>CQmB>%u0~KDPEbhVTRatWOLVKqY+SgCtqZh za?Z<3>1@`O`EzCvcpI_-9#Nwu+y_SwF$7+LQ3B$D!S^9=-@jQ(_2jq8@Qk2&Q9L_i zchK3!+U1rsQh-|7y;323t}b54DPI`fZb*_QKaS^Ef~?kGdD&)m6|W@qv4P3$x>mCEJX*V^-C7?E9u(j{w) zc8vbk<MK?UQU|di9n!$z|%E5^B+AdjS`59Eam3@Svy&Ja5Zl z-tt)4b}*Zb5romd@>&mS2K?WgbC$jh$PaJh@hr8@^P*AEZAzpv(#dlw?U}9GBr+d1 z0^V()Z`{)kB+4jkz@pyoMY%hBr-H=B^A8T_SQv&CZ_nrvG038ZH~ z0BwPjuO7N?tb~1nD>0iS7CdCl2fh|)j1A5~Z$)wGZvQYd-O1*_U82u+M{xT8mVp&@ z19j|0&Gbp@SL#LP<~q-K8W>_HFne=8)}=X_+U{?;GK=P&*y6&=3;QRh&g^z7a&0|6 ziC$hw!Tp|n_BDiBRqE-|t=OWUohD~jNz2XL_!2r!JYB1@Y)x#t+miTIJh;;Y$FX`> zQ6<;R8QbM`p;sMJ;&ox^;{($KzCQj&ndUXyuUo}`o4a3#zy$eDwUO9xbWv~>X;{P? zB@3%Yqf3qE8%)e>VJ&)JD{UDY!^m#vkX;(n+!5OmZ=yrPI?MrrZWICVpH4UWI8cm_ zFdIJ_P&4cSG9!~8*`(da9`~&=7`62Whm6~Nual;Q#S;hp#arQk2@GR12$Bt=BnV-H z^D#kBSZ4K_qAu4)k`sF!eR(5_(Yx8FoNG`zX@yw>4|)F@i*V2EL2wNG z$TM%g`%vIq1n@2+F$LZs4dDE`OvXr}gvX((-b|@V)yQ@f?Og0VCV%bUPU6vGFI>aM z6(3!Eo?PV;ba8Z(W!ELVfZw1Yp^=;LnQ#`^e4u&>IR(s3X3~MUg0)?mS-`_u^=1gX z_|HOGvd7Ku3p)Uq!DWCb0Lg5ZS#Us_6@E+DN-$G`Bs~+OE2e0#2*L1 z)z6d^p1TX4N}f*RPtGL(r^ZY`5^!5LTA87KY)6bgNtC_Q-|uq~VB0N}85zW570>&= zKmwl0|2Z)2!9bZR*MSbw>^ky|(Bp4SHYJ-sOb=r-T)bN@2&o7P^*%DW6mnJm68+Cx z`&XCQD!FID+r*_}WqtxJUSsLBk9~+KP!XF}U9?NaI8lMHkSx8`_SH`Nnbo%k--N%F zmK439NS50l)ZgJx&p#y4Ocwidq4e(k-}Sav0-Y9j*t>(deqiV8k}`#dL`Plxp6{0J z=C}c(URC#>7E6gwk1Qq0B(dsa5=WYaJGd_XRMbLSwujaweF18vKV)_WjM(Zp5qApK z2pFPm>ASH5)%Wl_p?h`)Uo?%Kbjqp5H}y*mZXDki+2d@V{&HxFuIRwrB_y>kfz1{VevFCZQpb9A+)< zNDJA7VjD{AAd8TXEnCb^^#UU#Mz)=3NX;g%B-q*2gf%F_8M~KZDkTHQZ?8PQSK8o{ z&x8rOQ38DA7(X;NCKD=Rq5A4U#z7`W{@!LHG4>@(8-48Ut3_?}z%>0;IZKyNuSB#4 zZ<2;E&jFw?R{Pgyqub^z*kpDt#^}~pT9q!YOIT$5;XxrJQ#0iBrtGx)yL}&OikJOq zrj-~7?c?e$)~}h){nawUu#73w?7St^;>U4bn#llui++He=ubG+*l)9DVq)QxeI27{_% zot?2PzTy?-OT?@ufyIOyDj4JO8g1v**5zakB+BCXVpZxyqPsm4uDG!wj5YK={UwQ? zfoSk*o+vZMnk|R{!rh)Nn$tNlaFBhw%dSRf;wQE~>)xC1(?QN3Q{`T5m5H(_`pVMj zcs=(oe~CRT(U^K}1EylgJ?2osgnPqQynC~mDc|Ks>c`(NV4Y0W#KsuB$=Ts2#x8Lu#Y&ciw9!Hy_hWAlRa`ZYV=74 zbe?iC^%M>99#eT)Q;6$t6fp>{2qj^eJ1@lt=JQafeE%x|8kB3Gku|_5IQlL z+yo&wJ+AcpHmeiit4+%|;{E88N%kk zFs9;5y|B6kk^828JK$)_rh4sZW#`SOmE9bUIRBU21ay~mvTmikyvoPYdAE}{2_%-aW?+!DA~@*fm9-`y zsAJ%llFvVzlK0mVci#?je5ywwje$|%!Ce_HPS$**N~A8@UtVB+4Z7Wxb-7LXwjDzc1jXCB#v(8vbfcX4n)MY#QcQ>4uT346CfYka z0){junZ=CTncZ%2>$Ciecf6MsrLuf>YH28y6KocR0a8|Q~&nJi^ zCE>u7q<#`D78$h@s7@>_b?z&$65UNLw24s-pWhUqb5R=quEIXAl=t2~RLDZ$3kUel z(-M7Db{+RRv_+A*OHNFL^lM1+=Q946J*$}EXOV07@Rn|rC7%@4WSZH+9(+1obS^S& zFH)h<-MU$9R8I9hwzzLk62@5FzaUtiN;JG20%;Hnmt>6a`J$O(U++AYOO>4BsD`iz z(`u+X_DXqqw>Gai9=@frzxa1S`&zlT>R6L{p7R5)auXh=v>lFpMezf37IlH`JF}qHxv%yN~ zV+7k5w&6k(8coVCpMyb+X|^8q;Z%iHoiBwS|6ohg7Hpj#jTzNTYI2~+Lkp^|PaiBq zK<(fc*3aO_;rRh2_~;pd1*d%HEA!M3AN6J~IVNfZRg=?ya03hU3xvFO`*3O#rW`iU zy3D$8Tmk;%U}^Rt$8hF_m*oiB;}=Vfn4=;f{QJgv)p~HGMp}fQ3I2mahv|pl1DC_5 zq0Zeq-7iSxVL2cAga#FBDnHp7k7HkI#@$uD+xA6Hjb3v^gFDT*)Z~Z8WVu1U^Tg{lKo6xiUo$zm zsZf5P9*|nA*QlM}K8Vph<=O#lP3fKdAxnEmV&Q5ooNu@`gfk)*Lze+EzT?n2P~b2_ zk6u8+e-sfU{*X}-;wc)B972t+5;=ip?Q3YOHt;lYJm1vLZQb=^2Yy!f}yHMYWtBVBrkpXFfr z-H8MdCEE45%qjU7P}v~QfPbc~pkKdV zNNJcHoA!fStr0GccPO4>6%>Z!!TdqR*Lv<#7|^OgEqyko;uXekYX42c>xxNZ&W1Ao zh;#z2%Q4egK?Hom?@X+^z)CQ{O+{-$)UFCuRi|f!kTt39yY}vWZMWPD4;Af#jFG}O z=Ta2QgE2r&=!vH*#Geu#l|a_IAMCxiZItze(G@bu+`oSst~ypD&TPhV#6BQu6zTix z*T#d=C#8+12Y$UoaYkhe-V{{kQSCy;K2M^b!)E#iMS3({L@?)A6VIXz&H6k8b~5>T zc)RLw*{!kd7aZV^ofpNwcq`ajl-BnnO}(p!yrrrYe*PZR(b=h8FtP471hl5*{*ZAJ zKv><5JsM{&TKore5PRo5>jZ<{YC`$6>Radj3;Vmb#1v;0X1xOYw9e&4_sUkOrGdR% zsLokO4Cf|2aT#8J>I7twz=6?-cibhYx-BJennNyGivp-(TGX(^=a!F}Z+d*mNnqio^T^@nWW4;eWMy{vwx`OFt&@n%4#U2W_Qkz2F+ zgYM{ICcCz*_V=2&S2dO2D?=146cilOsc$k(;?%E66j3F9D_S%a_VWw)VP?1acP5l@ zKNq(k7jN4DFwNYTm8MCgFOt4&@~X7}RJop&G}fHoH* zA4mbih|KeH$>BP<$TH5fa9GTx?;5vnXpTW&w=Z204{qRfRc-Q=$vFF2by2b+6LomD zc{YCP=6C>=CD8sMQ+P}N6Tb3`_!w~En`*J4BuLmUE<|wM9BJZ4mn%U>4u3F>h~~c4 zEa~wJkYDgAc4pY2`RnVP&0O7qn7f^qd40a1#=JIiF5Sh|@8-L^uMwG$wJ8~ScRhOVEGqWnsbHL-OajBQdIC|sMVacQp9Gb!_}OkQ2CUJPjq`XQxqU6$XFVHlGe_&YUb6v-FeYui|9=hgu=KCRM zBW<=RlSWt*5#8H0d4GFfE_|M4xJS6D>id1oJswFe`&qXi7JlG?H1OX!_5Lk1<-hNd z3$gtnmo0$X;+ZQX`fqXqVNLP<+AKw3ITqkq) z@ZN)7Gt6k9MNUjiktg>uGxep8+2Uf4m2YE-q;m9}h1U3amr`er%O|Fi^SdovwieH zCwlYIrPsC`BpZ0MGZp{e?cV>6KmHG+)c*m$y8u7Y1qT28?-aYnNa~F`DBMPo-xBfp z4kb6&=}O&cSRNJ@n8Vc6BevaK6h5#CKL)};}jcygd2M#s;Kja z&{k2XBQ+=nN-55ZV}2K?%Ks%l&EwzF>!ixFbL%z+PZK?tV(t>CM;t_YgWK1XYT;du;$kK5`{ z;pT&&&V|Bwk7Dy=8_-m`WCR5C_W<6(|hT9$uuI$i4>jkN`0N0`niT)xq2?Bk1QpWQ*d2i0u-nI0n^E z1ahhnE8y*jpca9yF&}*Af&&hW7HCNz$H%lN-$~XPZI&W1P5dni!WXEEIrTg3ji*rNwWH&1Q~?Ko#_k!-E=+BU=XnXtkK>8`4hW zH#F6EKP{b-Et~FLhm+H9zn%TqWMaza9Unx5iyc`B>x@f7DL4HdXdf4&gB~9bvS$vk z9UnX#_lcw0-FsS}rbRt{sBLOAYK@uKKny%S(RFlZA0h;ve-SXf_RZ)Tt(RmcnbzOr zNB_Zq{cqcO|4$!DlQzE6Ng&p`eIr2oTSd_IoG}jD-=4E@J-Yw@toLvMSW5t$=|d0* z9pFS_BsPE+bIi57Lr``K6qPvUwxJIVqjOH#d_eC=(bQ8b-z8gkZ00g*G?>mBVTagJ z=DG3%cmE>N#8wCUB<&0yby|v%2UCFokC?n5MF941Ra>ZeoKm~qcy<~boJk6R0$BO) z;pykspsi0yw=EzP?HS+*<*UIXY}&AH0MF_VjzH`IDHhGT%)C%j^H`JL;(!=6WK3gh z3A@)pBVf}AsH^9l`ucN!sM(|Fyqy0fzcY`zfU6KuP_cLS96nTi3h!DrP7wK0>kr?W z!d9M`64-3d-P*C><5qmsISXXUoXxL&XjZt*S~qO9ZhTh+T1k=)d@y=6pz<)`X-XYp zY?t7&IH%Q_A+oRLwpSAbeTwA^WzhC?vvc8ng&w#p-6Z>$*!r$7^sSMdlNW%aSVavH z5_SV20vNuE{30hwJgPH62KH7dSA&QuyCBqg`}vx&OIL>Q^#{ zG(p+Jm4$E$7l=CnCOp3{%f4Oq9J2mUPUgQBDuuc^-NVu}apaQN6+BX8{fv&MIL)M+ z>>zn7+mU?TN}BWbL&C>gf$UEkLv`yxlJ7gooQD5ruhf6vBBBZ0arNnfiaC<^mtRrz zbM%}X(>nul6PvyxIpt4M7YJ%VGy&3>#f1RSjo=X|GYGtZzdIFLI2uep14xr(V!-d9 z)wbD&2t=^Qp2B)fn-8284Au3aM19Pis%Kl+&Td!vCiJ6x2y zy|({y{Abt7GH1<_$H{X|nm081pVCt#f;p}Wby^BM!oLOZw6}u04uU7Sv09PA_Z|Ih zH$lv(7eBnVx^lkR#qS<04wkzWI-+ihUVNI*AE7(!8Ys9_+B5H%f1RK(!SuUNdZe~) zqirayP+VgJ@Y7E3??r&wkK$2csI`62pgLN%lbb#8IzAV>wpbKZ_V&6J$b4X`D$F`g)CFmDtnP)pVI_7b^J_QkUzV)0G2CnSgq|| zqkb+;>RUi?zk|B`A)7u}l-;qzo-u&Ypac+Y69}{XJ^PW;q-66MMm?JCH4WOCvZ>(Kae zysi@Nh~sI`m~KsMTw+nTJedQkNJ)-Ip75RQa_7SjWP0R9|9xrke|2Ve1vLkXIQU8@ z+}s%R1b1~(Y}6roe)8}t+G@X#H?oxDX`$oqj{SaPBfGhf_=k$Y2bxpOckqeQL4N+T z7Lw`(PEmC;PLutMiEN4IeNm6EG&cIsd90UQ^4+*bPZkjW1;0l02eJ@+xYj(#4^@Yf}O2u%QxvOLF6aI)Kc=k~$FHdUx7L;W;Rn9X$` zH-$E~!NRNITb)oE9}_D-bYaYIwJ29RocQ}1Q3~T9@xwh}yJAc0jW)HU!Dj(dtA$s4 ze9TXkOP2>()zh?np%J<*q#n@Xu=wmNZWh8_{5i0#9O1HS+#B}Vf2fm~Pg*i9`iiZO zPui^cnvkO;L41IAv;))RG1pC8G{mN3c*dN&#(D?Uhz14>+J`w2_8Dwe(v%1!gzh%eTgTrjVF0l^6xw1fS5=Kq&)=|k zU5}${v$-jZ2V<0@@42sG)AEb0)`x!!J`H?imuK??Yh^b3TV=|GYxG8fPhrVK zFuz2)Nb>d(fY#*R{*de3V7EMJJ{eXt?L5zcGs$$o0IP6J>{Zj4kCK8BGJb#ltZjcT zFJyP{SnyjjqCP||#Kon~npsGNo866eshQ#yw>g>l-!)DCtE0hxN0~_L*WpVYU@Mde zORQ@VP_Ex0fx^gw-;%~*)pVhM$XsF5(Bn_UC_;dAd0H~AucaY{i(x|Cdj%4Jq5aHP z(6~56Uqo-IA&Ix`%HR%DG-WK)YaHN;ddr=D>r1DVe4UP@7599t%W4?k08=9z@38NH zT{{N?ODllfK@Pj z8|_Tn^Y+Kd_=C>i>l1E;Nvw1cV4fRl3M(-M=?z)1-|3~${6RZ4-2gtI6KkWuy|C9J zeibm68wRIS4!SVvKwJ;Fr_SMJLx>3;udemXVT`m@6GW4 zP1*au=0q1big?uwF8ovqPPu?4DPZqTyib!B7D~MH6viW5{JSi+4v>#wd;#I%$spUO zz`v|;KJi^M2b@sN73>G9HvLYJJ?<=FcP=+%*u}(uyI0S`vhj}Yt0Md2FU0fQju&p^ zNd28LC0da3UGnji%X+!*0LnPx|7qRwuSfoW`Xe4`$&F#2VT{=PSlHinbhsy5rRR?hW~=Ze2U-`%+5 zN?dwMrI!aIYj`s@1Iiz^{R8jwe|~5u-?t!9)d1VECH^lRlwWw$55&()@EO_e2UgQ~ zEo}0RTdcj7E?$QKapScp=Wg*=#WaM`xfMf@`nBnghj}Aa%3aJUOqi)fo}kjQY)~L# ztXIs9(40Im8V{aeyp$7LD1}6bJ?;R z(sy_0b}2pS3k>^sA@mH^Mu+Ds+%C;?QTE!jmcVvLDvKz3g&W6cWnN$b4)!_^CoG(71|z3#zxZNUbhvuI;&3Bo>dak*9vuwvTTBzClg5otTq zfh{BxlrtUv?n$?9oVCbAdEjM$nsl8Yiht=8;0;C((6yPz4Zg2%_7C)u@^B6ooO(0; zV!|E1hcV8!5~BWf=q7jHLdDJ7^V&?@Lat8et@QhVeFxZhUspGKRZRO-oM#z?w^;zj zgzGf~3*bK|EOC=8C!0Q!o&uGsFd@uujtFp5sLz*BL?%=W6z@r}{X^E5A%B~Y_=l{; z^z`zA-$?{Pd@ueF*`YZJkg7p<;}ZUmi8(Gu?5hLmz0ERn(84@77S*iqhit?JkNivR zunR<}&rRa)0ZtqAqtyu%uuLQ2_x_Nn!Z8aZ4k*y~-CvD=3gv}j8A*@+YuKV-KWcS#4wLnO-5^FUy& zrN#g_&%PB>G{Ma@`FIHK|yr=tz%q`(9|bJPm(<(M^yx8L!z1F!UJJx=npKEwf;{t=K8wamM)Dqk{De z{>;nGnRy$v$CFGgnBsJP3)qIF zpupt&uJ}$edZ>zEJVjz}MRQLVF8W1^8oLKFlo71P-z;2MM==C?=gp-YD84QD1xecK z1cq*L%V5BT*Qz3Io@dI9A7^CZ4-Tu#k3RmD@#ZedM=K+5YDUj;Q1~2a0xsW1Ol1T}Tv$}E)nIrxuQR8Icg z6pwr#7^5`erbvtt+c*F)u&2?uAE=KjAlcBo=g1TjZDP%j3D{${s-WZ(f6`zR!523! zGMTZn#RGm9z22^pQ7HS=X_3r)b=h@GDz5CtQ`|S7G*VP|gS6ufs_xK$?-_Q5+Jy|>;V9?ETz8RM14+Nzb@7Yhwzn^ceLo+>KMS%V?me8=2pap3&B5ge}x|YWdK$n+2As9Sy2jH z$tpM=#HM|)7xMsZS~>tNZ5)mv0uS&p^#AUuq*1&aH27qoa4`h^9=XIPhN05tP6Z(C zJuHT1l-^I-5qP|O%kBC|wz-`pORbqY5aB}oO{g_pBIPf0u$idFRCCRUN|H@?$a!); zE&7~AUvzW9t|Rr#Gch^%#8>mDVjc|FY4>IR6aq?Iy7=e4o9#vo7_3k(JUzfoGsP7nO3}+T{i_<_v)l z9vnli#}>!@j_VRMG~mArT!jk_w9u|4{NQ@X9mgryI=QPPN2F5gr|mo7)af&Qs&?De z*Hq|;-Fnu$p6wC&Y-;+2j0s!I@)56&h|V*OQhPH>>@AoDu(D&rbUIIYJ5&o&Kd_Ww z

J~h*l*u$ZUniO&%j=%by{F)=0|#Wh%l+ls&@(+@8AYKGCgfPC2r_?CdAnnjDTrY+=UU_LsT)T0Cf% zyM+R&hZm-CNrON=SXdE*l?p`iAVC+z9>Vl$29QU#LDt|@8oEP+2PkfsQR7-dSs5bJ zAkY=1kiT`my$Je*S+EJZYMxg- zuNJ$uSC$)5a9a0d!Zpty@;DnL+_%cMD?KuK_hd`a!$&Fh&(fwByS$c_59Mqwaid2f z%(*_eou9*@Oz+@ZfJ?B=@DPb%&0nl7ke`@!r|;y8=j@E*jQW358Z`B=O<7(@|*g^jAWb&|b z-HZB$YVsLvx#ruNgo={Ua!?D5EA#7g&g53=`YvWrKUerKqsG8`th*FQv|l%foni_N zYzWtAa4cW1mLj!KVRD6_A;hr5!s3syp3@&VcXXcZAn#5|F&A2L#%ks?1G-x*)NcId zka;TMqxw0EmNUzN&*A9eR<#*0q8HIYI-n{!9CSeF+!onRLyArOyJ1+F{(h^y71zU#IaJJoROBu3fjv_ge2eOvT>C!9L15A9E~hSWjg9jWQRhmmfY8xGigZUVi^? zoEH0b4B2cwREFTd_{Vw~Sx;^^g5~j3*qy)7UTSwYi{JIRUOtnv>csH-^0NCQ?aF19 zr&Ch*8>j|0M1SkMd}~*uIl(`GIaai!5;)_e><42ZV5;TFYsBaVqGwta7DFdL z8{4?c2e;Mz19z)ljKDC)?WT;v)e86KP#-XlhQ}gspg2N7?@wE}!{k}(O;7)*EhZIA zD}y|PN&X!AwxA9#I!5g-hqmJzu+8hIMB9)vpwk_61N$9gI1vF`Q7BQhBDNgk);?^; zNrWk*UZoEA5fH5l{v9l8_Bcgg9f4f>rT+^RJo zI-zf7Pl_32j;x4f?pEOACeuYh)(O}CcQorC2yuV+qu13ic$QFih_xsR@5t;{7R2yI za%IRWFf`a?MikHNEAQ*FgFEX{#SbW!q<4-{;yu#uwrmkjv&x((zxU*x-vod@SFVJ9dww`VE3~6~FFSf~;`sBe)%(>?sYeu< z{TN%@I6tK81M5V++Js~(G zwd(z4(vaHbqEMAzGef;&jaXg1n0^R8%pJ_C=0@Rp=N=Lw9Dev1=t1OF3>G{ftCIHD zTnf*hZ&u-8!UA1*13!XH)Ke3QJ*t@y?Ro~qRMmM0Vo4?T2J z98%2OlFMq>lyU2GZAD)U@J`2cS6GRFX5h%Y1C>~W?<}G6vm$BQ*{-NzX#FPQ6;uag z*nq`?pPwtHT3yVYT9~#tno@iC!p0;8*0h%Efi*>1#p+8>%=et6p7OZD#qt{W;oj)s zPn1fIMg%P`xdx40-2BJ2!|p+Q26o5@0!2^sgNE$%(utg?Gfn75?&>=e@mOg%K__>L zt6H;(ZvI`P4`!2Q;8N^32Fs7=c%U<3bgOR}H`g<|PfrQLqSy~UFAS=&DwTi-#x|bzH#$m z#xkSk*^=spk3}X6<*|SCLtPhveuQSd7+CyN1af{wtWC~7CyQT$cq1Run5~rBk=ym_ z7Iy*P%@nGEgd1r9xUvPQ4nNZOLE-4tN$1ZoEll_T21$+vnwGQQ7vOW^2NCa~I1wl%kCgHV|#0hb^~-4XtQcBgFF{AQ?^#0|K`JNydURB9nI$zvu&k1VAgvc%O`y z0}2Y#iU#`(rXKs(g~JX5OA5y*;~ z|Ha#4C@}|LiGj88=s6>vHrjxTqAZuv>>T7B(S`FLvCBW6NhW-=03`|IFP*&m`lBb8Y#3{X=6eauB7Km)1wUd{aqCTke6KIj8p%haOX0)t`X+lp^Ny=ycZ053R4nG|$G=+(R zW1>X#Fu4`oC)Dr2OXzQSISKp-pM9YQP@SKWszR0FR!J3==Wt5ha&&mQN_yX>HvRrJ zSEBZ^z;OCxp`|Ik$sZqAv6*tfZi>NXNFhly7YRsG*tG32X%m0b=3_URl6bLg^?};m(QAV&Pwg{O*_#1^X+;FZ>t%j^ z6>VU4;Q+h`nreQ9zNNfYp6cT1)&3fkQg5pqjIBlWs5`?C=zH*GY}ycrV=n6yS7gd= zK2aM-y4Jk);+XxetLKF8DUWO0tUTJ1yWX{~h<$Gv0cjS@>Fs=TIq}f|^ZdNz>jQsC z_xLyhysr#N8>^=Xvlz=cfl>}>Sok1_NiybNZe?;H+*=X2-@ylgQT|Sb6Z?B3Tyao& z`>**S9G_JF)I;FlifLFn^tAAdS2L)JT3HbK+ z|Mcyx{&{@+RWJb4b!(w_3V09fB7H41X@cy`f4@%HhZ6#R^kUS-8oseac16Kz52j*g zeQ`0xd@f$cta5alUe}Os*hLA zu~7ijQSgDsba`i<{+YJD8g2)dJR7?9v(zACN{4N5uIx?BP*(lcyv*t)C!z6C*q+_= zB0PGwMcg%2>q2l-DOKbh6^Hhf{zlkDnjNe8;4psEOE)G= zRo|#oIkcPoe5%1paM9mJ$P)EJ)5A09IeO)e`&sgC`AvihA^@M$-AgsO|0_0yIzxkb z09z4rHojZj;z49q-z5@`lNSHfNL0L?xF?OmVQg?sNRu!BFf(km&%@h0!%f!f<jYUmZxn7?5lhtk z%L6+{6R-cBk8l+LyFAv5{}P{QR%3%pW-dGpwN?d!O|D59!l9R1r(OcD{Wl22P(qUJ znG*!TMk@aq`5j|D6}s=B%vX-2*>R@jx%Ga_%m|;n6ZUPxh5W-={$Oy&+RC=EH|2J& zf!b=nD%^c>#Z=biXs~(Y*oCr^xCm3_D{)1vAli(_jz=w%g4g^l_t=!KtfA6$&JNp} zlSOY}i=k=R{;{*aMfa;j+1c|-UuJw>z9xSB`_A&TEPqcYXOE5k`D)71M_M1ZvCP}< zJraFJHyp;ed}eYwDxFsMdg9#}-MZBs-StgFo%JeaDk>yTRaI5GB8e^+U}s0_kP9H~ zim|@P3Edj25TR&g(rWe7TCtx3bfHGfmvGJ!O!-%|5PMuO2xQNBH${ z|CBHWU2nr9);Z{lvh?-%k{|0wapH(lh;;|;SYFAQQj1sa$y+jkZnd_u>iqWPN5ji0 z?l`X>&YQ7_&b}u-ybm8q%4T^_swmRpE1-LoHfL=I3Pt9fPu%}$eDfh~WVn8^k{VwKkI?M z4sWrl{{VmSftFbirrKd0ucHDuLz^e9J&RZ-JZ@-7MV^aY+YABroYL%30rN~syw$Td z54TxX#G9&3SL|5~@wJ|QiJD_ep=nhPp=X^S1MU(U!%usS{rD#uWYY>W+{z^Vqrk;l z*R^!p_%3oVciY3PP-It@Yq{FOk<_WQkz&P`h6z_NSo3(YP~CK?av1fRV#klh2LTNR z#`fV5Ie+1HN>`6yyG0aTiDlTpmlC{g&m-?NaS3}@`5Lx)nmO}`S7H8ZQQYPBpUXQD zKcXhFC`hl~_R5XjO|Bkw?>z!e^@a;e5^*9LimNa|l31q>M=duI5-sNN=@I|NVSgaj z(J{P&m_U3se7>H(qZP4Y=Q(T=&rF}}4l2!h(f90ioQ7&%+YRHP#CT);cv_(f{Ly6&mi$6br zzW3h$EL!?#9=*_Ri7|T-=pp*C({NE4qB|#0S`m9@2LAdm84dx=IcW>JS~drLiI?pB z5(x?WKR-gjpvRDS;=P#8<8X{6_5n?fi@J1Y7H0W|a72wR)|X`-su2F4x;W z-8TKCR~~w0tPS(!j4tl3w2q%%`}|h+TjVWCw^LM`wg;C=`hm4(Zy`+xW-^}apOhNCJ~qkDzq#5mjOqvxsCcrg9(%$xEDj#lAJu{0HGg;IZ` z_M-b0$U}ZN-?)a^#buwGl;7WR4Z#g!!wh9vnpFX$fr%;2NR=QBv)3heR{;`9+t}0f z$xZN5wSA#C)~=^^)?}^!zEd|^9W0?p?Jn%Q&goR43yCQxoHo8I?t;T0yy%H`ddkU8P!Yw2O|&BrU1 zbklq#R!N`fh1{3G zN(9({0Fg>TV<>{NfECQ~0H03Yzr@VBj0eqO5gFX9o(>yn;^JeOuuiccUPQsWGUd>> z)&pYn!^i=c>B1&_hd5FBTFe^k4${r~51(ap^9y*ho`*JEw!pZ{OlFy78#x8+iL-wk z_0jfH$*x+->4h8JKKowvf0Vq}tJ*9h*L6xz-cc`|>~+}fv%v5Qun0E{j|9rWtAr#{ z5Afu+)Au2G_{88Oql?mj%2WBqwJ}><(>8qY@|gruD1JThT8T%{d56lv;*_7ti&;1w>-b^_%$@H(MdAQ^Vz->fH;$b_rXa6@(l_vH0?AVmRUOTu<+L0Kp5yr|HJ zU3ucHy&6$w;6(`A&Q1lya(q(7SH$X`iF;?YPmmIQK$vKbGsUh>`Kbu@F6=1NP6OeSyBmB%(YRiatLJl zs629go?^-iP0F>mSs&5hot>Hbn0Rg2--eDMzb;rWQA(t=^ft#hWJXf5%) z=rT=<-7Hbnzx{*00z2ps>qlPay<6rgHEBCqa}{QDZ$(L*C=5CM@mAB3qQD9>2?@IZ zGt#W@2}!jxDkGq!#)4<*fbW8fTNx-j|Mv~=Fm*&&bzSYT7lB%^DX+Z$ngxd`<4!-= z=5$gnG<8s(pise5&b{yH*M>6TROuQ1e1a1LY(fo7llD1F+ zA94%o)~Kdzr0rCNY z2aaHt_LDU!}0K$>Uk~yJfFrE*%A;z&^{L5{;E<45N{yh1oqS%f8ys zW!$HbIttY#A~f&SAK0$16C_D0s0+s?-puJWE^^_O{nG8)FPD0iqjWxqZ0Ui+be~T2 z3pZ%%_D#v&-~LF;Ik&&5EM<0f68^=>Zy2)b7w2jJg37`cCwSU-OH{BMVC$L$_3`DC zu~|kVRi117ulik8Rc-EjpSP!ZVWBPFfzWSmFfu%Msrf*`=({uKr8E6gJx;m*Jh=O( z(yoqnF^chFjBCWMn?u%9EKa~&h8s8nh@AH`o5|oVBA$)qt5N)2I2ds_Dz__sIvi|< zjO(&ev1)SD>b{1{0zN3&%+b7kF8g!)J);7}0zq^tpGd2&JA{YxyRnpup2jTgAf-+-7ctP14bAx(Qf0?9_;2o5I-em-gr2;15+ z268nrf08R<`2KIdORG;`5Zk3I#SjYz3~{%3=t5zEDud8gQcA5Xwc6IrRwfM5$n(%` z$@1A%>)TCE%CfoC-+#%3Wa9ZW?j+vFTzPM%pJH5JX&gblO8|L`y1^H$9N?KU?hh1+ zrwn1bp9>OrEZBI+x|XpaDsl4Ep6Jh0;jR; zTcG*3UA|W@T>~IYg#|=ua)&i4)3>t(b{nL8M{?fnrJ$W$7fj&3YRlR-74SCBXdpr%{57x!8QV?_4wPbBgc(YI0E4@ueyFJ-OY=q^-1d!n?$+w>+mXeGB zL!*i2vSuCQ1QvhKv4vJ_D>E38VG{w>|A0shrh;8d+rk_9#nvn4xm%(Ch0=t=D~qa% zi&Afy-v0jHieT2?jb=YT%}xz772e_D93>!?ivKwknqN=W z*OT@2wEpv#!+hPNuY2@AusrvxdHHHyzCzbm==us>|6c0+ii%%R@hd8RMa8eE_!SlZ ODhBpnH4I`aUH<~F|HR_} literal 0 HcmV?d00001 diff --git a/python/api-examples-source/charts.video3/requirements.txt b/python/api-examples-source/charts.video3/requirements.txt index d6ec53ffe..242adb604 100644 --- a/python/api-examples-source/charts.video3/requirements.txt +++ b/python/api-examples-source/charts.video3/requirements.txt @@ -1,2 +1,2 @@ -streamlit>=1.36.0 +streamlit>=1.37.0 webvtt-py \ No newline at end of file diff --git a/python/api-examples-source/guides/requirements.txt b/python/api-examples-source/guides/requirements.txt index 928232198..e7d18c522 100644 --- a/python/api-examples-source/guides/requirements.txt +++ b/python/api-examples-source/guides/requirements.txt @@ -1 +1 @@ -streamlit>=1.36.0 +streamlit>=1.37.0 diff --git a/python/api-examples-source/hello/requirements.txt b/python/api-examples-source/hello/requirements.txt index ce484d763..d15b408e6 100644 --- a/python/api-examples-source/hello/requirements.txt +++ b/python/api-examples-source/hello/requirements.txt @@ -8,4 +8,4 @@ numpy==1.23.5 scipy altair==4.2.0 pydeck==0.8.0 -streamlit>=1.36.0 +streamlit>=1.37.0 diff --git a/python/api-examples-source/mpa-hello/requirements.txt b/python/api-examples-source/mpa-hello/requirements.txt index c4cfed0d0..49d10200a 100644 --- a/python/api-examples-source/mpa-hello/requirements.txt +++ b/python/api-examples-source/mpa-hello/requirements.txt @@ -4,4 +4,4 @@ scipy altair==4.2.0 pydeck==0.8.0 opencv-python-headless==4.6.0.66 -streamlit>=1.36.0 +streamlit>=1.37.0 diff --git a/python/api-examples-source/requirements.txt b/python/api-examples-source/requirements.txt index 72b587ff4..be68d632e 100644 --- a/python/api-examples-source/requirements.txt +++ b/python/api-examples-source/requirements.txt @@ -11,4 +11,4 @@ pydeck==0.8.0 Faker==19.1.0 openai==1.3.0 vega_datasets -streamlit-nightly +streamlit>=1.37.0 diff --git a/python/api-examples-source/st-experimental-connection/1.22/st-experimental-connection/requirements.txt b/python/api-examples-source/st-experimental-connection/1.22/st-experimental-connection/requirements.txt index b1577d99d..e0277ec52 100644 --- a/python/api-examples-source/st-experimental-connection/1.22/st-experimental-connection/requirements.txt +++ b/python/api-examples-source/st-experimental-connection/1.22/st-experimental-connection/requirements.txt @@ -1,4 +1,4 @@ -streamlit>=1.36.0 +streamlit>=1.37.0 toml sqlalchemy==1.4 duckdb diff --git a/python/api-examples-source/text.header.py b/python/api-examples-source/text.header.py index 09bf64835..2b3a1a56a 100644 --- a/python/api-examples-source/text.header.py +++ b/python/api-examples-source/text.header.py @@ -1,4 +1,9 @@ import streamlit as st -st.header("This is a header with a divider", divider="rainbow") st.header("_Streamlit_ is :blue[cool] :sunglasses:") +st.header("This is a header with a divider", divider="gray") +st.header("These headers have rotating dividers", divider=True) +st.header("One", divider=True) +st.header("Two", divider=True) +st.header("Three", divider=True) +st.header("Four", divider=True) diff --git a/python/api-examples-source/text.subheader.py b/python/api-examples-source/text.subheader.py index 623af2210..83ba48065 100644 --- a/python/api-examples-source/text.subheader.py +++ b/python/api-examples-source/text.subheader.py @@ -1,4 +1,9 @@ import streamlit as st -st.subheader("This is a subheader with a divider", divider="rainbow") st.subheader("_Streamlit_ is :blue[cool] :sunglasses:") +st.subheader("This is a subheader with a divider", divider="gray") +st.subheader("These subheaders have rotating dividers", divider=True) +st.subheader("One", divider=True) +st.subheader("Two", divider=True) +st.subheader("Three", divider=True) +st.subheader("Four", divider=True) diff --git a/python/api-examples-source/theming/requirements.txt b/python/api-examples-source/theming/requirements.txt index f17cd79c1..ddc583326 100644 --- a/python/api-examples-source/theming/requirements.txt +++ b/python/api-examples-source/theming/requirements.txt @@ -1,4 +1,4 @@ -streamlit>=1.36.0 +streamlit>=1.37.0 vega_datasets altair==4.2.0 plotly==5.13.0 \ No newline at end of file diff --git a/python/api-examples-source/tutorials/custom-navigation/requirements.txt b/python/api-examples-source/tutorials/custom-navigation/requirements.txt index 928232198..e7d18c522 100644 --- a/python/api-examples-source/tutorials/custom-navigation/requirements.txt +++ b/python/api-examples-source/tutorials/custom-navigation/requirements.txt @@ -1 +1 @@ -streamlit>=1.36.0 +streamlit>=1.37.0 diff --git a/python/api-examples-source/tutorials/elements/charts/requirements.txt b/python/api-examples-source/tutorials/elements/charts/requirements.txt index fc17dc996..65b964150 100644 --- a/python/api-examples-source/tutorials/elements/charts/requirements.txt +++ b/python/api-examples-source/tutorials/elements/charts/requirements.txt @@ -1,2 +1,2 @@ vega_datasets -streamlit==1.36.0 \ No newline at end of file +streamlit==1.37.0 \ No newline at end of file diff --git a/python/api-examples-source/tutorials/elements/dataframes/requirements.txt b/python/api-examples-source/tutorials/elements/dataframes/requirements.txt index 36c8f202e..e9feb1060 100644 --- a/python/api-examples-source/tutorials/elements/dataframes/requirements.txt +++ b/python/api-examples-source/tutorials/elements/dataframes/requirements.txt @@ -1,2 +1,2 @@ Faker -streamlit==1.36.0 \ No newline at end of file +streamlit==1.37.0 \ No newline at end of file diff --git a/python/api-examples-source/tutorials/requirements.txt b/python/api-examples-source/tutorials/requirements.txt index 928232198..e7d18c522 100644 --- a/python/api-examples-source/tutorials/requirements.txt +++ b/python/api-examples-source/tutorials/requirements.txt @@ -1 +1 @@ -streamlit>=1.36.0 +streamlit>=1.37.0 diff --git a/python/api-examples-source/utilities.switch_page/requirements.txt b/python/api-examples-source/utilities.switch_page/requirements.txt index 928232198..e7d18c522 100644 --- a/python/api-examples-source/utilities.switch_page/requirements.txt +++ b/python/api-examples-source/utilities.switch_page/requirements.txt @@ -1 +1 @@ -streamlit>=1.36.0 +streamlit>=1.37.0 diff --git a/python/api-examples-source/widget.page_link/requirements.txt b/python/api-examples-source/widget.page_link/requirements.txt index 928232198..e7d18c522 100644 --- a/python/api-examples-source/widget.page_link/requirements.txt +++ b/python/api-examples-source/widget.page_link/requirements.txt @@ -1 +1 @@ -streamlit>=1.36.0 +streamlit>=1.37.0 diff --git a/python/generate.py b/python/generate.py index a730e9127..5e75d28a3 100644 --- a/python/generate.py +++ b/python/generate.py @@ -76,7 +76,16 @@ def get_github_source(func): source_file = inspect.getsourcefile(func) except TypeError: try: - source_file = inspect.getsourcefile(func.fget) + # TODO: The inspect module returns the correct line number but not + # the correct source file for functions with both @property and + # @gather_metrics. Replace ContextProxy properties with their + # parent class for the purposes of getting the correct source file. + # Generalize this two deal with arbitrarily wrapped functions. + context_obj = getattr(streamlit.runtime.context, "ContextProxy") + if func.fget.__module__ == context_obj.__module__: + source_file = inspect.getsourcefile(context_obj) + else: + source_file = inspect.getsourcefile(func.fget) except AttributeError: source_file = inspect.getsourcefile(func.__call__) @@ -538,18 +547,10 @@ def get_streamlit_docstring_dict(): obj_key = { streamlit: ["streamlit", "st"], - streamlit.runtime.caching.experimental_memo: [ - "streamlit.experimental_memo", - "st.experimental_memo", - ], streamlit.runtime.caching.cache_data_api.CacheDataAPI: [ "streamlit.cache_data", "st.cache_data", ], - streamlit.runtime.caching.experimental_singleton: [ - "streamlit.experimental_singleton", - "st.experimental_singleton", - ], streamlit.runtime.caching.cache_resource_api.CacheResourceAPI: [ "streamlit.cache_resource", "st.cache_resource", @@ -590,12 +591,14 @@ def get_streamlit_docstring_dict(): "st.testing.v1.element_tree", ], streamlit.user_info.UserInfoProxy: ["streamlit.experimental_user", "st.experimental_user"], + streamlit.runtime.context.ContextProxy: ["context", "context"], CachedFunc: ["CachedFunc", "CachedFunc"], page: ["", "", ["StreamlitPage"]], StreamlitPage: ["StreamlitPage", "StreamlitPage"], } proxy_obj_key = { streamlit.user_info.UserInfoProxy: ["streamlit.experimental_user", "st.experimental_user"], + streamlit.runtime.context.ContextProxy: ["streamlit.context", "st.context"] } attribute_dicts = { PlotlyState: ["PlotlyState", "PlotlyState"], diff --git a/python/streamlit.json b/python/streamlit.json index 492fe7b5e..2cd59e28e 100644 --- a/python/streamlit.json +++ b/python/streamlit.json @@ -144108,5 +144108,9801 @@ "returns": [], "is_attribute_dict": true } + }, + "1.37.0": { + "streamlit.Page": { + "name": "Page", + "signature": "st.Page(page, *, title=None, icon=None, url_path=None, default=False)", + "example": "

\n
\nimport streamlit as st\n\ndef page2():\n    st.title("Second page")\n\npg = st.navigation([\n    st.Page("page1.py", title="First page", icon="\ud83d\udd25"),\n    st.Page(page2, title="Second page", icon=":material/favorite:"),\n])\npg.run()\n
\n
\n", + "description": "

Configure a page for st.navigation in a multipage app.

\n

Call st.Page to initialize a StreamlitPage object, and pass it to\nst.navigation to declare a page in your app.

\n

When a user navigates to a page, st.navigation returns the selected\nStreamlitPage object. Call .run() on the returned StreamlitPage\nobject to execute the page. You can only run the page returned by\nst.navigation, and you can only run it once per app rerun.

\n

A page can be defined by a Python file or Callable. Python files used\nas a StreamlitPage source will have __name__ == "__page__".\nFunctions used as a StreamlitPage source will have __name__\ncorresponding to the module they were imported from. Only the entrypoint\nfile and functions defined within the entrypoint file have\n__name__ == "__main__" to adhere to Python convention.

\n", + "args": [ + { + "name": "page", + "type_name": "str, Path, or callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The page source as a Callable or path to a Python file. If the page\nsource is defined by a Python file, the path can be a string or\npathlib.Path object, but must be declared relative to the\nentrypoint file. If the page source is defined by a Callable, the\nCallable can't accept arguments.

\n", + "default": null + }, + { + "name": "title", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The title of the page. If this is None (default), the page title\n(in the browser tab) and label (in the navigation menu) will be\ninferred from the filename or callable name in page. For more\ninformation, see Overview of multipage apps.

\n", + "default": null + }, + { + "name": "icon", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional emoji or icon to display next to the page title and label.\nIf icon is None (default), no icon is displayed next to the\npage label in the navigation menu, and a Streamlit icon is displayed\nnext to the title (in the browser tab). If icon is a string, the\nfollowing options are valid:

\n
    \n
  • \n
    A single-character emoji. For example, you can set icon="\ud83d\udea8"
    \n

    or icon="\ud83d\udd25". Emoji short codes are not supported.

    \n
    \n
    \n
    • \n
  • \n
    An icon from the Material Symbols library (rounded style) in the
    \n

    format ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols\nfont library.

    \n
    \n
    \n
    • \n
\n", + "default": null + }, + { + "name": "url_path", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The page's URL pathname, which is the path relative to the app's root\nURL. If this is None (default), the URL pathname will be inferred\nfrom the filename or callable name in page. For more information,\nsee Overview of multipage apps.

\n

The default page will have a pathname of "", indicating the root\nURL of the app. If you set default=True, url_path is ignored.

\n", + "default": "page" + }, + { + "name": "default", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether this page is the default page to be shown when the app is\nloaded. If default is False (default), the page will have a\nnonempty URL pathname. However, if no default page is passed to\nst.navigation and this is the first page, this page will become the\ndefault page. If default is True, then the page will have\nan empty pathname and url_path will be ignored.

\n", + "default": "page" + } + ], + "returns": [ + { + "type_name": "StreamlitPage", + "is_generator": false, + "description": "

The page object associated to the given script.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L29" + }, + "streamlit.altair_chart": { + "name": "altair_chart", + "signature": "st.altair_chart(altair_chart, *, use_container_width=False, theme=\"streamlit\", key=None, on_select=\"ignore\", selection_mode=None)", + "example": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\nimport altair as alt\n\nchart_data = pd.DataFrame(np.random.randn(20, 3), columns=["a", "b", "c"])\n\nc = (\n   alt.Chart(chart_data)\n   .mark_circle()\n   .encode(x="a", y="b", size="c", color="c", tooltip=["a", "b", "c"])\n)\n\nst.altair_chart(c, use_container_width=True)\n
\n
\n", + "description": "

Display a chart using the Vega-Altair library.

\n

Vega-Altair is a declarative\nstatistical visualization library for Python, based on Vega and\nVega-Lite.

\n", + "args": [ + { + "name": "altair_chart", + "type_name": "altair.Chart", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The Altair chart object to display. See\nhttps://altair-viz.github.io/gallery/ for examples of graph\ndescriptions.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to override the figure's native width with the width of\nthe parent container. If use_container_width is False\n(default), Streamlit sets the width of the chart to fit its contents\naccording to the plotting library, up to the width of the parent\ncontainer. If use_container_width is True, Streamlit sets\nthe width of the figure to match the width of the parent container.

\n", + "default": null + }, + { + "name": "theme", + "type_name": "\"streamlit\" or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The theme of the chart. If theme is "streamlit" (default),\nStreamlit uses its own design default. If theme is None,\nStreamlit falls back to the default behavior of the library.

\n", + "default": "behavior" + }, + { + "name": "key", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string to use for giving this element a stable\nidentity. If key is None (default), this element's identity\nwill be determined based on the values of the other parameters.

\n

Additionally, if selections are activated and key is provided,\nStreamlit will register the key in Session State to store the\nselection state. The selection state is read-only.

\n", + "default": null + }, + { + "name": "on_select", + "type_name": "\"ignore\", \"rerun\", or callable", + "is_optional": false, + "is_kwarg_only": true, + "description": "

How the figure should respond to user selection events. This\ncontrols whether or not the figure behaves like an input widget.\non_select can be one of the following:

\n
    \n
  • "ignore" (default): Streamlit will not react to any selection\nevents in the chart. The figure will not behave like an input\nwidget.
    • \n
  • "rerun": Streamlit will rerun the app when the user selects\ndata in the chart. In this case, st.altair_chart will return\nthe selection data as a dictionary.
    • \n
  • A callable: Streamlit will rerun the app and execute the\ncallable as a callback function before the rest of the app.\nIn this case, st.altair_chart will return the selection data\nas a dictionary.
    • \n
\n

To use selection events, the object passed to altair_chart must\ninclude selection paramters. To learn about defining interactions\nin Altair and how to declare selection-type parameters, see\nInteractive Charts\nin Altair's documentation.

\n", + "default": null + }, + { + "name": "selection_mode", + "type_name": "str or Iterable of str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The selection parameters Streamlit should use. If\nselection_mode is None (default), Streamlit will use all\nselection parameters defined in the chart's Altair spec.

\n

When Streamlit uses a selection parameter, selections from that\nparameter will trigger a rerun and be included in the selection\nstate. When Streamlit does not use a selection parameter,\nselections from that parameter will not trigger a rerun and not be\nincluded in the selection state.

\n

Selection parameters are identified by their name property.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "element or dict", + "is_generator": false, + "description": "

If on_select is "ignore" (default), this method returns an\ninternal placeholder for the chart element that can be used with\nthe .add_rows() method. Otherwise, this method returns a\ndictionary-like object that supports both key and attribute\nnotation. The attributes are described by the VegaLiteState\ndictionary schema.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/vega_charts.py#L1489" + }, + "streamlit.area_chart": { + "name": "area_chart", + "signature": "st.area_chart(data=None, *, x=None, y=None, x_label=None, y_label=None, color=None, stack=None, width=None, height=None, use_container_width=True)", + "examples": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(np.random.randn(20, 3), columns=["a", "b", "c"])\n\nst.area_chart(chart_data)\n
\n

You can also choose different columns to use for x and y, as well as set\nthe color dynamically based on a 3rd column (assuming your dataframe is in\nlong format):

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(\n    {\n        "col1": np.random.randn(20),\n        "col2": np.random.randn(20),\n        "col3": np.random.choice(["A", "B", "C"], 20),\n    }\n)\n\nst.area_chart(chart_data, x="col1", y="col2", color="col3")\n
\n

If your dataframe is in wide format, you can group multiple\ncolumns under the y argument to show multiple series with different\ncolors:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(\n    np.random.randn(20, 3), columns=["col1", "col2", "col3"]\n)\n\nst.area_chart(\n    chart_data,\n    x="col1",\n    y=["col2", "col3"],\n    color=["#FF0000", "#0000FF"],  # Optional\n)\n
\n

You can adjust the stacking behavior by setting stack. Create a\nsteamgraph:

\n
\nimport streamlit as st\nfrom vega_datasets import data\n\nsource = data.unemployment_across_industries()\n\nst.area_chart(source, x="date", y="count", color="series", stack="center")\n
\n
\n", + "description": "

Display an area chart.

\n

This is syntax-sugar around st.altair_chart. The main difference\nis this command uses the data's own column and indices to figure out\nthe chart's Altair spec. As a result this is easier to use for many\n"just plot this" scenarios, while being less customizable.

\n

If st.area_chart does not guess the data specification\ncorrectly, try specifying your desired chart using st.altair_chart.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Styler, pyarrow.Table, numpy.ndarray, pyspark.sql.DataFrame, snowflake.snowpark.dataframe.DataFrame, snowflake.snowpark.table.Table, Iterable, or dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Data to be plotted.

\n", + "default": null + }, + { + "name": "x", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column name or key associated to the x-axis data. If x is\nNone (default), Streamlit uses the data index for the x-axis\nvalues.

\n", + "default": null + }, + { + "name": "y", + "type_name": "str, Sequence of str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column name(s) or key(s) associated to the y-axis data. If this is\nNone (default), Streamlit draws the data of all remaining\ncolumns as data series. If this is a Sequence of strings,\nStreamlit draws several series on the same chart by melting your\nwide-format table into a long-format table behind the scenes.

\n", + "default": null + }, + { + "name": "x_label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The label for the x-axis. If this is None (default), Streamlit\nwill use the column name specified in x if available, or else\nno label will be displayed.

\n", + "default": null + }, + { + "name": "y_label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The label for the y-axis. If this is None (default), Streamlit\nwill use the column name(s) specified in y if available, or\nelse no label will be displayed.

\n", + "default": null + }, + { + "name": "color", + "type_name": "str, tuple, Sequence of str, Sequence of tuple, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The color to use for different series in this chart.

\n

For an area chart with just 1 series, this can be:

\n
    \n
  • None, to use the default color.
    • \n
  • A hex string like "#ffaa00" or "#ffaa0088".
    • \n
  • An RGB or RGBA tuple with the red, green, blue, and alpha\ncomponents specified as ints from 0 to 255 or floats from 0.0 to\n1.0.
    • \n
\n

For an area chart with multiple series, where the dataframe is in\nlong format (that is, y is None or just one column), this can be:

\n
    \n

  • None, to use the default colors.

    \n
    • \n

  • The name of a column in the dataset. Data points will be grouped\ninto series of the same color based on the value of this column.\nIn addition, if the values in this column match one of the color\nformats above (hex string or color tuple), then that color will\nbe used.

    \n

    For example: if the dataset has 1000 rows, but this column only\ncontains the values "adult", "child", and "baby", then those 1000\ndatapoints will be grouped into three series whose colors will be\nautomatically selected from the default palette.

    \n

    But, if for the same 1000-row dataset, this column contained\nthe values "#ffaa00", "#f0f", "#0000ff", then then those 1000\ndatapoints would still be grouped into 3 series, but their\ncolors would be "#ffaa00", "#f0f", "#0000ff" this time around.

    \n
    • \n
\n

For an area chart with multiple series, where the dataframe is in\nwide format (that is, y is a Sequence of columns), this can be:

\n
    \n
  • None, to use the default colors.
    • \n
  • A list of string colors or color tuples to be used for each of\nthe series in the chart. This list should have the same length\nas the number of y values (e.g. color=["#fd0", "#f0f", "#04f"]\nfor three lines).
    • \n
\n", + "default": "color" + }, + { + "name": "stack", + "type_name": "bool, \"normalize\", \"center\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to stack the areas. If this is None (default),\nStreamlit uses Vega's default. Other values can be as follows:

\n
    \n
  • True: The areas form a non-overlapping, additive stack within\nthe chart.
    • \n
  • False: The areas overlap each other without stacking.
    • \n
  • "normalize": The areas are stacked and the total height is\nnormalized to 100% of the height of the chart.
    • \n
  • "center": The areas are stacked and shifted to center their\nbaseline, which creates a steamgraph.
    • \n
\n", + "default": null + }, + { + "name": "width", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired width of the chart expressed in pixels. If width is\nNone (default), Streamlit sets the width of the chart to fit\nits contents according to the plotting library, up to the width of\nthe parent container. If width is greater than the width of the\nparent container, Streamlit sets the chart width to match the width\nof the parent container.

\n

To use width, you must set use_container_width=False.

\n", + "default": null + }, + { + "name": "height", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired height of the chart expressed in pixels. If height is\nNone (default), Streamlit sets the height of the chart to fit\nits contents according to the plotting library.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to override width with the width of the parent\ncontainer. If use_container_width is True (default),\nStreamlit sets the width of the chart to match the width of the\nparent container. If use_container_width is False,\nStreamlit sets the chart's width according to width.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/vega_charts.py#L748" + }, + "streamlit.audio": { + "name": "audio", + "signature": "st.audio(data, format=\"audio/wav\", start_time=0, *, sample_rate=None, end_time=None, loop=False, autoplay=False)", + "examples": "
\n

To display an audio player for a local file, specify the file's string\npath and format.

\n
\nimport streamlit as st\n\nst.audio("cat-purr.mp3", format="audio/mpeg", loop=True)\n
\n

You can also pass bytes or numpy.ndarray objects to st.audio.

\n
\nimport streamlit as st\nimport numpy as np\n\naudio_file = open("myaudio.ogg", "rb")\naudio_bytes = audio_file.read()\n\nst.audio(audio_bytes, format="audio/ogg")\n\nsample_rate = 44100  # 44100 samples per second\nseconds = 2  # Note duration of 2 seconds\nfrequency_la = 440  # Our played note will be 440 Hz\n# Generate array with seconds*sample_rate steps, ranging between 0 and seconds\nt = np.linspace(0, seconds, seconds * sample_rate, False)\n# Generate a 440 Hz sine wave\nnote_la = np.sin(frequency_la * t * 2 * np.pi)\n\nst.audio(note_la, sample_rate=sample_rate)\n
\n
\n", + "description": "

Display an audio player.

\n", + "args": [ + { + "name": "data", + "type_name": "str, bytes, BytesIO, numpy.ndarray, or file", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Raw audio data, filename, or a URL pointing to the file to load.\nRaw data formats must include all necessary file headers to match the file\nformat specified via format.\nIf data is a numpy array, it must either be a 1D array of the waveform\nor a 2D array of shape (num_channels, num_samples) with waveforms\nfor all channels. See the default channel order at\nhttp://msdn.microsoft.com/en-us/library/windows/hardware/dn653308(v=vs.85).aspx

\n", + "default": "channel" + }, + { + "name": "format", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The mime type for the audio file. Defaults to "audio/wav".\nSee https://tools.ietf.org/html/rfc4281 for more info.

\n", + "default": "s" + }, + { + "name": "start_time", + "type_name": "int, float, timedelta, str, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The time from which the element should start playing. This can be\none of the following:

\n
    \n
  • None (default): The element plays from the beginning.
    • \n
  • An int or float specifying the time in seconds. float\nvalues are rounded down to whole seconds.
    • \n
  • A string specifying the time in a format supported by Pandas'\nTimedelta constructor,\ne.g. "2 minute", "20s", or "1m14s".
    • \n
  • A timedelta object from Python's built-in datetime library,\ne.g. timedelta(seconds=70).
    • \n
\n", + "default": null + }, + { + "name": "sample_rate", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The sample rate of the audio data in samples per second. Only required if\ndata is a numpy array.

\n", + "default": null + }, + { + "name": "end_time", + "type_name": "int, float, timedelta, str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The time at which the element should stop playing. This can be\none of the following:

\n
    \n
  • None (default): The element plays through to the end.
    • \n
  • An int or float specifying the time in seconds. float\nvalues are rounded down to whole seconds.
    • \n
  • A string specifying the time in a format supported by Pandas'\nTimedelta constructor,\ne.g. "2 minute", "20s", or "1m14s".
    • \n
  • A timedelta object from Python's built-in datetime library,\ne.g. timedelta(seconds=70).
    • \n
\n", + "default": null + }, + { + "name": "loop", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether the audio should loop playback.

\n", + "default": null + }, + { + "name": "autoplay", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether the audio file should start playing automatically. This is\nFalse by default. Browsers will not autoplay audio files if the\nuser has not interacted with the page by clicking somewhere.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/media.py#L64" + }, + "streamlit.balloons": { + "name": "balloons", + "signature": "st.balloons()", + "example": "
\n
\nimport streamlit as st\n\nst.balloons()\n
\n

...then watch your app and get ready for a celebration!

\n
\n", + "description": "

Draw celebratory balloons.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/balloons.py#L27" + }, + "streamlit.bar_chart": { + "name": "bar_chart", + "signature": "st.bar_chart(data=None, *, x=None, y=None, x_label=None, y_label=None, color=None, horizontal=False, stack=None, width=None, height=None, use_container_width=True)", + "examples": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(np.random.randn(20, 3), columns=["a", "b", "c"])\n\nst.bar_chart(chart_data)\n
\n

You can also choose different columns to use for x and y, as well as set\nthe color dynamically based on a 3rd column (assuming your dataframe is in\nlong format):

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(\n    {\n        "col1": list(range(20)) * 3,\n        "col2": np.random.randn(60),\n        "col3": ["A"] * 20 + ["B"] * 20 + ["C"] * 20,\n    }\n)\n\nst.bar_chart(chart_data, x="col1", y="col2", color="col3")\n
\n

If your dataframe is in wide format, you can group multiple\ncolumns under the y argument to show multiple series with different\ncolors:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(\n    {\n        "col1": list(range(20)),\n        "col2": np.random.randn(20),\n        "col3": np.random.randn(20),\n    }\n)\n\nst.bar_chart(\n    chart_data,\n    x="col1",\n    y=["col2", "col3"],\n    color=["#FF0000", "#0000FF"],  # Optional\n)\n
\n

You can rotate your bar charts to display horizontally.

\n
\nimport streamlit as st\nfrom vega_datasets import data\n\nsource = data.barley()\n\nst.bar_chart(source, x="variety", y="yield", color="site", horizontal=True)\n
\n

You can unstack your bar charts.

\n
\nimport streamlit as st\nfrom vega_datasets import data\n\nsource = data.barley()\n\nst.bar_chart(source, x="year", y="yield", color="site", stack=False)\n
\n
\n", + "description": "

Display a bar chart.

\n

This is syntax-sugar around st.altair_chart. The main difference\nis this command uses the data's own column and indices to figure out\nthe chart's Altair spec. As a result this is easier to use for many\n"just plot this" scenarios, while being less customizable.

\n

If st.bar_chart does not guess the data specification\ncorrectly, try specifying your desired chart using st.altair_chart.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Styler, pyarrow.Table, numpy.ndarray, pyspark.sql.DataFrame, snowflake.snowpark.dataframe.DataFrame, snowflake.snowpark.table.Table, Iterable, or dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Data to be plotted.

\n", + "default": null + }, + { + "name": "x", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column name or key associated to the x-axis data. If x is\nNone (default), Streamlit uses the data index for the x-axis\nvalues.

\n", + "default": null + }, + { + "name": "y", + "type_name": "str, Sequence of str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column name(s) or key(s) associated to the y-axis data. If this is\nNone (default), Streamlit draws the data of all remaining\ncolumns as data series. If this is a Sequence of strings,\nStreamlit draws several series on the same chart by melting your\nwide-format table into a long-format table behind the scenes.

\n", + "default": null + }, + { + "name": "x_label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The label for the x-axis. If this is None (default), Streamlit\nwill use the column name specified in x if available, or else\nno label will be displayed.

\n", + "default": null + }, + { + "name": "y_label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The label for the y-axis. If this is None (default), Streamlit\nwill use the column name(s) specified in y if available, or\nelse no label will be displayed.

\n", + "default": null + }, + { + "name": "color", + "type_name": "str, tuple, Sequence of str, Sequence of tuple, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The color to use for different series in this chart.

\n

For a bar chart with just one series, this can be:

\n
    \n
  • None, to use the default color.
    • \n
  • A hex string like "#ffaa00" or "#ffaa0088".
    • \n
  • An RGB or RGBA tuple with the red, green, blue, and alpha\ncomponents specified as ints from 0 to 255 or floats from 0.0 to\n1.0.
    • \n
\n

For a bar chart with multiple series, where the dataframe is in\nlong format (that is, y is None or just one column), this can be:

\n
    \n

  • None, to use the default colors.

    \n
    • \n

  • The name of a column in the dataset. Data points will be grouped\ninto series of the same color based on the value of this column.\nIn addition, if the values in this column match one of the color\nformats above (hex string or color tuple), then that color will\nbe used.

    \n

    For example: if the dataset has 1000 rows, but this column only\ncontains the values "adult", "child", and "baby", then those 1000\ndatapoints will be grouped into three series whose colors will be\nautomatically selected from the default palette.

    \n

    But, if for the same 1000-row dataset, this column contained\nthe values "#ffaa00", "#f0f", "#0000ff", then then those 1000\ndatapoints would still be grouped into 3 series, but their\ncolors would be "#ffaa00", "#f0f", "#0000ff" this time around.

    \n
    • \n
\n

For a bar chart with multiple series, where the dataframe is in\nwide format (that is, y is a Sequence of columns), this can be:

\n
    \n
  • None, to use the default colors.
    • \n
  • A list of string colors or color tuples to be used for each of\nthe series in the chart. This list should have the same length\nas the number of y values (e.g. color=["#fd0", "#f0f", "#04f"]\nfor three lines).
    • \n
\n", + "default": "color" + }, + { + "name": "horizontal", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to make the bars horizontal. If this is False\n(default), the bars display vertically. If this is True,\nStreamlit swaps the x-axis and y-axis and the bars display\nhorizontally.

\n", + "default": null + }, + { + "name": "stack", + "type_name": "bool, \"normalize\", \"center\", \"layered\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to stack the bars. If this is None (default),\nStreamlit uses Vega's default. Other values can be as follows:

\n
    \n
  • True: The bars form a non-overlapping, additive stack within\nthe chart.
    • \n
  • False: The bars display side by side.
    • \n
  • "layered": The bars overlap each other without stacking.
    • \n
  • "normalize": The bars are stacked and the total height is\nnormalized to 100% of the height of the chart.
    • \n
  • "center": The bars are stacked and shifted to center the\ntotal height around an axis.
    • \n
\n", + "default": null + }, + { + "name": "width", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired width of the chart expressed in pixels. If width is\nNone (default), Streamlit sets the width of the chart to fit\nits contents according to the plotting library, up to the width of\nthe parent container. If width is greater than the width of the\nparent container, Streamlit sets the chart width to match the width\nof the parent container.

\n

To use width, you must set use_container_width=False.

\n", + "default": null + }, + { + "name": "height", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired height of the chart expressed in pixels. If height is\nNone (default), Streamlit sets the height of the chart to fit\nits contents according to the plotting library.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to override width with the width of the parent\ncontainer. If use_container_width is True (default),\nStreamlit sets the width of the chart to match the width of the\nparent container. If use_container_width is False,\nStreamlit sets the chart's width according to width.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/vega_charts.py#L986" + }, + "streamlit.bokeh_chart": { + "name": "bokeh_chart", + "signature": "st.bokeh_chart(figure, use_container_width=False)", + "example": "
\n
\nimport streamlit as st\nfrom bokeh.plotting import figure\n\nx = [1, 2, 3, 4, 5]\ny = [6, 7, 2, 4, 5]\n\np = figure(title="simple line example", x_axis_label="x", y_axis_label="y")\np.line(x, y, legend_label="Trend", line_width=2)\n\nst.bokeh_chart(p, use_container_width=True)\n
\n
\n", + "description": "

Display an interactive Bokeh chart.

\n

Bokeh is a charting library for Python. The arguments to this function\nclosely follow the ones for Bokeh's show function. You can find\nmore about Bokeh at https://bokeh.pydata.org.

\n

To show Bokeh charts in Streamlit, call st.bokeh_chart\nwherever you would call Bokeh's show.

\n", + "args": [ + { + "name": "figure", + "type_name": "bokeh.plotting.figure.Figure", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A Bokeh figure to plot.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to override the figure's native width with the width of\nthe parent container. If use_container_width is False\n(default), Streamlit sets the width of the chart to fit its contents\naccording to the plotting library, up to the width of the parent\ncontainer. If use_container_width is True, Streamlit sets\nthe width of the figure to match the width of the parent container.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/bokeh_chart.py#L37" + }, + "streamlit.button": { + "name": "button", + "signature": "st.button(label, key=None, help=None, on_click=None, args=None, kwargs=None, *, type=\"secondary\", disabled=False, use_container_width=False)", + "example": "
\n
\nimport streamlit as st\n\nst.button("Reset", type="primary")\nif st.button("Say hello"):\n    st.write("Why hello there")\nelse:\n    st.write("Goodbye")\n
\n
\n", + "description": "

Display a button widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this button is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed when the button is\nhovered over.

\n", + "default": null + }, + { + "name": "on_click", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this button is clicked.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "type", + "type_name": "\"secondary\" or \"primary\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string that specifies the button type. Can be "primary" for a\nbutton with additional emphasis or "secondary" for a normal button. Defaults\nto "secondary".

\n", + "default": "s" + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the button if set to True. The\ndefault is False.

\n", + "default": "False" + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to expand the button's width to fill its parent container.\nIf use_container_width is False (default), Streamlit sizes\nthe button to fit its contents. If use_container_width is\nTrue, the width of the button matches its parent container.

\n

In both cases, if the contents of the button are wider than the\nparent container, the contents will line wrap.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "bool", + "is_generator": false, + "description": "

True if the button was clicked on the last run of the app,\nFalse otherwise.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/button.py#L78" + }, + "streamlit.cache": { + "name": "cache", + "signature": "st.cache(func=None, persist=False, allow_output_mutation=False, show_spinner=True, suppress_st_warning=False, hash_funcs=None, max_entries=None, ttl=None)", + "example": "
\n
\nimport streamlit as st\n\n@st.cache\ndef fetch_and_clean_data(url):\n    # Fetch data from URL here, and then clean it up.\n    return data\n\nd1 = fetch_and_clean_data(DATA_URL_1)\n# Actually executes the function, since this is the first time it was\n# encountered.\n\nd2 = fetch_and_clean_data(DATA_URL_1)\n# Does not execute the function. Instead, returns its previously computed\n# value. This means that now the data in d1 is the same as in d2.\n\nd3 = fetch_and_clean_data(DATA_URL_2)\n# This is a different URL, so the function executes.\n
\n

To set the persist parameter, use this command as follows:

\n
\n@st.cache(persist=True)\ndef fetch_and_clean_data(url):\n    # Fetch data from URL here, and then clean it up.\n    return data\n
\n

To disable hashing return values, set the allow_output_mutation parameter to True:

\n
\n@st.cache(allow_output_mutation=True)\ndef fetch_and_clean_data(url):\n    # Fetch data from URL here, and then clean it up.\n    return data\n
\n

To override the default hashing behavior, pass a custom hash function.\nYou can do that by mapping a type (e.g. MongoClient) to a hash function (id) like this:

\n
\n@st.cache(hash_funcs={MongoClient: id})\ndef connect_to_database(url):\n    return MongoClient(url)\n
\n

Alternatively, you can map the type's fully-qualified name\n(e.g. "pymongo.mongo_client.MongoClient") to the hash function instead:

\n
\n@st.cache(hash_funcs={"pymongo.mongo_client.MongoClient": id})\ndef connect_to_database(url):\n    return MongoClient(url)\n
\n
\n", + "description": "

Legacy caching decorator (deprecated).

\n

Legacy caching with st.cache has been removed from Streamlit. This is\nnow an alias for st.cache_data and st.cache_resource.

\n", + "args": [ + { + "name": "func", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The function to cache. Streamlit hashes the function's source code.

\n", + "default": null + }, + { + "name": "persist", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to persist the cache on disk.

\n", + "default": null + }, + { + "name": "allow_output_mutation", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to use st.cache_data or st.cache_resource. If this is\nFalse (default), the arguments are passed to st.cache_data. If\nthis is True, the arguments are passed to st.cache_resource.

\n", + "default": null + }, + { + "name": "show_spinner", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Enable the spinner. Default is True to show a spinner when there is\na "cache miss" and the cached data is being created.

\n", + "default": "is" + }, + { + "name": "suppress_st_warning", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

This is not used.

\n", + "default": null + }, + { + "name": "hash_funcs", + "type_name": "dict or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Mapping of types or fully qualified names to hash functions. This is used to override\nthe behavior of the hasher inside Streamlit's caching mechanism: when the hasher\nencounters an object, it will first check to see if its type matches a key in this\ndict and, if so, will use the provided function to generate a hash for it. See below\nfor an example of how this can be used.

\n", + "default": null + }, + { + "name": "max_entries", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The maximum number of entries to keep in the cache, or None\nfor an unbounded cache. (When a new entry is added to a full cache,\nthe oldest cached entry will be removed.) The default is None.

\n", + "default": "is" + }, + { + "name": "ttl", + "type_name": "float or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The maximum number of seconds to keep an entry in the cache, or\nNone if cache entries should not expire. The default is None.

\n", + "default": "None" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/caching/legacy_cache_api.py#L33" + }, + "streamlit.cache_data": { + "name": "cache_data", + "signature": "st.cache_data(func=None, *, ttl, max_entries, show_spinner, persist, experimental_allow_widgets, hash_funcs=None)", + "example": "
\n
\nimport streamlit as st\n\n@st.cache_data\ndef fetch_and_clean_data(url):\n    # Fetch data from URL here, and then clean it up.\n    return data\n\nd1 = fetch_and_clean_data(DATA_URL_1)\n# Actually executes the function, since this is the first time it was\n# encountered.\n\nd2 = fetch_and_clean_data(DATA_URL_1)\n# Does not execute the function. Instead, returns its previously computed\n# value. This means that now the data in d1 is the same as in d2.\n\nd3 = fetch_and_clean_data(DATA_URL_2)\n# This is a different URL, so the function executes.\n
\n

To set the persist parameter, use this command as follows:

\n
\nimport streamlit as st\n\n@st.cache_data(persist="disk")\ndef fetch_and_clean_data(url):\n    # Fetch data from URL here, and then clean it up.\n    return data\n
\n

By default, all parameters to a cached function must be hashable.\nAny parameter whose name begins with _ will not be hashed. You can use\nthis as an "escape hatch" for parameters that are not hashable:

\n
\nimport streamlit as st\n\n@st.cache_data\ndef fetch_and_clean_data(_db_connection, num_rows):\n    # Fetch data from _db_connection here, and then clean it up.\n    return data\n\nconnection = make_database_connection()\nd1 = fetch_and_clean_data(connection, num_rows=10)\n# Actually executes the function, since this is the first time it was\n# encountered.\n\nanother_connection = make_database_connection()\nd2 = fetch_and_clean_data(another_connection, num_rows=10)\n# Does not execute the function. Instead, returns its previously computed\n# value - even though the _database_connection parameter was different\n# in both calls.\n
\n

A cached function's cache can be procedurally cleared:

\n
\nimport streamlit as st\n\n@st.cache_data\ndef fetch_and_clean_data(_db_connection, num_rows):\n    # Fetch data from _db_connection here, and then clean it up.\n    return data\n\nfetch_and_clean_data.clear(_db_connection, 50)\n# Clear the cached entry for the arguments provided.\n\nfetch_and_clean_data.clear()\n# Clear all cached entries for this function.\n
\n

To override the default hashing behavior, pass a custom hash function.\nYou can do that by mapping a type (e.g. datetime.datetime) to a hash\nfunction (lambda dt: dt.isoformat()) like this:

\n
\nimport streamlit as st\nimport datetime\n\n@st.cache_data(hash_funcs={datetime.datetime: lambda dt: dt.isoformat()})\ndef convert_to_utc(dt: datetime.datetime):\n    return dt.astimezone(datetime.timezone.utc)\n
\n

Alternatively, you can map the type's fully-qualified name\n(e.g. "datetime.datetime") to the hash function instead:

\n
\nimport streamlit as st\nimport datetime\n\n@st.cache_data(hash_funcs={"datetime.datetime": lambda dt: dt.isoformat()})\ndef convert_to_utc(dt: datetime.datetime):\n    return dt.astimezone(datetime.timezone.utc)\n
\n
\n", + "description": "

Decorator to cache functions that return data (e.g. dataframe transforms, database queries, ML inference).

\n

Cached objects are stored in "pickled" form, which means that the return\nvalue of a cached function must be pickleable. Each caller of the cached\nfunction gets its own copy of the cached data.

\n

You can clear a function's cache with func.clear() or clear the entire\ncache with st.cache_data.clear().

\n

To cache global resources, use st.cache_resource instead. Learn more\nabout caching at https://docs.streamlit.io/develop/concepts/architecture/caching.

\n", + "args": [ + { + "name": "func", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The function to cache. Streamlit hashes the function's source code.

\n", + "default": null + }, + { + "name": "ttl", + "type_name": "float, timedelta, str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum time to keep an entry in the cache. Can be one of:

\n\n

Note that ttl will be ignored if persist="disk" or persist=True.

\n", + "default": null + }, + { + "name": "max_entries", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of entries to keep in the cache, or None\nfor an unbounded cache. When a new entry is added to a full cache,\nthe oldest cached entry will be removed. Defaults to None.

\n", + "default": "None" + }, + { + "name": "show_spinner", + "type_name": "bool or str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Enable the spinner. Default is True to show a spinner when there is\na "cache miss" and the cached data is being created. If string,\nvalue of show_spinner param will be used for spinner text.

\n", + "default": "True" + }, + { + "name": "persist", + "type_name": "\"disk\", bool, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Optional location to persist cached data to. Passing "disk" (or True)\nwill persist the cached data to the local disk. None (or False) will disable\npersistence. The default is None.

\n", + "default": "None" + }, + { + "name": "experimental_allow_widgets", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Allow widgets to be used in the cached function. Defaults to False.\nSupport for widgets in cached functions is currently experimental.\nSetting this parameter to True may lead to excessive memory use since the\nwidget value is treated as an additional input parameter to the cache.

\n", + "default": "False", + "deprecated": { + "deprecated": true, + "deprecatedText": "

experimental_allow_widgets is deprecated and will be removed in\na later version.

\n" + } + }, + { + "name": "hash_funcs", + "type_name": "dict or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Mapping of types or fully qualified names to hash functions.\nThis is used to override the behavior of the hasher inside Streamlit's\ncaching mechanism: when the hasher encounters an object, it will first\ncheck to see if its type matches a key in this dict and, if so, will use\nthe provided function to generate a hash for it. See below for an example\nof how this can be used.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/caching/cache_data_api.py#L387" + }, + "streamlit.cache_resource": { + "name": "cache_resource", + "signature": "st.cache_resource(func, *, ttl, max_entries, show_spinner, validate, experimental_allow_widgets, hash_funcs=None)", + "example": "
\n
\nimport streamlit as st\n\n@st.cache_resource\ndef get_database_session(url):\n    # Create a database session object that points to the URL.\n    return session\n\ns1 = get_database_session(SESSION_URL_1)\n# Actually executes the function, since this is the first time it was\n# encountered.\n\ns2 = get_database_session(SESSION_URL_1)\n# Does not execute the function. Instead, returns its previously computed\n# value. This means that now the connection object in s1 is the same as in s2.\n\ns3 = get_database_session(SESSION_URL_2)\n# This is a different URL, so the function executes.\n
\n

By default, all parameters to a cache_resource function must be hashable.\nAny parameter whose name begins with _ will not be hashed. You can use\nthis as an "escape hatch" for parameters that are not hashable:

\n
\nimport streamlit as st\n\n@st.cache_resource\ndef get_database_session(_sessionmaker, url):\n    # Create a database connection object that points to the URL.\n    return connection\n\ns1 = get_database_session(create_sessionmaker(), DATA_URL_1)\n# Actually executes the function, since this is the first time it was\n# encountered.\n\ns2 = get_database_session(create_sessionmaker(), DATA_URL_1)\n# Does not execute the function. Instead, returns its previously computed\n# value - even though the _sessionmaker parameter was different\n# in both calls.\n
\n

A cache_resource function's cache can be procedurally cleared:

\n
\nimport streamlit as st\n\n@st.cache_resource\ndef get_database_session(_sessionmaker, url):\n    # Create a database connection object that points to the URL.\n    return connection\n\nfetch_and_clean_data.clear(_sessionmaker, "https://streamlit.io/")\n# Clear the cached entry for the arguments provided.\n\nget_database_session.clear()\n# Clear all cached entries for this function.\n
\n

To override the default hashing behavior, pass a custom hash function.\nYou can do that by mapping a type (e.g. Person) to a hash\nfunction (str) like this:

\n
\nimport streamlit as st\nfrom pydantic import BaseModel\n\nclass Person(BaseModel):\n    name: str\n\n@st.cache_resource(hash_funcs={Person: str})\ndef get_person_name(person: Person):\n    return person.name\n
\n

Alternatively, you can map the type's fully-qualified name\n(e.g. "__main__.Person") to the hash function instead:

\n
\nimport streamlit as st\nfrom pydantic import BaseModel\n\nclass Person(BaseModel):\n    name: str\n\n@st.cache_resource(hash_funcs={"__main__.Person": str})\ndef get_person_name(person: Person):\n    return person.name\n
\n
\n", + "description": "

Decorator to cache functions that return global resources (e.g. database connections, ML models).

\n

Cached objects are shared across all users, sessions, and reruns. They\nmust be thread-safe because they can be accessed from multiple threads\nconcurrently. If thread safety is an issue, consider using st.session_state\nto store resources per session instead.

\n

You can clear a function's cache with func.clear() or clear the entire\ncache with st.cache_resource.clear().

\n

To cache data, use st.cache_data instead. Learn more about caching at\nhttps://docs.streamlit.io/develop/concepts/architecture/caching.

\n", + "args": [ + { + "name": "func", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The function that creates the cached resource. Streamlit hashes the\nfunction's source code.

\n", + "default": null + }, + { + "name": "ttl", + "type_name": "float, timedelta, str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum time to keep an entry in the cache. Can be one of:

\n\n", + "default": null + }, + { + "name": "max_entries", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of entries to keep in the cache, or None\nfor an unbounded cache. When a new entry is added to a full cache,\nthe oldest cached entry will be removed. Defaults to None.

\n", + "default": "None" + }, + { + "name": "show_spinner", + "type_name": "bool or str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Enable the spinner. Default is True to show a spinner when there is\na "cache miss" and the cached resource is being created. If string,\nvalue of show_spinner param will be used for spinner text.

\n", + "default": "True" + }, + { + "name": "validate", + "type_name": "callable or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional validation function for cached data. validate is called\neach time the cached value is accessed. It receives the cached value as\nits only parameter and it must return a boolean. If validate returns\nFalse, the current cached value is discarded, and the decorated function\nis called to compute a new value. This is useful e.g. to check the\nhealth of database connections.

\n", + "default": null + }, + { + "name": "experimental_allow_widgets", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Allow widgets to be used in the cached function. Defaults to False.\nSupport for widgets in cached functions is currently experimental.\nSetting this parameter to True may lead to excessive memory use since the\nwidget value is treated as an additional input parameter to the cache.

\n", + "default": "False", + "deprecated": { + "deprecated": true, + "deprecatedText": "

experimental_allow_widgets is deprecated and will be removed in\na later version.

\n" + } + }, + { + "name": "hash_funcs", + "type_name": "dict or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Mapping of types or fully qualified names to hash functions.\nThis is used to override the behavior of the hasher inside Streamlit's\ncaching mechanism: when the hasher encounters an object, it will first\ncheck to see if its type matches a key in this dict and, if so, will use\nthe provided function to generate a hash for it. See below for an example\nof how this can be used.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/caching/cache_resource_api.py#L256" + }, + "streamlit.camera_input": { + "name": "camera_input", + "signature": "st.camera_input(label, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility=\"visible\")", + "examples": "
\n
\nimport streamlit as st\n\npicture = st.camera_input("Take a picture")\n\nif picture:\n    st.image(picture)\n
\n
\n", + "description": "

Display a widget that returns pictures from the user's webcam.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this widget is used for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A tooltip that gets displayed next to the camera input.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this camera_input's value\nchanges.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the camera input if set to\nTrue. Default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "None or UploadedFile", + "is_generator": false, + "description": "

The UploadedFile class is a subclass of BytesIO, and therefore\nit is "file-like". This means you can pass them anywhere where\na file is expected.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/camera_input.py#L86" + }, + "streamlit.caption": { + "name": "caption", + "signature": "st.caption(body, unsafe_allow_html=False, *, help=None)", + "examples": "
\n
\nimport streamlit as st\n\nst.caption("This is a string that explains something above.")\nst.caption("A caption with _italics_ :blue[colors] and emojis :sunglasses:")\n
\n
\n", + "description": "

Display text in small font.

\n

This should be used for captions, asides, footnotes, sidenotes, and\nother explanatory text.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The text to display as GitHub-flavored Markdown. Syntax\ninformation can be found at: https://github.github.com/gfm.

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "unsafe_allow_html", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to render HTML within body. If this is False\n(default), any HTML tags found in body will be escaped and\ntherefore treated as raw text. If this is True, any HTML\nexpressions within body will be rendered.

\n

Adding custom HTML to your app impacts safety, styling, and\nmaintainability.

\n
\n

Note

\n

If you only want to insert HTML or CSS without Markdown text,\nwe recommend using st.html instead.

\n
\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed next to the caption.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/markdown.py#L159" + }, + "streamlit.chat_input": { + "name": "chat_input", + "signature": "st.chat_input(placeholder=\"Your message\", *, key=None, max_chars=None, disabled=False, on_submit=None, args=None, kwargs=None)", + "examples": "
\n

When st.chat_input is used in the main body of an app, it will be\npinned to the bottom of the page.

\n
\nimport streamlit as st\n\nprompt = st.chat_input("Say something")\nif prompt:\n    st.write(f"User has sent the following prompt: {prompt}")\n
\n

The chat input can also be used inline by nesting it inside any layout\ncontainer (container, columns, tabs, sidebar, etc) or fragment. Create\nchat interfaces embedded next to other content or have multiple\nchatbots!

\n
\nimport streamlit as st\n\nwith st.sidebar:\n    messages = st.container(height=300)\n    if prompt := st.chat_input("Say something"):\n        messages.chat_message("user").write(prompt)\n        messages.chat_message("assistant").write(f"Echo: {prompt}")\n
\n
\n", + "description": "

Display a chat input widget.

\n", + "args": [ + { + "name": "placeholder", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A placeholder text shown when the chat input is empty. Defaults to\n"Your message". For accessibility reasons, you should not use an\nempty string.

\n", + "default": "s" + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget based on\nits content. Multiple widgets of the same type may not share the same key.

\n", + "default": null + }, + { + "name": "max_chars", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of characters that can be entered. If None\n(default), there will be no maximum.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether the chat input should be disabled. Defaults to False.

\n", + "default": "s" + }, + { + "name": "on_submit", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional callback invoked when the chat input's value is submitted.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "str or None", + "is_generator": false, + "description": "

The current (non-empty) value of the text input widget on the last\nrun of the app. Otherwise, None.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/chat.py#L232" + }, + "streamlit.chat_message": { + "name": "chat_message", + "signature": "st.chat_message(name, *, avatar=None)", + "examples": "
\n

You can use with notation to insert any element into an expander

\n
\nimport streamlit as st\nimport numpy as np\n\nwith st.chat_message("user"):\n    st.write("Hello \ud83d\udc4b")\n    st.line_chart(np.random.randn(30, 3))\n
\n

Or you can just call methods directly in the returned objects:

\n
\nimport streamlit as st\nimport numpy as np\n\nmessage = st.chat_message("assistant")\nmessage.write("Hello human")\nmessage.bar_chart(np.random.randn(30, 3))\n
\n
\n", + "description": "

Insert a chat message container.

\n

To add elements to the returned container, you can use with notation\n(preferred) or just call methods directly on the returned object. See the\nexamples below.

\n", + "args": [ + { + "name": "name", + "type_name": "\"user\", \"assistant\", \"ai\", \"human\", or str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The name of the message author. Can be "human"/"user" or\n"ai"/"assistant" to enable preset styling and avatars.

\n

Currently, the name is not shown in the UI but is only set as an\naccessibility label. For accessibility reasons, you should not use\nan empty string.

\n", + "default": null + }, + { + "name": "avatar", + "type_name": "Anything supported by st.image, str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The avatar shown next to the message.

\n

If avatar is None (default), the icon will be determined\nfrom name as follows:

\n
    \n
  • If name is "user" or "human", the message will have a\ndefault user icon.
    • \n
  • If name is "ai" or "assistant", the message will have\na default bot icon.
    • \n
  • For all other values of name, the message will show the first\nletter of the name.
    • \n
\n

In addition to the types supported by st.image (like URLs or numpy\narrays), the following strings are valid:

\n
    \n

  • A single-character emoji. For example, you can set avatar="\ud83e\uddd1\u200d\ud83d\udcbb"\nor avatar="\ud83e\udd96". Emoji short codes are not supported.

    \n
    • \n

  • An icon from the Material Symbols library (rounded style) in the\nformat ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols\nfont library.

    \n
    • \n
\n", + "default": "user" + } + ], + "returns": [ + { + "type_name": "Container", + "is_generator": false, + "description": "

A single container that can hold multiple elements.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/chat.py#L121" + }, + "streamlit.checkbox": { + "name": "checkbox", + "signature": "st.checkbox(label, value=False, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\nagree = st.checkbox("I agree")\n\nif agree:\n    st.write("Great!")\n
\n
\n", + "description": "

Display a checkbox widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this checkbox is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "value", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Preselect the checkbox when it first renders. This will be\ncast to bool internally.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the checkbox.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this checkbox's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the checkbox if set to True.\nThe default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "bool", + "is_generator": false, + "description": "

Whether or not the checkbox is checked.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/checkbox.py#L59" + }, + "streamlit.code": { + "name": "code", + "signature": "st.code(body, language=\"python\", line_numbers=False)", + "example": "
\n
\nimport streamlit as st\n\ncode = '''def hello():\n    print("Hello, Streamlit!")'''\nst.code(code, language="python")\n
\n
\n", + "description": "

Display a code block with optional syntax highlighting.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The string to display as code.

\n", + "default": null + }, + { + "name": "language", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The language that the code is written in, for syntax highlighting.\nIf None, the code will be unstyled. Defaults to "python".

\n

For a list of available language values, see:

\n

https://github.com/react-syntax-highlighter/react-syntax-highlighter/blob/master/AVAILABLE_LANGUAGES_PRISM.MD

\n", + "default": "s" + }, + { + "name": "line_numbers", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional boolean indicating whether to show line numbers to the\nleft of the code block. Defaults to False.

\n", + "default": "s" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/code.py#L29" + }, + "streamlit.color_picker": { + "name": "color_picker", + "signature": "st.color_picker(label, value=None, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\ncolor = st.color_picker("Pick A Color", "#00f900")\nst.write("The current color is", color)\n
\n
\n", + "description": "

Display a color picker widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this input is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "value", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The hex value of this widget when it first renders. If None,\ndefaults to black.

\n", + "default": "black" + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the color picker.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this color_picker's value\nchanges.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the color picker if set to\nTrue. The default is False. This argument can only be supplied by\nkeyword.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "str", + "is_generator": false, + "description": "

The selected color as a hex string.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/color_picker.py#L61" + }, + "streamlit.columns": { + "name": "columns", + "signature": "st.columns(spec, *, gap=\"small\", vertical_alignment=\"top\")", + "examples": "
\n

You can use the with notation to insert any element into a column:

\n
\nimport streamlit as st\n\ncol1, col2, col3 = st.columns(3)\n\nwith col1:\n    st.header("A cat")\n    st.image("https://static.streamlit.io/examples/cat.jpg")\n\nwith col2:\n    st.header("A dog")\n    st.image("https://static.streamlit.io/examples/dog.jpg")\n\nwith col3:\n    st.header("An owl")\n    st.image("https://static.streamlit.io/examples/owl.jpg")\n
\n

Or you can just call methods directly on the returned objects:

\n
\nimport streamlit as st\nimport numpy as np\n\ncol1, col2 = st.columns([3, 1])\ndata = np.random.randn(10, 1)\n\ncol1.subheader("A wide column with a chart")\ncol1.line_chart(data)\n\ncol2.subheader("A narrow column with the data")\ncol2.write(data)\n
\n

Use vertical_alignment="bottom" to align widgets.

\n
\nimport streamlit as st\n\nleft, middle, right = st.columns(3, vertical_alignment="bottom")\n\nleft.text_input("Write something")\nmiddle.button("Click me", use_container_width=True)\nright.checkbox("Check me")\n
\n

Adjust vertical alignment to customize your grid layouts.

\n
\nimport streamlit as st\nimport numpy as np\n\nvertical_alignment = st.selectbox(\n    "Vertical alignment", ["top", "center", "bottom"], index=2\n)\n\nleft, middle, right = st.columns(3, vertical_alignment=vertical_alignment)\nleft.image("https://static.streamlit.io/examples/cat.jpg")\nmiddle.image("https://static.streamlit.io/examples/dog.jpg")\nright.image("https://static.streamlit.io/examples/owl.jpg")\n
\n
\n", + "description": "

Insert containers laid out as side-by-side columns.

\n

Inserts a number of multi-element containers laid out side-by-side and\nreturns a list of container objects.

\n

To add elements to the returned containers, you can use the with notation\n(preferred) or just call methods directly on the returned object. See\nexamples below.

\n

Columns can only be placed inside other columns up to one level of nesting.

\n
\n

Warning

\n

Columns cannot be placed inside other columns in the sidebar. This\nis only possible in the main area of the app.

\n
\n", + "args": [ + { + "name": "spec", + "type_name": "int or Iterable of numbers", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Controls the number and width of columns to insert. Can be one of:

\n
    \n
  • An integer that specifies the number of columns. All columns have equal\nwidth in this case.
    • \n
  • An Iterable of numbers (int or float) that specify the relative width of\neach column. E.g. [0.7, 0.3] creates two columns where the first\none takes up 70% of the available with and the second one takes up 30%.\nOr [1, 2, 3] creates three columns where the second one is two times\nthe width of the first one, and the third one is three times that width.
    • \n
\n", + "default": null + }, + { + "name": "gap", + "type_name": "\"small\", \"medium\", or \"large\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The size of the gap between the columns. The default is "small".

\n", + "default": "is" + }, + { + "name": "vertical_alignment", + "type_name": "\"top\", \"center\", or \"bottom\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The vertical alignment of the content inside the columns. The\ndefault is "top".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "list of containers", + "is_generator": false, + "description": "

A list of container objects.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/layouts.py#L147" + }, + "streamlit.connection": { + "name": "connection", + "signature": "st.connection(name, type=None, max_entries=None, ttl=None, **kwargs)", + "examples": "
\n

The easiest way to create a first-party (SQL, Snowflake, or Snowpark) connection is\nto use their default names and define corresponding sections in your secrets.toml\nfile.

\n
\nimport streamlit as st\nconn = st.connection("sql")  # [connections.sql] section in secrets.toml.\n
\n

Creating a SQLConnection with a custom name requires you to explicitly specify the\ntype. If type is not passed as a kwarg, it must be set in the appropriate section of\nsecrets.toml.

\n
\nimport streamlit as st\nconn1 = st.connection(\n    "my_sql_connection", type="sql"\n)  # Config section defined in [connections.my_sql_connection].\nconn2 = st.connection(\n    "my_other_sql_connection"\n)  # type must be set in [connections.my_other_sql_connection].\n
\n

Passing the full module path to the connection class that you want to use can be\nuseful, especially when working with a custom connection:

\n
\nimport streamlit as st\nconn = st.connection(\n    "my_sql_connection", type="streamlit.connections.SQLConnection"\n)\n
\n

Finally, you can pass the connection class to use directly to this function. Doing\nso allows static type checking tools such as mypy to infer the exact return\ntype of st.connection.

\n
\nimport streamlit as st\nfrom streamlit.connections import SQLConnection\nconn = st.connection("my_sql_connection", type=SQLConnection)\n
\n
\n", + "description": "

Create a new connection to a data store or API, or return an existing one.

\n

Config options, credentials, secrets, etc. for connections are taken from various\nsources:

\n
    \n
  • Any connection-specific configuration files.
    • \n
  • An app's secrets.toml files.
    • \n
  • The kwargs passed to this function.
    • \n
\n", + "args": [ + { + "name": "name", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The connection name used for secrets lookup in [connections.<name>].\nType will be inferred from passing "sql", "snowflake", or "snowpark".

\n", + "default": null + }, + { + "name": "type", + "type_name": "str, connection class, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The type of connection to create. It can be a keyword ("sql", "snowflake",\nor "snowpark"), a path to an importable class, or an imported class reference.\nAll classes must extend st.connections.BaseConnection and implement the\n_connect() method. If the type kwarg is None, a type field must be set in\nthe connection's section in secrets.toml.

\n", + "default": null + }, + { + "name": "max_entries", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The maximum number of connections to keep in the cache, or None\nfor an unbounded cache. (When a new entry is added to a full cache,\nthe oldest cached entry will be removed.) The default is None.

\n", + "default": "None" + }, + { + "name": "ttl", + "type_name": "float, timedelta, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The maximum number of seconds to keep results in the cache, or\nNone if cached results should not expire. The default is None.

\n", + "default": "None" + }, + { + "name": "**kwargs", + "type_name": "any", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Additional connection specific kwargs that are passed to the Connection's\n_connect() method. Learn more from the specific Connection's documentation.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "Connection object", + "is_generator": false, + "description": "

An initialized Connection object of the specified type.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/connection_factory.py#L205" + }, + "streamlit.container": { + "name": "container", + "signature": "st.container(*, height=None, border=None)", + "examples": "
\n

Inserting elements using with notation:

\n
\nimport streamlit as st\n\nwith st.container():\n    st.write("This is inside the container")\n\n    # You can call any Streamlit command, including custom components:\n    st.bar_chart(np.random.randn(50, 3))\n\nst.write("This is outside the container")\n
\n

Inserting elements out of order:

\n
\nimport streamlit as st\n\ncontainer = st.container(border=True)\ncontainer.write("This is inside the container")\nst.write("This is outside the container")\n\n# Now insert some more in the container\ncontainer.write("This is inside too")\n
\n

Using height to make a grid:

\n
\nimport streamlit as st\n\nrow1 = st.columns(3)\nrow2 = st.columns(3)\n\nfor col in row1 + row2:\n    tile = col.container(height=120)\n    tile.title(":balloon:")\n
\n

Using height to create a scrolling container for long content:

\n
\nimport streamlit as st\n\nlong_text = "Lorem ipsum. " * 1000\n\nwith st.container(height=300):\n    st.markdown(long_text)\n
\n
\n", + "description": "

Insert a multi-element container.

\n

Inserts an invisible container into your app that can be used to hold\nmultiple elements. This allows you to, for example, insert multiple\nelements into your app out of order.

\n

To add elements to the returned container, you can use the with notation\n(preferred) or just call methods directly on the returned object. See\nexamples below.

\n", + "args": [ + { + "name": "height", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired height of the container expressed in pixels. If None (default)\nthe container grows to fit its content. If a fixed height, scrolling is\nenabled for large content and a grey border is shown around the container\nto visually separate its scroll surface from the rest of the app.

\n
\n

Note

\n

Use containers with scroll sparingly. If you do, try to keep\nthe height small (below 500 pixels). Otherwise, the scroll\nsurface of the container might cover the majority of the screen\non mobile devices, which makes it hard to scroll the rest of the app.

\n
\n", + "default": null + }, + { + "name": "border", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to show a border around the container. If None (default), a\nborder is shown if the container is set to a fixed height and not\nshown otherwise.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/layouts.py#L35" + }, + "streamlit.data_editor": { + "name": "data_editor", + "signature": "st.data_editor(data, *, width=None, height=None, use_container_width=False, hide_index=None, column_order=None, column_config=None, num_rows=\"fixed\", disabled=False, key=None, on_change=None, args=None, kwargs=None)", + "examples": "
\n
\nimport streamlit as st\nimport pandas as pd\n\ndf = pd.DataFrame(\n    [\n       {"command": "st.selectbox", "rating": 4, "is_widget": True},\n       {"command": "st.balloons", "rating": 5, "is_widget": False},\n       {"command": "st.time_input", "rating": 3, "is_widget": True},\n   ]\n)\nedited_df = st.data_editor(df)\n\nfavorite_command = edited_df.loc[edited_df["rating"].idxmax()]["command"]\nst.markdown(f"Your favorite command is **{favorite_command}** \ud83c\udf88")\n
\n

You can also allow the user to add and delete rows by setting num_rows to "dynamic":

\n
\nimport streamlit as st\nimport pandas as pd\n\ndf = pd.DataFrame(\n    [\n       {"command": "st.selectbox", "rating": 4, "is_widget": True},\n       {"command": "st.balloons", "rating": 5, "is_widget": False},\n       {"command": "st.time_input", "rating": 3, "is_widget": True},\n   ]\n)\nedited_df = st.data_editor(df, num_rows="dynamic")\n\nfavorite_command = edited_df.loc[edited_df["rating"].idxmax()]["command"]\nst.markdown(f"Your favorite command is **{favorite_command}** \ud83c\udf88")\n
\n

Or you can customize the data editor via column_config, hide_index, column_order, or disabled:

\n
\nimport pandas as pd\nimport streamlit as st\n\ndf = pd.DataFrame(\n    [\n        {"command": "st.selectbox", "rating": 4, "is_widget": True},\n        {"command": "st.balloons", "rating": 5, "is_widget": False},\n        {"command": "st.time_input", "rating": 3, "is_widget": True},\n    ]\n)\nedited_df = st.data_editor(\n    df,\n    column_config={\n        "command": "Streamlit Command",\n        "rating": st.column_config.NumberColumn(\n            "Your rating",\n            help="How much do you like this command (1-5)?",\n            min_value=1,\n            max_value=5,\n            step=1,\n            format="%d \u2b50",\n        ),\n        "is_widget": "Widget ?",\n    },\n    disabled=["command", "is_widget"],\n    hide_index=True,\n)\n\nfavorite_command = edited_df.loc[edited_df["rating"].idxmax()]["command"]\nst.markdown(f"Your favorite command is **{favorite_command}** \ud83c\udf88")\n
\n
\n", + "description": "

Display a data editor widget.

\n

The data editor widget allows you to edit dataframes and many other data structures in a table-like UI.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Series, pandas.Styler, pandas.Index, pyarrow.Table, numpy.ndarray, pyspark.sql.DataFrame, snowflake.snowpark.DataFrame, list, set, tuple, dict, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The data to edit in the data editor.

\n
\n

Note

\n
    \n
  • Styles from pandas.Styler will only be applied to non-editable columns.
    • \n
  • Mixing data types within a column can make the column uneditable.
    • \n
  • Additionally, the following data types are not yet supported for editing:\ncomplex, list, tuple, bytes, bytearray, memoryview, dict, set, frozenset,\nfractions.Fraction, pandas.Interval, and pandas.Period.
    • \n
  • To prevent overflow in JavaScript, columns containing datetime.timedelta\nand pandas.Timedelta values will default to uneditable but this can be\nchanged through column configuration.
    • \n
\n
\n", + "default": "to" + }, + { + "name": "width", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired width of the data editor expressed in pixels. If width\nis None (default), Streamlit sets the data editor width to fit\nits contents up to the width of the parent container. If width\nis greater than the width of the parent container, Streamlit sets\nthe data editor width to match the width of the parent container.

\n", + "default": null + }, + { + "name": "height", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired height of the data editor expressed in pixels. If height\nis None (default), Streamlit sets the height to show at most\nten rows. Vertical scrolling within the data editor element is\nenabled when the height does not accomodate all rows.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to override width with the width of the parent\ncontainer. If use_container_width is False (default),\nStreamlit sets the data editor's width according to width. If\nuse_container_width is True, Streamlit sets the width of\nthe data editor to match the width of the parent container.

\n", + "default": null + }, + { + "name": "hide_index", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to hide the index column(s). If hide_index is None\n(default), the visibility of index columns is automatically\ndetermined based on the data.

\n", + "default": null + }, + { + "name": "column_order", + "type_name": "Iterable of str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies the display order of columns. This also affects which columns are\nvisible. For example, column_order=("col2", "col1") will display 'col2'\nfirst, followed by 'col1', and will hide all other non-index columns. If\nNone (default), the order is inherited from the original data structure.

\n", + "default": null + }, + { + "name": "column_config", + "type_name": "dict or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Configures how columns are displayed, e.g. their title, visibility, type, or\nformat, as well as editing properties such as min/max value or step.\nThis needs to be a dictionary where each key is a column name and the value\nis one of:

\n
    \n
  • None to hide the column.
    • \n
  • A string to set the display label of the column.
    • \n
  • One of the column types defined under st.column_config, e.g.\nst.column_config.NumberColumn("Dollar values\u201d, format=\u201d$ %d") to show\na column as dollar amounts. See more info on the available column types\nand config options here.
    • \n
\n

To configure the index column(s), use _index as the column name.

\n", + "default": null + }, + { + "name": "num_rows", + "type_name": "\"fixed\" or \"dynamic\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies if the user can add and delete rows in the data editor.\nIf "fixed", the user cannot add or delete rows. If "dynamic", the user can\nadd and delete rows in the data editor, but column sorting is disabled.\nDefaults to "fixed".

\n", + "default": "s" + }, + { + "name": "disabled", + "type_name": "bool or Iterable of str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Controls the editing of columns. If True, editing is disabled for all columns.\nIf an Iterable of column names is provided (e.g., disabled=("col1", "col2")),\nonly the specified columns will be disabled for editing. If False (default),\nall columns that support editing are editable.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string to use as the unique key for this widget. If this\nis omitted, a key will be generated for the widget based on its\ncontent. Multiple widgets of the same type may not share the same\nkey.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional callback invoked when this data_editor's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "pandas.DataFrame, pandas.Series, pyarrow.Table, numpy.ndarray, list, set, tuple, or dict.", + "is_generator": false, + "description": "

The edited data. The edited data is returned in its original data type if\nit corresponds to any of the supported return types. All other data types\nare returned as a pandas.DataFrame.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/data_editor.py#L578" + }, + "streamlit.dataframe": { + "name": "dataframe", + "signature": "st.dataframe(data=None, width=None, height=None, *, use_container_width=False, hide_index=None, column_order=None, column_config=None, key=None, on_select=\"ignore\", selection_mode=\"multi-row\")", + "examples": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\ndf = pd.DataFrame(np.random.randn(50, 20), columns=("col %d" % i for i in range(20)))\n\nst.dataframe(df)  # Same as st.write(df)\n
\n

You can also pass a Pandas Styler object to change the style of\nthe rendered DataFrame:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\ndf = pd.DataFrame(np.random.randn(10, 20), columns=("col %d" % i for i in range(20)))\n\nst.dataframe(df.style.highlight_max(axis=0))\n
\n

Or you can customize the dataframe via column_config, hide_index, or column_order:

\n
\nimport random\nimport pandas as pd\nimport streamlit as st\n\ndf = pd.DataFrame(\n    {\n        "name": ["Roadmap", "Extras", "Issues"],\n        "url": ["https://roadmap.streamlit.app", "https://extras.streamlit.app", "https://issues.streamlit.app"],\n        "stars": [random.randint(0, 1000) for _ in range(3)],\n        "views_history": [[random.randint(0, 5000) for _ in range(30)] for _ in range(3)],\n    }\n)\nst.dataframe(\n    df,\n    column_config={\n        "name": "App name",\n        "stars": st.column_config.NumberColumn(\n            "Github Stars",\n            help="Number of stars on GitHub",\n            format="%d \u2b50",\n        ),\n        "url": st.column_config.LinkColumn("App URL"),\n        "views_history": st.column_config.LineChartColumn(\n            "Views (past 30 days)", y_min=0, y_max=5000\n        ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Display a dataframe as an interactive table.

\n

This command works with dataframes from Pandas, PyArrow, Snowpark, and PySpark.\nIt can also display several other types that can be converted to dataframes,\ne.g. numpy arrays, lists, sets and dictionaries.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Series, pandas.Styler, pandas.Index, pyarrow.Table, numpy.ndarray, pyspark.sql.DataFrame, snowflake.snowpark.dataframe.DataFrame, snowflake.snowpark.table.Table, Iterable, dict, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The data to display.

\n

If data is a pandas.Styler, it will be used to style its\nunderlying pandas.DataFrame. Streamlit supports custom cell\nvalues and colors. It does not support some of the more exotic\npandas styling features, like bar charts, hovering, and captions.

\n", + "default": null + }, + { + "name": "width", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Desired width of the dataframe expressed in pixels. If width is\nNone (default), Streamlit sets the dataframe width to fit its\ncontents up to the width of the parent container. If width is\ngreater than the width of the parent container, Streamlit sets the\ndataframe width to match the width of the parent container.

\n", + "default": null + }, + { + "name": "height", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Desired height of the dataframe expressed in pixels. If height\nis None (default), Streamlit sets the height to show at most\nten rows. Vertical scrolling within the dataframe element is\nenabled when the height does not accomodate all rows.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to override width with the width of the parent\ncontainer. If use_container_width is False (default),\nStreamlit sets the dataframe's width according to width. If\nuse_container_width is True, Streamlit sets the width of\nthe dataframe to match the width of the parent container.

\n", + "default": null + }, + { + "name": "hide_index", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to hide the index column(s). If hide_index is None\n(default), the visibility of index columns is automatically\ndetermined based on the data.

\n", + "default": null + }, + { + "name": "column_order", + "type_name": "Iterable of str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The ordered list of columns to display. If column_order is\nNone (default), Streamlit displays all columns in the order\ninherited from the underlying data structure. If column_order\nis a list, the indicated columns will display in the order they\nappear within the list. Columns may be omitted or repeated within\nthe list.

\n

For example, column_order=("col2", "col1") will display\n"col2" first, followed by "col1", and will hide all other\nnon-index columns.

\n", + "default": null + }, + { + "name": "column_config", + "type_name": "dict or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Configuration to customize how columns display. If column_config\nis None (default), columns are styled based on the underlying\ndata type of each column.

\n

Column configuration can modify column names, visibility, type,\nwidth, or format, among other things. column_config must be a\ndictionary where each key is a column name and the associated value\nis one of the following:

\n
    \n
  • None: Streamlit hides the column.
    • \n
  • A string: Streamlit changes the display label of the column to\nthe given string.
    • \n
  • A column type within st.column_config: Streamlit applies the\ndefined configuration to the column. For example, use\nst.column_config.NumberColumn("Dollar values\u201d, format=\u201d$ %d")\nto change the displayed name of the column to "Dollar values"\nand add a "$" prefix in each cell. For more info on the\navailable column types and config options, see\nColumn configuration.
    • \n
\n

To configure the index column(s), use _index as the column name.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string to use for giving this element a stable\nidentity. If key is None (default), this element's identity\nwill be determined based on the values of the other parameters.

\n

Additionally, if selections are activated and key is provided,\nStreamlit will register the key in Session State to store the\nselection state. The selection state is read-only.

\n", + "default": null + }, + { + "name": "on_select", + "type_name": "\"ignore\" or \"rerun\" or callable", + "is_optional": false, + "is_kwarg_only": true, + "description": "

How the dataframe should respond to user selection events. This\ncontrols whether or not the dataframe behaves like an input widget.\non_select can be one of the following:

\n
    \n
  • "ignore" (default): Streamlit will not react to any selection\nevents in the dataframe. The dataframe will not behave like an\ninput widget.
    • \n
  • "rerun": Streamlit will rerun the app when the user selects\nrows or columns in the dataframe. In this case, st.dataframe\nwill return the selection data as a dictionary.
    • \n
  • A callable: Streamlit will rerun the app and execute the\ncallable as a callback function before the rest of the app.\nIn this case, st.dataframe will return the selection data\nas a dictionary.
    • \n
\n", + "default": null + }, + { + "name": "selection_mode", + "type_name": "\"single-row\", \"multi-row\", single-column\", \"multi-column\", or Iterable of these", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The types of selections Streamlit should allow. This can be one of\nthe following:

\n
    \n
  • "multi-row" (default): Multiple rows can be selected at a time.
    • \n
  • "single-row": Only one row can be selected at a time.
    • \n
  • "multi-column": Multiple columns can be selected at a time.
    • \n
  • "single-column": Only one column can be selected at a time.
    • \n
  • An Iterable of the above options: The table will allow\nselection based on the modes specified.
    • \n
\n

When column selections are enabled, column sorting is disabled.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "element or dict", + "is_generator": false, + "description": "

If on_select is "ignore" (default), this method returns an\ninternal placeholder for the dataframe element that can be used\nwith the .add_rows() method. Otherwise, this method returns a\ndictionary-like object that supports both key and attribute\nnotation. The attributes are described by the DataframeState\ndictionary schema.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/arrow.py#L246" + }, + "streamlit.date_input": { + "name": "date_input", + "signature": "st.date_input(label, value=\"default_value_today\", min_value=None, max_value=None, key=None, help=None, on_change=None, args=None, kwargs=None, *, format=\"YYYY/MM/DD\", disabled=False, label_visibility=\"visible\")", + "examples": "
\n
\nimport datetime\nimport streamlit as st\n\nd = st.date_input("When's your birthday", datetime.date(2019, 7, 6))\nst.write("Your birthday is:", d)\n
\n
\nimport datetime\nimport streamlit as st\n\ntoday = datetime.datetime.now()\nnext_year = today.year + 1\njan_1 = datetime.date(next_year, 1, 1)\ndec_31 = datetime.date(next_year, 12, 31)\n\nd = st.date_input(\n    "Select your vacation for next year",\n    (jan_1, datetime.date(next_year, 1, 7)),\n    jan_1,\n    dec_31,\n    format="MM.DD.YYYY",\n)\nd\n
\n

To initialize an empty date input, use None as the value:

\n
\nimport datetime\nimport streamlit as st\n\nd = st.date_input("When's your birthday", value=None)\nst.write("Your birthday is:", d)\n
\n
\n", + "description": "

Display a date input widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this date input is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "value", + "type_name": "datetime.date or datetime.datetime or list/tuple of datetime.date or datetime.datetime, \"today\", or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The value of this widget when it first renders. If a list/tuple with\n0 to 2 date/datetime values is provided, the datepicker will allow\nusers to provide a range. If None, will initialize empty and\nreturn None until the user provides input. If "today" (default),\nwill initialize with today as a single-date picker.

\n", + "default": null + }, + { + "name": "min_value", + "type_name": "datetime.date or datetime.datetime", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The minimum selectable date. If value is a date, defaults to value - 10 years.\nIf value is the interval [start, end], defaults to start - 10 years.

\n", + "default": "value" + }, + { + "name": "max_value", + "type_name": "datetime.date or datetime.datetime", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The maximum selectable date. If value is a date, defaults to value + 10 years.\nIf value is the interval [start, end], defaults to end + 10 years.

\n", + "default": "value" + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the input.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this date_input's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "format", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A format string controlling how the interface should display dates.\nSupports "YYYY/MM/DD" (default), "DD/MM/YYYY", or "MM/DD/YYYY".\nYou may also use a period (.) or hyphen (-) as separators.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the date input if set to True.\nThe default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "datetime.date or a tuple with 0-2 dates or None", + "is_generator": false, + "description": "

The current value of the date input widget or None if no date has been\nselected.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/time_widgets.py#L520" + }, + "streamlit.dialog": { + "name": "dialog", + "signature": "st.dialog(title, *, width=\"small\")", + "examples": "
\n

The following example demonstrates the basic usage of @st.dialog.\nIn this app, clicking "A" or "B" will open a modal dialog and prompt you\nto enter a reason for your vote. In the modal dialog, click "Submit" to record\nyour vote into Session State and rerun the app. This will close the modal dialog\nsince the dialog function is not called during the full-script rerun.

\n
\nimport streamlit as st\n\n@st.dialog("Cast your vote")\ndef vote(item):\n    st.write(f"Why is {item} your favorite?")\n    reason = st.text_input("Because...")\n    if st.button("Submit"):\n        st.session_state.vote = {"item": item, "reason": reason}\n        st.rerun()\n\nif "vote" not in st.session_state:\n    st.write("Vote for your favorite")\n    if st.button("A"):\n        vote("A")\n    if st.button("B"):\n        vote("B")\nelse:\n    f"You voted for {st.session_state.vote['item']} because {st.session_state.vote['reason']}"\n
\n
\n", + "description": "

Function decorator to create a modal dialog.

\n

A function decorated with @st.dialog becomes a dialog\nfunction. When you call a dialog function, Streamlit inserts a modal dialog\ninto your app. Streamlit element commands called within the dialog function\nrender inside the modal dialog.

\n

The dialog function can accept arguments that can be passed when it is\ncalled. Any values from the dialog that need to be accessed from the wider\napp should generally be stored in Session State.

\n

A user can dismiss a modal dialog by clicking outside of it, clicking the\n"X" in its upper-right corner, or pressing ESC on their keyboard.\nDismissing a modal dialog does not trigger an app rerun. To close the modal\ndialog programmatically, call st.rerun() explicitly inside of the\ndialog function.

\n

st.dialog inherits behavior from st.fragment.\nWhen a user interacts with an input widget created inside a dialog function,\nStreamlit only reruns the dialog function instead of the full script.

\n

Calling st.sidebar in a dialog function is not supported.

\n

Dialog code can interact with Session State, imported modules, and other\nStreamlit elements created outside the dialog. Note that these interactions\nare additive across multiple dialog reruns. You are responsible for\nhandling any side effects of that behavior.

\n
\n

Warning

\n

Only one dialog function may be called in a script run, which means\nthat only one dialog can be open at any given time.

\n
\n", + "args": [ + { + "name": "title", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The title to display at the top of the modal dialog. It cannot be empty.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"large\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The width of the modal dialog. If width is "small (default), the\nmodal dialog will be 500 pixels wide. If width is "large", the\nmodal dialog will be about 750 pixels wide.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/dialog_decorator.py#L112" + }, + "streamlit.divider": { + "name": "divider", + "signature": "st.divider()", + "example": "
\n
\nimport streamlit as st\n\nst.divider()\n
\n
\n", + "description": "

Display a horizontal rule.

\n
\n

Note

\n

You can achieve the same effect with st.write("---") or\neven just "---" in your script (via magic).

\n
\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/markdown.py#L265" + }, + "streamlit.download_button": { + "name": "download_button", + "signature": "st.download_button(label, data, file_name=None, mime=None, key=None, help=None, on_click=None, args=None, kwargs=None, *, type=\"secondary\", disabled=False, use_container_width=False)", + "examples": "
\n

Download a large DataFrame as a CSV:

\n
\nimport streamlit as st\n\n@st.cache_data\ndef convert_df(df):\n    # IMPORTANT: Cache the conversion to prevent computation on every rerun\n    return df.to_csv().encode("utf-8")\n\ncsv = convert_df(my_large_df)\n\nst.download_button(\n    label="Download data as CSV",\n    data=csv,\n    file_name="large_df.csv",\n    mime="text/csv",\n)\n
\n

Download a string as a file:

\n
\nimport streamlit as st\n\ntext_contents = '''This is some text'''\nst.download_button("Download some text", text_contents)\n
\n

Download a binary file:

\n
\nimport streamlit as st\n\nbinary_contents = b"example content"\n# Defaults to "application/octet-stream"\nst.download_button("Download binary file", binary_contents)\n
\n

Download an image:

\n
\nimport streamlit as st\n\nwith open("flower.png", "rb") as file:\n    btn = st.download_button(\n        label="Download image",\n        data=file,\n        file_name="flower.png",\n        mime="image/png",\n    )\n
\n
\n", + "description": "

Display a download button widget.

\n

This is useful when you would like to provide a way for your users\nto download a file directly from your app.

\n

Note that the data to be downloaded is stored in-memory while the\nuser is connected, so it's a good idea to keep file sizes under a\ncouple hundred megabytes to conserve memory.

\n

If you want to prevent your app from rerunning when a user clicks the\ndownload button, wrap the download button in a fragment.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this button is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "data", + "type_name": "str or bytes or file", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The contents of the file to be downloaded. See example below for\ncaching techniques to avoid recomputing this data unnecessarily.

\n", + "default": null + }, + { + "name": "file_name", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string to use as the name of the file to be downloaded,\nsuch as 'my_file.csv'. If not specified, the name will be\nautomatically generated.

\n", + "default": null + }, + { + "name": "mime", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The MIME type of the data. If None, defaults to "text/plain"\n(if data is of type str or is a textual file) or\n"application/octet-stream" (if data is of type bytes or is a\nbinary file).

\n", + "default": "s" + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed when the button is\nhovered over.

\n", + "default": null + }, + { + "name": "on_click", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this button is clicked.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "type", + "type_name": "\"secondary\" or \"primary\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string that specifies the button type. Can be "primary" for a\nbutton with additional emphasis or "secondary" for a normal button. Defaults\nto "secondary".

\n", + "default": "s" + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the download button if set to\nTrue. The default is False.

\n", + "default": "False" + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to expand the button's width to fill its parent container.\nIf use_container_width is False (default), Streamlit sizes\nthe button to fit its contents. If use_container_width is\nTrue, the width of the button matches its parent container.

\n

In both cases, if the contents of the button are wider than the\nparent container, the contents will line wrap.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "bool", + "is_generator": false, + "description": "

True if the button was clicked on the last run of the app,\nFalse otherwise.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/button.py#L195" + }, + "streamlit.echo": { + "name": "echo", + "signature": "st.echo(code_location=\"above\")", + "example": "
\n
\nimport streamlit as st\n\nwith st.echo():\n    st.write('This code will be printed')\n
\n
\n", + "description": "

Use in a with block to draw some code on the app, then execute it.

\n", + "args": [ + { + "name": "code_location", + "type_name": "\"above\" or \"below\"", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to show the echoed code before or after the results of the\nexecuted code block.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/echo.py#L30" + }, + "streamlit.empty": { + "name": "empty", + "signature": "st.empty()", + "examples": "
\n

Overwriting elements in-place using with notation:

\n
\nimport streamlit as st\nimport time\n\nwith st.empty():\n    for seconds in range(60):\n        st.write(f"\u23f3 {seconds} seconds have passed")\n        time.sleep(1)\n    st.write("\u2714\ufe0f 1 minute over!")\n
\n

Replacing several elements, then clearing them:

\n
\nimport streamlit as st\n\nplaceholder = st.empty()\n\n# Replace the placeholder with some text:\nplaceholder.text("Hello")\n\n# Replace the text with a chart:\nplaceholder.line_chart({"data": [1, 5, 2, 6]})\n\n# Replace the chart with several elements:\nwith placeholder.container():\n    st.write("This is one element")\n    st.write("This is another")\n\n# Clear all those elements:\nplaceholder.empty()\n
\n
\n", + "description": "

Insert a single-element container.

\n

Inserts a container into your app that can be used to hold a single element.\nThis allows you to, for example, remove elements at any point, or replace\nseveral elements at once (using a child multi-element container).

\n

To insert/replace/clear an element on the returned container, you can\nuse with notation or just call methods directly on the returned object.\nSee examples below.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/empty.py#L28" + }, + "streamlit.error": { + "name": "error", + "signature": "st.error(body, *, icon=None)", + "example": "
\n
\nimport streamlit as st\n\nst.error('This is an error', icon="\ud83d\udea8")\n
\n
\n", + "description": "

Display error message.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The error text to display.

\n", + "default": null + }, + { + "name": "icon", + "type_name": "str, None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional emoji or icon to display next to the alert. If icon\nis None (default), no icon is displayed. If icon is a\nstring, the following options are valid:

\n
    \n

  • A single-character emoji. For example, you can set icon="\ud83d\udea8"\nor icon="\ud83d\udd25". Emoji short codes are not supported.

    \n
    • \n

  • An icon from the Material Symbols library (rounded style) in the\nformat ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols\nfont library.

    \n
    • \n
\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/alert.py#L29" + }, + "streamlit.exception": { + "name": "exception", + "signature": "st.exception(exception)", + "example": "
\n
\nimport streamlit as st\n\ne = RuntimeError("This is an exception of type RuntimeError")\nst.exception(e)\n
\n
\n", + "description": "

Display an exception.

\n", + "args": [ + { + "name": "exception", + "type_name": "Exception", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The exception to display.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/exception.py#L49" + }, + "streamlit.expander": { + "name": "expander", + "signature": "st.expander(label, expanded=False, *, icon=None)", + "examples": "
\n

You can use the with notation to insert any element into an expander

\n
\nimport streamlit as st\n\nst.bar_chart({"data": [1, 5, 2, 6, 2, 1]})\n\nwith st.expander("See explanation"):\n    st.write('''\n        The chart above shows some numbers I picked for you.\n        I rolled actual dice for these, so they're *guaranteed* to\n        be random.\n    ''')\n    st.image("https://static.streamlit.io/examples/dice.jpg")\n
\n

Or you can just call methods directly on the returned objects:

\n
\nimport streamlit as st\n\nst.bar_chart({"data": [1, 5, 2, 6, 2, 1]})\n\nexpander = st.expander("See explanation")\nexpander.write('''\n    The chart above shows some numbers I picked for you.\n    I rolled actual dice for these, so they're *guaranteed* to\n    be random.\n''')\nexpander.image("https://static.streamlit.io/examples/dice.jpg")\n
\n
\n", + "description": "

Insert a multi-element container that can be expanded/collapsed.

\n

Inserts a container into your app that can be used to hold multiple elements\nand can be expanded or collapsed by the user. When collapsed, all that is\nvisible is the provided label.

\n

To add elements to the returned container, you can use the with notation\n(preferred) or just call methods directly on the returned object. See\nexamples below.

\n
\n

Warning

\n

Currently, you may not put expanders inside another expander.

\n
\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A string to use as the header for the expander. The label can optionally\ncontain GitHub-flavored Markdown of the following types: Bold, Italics,\nStrikethroughs, Inline Code, and Links.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "expanded", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

If True, initializes the expander in "expanded" state. Defaults to\nFalse (collapsed).

\n", + "default": "s" + }, + { + "name": "icon", + "type_name": "str, None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional emoji or icon to display next to the expander label. If icon\nis None (default), no icon is displayed. If icon is a\nstring, the following options are valid:

\n
    \n

  • A single-character emoji. For example, you can set icon="\ud83d\udea8"\nor icon="\ud83d\udd25". Emoji short codes are not supported.

    \n
    • \n

  • An icon from the Material Symbols library (rounded style) in the\nformat ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols \nfont library.

    \n
    • \n
\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/layouts.py#L433" + }, + "streamlit.experimental_dialog": { + "name": "experimental_dialog", + "signature": "st.experimental_dialog(title, *, width=\"small\")", + "description": "

Deprecated alias for @st.dialog. See the docstring for the decorator's new name.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/dialog_decorator.py#L221" + }, + "streamlit.experimental_fragment": { + "name": "experimental_fragment", + "signature": "st.experimental_fragment(func=None, *, run_every=None)", + "description": "

Deprecated alias for @st.fragment. See the docstring for the decorator's new name.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/fragment.py#L455" + }, + "streamlit.experimental_get_query_params": { + "name": "experimental_get_query_params", + "signature": "st.experimental_get_query_params()", + "example": "
\n

Let's say the user's web browser is at\nhttp://localhost:8501/?show_map=True&selected=asia&selected=america.\nThen, you can get the query parameters using the following:

\n
\nimport streamlit as st\n\nst.experimental_get_query_params()\n{"show_map": ["True"], "selected": ["asia", "america"]}\n
\n

Note that the values in the returned dict are always lists. This is\nbecause we internally use Python's urllib.parse.parse_qs(), which behaves\nthis way. And this behavior makes sense when you consider that every item\nin a query string is potentially a 1-element array.

\n
\n", + "description": "

Return the query parameters that is currently showing in the browser's URL bar.

\n", + "args": [], + "returns": [ + { + "type_name": "dict", + "is_generator": false, + "description": "

The current query parameters as a dict. "Query parameters" are the part of the URL that comes\nafter the first "?".

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/commands/experimental_query_params.py#L32" + }, + "streamlit.experimental_set_query_params": { + "name": "experimental_set_query_params", + "signature": "st.experimental_set_query_params(**query_params)", + "example": "
\n

To point the user's web browser to something like\n"http://localhost:8501/?show_map=True&selected=asia&selected=america",\nyou would do the following:

\n
\nimport streamlit as st\n\nst.experimental_set_query_params(\n    show_map=True,\n    selected=["asia", "america"],\n)\n
\n
\n", + "description": "

Set the query parameters that are shown in the browser's URL bar.

\n
\n

Warning

\n

Query param embed cannot be set using this method.

\n
\n", + "args": [ + { + "name": "**query_params", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The query parameters to set, as key-value pairs.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/commands/experimental_query_params.py#L70" + }, + "streamlit.feedback": { + "name": "feedback", + "signature": "st.feedback(options=\"thumbs\", *, key=None, disabled=False, on_change=None, args=None, kwargs=None)", + "examples": "
\n

Display a feedback widget with stars, and show the selected sentiment:

\n
\nimport streamlit as st\n\nsentiment_mapping = ["one", "two", "three", "four", "five"]\nselected = st.feedback("stars")\nif selected is not None:\n    st.markdown(f"You selected {sentiment_mapping[selected]} star(s).")\n
\n

Display a feedback widget with thumbs, and show the selected sentiment:

\n
\nimport streamlit as st\n\nsentiment_mapping = [":material/thumb_down:", ":material/thumb_up:"]\nselected = st.feedback("thumbs")\nif selected is not None:\n    st.markdown(f"You selected: {sentiment_mapping[selected]}")\n
\n
\n", + "description": "

Display a feedback widget.

\n

A feedback widget is an icon-based button group available in three\nstyles, as described in options. It is commonly used in chat and AI\napps to allow users to rate responses.

\n", + "args": [ + { + "name": "options", + "type_name": "\"thumbs\", \"faces\", or \"stars\"", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The feedback options displayed to the user. options can be one\nof the following:

\n
    \n
  • "thumbs" (default): Streamlit displays a thumb-up and\nthumb-down button group.
    • \n
  • "faces": Streamlit displays a row of five buttons with\nfacial expressions depicting increasing satisfaction from left to\nright.
    • \n
  • "stars": Streamlit displays a row of star icons, allowing the\nuser to select a rating from one to five stars.
    • \n
\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the feedback widget if set\nto True. The default is False. This argument can only be supplied\nby keyword.

\n", + "default": "False" + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional callback invoked when this feedback widget's value\nchanges.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "int or None", + "is_generator": false, + "description": "

An integer indicating the user's selection, where 0 is the\nlowest feedback. Higher values indicate more positive feedback.\nIf no option was selected, the widget returns None.

\n
    \n
  • For options="thumbs", a return value of 0 indicates\nthumbs-down, and 1 indicates thumbs-up.
    • \n
  • For options="faces" and options="stars", return values\nrange from 0 (least satisfied) to 4 (most satisfied).
    • \n
\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/button_group.py#L171" + }, + "streamlit.file_uploader": { + "name": "file_uploader", + "signature": "st.file_uploader(label, type=None, accept_multiple_files=False, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility=\"visible\")", + "examples": "
\n

Insert a file uploader that accepts a single file at a time:

\n
\nimport streamlit as st\nimport pandas as pd\nfrom io import StringIO\n\nuploaded_file = st.file_uploader("Choose a file")\nif uploaded_file is not None:\n    # To read file as bytes:\n    bytes_data = uploaded_file.getvalue()\n    st.write(bytes_data)\n\n    # To convert to a string based IO:\n    stringio = StringIO(uploaded_file.getvalue().decode("utf-8"))\n    st.write(stringio)\n\n    # To read file as string:\n    string_data = stringio.read()\n    st.write(string_data)\n\n    # Can be used wherever a "file-like" object is accepted:\n    dataframe = pd.read_csv(uploaded_file)\n    st.write(dataframe)\n
\n

Insert a file uploader that accepts multiple files at a time:

\n
\nimport streamlit as st\n\nuploaded_files = st.file_uploader(\n    "Choose a CSV file", accept_multiple_files=True\n)\nfor uploaded_file in uploaded_files:\n    bytes_data = uploaded_file.read()\n    st.write("filename:", uploaded_file.name)\n    st.write(bytes_data)\n
\n
\n", + "description": "

Display a file uploader widget.

\n

By default, uploaded files are limited to 200MB. You can configure\nthis using the server.maxUploadSize config option. For more info\non how to set config options, see\nhttps://docs.streamlit.io/develop/api-reference/configuration/config.toml

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this file uploader is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "type", + "type_name": "str or list of str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Array of allowed extensions. ['png', 'jpg']\nThe default is None, which means all extensions are allowed.

\n", + "default": "None" + }, + { + "name": "accept_multiple_files", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

If True, allows the user to upload multiple files at the same time,\nin which case the return value will be a list of files.\nDefault: False

\n", + "default": "False" + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A tooltip that gets displayed next to the file uploader.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this file_uploader's value\nchanges.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the file uploader if set to\nTrue. The default is False. This argument can only be supplied by\nkeyword.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "None or UploadedFile or list of UploadedFile", + "is_generator": false, + "description": "
    \n
  • If accept_multiple_files is False, returns either None or\nan UploadedFile object.
    • \n
  • If accept_multiple_files is True, returns a list with the\nuploaded files as UploadedFile objects. If no files were\nuploaded, returns an empty list.
    • \n
\n

The UploadedFile class is a subclass of BytesIO, and therefore\nit is "file-like". This means you can pass them anywhere where\na file is expected.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/file_uploader.py#L228" + }, + "streamlit.form": { + "name": "form", + "signature": "st.form(key, clear_on_submit=False, *, border=True)", + "examples": "
\n

Inserting elements using with notation:

\n
\nimport streamlit as st\n\nwith st.form("my_form"):\n    st.write("Inside the form")\n    slider_val = st.slider("Form slider")\n    checkbox_val = st.checkbox("Form checkbox")\n\n    # Every form must have a submit button.\n    submitted = st.form_submit_button("Submit")\n    if submitted:\n        st.write("slider", slider_val, "checkbox", checkbox_val)\nst.write("Outside the form")\n
\n

Inserting elements out of order:

\n
\nimport streamlit as st\n\nform = st.form("my_form")\nform.slider("Inside the form")\nst.slider("Outside the form")\n\n# Now add a submit button to the form:\nform.form_submit_button("Submit")\n
\n
\n", + "description": "

Create a form that batches elements together with a "Submit" button.

\n

A form is a container that visually groups other elements and\nwidgets together, and contains a Submit button. When the form's\nSubmit button is pressed, all widget values inside the form will be\nsent to Streamlit in a batch.

\n

To add elements to a form object, you can use with notation\n(preferred) or just call methods directly on the form. See\nexamples below.

\n

Forms have a few constraints:

\n
    \n
  • Every form must contain a st.form_submit_button.
    • \n
  • st.button and st.download_button cannot be added to a form.
    • \n
  • Forms can appear anywhere in your app (sidebar, columns, etc),\nbut they cannot be embedded inside other forms.
    • \n
  • Within a form, the only widget that can have a callback function is\nst.form_submit_button.
    • \n
\n", + "args": [ + { + "name": "key", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A string that identifies the form. Each form must have its own\nkey. (This key is not displayed to the user in the interface.)

\n", + "default": null + }, + { + "name": "clear_on_submit", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

If True, all widgets inside the form will be reset to their default\nvalues after the user presses the Submit button. Defaults to False.\n(Note that Custom Components are unaffected by this flag, and\nwill not be reset to their defaults on form submission.)

\n", + "default": "values" + }, + { + "name": "border", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to show a border around the form. Defaults to True.

\n
\n

Note

\n

Not showing a border can be confusing to viewers since interacting with a\nwidget in the form will do nothing. You should only remove the border if\nthere's another border (e.g. because of an expander) or the form is small\n(e.g. just a text input and a submit button).

\n
\n", + "default": "True" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/form.py#L115" + }, + "streamlit.form_submit_button": { + "name": "form_submit_button", + "signature": "st.form_submit_button(label=\"Submit\", help=None, on_click=None, args=None, kwargs=None, *, type=\"secondary\", disabled=False, use_container_width=False)", + "description": "

Display a form submit button.

\n

When this button is clicked, all widget values inside the form will be\nsent to Streamlit in a batch.

\n

Every form must have a form_submit_button. A form_submit_button\ncannot exist outside a form.

\n

For more information about forms, check out our\nblog post.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this button is for.\nDefaults to "Submit".

\n", + "default": "s" + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A tooltip that gets displayed when the button is hovered over.\nDefaults to None.

\n", + "default": "None" + }, + { + "name": "on_click", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this button is clicked.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "type", + "type_name": "\"secondary\" or \"primary\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string that specifies the button type. Can be "primary" for a\nbutton with additional emphasis or "secondary" for a normal button. Defaults\nto "secondary".

\n", + "default": "s" + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the button if set to True. The\ndefault is False.

\n", + "default": "False" + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to expand the button's width to fill its parent container.\nIf use_container_width is False (default), Streamlit sizes\nthe button to fit its contents. If use_container_width is\nTrue, the width of the button matches its parent container.

\n

In both cases, if the contents of the button are wider than the\nparent container, the contents will line wrap.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "bool", + "is_generator": false, + "description": "

True if the button was clicked.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/form.py#L229" + }, + "streamlit.fragment": { + "name": "fragment", + "signature": "st.fragment(func=None, *, run_every=None)", + "examples": "
\n

The following example demonstrates basic usage of\n@st.fragment. As an analogy, "inflating balloons" is a slow process that happens\noutside of the fragment. "Releasing balloons" is a quick process that happens inside\nof the fragment.

\n
\nimport streamlit as st\nimport time\n\n@st.fragment\ndef release_the_balloons():\n    st.button("Release the balloons", help="Fragment rerun")\n    st.balloons()\n\nwith st.spinner("Inflating balloons..."):\n    time.sleep(5)\nrelease_the_balloons()\nst.button("Inflate more balloons", help="Full rerun")\n
\n

This next example demonstrates how elements both inside and outside of a\nfragement update with each app or fragment rerun. In this app, clicking\n"Rerun full app" will increment both counters and update all values\ndisplayed in the app. In contrast, clicking "Rerun fragment" will only\nincrement the counter within the fragment. In this case, the st.write\ncommand inside the fragment will update the app's frontend, but the two\nst.write commands outside the fragment will not update the frontend.

\n
\nimport streamlit as st\n\nif "app_runs" not in st.session_state:\n    st.session_state.app_runs = 0\n    st.session_state.fragment_runs = 0\n\n@st.fragment\ndef my_fragment():\n    st.session_state.fragment_runs += 1\n    st.button("Rerun fragment")\n    st.write(f"Fragment says it ran {st.session_state.fragment_runs} times.")\n\nst.session_state.app_runs += 1\nmy_fragment()\nst.button("Rerun full app")\nst.write(f"Full app says it ran {st.session_state.app_runs} times.")\nst.write(f"Full app sees that fragment ran {st.session_state.fragment_runs} times.")\n
\n

You can also trigger an app rerun from inside a fragment by calling\nst.rerun.

\n
\nimport streamlit as st\n\nif "clicks" not in st.session_state:\n    st.session_state.clicks = 0\n\n@st.fragment\ndef count_to_five():\n    if st.button("Plus one!"):\n        st.session_state.clicks += 1\n        if st.session_state.clicks % 5 == 0:\n            st.rerun()\n    return\n\ncount_to_five()\nst.header(f"Multiples of five clicks: {st.session_state.clicks // 5}")\n\nif st.button("Check click count"):\n    st.toast(f"## Total clicks: {st.session_state.clicks}")\n
\n
\n", + "description": "

Decorator to turn a function into a fragment which can rerun independently of the full app.

\n

When a user interacts with an input widget created inside a fragment,\nStreamlit only reruns the fragment instead of the full app. If\nrun_every is set, Streamlit will also rerun the fragment at the\nspecified interval while the session is active, even if the user is not\ninteracting with your app.

\n

To trigger an app rerun from inside a fragment, call st.rerun()\ndirectly. To trigger a fragment rerun from within itself, call\nst.rerun(scope="fragment"). Any values from the fragment that need to\nbe accessed from the wider app should generally be stored in Session State.

\n

When Streamlit element commands are called directly in a fragment, the\nelements are cleared and redrawn on each fragment rerun, just like all\nelements are redrawn on each app rerun. The rest of the app is persisted\nduring a fragment rerun. When a fragment renders elements into externally\ncreated containers, the elements will not be cleared with each fragment\nrerun. Instead, elements will accumulate in those containers with each\nfragment rerun, until the next app rerun.

\n

Calling st.sidebar in a fragment is not supported. To write elements to\nthe sidebar with a fragment, call your fragment function inside a\nwith st.sidebar context manager.

\n

Fragment code can interact with Session State, imported modules, and\nother Streamlit elements created outside the fragment. Note that these\ninteractions are additive across multiple fragment reruns. You are\nresponsible for handling any side effects of that behavior.

\n
\n

Warning

\n
    \n
  • Fragments can only contain widgets in their main body. Fragments\ncan't render widgets to externally created containers.
    • \n
\n
\n", + "args": [ + { + "name": "func", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The function to turn into a fragment.

\n", + "default": null + }, + { + "name": "run_every", + "type_name": "int, float, timedelta, str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The time interval between automatic fragment reruns. This can be one of\nthe following:

\n
\n\n
\n

If run_every is None, the fragment will only rerun from\nuser-triggered events.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/fragment.py#L290" + }, + "streamlit.get_option": { + "name": "get_option", + "signature": "st.get_option(key)", + "description": "

Return the current value of a given Streamlit config option.

\n

Run streamlit config show in the terminal to see all available options.

\n", + "args": [ + { + "name": "key", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The config option key of the form "section.optionName". To see all\navailable options, run streamlit config show on a terminal.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/config.py#L126" + }, + "streamlit.graphviz_chart": { + "name": "graphviz_chart", + "signature": "st.graphviz_chart(figure_or_dot, use_container_width=False)", + "example": "
\n
\nimport streamlit as st\nimport graphviz\n\n# Create a graphlib graph object\ngraph = graphviz.Digraph()\ngraph.edge("run", "intr")\ngraph.edge("intr", "runbl")\ngraph.edge("runbl", "run")\ngraph.edge("run", "kernel")\ngraph.edge("kernel", "zombie")\ngraph.edge("kernel", "sleep")\ngraph.edge("kernel", "runmem")\ngraph.edge("sleep", "swap")\ngraph.edge("swap", "runswap")\ngraph.edge("runswap", "new")\ngraph.edge("runswap", "runmem")\ngraph.edge("new", "runmem")\ngraph.edge("sleep", "runmem")\n\nst.graphviz_chart(graph)\n
\n

Or you can render the chart from the graph using GraphViz's Dot\nlanguage:

\n
\nst.graphviz_chart('''\n    digraph {\n        run -> intr\n        intr -> runbl\n        runbl -> run\n        run -> kernel\n        kernel -> zombie\n        kernel -> sleep\n        kernel -> runmem\n        sleep -> swap\n        swap -> runswap\n        runswap -> new\n        runswap -> runmem\n        new -> runmem\n        sleep -> runmem\n    }\n''')\n
\n
\n", + "description": "

Display a graph using the dagre-d3 library.

\n", + "args": [ + { + "name": "figure_or_dot", + "type_name": "graphviz.dot.Graph, graphviz.dot.Digraph, graphviz.sources.Source, str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The Graphlib graph object or dot string to display

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to override the figure's native width with the width of\nthe parent container. If use_container_width is False\n(default), Streamlit sets the width of the chart to fit its contents\naccording to the plotting library, up to the width of the parent\ncontainer. If use_container_width is True, Streamlit sets\nthe width of the figure to match the width of the parent container.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/graphviz_chart.py#L41" + }, + "streamlit.header": { + "name": "header", + "signature": "st.header(body, anchor=None, *, help=None, divider=False)", + "examples": "
\n
\nimport streamlit as st\n\nst.header("_Streamlit_ is :blue[cool] :sunglasses:")\nst.header("This is a header with a divider", divider="gray")\nst.header("These headers have rotating dividers", divider=True)\nst.header("One", divider=True)\nst.header("Two", divider=True)\nst.header("Three", divider=True)\nst.header("Four", divider=True)\n
\n
\n", + "description": "

Display text in header formatting.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The text to display as GitHub-flavored Markdown. Syntax\ninformation can be found at: https://github.github.com/gfm.

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "anchor", + "type_name": "str or False", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The anchor name of the header that can be accessed with #anchor\nin the URL. If omitted, it generates an anchor using the body.\nIf False, the anchor is not shown in the UI.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed next to the header.

\n", + "default": null + }, + { + "name": "divider", + "type_name": "bool or \u201cblue\u201d, \u201cgreen\u201d, \u201corange\u201d, \u201cred\u201d, \u201cviolet\u201d, \u201cgray\u201d/\"grey\", or \u201crainbow\u201d", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Shows a colored divider below the header. If True, successive\nheaders will cycle through divider colors. That is, the first\nheader will have a blue line, the second header will have a\ngreen line, and so on. If a string, the color can be set to one of\nthe following: blue, green, orange, red, violet, gray/grey, or\nrainbow.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/heading.py#L43" + }, + "streamlit.help": { + "name": "help", + "signature": "st.help(obj=)", + "example": "
\n

Don't remember how to initialize a dataframe? Try this:

\n
\nimport streamlit as st\nimport pandas\n\nst.help(pandas.DataFrame)\n
\n

Want to quickly check what data type is output by a certain function?\nTry:

\n
\nimport streamlit as st\n\nx = my_poorly_documented_function()\nst.help(x)\n
\n

Want to quickly inspect an object? No sweat:

\n
\nclass Dog:\n  '''A typical dog.'''\n\n  def __init__(self, breed, color):\n    self.breed = breed\n    self.color = color\n\n  def bark(self):\n    return 'Woof!'\n\n\nfido = Dog("poodle", "white")\n\nst.help(fido)\n
\n

And if you're using Magic, you can get help for functions, classes,\nand modules without even typing st.help:

\n
\nimport streamlit as st\nimport pandas\n\n# Get help for Pandas read_csv:\npandas.read_csv\n\n# Get help for Streamlit itself:\nst\n
\n
\n", + "description": "

Display help and other information for a given object.

\n

Depending on the type of object that is passed in, this displays the\nobject's name, type, value, signature, docstring, and member variables,\nmethods \u2014 as well as the values/docstring of members and methods.

\n", + "args": [ + { + "name": "obj", + "type_name": "any", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The object whose information should be displayed. If left\nunspecified, this call will display help for Streamlit itself.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/doc_string.py#L44" + }, + "streamlit.html": { + "name": "html", + "signature": "st.html(body)", + "example": "
\n
\nimport streamlit as st\n\nst.html(\n    "<p><span style='text-decoration: line-through double red;'>Oops</span>!</p>"\n)\n
\n
\n", + "description": "

Insert HTML into your app.

\n

Adding custom HTML to your app impacts safety, styling, and\nmaintainability. We sanitize HTML with DOMPurify, but inserting HTML remains a\ndeveloper risk. Passing untrusted code to st.html or dynamically\nloading external code can increase the risk of vulnerabilities in your\napp.

\n

st.html content is not iframed. Executing JavaScript is not\nsupported at this time.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The HTML code to insert, or path to an HTML code file which is\nloaded and inserted.

\n

If the provided string is the path of a local file, Streamlit will\nload the file and render its contents as HTML. Otherwise, Streamlit\nwill render the string directly as HTML.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/html.py#L29" + }, + "streamlit.image": { + "name": "image", + "signature": "st.image(image, caption=None, width=None, use_column_width=None, clamp=False, channels=\"RGB\", output_format=\"auto\")", + "example": "
\n
\nimport streamlit as st\nst.image("sunrise.jpg", caption="Sunrise by the mountains")\n
\n
\n", + "description": "

Display an image or list of images.

\n", + "args": [ + { + "name": "image", + "type_name": "numpy.ndarray, [numpy.ndarray], BytesIO, str, or [str]", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Monochrome image of shape (w,h) or (w,h,1)\nOR a color image of shape (w,h,3)\nOR an RGBA image of shape (w,h,4)\nOR a URL to fetch the image from\nOR a path of a local image file\nOR an SVG XML string like <svg xmlns=...</svg>\nOR a list of one of the above, to display multiple images.

\n", + "default": null + }, + { + "name": "caption", + "type_name": "str or list of str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Image caption. If displaying multiple images, caption should be a\nlist of captions (one for each image).

\n", + "default": null + }, + { + "name": "width", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Image width. None means use the image width,\nbut do not exceed the width of the column.\nShould be set for SVG images, as they have no default image width.

\n", + "default": "image" + }, + { + "name": "use_column_width", + "type_name": "\"auto\", \"always\", \"never\", or bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

If "auto", set the image's width to its natural size,\nbut do not exceed the width of the column.\nIf "always" or True, set the image's width to the column width.\nIf "never" or False, set the image's width to its natural size.\nNote: if set, use_column_width takes precedence over the width parameter.

\n", + "default": null + }, + { + "name": "clamp", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Clamp image pixel values to a valid range ([0-255] per channel).\nThis is only meaningful for byte array images; the parameter is\nignored for image URLs. If this is not set, and an image has an\nout-of-range value, an error will be thrown.

\n", + "default": null + }, + { + "name": "channels", + "type_name": "\"RGB\" or \"BGR\"", + "is_optional": false, + "is_kwarg_only": false, + "description": "

If image is an nd.array, this parameter denotes the format used to\nrepresent color information. Defaults to "RGB", meaning\nimage[:, :, 0] is the red channel, image[:, :, 1] is green, and\nimage[:, :, 2] is blue. For images coming from libraries like\nOpenCV you should set this to "BGR", instead.

\n", + "default": "s" + }, + { + "name": "output_format", + "type_name": "\"JPEG\", \"PNG\", or \"auto\"", + "is_optional": false, + "is_kwarg_only": false, + "description": "

This parameter specifies the format to use when transferring the\nimage data. Photos should use the JPEG format for lossy compression\nwhile diagrams should use the PNG format for lossless compression.\nDefaults to "auto" which identifies the compression type based\non the type and format of the image argument.

\n", + "default": "s" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/image.py#L84" + }, + "streamlit.info": { + "name": "info", + "signature": "st.info(body, *, icon=None)", + "example": "
\n
\nimport streamlit as st\n\nst.info('This is a purely informational message', icon="\u2139\ufe0f")\n
\n
\n", + "description": "

Display an informational message.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The info text to display.

\n", + "default": null + }, + { + "name": "icon", + "type_name": "str, None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional emoji or icon to display next to the alert. If icon\nis None (default), no icon is displayed. If icon is a\nstring, the following options are valid:

\n
    \n

  • A single-character emoji. For example, you can set icon="\ud83d\udea8"\nor icon="\ud83d\udd25". Emoji short codes are not supported.

    \n
    • \n

  • An icon from the Material Symbols library (rounded style) in the\nformat ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols\nfont library.

    \n
    • \n
\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/alert.py#L116" + }, + "streamlit.json": { + "name": "json", + "signature": "st.json(body, *, expanded=True)", + "example": "
\n
\nimport streamlit as st\n\nst.json(\n    {\n        "foo": "bar",\n        "baz": "boz",\n        "stuff": [\n            "stuff 1",\n            "stuff 2",\n            "stuff 3",\n            "stuff 5",\n        ],\n    }\n)\n
\n
\n", + "description": "

Display object or string as a pretty-printed JSON string.

\n", + "args": [ + { + "name": "body", + "type_name": "object or str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The object to print as JSON. All referenced objects should be\nserializable to JSON as well. If object is a string, we assume it\ncontains serialized JSON.

\n", + "default": null + }, + { + "name": "expanded", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean that allows the user to set whether the initial\nstate of this json element should be expanded. Defaults to True.

\n", + "default": "True" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/json.py#L38" + }, + "streamlit.latex": { + "name": "latex", + "signature": "st.latex(body, *, help=None)", + "example": "
\n
\nimport streamlit as st\n\nst.latex(r'''\n    a + ar + a r^2 + a r^3 + \\cdots + a r^{n-1} =\n    \\sum_{k=0}^{n-1} ar^k =\n    a \\left(\\frac{1-r^{n}}{1-r}\\right)\n    ''')\n
\n
\n", + "description": "

Display mathematical expressions formatted as LaTeX.

\n

Supported LaTeX functions are listed at\nhttps://katex.org/docs/supported.html.

\n", + "args": [ + { + "name": "body", + "type_name": "str or SymPy expression", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The string or SymPy expression to display as LaTeX. If str, it's\na good idea to use raw Python strings since LaTeX uses backslashes\na lot.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed next to the LaTeX expression.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/markdown.py#L217" + }, + "streamlit.line_chart": { + "name": "line_chart", + "signature": "st.line_chart(data=None, *, x=None, y=None, x_label=None, y_label=None, color=None, width=None, height=None, use_container_width=True)", + "examples": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(np.random.randn(20, 3), columns=["a", "b", "c"])\n\nst.line_chart(chart_data)\n
\n

You can also choose different columns to use for x and y, as well as set\nthe color dynamically based on a 3rd column (assuming your dataframe is in\nlong format):

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(\n    {\n        "col1": np.random.randn(20),\n        "col2": np.random.randn(20),\n        "col3": np.random.choice(["A", "B", "C"], 20),\n    }\n)\n\nst.line_chart(chart_data, x="col1", y="col2", color="col3")\n
\n

Finally, if your dataframe is in wide format, you can group multiple\ncolumns under the y argument to show multiple lines with different\ncolors:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(\n    np.random.randn(20, 3), columns=["col1", "col2", "col3"]\n)\n\nst.line_chart(\n    chart_data,\n    x="col1",\n    y=["col2", "col3"],\n    color=["#FF0000", "#0000FF"],  # Optional\n)\n
\n
\n", + "description": "

Display a line chart.

\n

This is syntax-sugar around st.altair_chart. The main difference\nis this command uses the data's own column and indices to figure out\nthe chart's Altair spec. As a result this is easier to use for many\n"just plot this" scenarios, while being less customizable.

\n

If st.line_chart does not guess the data specification\ncorrectly, try specifying your desired chart using st.altair_chart.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Styler, pyarrow.Table, numpy.ndarray, pyspark.sql.DataFrame, snowflake.snowpark.dataframe.DataFrame, snowflake.snowpark.table.Table, Iterable, dict or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Data to be plotted.

\n", + "default": null + }, + { + "name": "x", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column name or key associated to the x-axis data. If x is\nNone (default), Streamlit uses the data index for the x-axis\nvalues.

\n", + "default": null + }, + { + "name": "y", + "type_name": "str, Sequence of str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column name(s) or key(s) associated to the y-axis data. If this is\nNone (default), Streamlit draws the data of all remaining\ncolumns as data series. If this is a Sequence of strings,\nStreamlit draws several series on the same chart by melting your\nwide-format table into a long-format table behind the scenes.

\n", + "default": null + }, + { + "name": "x_label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The label for the x-axis. If this is None (default), Streamlit\nwill use the column name specified in x if available, or else\nno label will be displayed.

\n", + "default": null + }, + { + "name": "y_label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The label for the y-axis. If this is None (default), Streamlit\nwill use the column name(s) specified in y if available, or\nelse no label will be displayed.

\n", + "default": null + }, + { + "name": "color", + "type_name": "str, tuple, Sequence of str, Sequence of tuple, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The color to use for different lines in this chart.

\n

For a line chart with just one line, this can be:

\n
    \n
  • None, to use the default color.
    • \n
  • A hex string like "#ffaa00" or "#ffaa0088".
    • \n
  • An RGB or RGBA tuple with the red, green, blue, and alpha\ncomponents specified as ints from 0 to 255 or floats from 0.0 to\n1.0.
    • \n
\n

For a line chart with multiple lines, where the dataframe is in\nlong format (that is, y is None or just one column), this can be:

\n
    \n

  • None, to use the default colors.

    \n
    • \n

  • The name of a column in the dataset. Data points will be grouped\ninto lines of the same color based on the value of this column.\nIn addition, if the values in this column match one of the color\nformats above (hex string or color tuple), then that color will\nbe used.

    \n

    For example: if the dataset has 1000 rows, but this column only\ncontains the values "adult", "child", and "baby", then those 1000\ndatapoints will be grouped into three lines whose colors will be\nautomatically selected from the default palette.

    \n

    But, if for the same 1000-row dataset, this column contained\nthe values "#ffaa00", "#f0f", "#0000ff", then then those 1000\ndatapoints would still be grouped into three lines, but their\ncolors would be "#ffaa00", "#f0f", "#0000ff" this time around.

    \n
    • \n
\n

For a line chart with multiple lines, where the dataframe is in\nwide format (that is, y is a Sequence of columns), this can be:

\n
    \n
  • None, to use the default colors.
    • \n
  • A list of string colors or color tuples to be used for each of\nthe lines in the chart. This list should have the same length\nas the number of y values (e.g. color=["#fd0", "#f0f", "#04f"]\nfor three lines).
    • \n
\n", + "default": "color" + }, + { + "name": "width", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired width of the chart expressed in pixels. If width is\nNone (default), Streamlit sets the width of the chart to fit\nits contents according to the plotting library, up to the width of\nthe parent container. If width is greater than the width of the\nparent container, Streamlit sets the chart width to match the width\nof the parent container.

\n

To use width, you must set use_container_width=False.

\n", + "default": null + }, + { + "name": "height", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired height of the chart expressed in pixels. If height is\nNone (default), Streamlit sets the height of the chart to fit\nits contents according to the plotting library.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to override width with the width of the parent\ncontainer. If use_container_width is True (default),\nStreamlit sets the width of the chart to match the width of the\nparent container. If use_container_width is False,\nStreamlit sets the chart's width according to width.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/vega_charts.py#L550" + }, + "streamlit.link_button": { + "name": "link_button", + "signature": "st.link_button(label, url, *, help=None, type=\"secondary\", disabled=False, use_container_width=False)", + "example": "
\n
\nimport streamlit as st\n\nst.link_button("Go to gallery", "https://streamlit.io/gallery")\n
\n
\n", + "description": "

Display a link button element.

\n

When clicked, a new tab will be opened to the specified URL. This will\ncreate a new session for the user if directed within the app.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this button is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "url", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The url to be opened on user click

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when the button is\nhovered over.

\n", + "default": null + }, + { + "name": "type", + "type_name": "\"secondary\" or \"primary\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string that specifies the button type. Can be "primary" for a\nbutton with additional emphasis or "secondary" for a normal button. Defaults\nto "secondary".

\n", + "default": "s" + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the link button if set to\nTrue. The default is False.

\n", + "default": "False" + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to expand the button's width to fill its parent container.\nIf use_container_width is False (default), Streamlit sizes\nthe button to fit its contents. If use_container_width is\nTrue, the width of the button matches its parent container.

\n

In both cases, if the contents of the button are wider than the\nparent container, the contents will line wrap.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/button.py#L378" + }, + "streamlit.logo": { + "name": "logo", + "signature": "st.logo(image, *, link=None, icon_image=None)", + "examples": "

A common design practice is to use a wider logo in the sidebar, and a\nsmaller, icon-styled logo in your app's main body.

\n
\nimport streamlit as st\n\nst.logo(\n    LOGO_URL_LARGE,\n    link="https://streamlit.io/gallery",\n    icon_image=LOGO_URL_SMALL,\n)\n
\n

Try switching logos around in the following example:

\n
\nimport streamlit as st\n\nHORIZONTAL_RED = "images/horizontal_red.png"\nICON_RED = "images/icon_red.png"\nHORIZONTAL_BLUE = "images/horizontal_blue.png"\nICON_BLUE = "images/icon_blue.png"\n\noptions = [HORIZONTAL_RED, ICON_RED, HORIZONTAL_BLUE, ICON_BLUE]\nsidebar_logo = st.selectbox("Sidebar logo", options, 0)\nmain_body_logo = st.selectbox("Main body logo", options, 1)\n\nst.logo(sidebar_logo, icon_image=main_body_logo)\nst.sidebar.markdown("Hi!")\n
\n", + "description": "

Renders a logo in the upper-left corner of your app and its sidebar.

\n

If st.logo is called multiple times within a page, Streamlit will\nrender the image passed in the last call. For the most consistent results,\ncall st.logo early in your page script and choose an image that works\nwell in both light and dark mode. Avoid empty margins around your image.

\n

If your logo does not work well for both light and dark mode, consider\nsetting the theme and hiding the settings menu from users with the\nconfiguration option\nclient.toolbarMode="minimal".

\n", + "args": [ + { + "name": "image", + "type_name": "Anything supported by st.image", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The image to display in the upper-left corner of your app and its\nsidebar. If icon_image is also provided, then Streamlit will only\ndisplay image in the sidebar.

\n

Streamlit scales the image to a height of 24 pixels and a maximum\nwidth of 240 pixels. Use images with an aspect ratio of 10:1 or less to\navoid distortion.

\n", + "default": null + }, + { + "name": "link", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The external URL to open when a user clicks on the logo. The URL must\nstart with "http://" or "https://". If link is None (default),\nthe logo will not include a hyperlink.

\n", + "default": null + }, + { + "name": "icon_image", + "type_name": "Anything supported by st.image or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An alternate image to replace image in the upper-left corner of the\napp's main body. If icon_image is None (default), Streamlit\nwill render image in the upper-left corner of the app and its\nsidebar. Otherwise, Streamlit will render icon_image in the\nupper-left corner of the app and image in the upper-left corner\nof the sidebar.

\n

Streamlit scales the image to a height of 24 pixels and a maximum\nwidth of 240 pixels. Use images with an aspect ratio of 10:1 or less to\navoid distortion.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/commands/logo.py#L31" + }, + "streamlit.map": { + "name": "map", + "signature": "st.map(data=None, *, latitude=None, longitude=None, color=None, size=None, zoom=None, use_container_width=True)", + "examples": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\ndf = pd.DataFrame(\n    np.random.randn(1000, 2) / [50, 50] + [37.76, -122.4],\n    columns=['lat', 'lon'])\n\nst.map(df)\n
\n

You can also customize the size and color of the datapoints:

\n
\nst.map(df, size=20, color='#0044ff')\n
\n

And finally, you can choose different columns to use for the latitude\nand longitude components, as well as set size and color of each\ndatapoint dynamically based on other columns:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\ndf = pd.DataFrame({\n    "col1": np.random.randn(1000) / 50 + 37.76,\n    "col2": np.random.randn(1000) / 50 + -122.4,\n    "col3": np.random.randn(1000) * 100,\n    "col4": np.random.rand(1000, 4).tolist(),\n})\n\nst.map(df,\n    latitude='col1',\n    longitude='col2',\n    size='col3',\n    color='col4')\n
\n
\n", + "description": "

Display a map with a scatterplot overlaid onto it.

\n

This is a wrapper around st.pydeck_chart to quickly create\nscatterplot charts on top of a map, with auto-centering and auto-zoom.

\n

When using this command, Mapbox provides the map tiles to render map\ncontent. Note that Mapbox is a third-party product and Streamlit accepts\nno responsibility or liability of any kind for Mapbox or for any content\nor information made available by Mapbox.

\n

Mapbox requires users to register and provide a token before users can\nrequest map tiles. Currently, Streamlit provides this token for you, but\nthis could change at any time. We strongly recommend all users create and\nuse their own personal Mapbox token to avoid any disruptions to their\nexperience. You can do this with the mapbox.token config option. The\nuse of Mapbox is governed by Mapbox's Terms of Use.

\n

To get a token for yourself, create an account at https://mapbox.com.\nFor more info on how to set config options, see\nhttps://docs.streamlit.io/develop/api-reference/configuration/config.toml.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Styler, pyarrow.Table, pyspark.sql.DataFrame, snowflake.snowpark.dataframe.DataFrame, snowflake.snowpark.table.Table, Iterable, dict, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The data to be plotted.

\n", + "default": null + }, + { + "name": "latitude", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The name of the column containing the latitude coordinates of\nthe datapoints in the chart.

\n

If None, the latitude data will come from any column named 'lat',\n'latitude', 'LAT', or 'LATITUDE'.

\n", + "default": null + }, + { + "name": "longitude", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The name of the column containing the longitude coordinates of\nthe datapoints in the chart.

\n

If None, the longitude data will come from any column named 'lon',\n'longitude', 'LON', or 'LONGITUDE'.

\n", + "default": null + }, + { + "name": "color", + "type_name": "str or tuple or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The color of the circles representing each datapoint.

\n

Can be:

\n
    \n
  • None, to use the default color.
    • \n
  • A hex string like "#ffaa00" or "#ffaa0088".
    • \n
  • An RGB or RGBA tuple with the red, green, blue, and alpha\ncomponents specified as ints from 0 to 255 or floats from 0.0 to\n1.0.
    • \n
  • The name of the column to use for the color. Cells in this column\nshould contain colors represented as a hex string or color tuple,\nas described above.
    • \n
\n", + "default": "color" + }, + { + "name": "size", + "type_name": "str or float or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The size of the circles representing each point, in meters.

\n

This can be:

\n
    \n
  • None, to use the default size.
    • \n
  • A number like 100, to specify a single size to use for all\ndatapoints.
    • \n
  • The name of the column to use for the size. This allows each\ndatapoint to be represented by a circle of a different size.
    • \n
\n", + "default": "size" + }, + { + "name": "zoom", + "type_name": "int", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Zoom level as specified in\nhttps://wiki.openstreetmap.org/wiki/Zoom_levels.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to override the map's native width with the width of\nthe parent container. If use_container_width is True\n(default), Streamlit sets the width of the map to match the width\nof the parent container. If use_container_width is False,\nStreamlit sets the width of the chart to fit its contents according\nto the plotting library, up to the width of the parent container.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/map.py#L73" + }, + "streamlit.markdown": { + "name": "markdown", + "signature": "st.markdown(body, unsafe_allow_html=False, *, help=None)", + "examples": "
\n
\nimport streamlit as st\n\nst.markdown("*Streamlit* is **really** ***cool***.")\nst.markdown('''\n    :red[Streamlit] :orange[can] :green[write] :blue[text] :violet[in]\n    :gray[pretty] :rainbow[colors] and :blue-background[highlight] text.''')\nst.markdown("Here's a bouquet &mdash;\\\n            :tulip::cherry_blossom::rose::hibiscus::sunflower::blossom:")\n\nmulti = '''If you end a line with two spaces,\na soft return is used for the next line.\n\nTwo (or more) newline characters in a row will result in a hard return.\n'''\nst.markdown(multi)\n
\n
\n", + "description": "

Display string formatted as Markdown.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The string to display as GitHub-flavored Markdown. Syntax\ninformation can be found at: https://github.github.com/gfm.

\n

This also supports:

\n
    \n
  • Emoji shortcodes, such as :+1: and :sunglasses:.\nFor a list of all supported codes,\nsee https://share.streamlit.io/streamlit/emoji-shortcodes.
    • \n
  • Google Material Symbols (rounded style), using the syntax\n:material/icon_name:, where "icon_name" is the name of the\nicon in snake case. For a complete list of icons, see Google's\nMaterial Symbols\nfont library.
    • \n
  • LaTeX expressions, by wrapping them in "$" or "$$" (the "$$"\nmust be on their own lines). Supported LaTeX functions are listed\nat https://katex.org/docs/supported.html.
    • \n
  • Colored text and background colors for text, using the syntax\n:color[text to be colored] and :color-background[text to be colored],\nrespectively. color must be replaced with any of the following\nsupported colors: blue, green, orange, red, violet, gray/grey, rainbow.\nFor example, you can use :orange[your text here] or\n:blue-background[your text here].
    • \n
\n", + "default": null + }, + { + "name": "unsafe_allow_html", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to render HTML within body. If this is False\n(default), any HTML tags found in body will be escaped and\ntherefore treated as raw text. If this is True, any HTML\nexpressions within body will be rendered.

\n

Adding custom HTML to your app impacts safety, styling, and\nmaintainability.

\n
\n

Note

\n

If you only want to insert HTML or CSS without Markdown text,\nwe recommend using st.html instead.

\n
\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed next to the Markdown.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/markdown.py#L33" + }, + "streamlit.metric": { + "name": "metric", + "signature": "st.metric(label, value, delta=None, delta_color=\"normal\", help=None, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\nst.metric(label="Temperature", value="70 \u00b0F", delta="1.2 \u00b0F")\n
\n

st.metric looks especially nice in combination with st.columns:

\n
\nimport streamlit as st\n\ncol1, col2, col3 = st.columns(3)\ncol1.metric("Temperature", "70 \u00b0F", "1.2 \u00b0F")\ncol2.metric("Wind", "9 mph", "-8%")\ncol3.metric("Humidity", "86%", "4%")\n
\n

The delta indicator color can also be inverted or turned off:

\n
\nimport streamlit as st\n\nst.metric(label="Gas price", value=4, delta=-0.5, delta_color="inverse")\n\nst.metric(\n    label="Active developers", value=123, delta=123, delta_color="off"\n)\n
\n
\n", + "description": "

Display a metric in big bold font, with an optional indicator of how the metric changed.

\n

Tip: If you want to display a large number, it may be a good idea to\nshorten it using packages like millify\nor numerize. E.g. 1234 can be\ndisplayed as 1.2k using st.metric("Short number", millify(1234)).

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The header or title for the metric. The label can optionally\ncontain GitHub-flavored Markdown of the following types: Bold, Italics,\nStrikethroughs, Inline Code, and Links.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "value", + "type_name": "int, float, str, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Value of the metric. None is rendered as a long dash.

\n", + "default": null + }, + { + "name": "delta", + "type_name": "int, float, str, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Indicator of how the metric changed, rendered with an arrow below\nthe metric. If delta is negative (int/float) or starts with a minus\nsign (str), the arrow points down and the text is red; else the\narrow points up and the text is green. If None (default), no delta\nindicator is shown.

\n", + "default": null + }, + { + "name": "delta_color", + "type_name": "\"normal\", \"inverse\", or \"off\"", + "is_optional": false, + "is_kwarg_only": false, + "description": "

If "normal" (default), the delta indicator is shown as described\nabove. If "inverse", it is red when positive and green when\nnegative. This is useful when a negative change is considered\ngood, e.g. if cost decreased. If "off", delta is shown in gray\nregardless of its value.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the metric label.

\n", + "default": null + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/metric.py#L51" + }, + "streamlit.multiselect": { + "name": "multiselect", + "signature": "st.multiselect(label, options, default=None, format_func=special_internal_function, key=None, help=None, on_change=None, args=None, kwargs=None, *, max_selections=None, placeholder=\"Choose an option\", disabled=False, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\noptions = st.multiselect(\n    "What are your favorite colors",\n    ["Green", "Yellow", "Red", "Blue"],\n    ["Yellow", "Red"],\n)\n\nst.write("You selected:", options)\n
\n
\n", + "description": "

Display a multiselect widget.

\n

The multiselect widget starts as empty.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this select widget is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "options", + "type_name": "Iterable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Labels for the select options in an Iterable. For example, this can\nbe a list, numpy.ndarray, pandas.Series, pandas.DataFrame, or\npandas.Index. For pandas.DataFrame, the first column is used.\nEach label will be cast to str internally by default.

\n", + "default": null + }, + { + "name": "default", + "type_name": "Iterable of V, V, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

List of default values. Can also be a single value.

\n", + "default": "values" + }, + { + "name": "format_func", + "type_name": "function", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Function to modify the display of selectbox options. It receives\nthe raw option as an argument and should output the label to be\nshown for that option. This has no impact on the return value of\nthe multiselect.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the multiselect.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this multiselect's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "max_selections", + "type_name": "int", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The max selections that can be selected at a time.

\n", + "default": null + }, + { + "name": "placeholder", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A string to display when no options are selected.\nDefaults to 'Choose an option'.

\n", + "default": "s" + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the multiselect widget if set\nto True. The default is False. This argument can only be supplied\nby keyword.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "list", + "is_generator": false, + "description": "

A list with the selected options

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/multiselect.py#L114" + }, + "streamlit.navigation": { + "name": "navigation", + "signature": "st.navigation(pages, *, position=\"sidebar\")", + "examples": "

The following examples show possible entrypoint files, which is the file\nyou pass to streamlit run. Your entrypoint file manages your app's\nnavigation and serves as a router between pages.

\n

You can declare pages from callables or file paths.

\n
\nimport streamlit as st\nfrom page_functions import page1\n\npg = st.navigation([st.Page(page1), st.Page("page2.py")])\npg.run()\n
\n

Use a dictionary to create sections within your navigation menu.

\n
\nimport streamlit as st\n\npages = {\n    "Your account": [\n        st.Page("create_account.py", title="Create your account"),\n        st.Page("manage_account.py", title="Manage your account"),\n    ],\n    "Resources": [\n        st.Page("learn.py", title="Learn about us"),\n        st.Page("trial.py", title="Try it out"),\n    ],\n}\n\npg = st.navigation(pages)\npg.run()\n
\n

Call widget functions in your entrypoint file when you want a widget to be\nstateful across pages. Assign keys to your common widgets and access their\nvalues through Session State within your pages.

\n
\nimport streamlit as st\n\ndef page1():\n    st.write(st.session_state.foo)\n\ndef page2():\n    st.write(st.session_state.bar)\n\n# Widgets shared by all the pages\nst.sidebar.selectbox("Foo", ["A", "B", "C"], key="foo")\nst.sidebar.checkbox("Bar", key="bar")\n\npg = st.navigation([st.Page(page1), st.Page(page2)])\npg.run()\n
\n", + "description": "

Configure the available pages in a multipage app.

\n

Call st.navigation in your entrypoint file with one or more pages\ndefined by st.Page. st.navigation returns the current page, which\ncan be executed using .run() method.

\n

When using st.navigation, your entrypoint file (the file passed to\nstreamlit run) acts like a router or frame of common elements around\neach of your pages. Streamlit executes the entrypoint file with every app\nrerun. To execute the current page, you must call the .run() method on\nthe StreamlitPage object returned by st.navigation.

\n

The set of available pages can be updated with each rerun for dynamic\nnavigation. By default, st.navigation draws the available pages in the\nside navigation if there is more than one page. This behavior can be\nchanged using the position keyword argument.

\n

As soon as any session of your app executes the st.navigation command,\nyour app will ignore the pages/ directory (across all sessions).

\n", + "args": [ + { + "name": "pages", + "type_name": "list[StreamlitPage] or dict[str, list[StreamlitPage]]", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The available pages for the app.

\n

To create labeled sections or page groupings within the navigation\nmenu, pages must be a dictionary. Each key is the label of a\nsection and each value is the list of StreamlitPage objects for\nthat section.

\n

To create a navigation menu with no sections or page groupings,\npages must be a list of StreamlitPage objects.

\n

Use st.Page to create StreamlitPage objects.

\n", + "default": null + }, + { + "name": "position", + "type_name": "\"sidebar\" or \"hidden\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The position of the navigation menu. If position is "sidebar"\n(default), the navigation widget appears at the top of the sidebar. If\nposition is "hidden", the navigation widget is not displayed.

\n

If there is only one page in pages, the navigation will be hidden\nfor any value of position.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "StreamlitPage", + "is_generator": false, + "description": "

The current page selected by the user.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/commands/navigation.py#L55" + }, + "streamlit.number_input": { + "name": "number_input", + "signature": "st.number_input(label, min_value=None, max_value=None, value=\"min\", step=None, format=None, key=None, help=None, on_change=None, args=None, kwargs=None, *, placeholder=None, disabled=False, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\nnumber = st.number_input("Insert a number")\nst.write("The current number is ", number)\n
\n

To initialize an empty number input, use None as the value:

\n
\nimport streamlit as st\n\nnumber = st.number_input(\n    "Insert a number", value=None, placeholder="Type a number..."\n)\nst.write("The current number is ", number)\n
\n
\n", + "description": "

Display a numeric input widget.

\n
\n

Note

\n

Integer values exceeding +/- (1<<53) - 1 cannot be accurately\nstored or returned by the widget due to serialization contstraints\nbetween the Python server and JavaScript client. You must handle\nsuch numbers as floats, leading to a loss in precision.

\n
\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this input is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "min_value", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The minimum permitted value.\nIf None, there will be no minimum.

\n", + "default": null + }, + { + "name": "max_value", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The maximum permitted value.\nIf None, there will be no maximum.

\n", + "default": null + }, + { + "name": "value", + "type_name": "int, float, \"min\" or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The value of this widget when it first renders. If None, will initialize\nempty and return None until the user provides input.\nIf "min" (default), will initialize with min_value, or 0.0 if\nmin_value is None.

\n", + "default": null + }, + { + "name": "step", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The stepping interval.\nDefaults to 1 if the value is an int, 0.01 otherwise.\nIf the value is not specified, the format parameter will be used.

\n", + "default": "1" + }, + { + "name": "format", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A printf-style format string controlling how the interface should\ndisplay numbers. The output must be purely numeric. This does not\nimpact the return value of the widget. Formatting is handled by\nsprintf.js.

\n

For example, format="%0.1f" adjusts the displayed decimal\nprecision to only show one digit after the decimal.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the input.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this number_input's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "placeholder", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string displayed when the number input is empty.\nIf None, no placeholder is displayed.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the number input if set to\nTrue. The default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "int or float or None", + "is_generator": false, + "description": "

The current value of the numeric input widget or None if the widget\nis empty. The return type will match the data type of the value parameter.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/number_input.py#L118" + }, + "streamlit.page_link": { + "name": "page_link", + "signature": "st.page_link(page, *, label=None, icon=None, help=None, disabled=False, use_container_width=None)", + "example": "
\n

Consider the following example given this file structure:

\n
\nyour-repository/\n\u251c\u2500\u2500 pages/\n\u2502   \u251c\u2500\u2500 page_1.py\n\u2502   \u2514\u2500\u2500 page_2.py\n\u2514\u2500\u2500 your_app.py\n
\n
\nimport streamlit as st\n\nst.page_link("your_app.py", label="Home", icon="\ud83c\udfe0")\nst.page_link("pages/page_1.py", label="Page 1", icon="1\ufe0f\u20e3")\nst.page_link("pages/page_2.py", label="Page 2", icon="2\ufe0f\u20e3", disabled=True)\nst.page_link("http://www.google.com", label="Google", icon="\ud83c\udf0e")\n
\n

The default navigation is shown here for comparison, but you can hide\nthe default navigation using the client.showSidebarNavigation\nconfiguration option. This allows you to create custom, dynamic\nnavigation menus for your apps!

\n
\n", + "description": "

Display a link to another page in a multipage app or to an external page.

\n

If another page in a multipage app is specified, clicking st.page_link\nstops the current page execution and runs the specified page as if the\nuser clicked on it in the sidebar navigation.

\n

If an external page is specified, clicking st.page_link opens a new\ntab to the specified page. The current script run will continue if not\ncomplete.

\n", + "args": [ + { + "name": "page", + "type_name": "str or st.Page", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The file path (relative to the main script) or an st.Page indicating\nthe page to switch to. Alternatively, this can be the URL to an\nexternal page (must start with "http://" or "https://").

\n", + "default": null + }, + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The label for the page link. Labels are required for external pages.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "icon", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional emoji or icon to display next to the button label. If icon\nis None (default), no icon is displayed. If icon is a\nstring, the following options are valid:

\n
    \n

  • A single-character emoji. For example, you can set icon="\ud83d\udea8"\nor icon="\ud83d\udd25". Emoji short codes are not supported.

    \n
    • \n

  • An icon from the Material Symbols library (rounded style) in the\nformat ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols \nfont library.

    \n
    • \n
\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when the link is\nhovered over.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the page link if set to\nTrue. The default is False.

\n", + "default": "is" + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to expand the link's width to fill its parent container.\nThe default is True for page links in the sidebar and False\nfor those in the main app.

\n", + "default": "is" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/button.py#L465" + }, + "streamlit.plotly_chart": { + "name": "plotly_chart", + "signature": "st.plotly_chart(figure_or_data, use_container_width=False, *, theme=\"streamlit\", key=None, on_select=\"ignore\", selection_mode=('points', 'box', 'lasso'), **kwargs)", + "example": "
\n

The example below comes straight from the examples at\nhttps://plot.ly/python. Note that plotly.figure_factory requires\nscipy to run.

\n
\nimport streamlit as st\nimport numpy as np\nimport plotly.figure_factory as ff\n\n# Add histogram data\nx1 = np.random.randn(200) - 2\nx2 = np.random.randn(200)\nx3 = np.random.randn(200) + 2\n\n# Group data together\nhist_data = [x1, x2, x3]\n\ngroup_labels = ['Group 1', 'Group 2', 'Group 3']\n\n# Create distplot with custom bin_size\nfig = ff.create_distplot(\n        hist_data, group_labels, bin_size=[.1, .25, .5])\n\n# Plot!\nst.plotly_chart(fig, use_container_width=True)\n
\n
\n", + "description": "

Display an interactive Plotly chart.

\n

Plotly is a charting library for Python.\nThe arguments to this function closely follow the ones for Plotly's\nplot() function.

\n

To show Plotly charts in Streamlit, call st.plotly_chart wherever\nyou would call Plotly's py.plot or py.iplot.

\n", + "args": [ + { + "name": "figure_or_data", + "type_name": "plotly.graph_objs.Figure, plotly.graph_objs.Data, or dict/list of plotly.graph_objs.Figure/Data", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The Plotly Figure or Data object to render. See\nhttps://plot.ly/python/ for examples of graph descriptions.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to override the figure's native width with the width of\nthe parent container. If use_container_width is False\n(default), Streamlit sets the width of the chart to fit its contents\naccording to the plotting library, up to the width of the parent\ncontainer. If use_container_width is True, Streamlit sets\nthe width of the figure to match the width of the parent container.

\n", + "default": null + }, + { + "name": "theme", + "type_name": "\"streamlit\" or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The theme of the chart. If theme is "streamlit" (default),\nStreamlit uses its own design default. If theme is None,\nStreamlit falls back to the default behavior of the library.

\n", + "default": "behavior" + }, + { + "name": "key", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string to use for giving this element a stable\nidentity. If key is None (default), this element's identity\nwill be determined based on the values of the other parameters.

\n

Additionally, if selections are activated and key is provided,\nStreamlit will register the key in Session State to store the\nselection state. The selection state is read-only.

\n", + "default": null + }, + { + "name": "on_select", + "type_name": "\"ignore\" or \"rerun\" or callable", + "is_optional": false, + "is_kwarg_only": true, + "description": "

How the figure should respond to user selection events. This\ncontrols whether or not the figure behaves like an input widget.\non_select can be one of the following:

\n
    \n
  • "ignore" (default): Streamlit will not react to any selection\nevents in the chart. The figure will not behave like an input\nwidget.
    • \n
  • "rerun": Streamlit will rerun the app when the user selects\ndata in the chart. In this case, st.plotly_chart will return\nthe selection data as a dictionary.
    • \n
  • A callable: Streamlit will rerun the app and execute the\ncallable as a callback function before the rest of the app.\nIn this case, st.plotly_chart will return the selection data\nas a dictionary.
    • \n
\n", + "default": null + }, + { + "name": "selection_mode", + "type_name": "\"points\", \"box\", \"lasso\" or an Iterable of these", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The selection mode of the chart. This can be one of the following:

\n
    \n
  • "points": The chart will allow selections based on individual\ndata points.
    • \n
  • "box": The chart will allow selections based on rectangular\nareas.
    • \n
  • "lasso": The chart will allow selections based on freeform\nareas.
    • \n
  • An Iterable of the above options: The chart will allow\nselections based on the modes specified.
    • \n
\n

All selections modes are activated by default.

\n", + "default": null + }, + { + "name": "**kwargs", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

Any argument accepted by Plotly's plot() function.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "element or dict", + "is_generator": false, + "description": "

If on_select is "ignore" (default), this method returns an\ninternal placeholder for the chart element. Otherwise, this method\nreturns a dictionary-like object that supports both key and\nattribute notation. The attributes are described by the\nPlotlyState dictionary schema.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/plotly_chart.py#L305" + }, + "streamlit.popover": { + "name": "popover", + "signature": "st.popover(label, *, help=None, disabled=False, use_container_width=False)", + "examples": "
\n

You can use the with notation to insert any element into a popover:

\n
\nimport streamlit as st\n\nwith st.popover("Open popover"):\n    st.markdown("Hello World \ud83d\udc4b")\n    name = st.text_input("What's your name?")\n\nst.write("Your name:", name)\n
\n

Or you can just call methods directly on the returned objects:

\n
\nimport streamlit as st\n\npopover = st.popover("Filter items")\nred = popover.checkbox("Show red items.", True)\nblue = popover.checkbox("Show blue items.", True)\n\nif red:\n    st.write(":red[This is a red item.]")\nif blue:\n    st.write(":blue[This is a blue item.]")\n
\n
\n", + "description": "

Insert a popover container.

\n

Inserts a multi-element container as a popover. It consists of a button-like\nelement and a container that opens when the button is clicked.

\n

Opening and closing the popover will not trigger a rerun. Interacting\nwith widgets inside of an open popover will rerun the app while keeping\nthe popover open. Clicking outside of the popover will close it.

\n

To add elements to the returned container, you can use the "with"\nnotation (preferred) or just call methods directly on the returned object.\nSee examples below.

\n
\n

Warning

\n

You may not put a popover inside another popover.

\n
\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label of the button that opens the popover container.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when the popover button is\nhovered over.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the popover button if set to\nTrue. The default is False.

\n", + "default": "False" + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to expand the button's width to fill its parent container.\nIf use_container_width is False (default), Streamlit sizes\nthe button to fit its contents. If use_container_width is\nTrue, the width of the button matches its parent container.

\n

In both cases, if the contents of the button are wider than the\nparent container, the contents will line wrap.

\n

The popover containter's minimimun width matches the width of its\nbutton. The popover container may be wider than its button to fit\nthe container's contents.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/layouts.py#L547" + }, + "streamlit.progress": { + "name": "progress", + "signature": "st.progress(value, text=None)", + "example": "
\n

Here is an example of a progress bar increasing over time and disappearing when it reaches completion:

\n
\nimport streamlit as st\nimport time\n\nprogress_text = "Operation in progress. Please wait."\nmy_bar = st.progress(0, text=progress_text)\n\nfor percent_complete in range(100):\n    time.sleep(0.01)\n    my_bar.progress(percent_complete + 1, text=progress_text)\ntime.sleep(1)\nmy_bar.empty()\n\nst.button("Rerun")\n
\n
\n", + "description": "

Display a progress bar.

\n", + "args": [ + { + "name": "value", + "type_name": "int or float", + "is_optional": false, + "is_kwarg_only": false, + "description": "

0 <= value <= 100 for int

\n

0.0 <= value <= 1.0 for float

\n", + "default": null + }, + { + "name": "text", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A message to display above the progress bar. The text can optionally\ncontain GitHub-flavored Markdown of the following types: Bold, Italics,\nStrikethroughs, Inline Code, and Links.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/progress.py#L95" + }, + "streamlit.pydeck_chart": { + "name": "pydeck_chart", + "signature": "st.pydeck_chart(pydeck_obj=None, use_container_width=False)", + "example": "
\n

Here's a chart using a HexagonLayer and a ScatterplotLayer. It uses either the\nlight or dark map style, based on which Streamlit theme is currently active:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\nimport pydeck as pdk\n\nchart_data = pd.DataFrame(\n    np.random.randn(1000, 2) / [50, 50] + [37.76, -122.4],\n    columns=["lat", "lon"],\n)\n\nst.pydeck_chart(\n    pdk.Deck(\n        map_style=None,\n        initial_view_state=pdk.ViewState(\n            latitude=37.76,\n            longitude=-122.4,\n            zoom=11,\n            pitch=50,\n        ),\n        layers=[\n            pdk.Layer(\n                "HexagonLayer",\n                data=chart_data,\n                get_position="[lon, lat]",\n                radius=200,\n                elevation_scale=4,\n                elevation_range=[0, 1000],\n                pickable=True,\n                extruded=True,\n            ),\n            pdk.Layer(\n                "ScatterplotLayer",\n                data=chart_data,\n                get_position="[lon, lat]",\n                get_color="[200, 30, 0, 160]",\n                get_radius=200,\n            ),\n        ],\n    )\n)\n
\n
\n

Note

\n

To make the PyDeck chart's style consistent with Streamlit's theme,\nyou can set map_style=None in the pydeck.Deck object.

\n
\n
\n", + "description": "

Draw a chart using the PyDeck library.

\n

This supports 3D maps, point clouds, and more! More info about PyDeck\nat https://deckgl.readthedocs.io/en/latest/.

\n

These docs are also quite useful:

\n\n

When using this command, Mapbox provides the map tiles to render map\ncontent. Note that Mapbox is a third-party product and Streamlit accepts\nno responsibility or liability of any kind for Mapbox or for any content\nor information made available by Mapbox.

\n

Mapbox requires users to register and provide a token before users can\nrequest map tiles. Currently, Streamlit provides this token for you, but\nthis could change at any time. We strongly recommend all users create and\nuse their own personal Mapbox token to avoid any disruptions to their\nexperience. You can do this with the mapbox.token config option. The\nuse of Mapbox is governed by Mapbox's Terms of Use.

\n

To get a token for yourself, create an account at https://mapbox.com.\nFor more info on how to set config options, see\nhttps://docs.streamlit.io/develop/api-reference/configuration/config.toml.

\n", + "args": [ + { + "name": "pydeck_obj", + "type_name": "pydeck.Deck or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Object specifying the PyDeck chart to draw.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to override the figure's native width with the width of\nthe parent container. If use_container_width is False\n(default), Streamlit sets the width of the chart to fit its contents\naccording to the plotting library, up to the width of the parent\ncontainer. If use_container_width is True, Streamlit sets\nthe width of the figure to match the width of the parent container.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/deck_gl_json_chart.py#L39" + }, + "streamlit.pyplot": { + "name": "pyplot", + "signature": "st.pyplot(fig=None, clear_figure=None, use_container_width=True, **kwargs)", + "example": "
\n
\nimport streamlit as st\nimport matplotlib.pyplot as plt\nimport numpy as np\n\narr = np.random.normal(1, 1, size=100)\nfig, ax = plt.subplots()\nax.hist(arr, bins=20)\n\nst.pyplot(fig)\n
\n

Matplotlib supports several types of "backends". If you're getting an\nerror using Matplotlib with Streamlit, try setting your backend to "TkAgg":

\n
\necho "backend: TkAgg" >> ~/.matplotlib/matplotlibrc\n
\n

For more information, see https://matplotlib.org/faq/usage_faq.html.

\n
\n", + "description": "

Display a matplotlib.pyplot figure.

\n", + "args": [ + { + "name": "fig", + "type_name": "Matplotlib Figure", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The Matplotlib Figure object to render. See\nhttps://matplotlib.org/stable/gallery/index.html for examples.

\n
\n

Note

\n

When this argument isn't specified, this function will render the global\nMatplotlib figure object. However, this feature is deprecated and\nwill be removed in a later version.

\n
\n", + "default": null + }, + { + "name": "clear_figure", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

If True, the figure will be cleared after being rendered.\nIf False, the figure will not be cleared after being rendered.\nIf left unspecified, we pick a default based on the value of fig.

\n
    \n
  • If fig is set, defaults to False.
    • \n
  • If fig is not set, defaults to True. This simulates Jupyter's\napproach to matplotlib rendering.
    • \n
\n", + "default": "based" + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to override the figure's native width with the width of\nthe parent container. If use_container_width is True\n(default), Streamlit sets the width of the figure to match the\nwidth of the parent container. If use_container_width is\nFalse, Streamlit sets the width of the chart to fit its\ncontents according to the plotting library, up to the width of the\nparent container.

\n", + "default": null + }, + { + "name": "**kwargs", + "type_name": "any", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Arguments to pass to Matplotlib's savefig function.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/pyplot.py#L34" + }, + "streamlit.radio": { + "name": "radio", + "signature": "st.radio(label, options, index=0, format_func=special_internal_function, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, horizontal=False, captions=None, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\ngenre = st.radio(\n    "What's your favorite movie genre",\n    [":rainbow[Comedy]", "***Drama***", "Documentary :movie_camera:"],\n    captions=[\n        "Laugh out loud.",\n        "Get the popcorn.",\n        "Never stop learning.",\n    ],\n)\n\nif genre == ":rainbow[Comedy]":\n    st.write("You selected comedy.")\nelse:\n    st.write("You didn't select comedy.")\n
\n

To initialize an empty radio widget, use None as the index value:

\n
\nimport streamlit as st\n\ngenre = st.radio(\n    "What's your favorite movie genre",\n    [":rainbow[Comedy]", "***Drama***", "Documentary :movie_camera:"],\n    index=None,\n)\n\nst.write("You selected:", genre)\n
\n
\n", + "description": "

Display a radio button widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this radio group is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "options", + "type_name": "Iterable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Labels for the select options in an Iterable. For example, this can\nbe a list, numpy.ndarray, pandas.Series, pandas.DataFrame, or\npandas.Index. For pandas.DataFrame, the first column is used.

\n

Labels can include markdown as described in the label parameter\nand will be cast to str internally by default.

\n", + "default": null + }, + { + "name": "index", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The index of the preselected option on first render. If None,\nwill initialize empty and return None until the user selects an option.\nDefaults to 0 (the first option).

\n", + "default": "0" + }, + { + "name": "format_func", + "type_name": "function", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Function to modify the display of radio options. It receives\nthe raw option as an argument and should output the label to be\nshown for that option. This has no impact on the return value of\nthe radio.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the radio.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this radio's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the radio button if set to\nTrue. The default is False.

\n", + "default": "False" + }, + { + "name": "horizontal", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which orients the radio group horizontally.\nThe default is false (vertical buttons).

\n", + "default": "false" + }, + { + "name": "captions", + "type_name": "iterable of str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A list of captions to show below each radio button. If None (default),\nno captions are shown.

\n", + "default": null + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "any", + "is_generator": false, + "description": "

The selected option or None if no option is selected.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/radio.py#L84" + }, + "streamlit.rerun": { + "name": "rerun", + "signature": "st.rerun(*, scope=\"app\")", + "description": "

Rerun the script immediately.

\n

When st.rerun() is called, Streamlit halts the current script run and\nexecutes no further statements. Streamlit immediately queues the script to\nrerun.

\n

When using st.rerun in a fragment, you can scope the rerun to the\nfragment. However, if a fragment is running as part of a full-app rerun,\na fragment-scoped rerun is not allowed.

\n", + "args": [ + { + "name": "scope", + "type_name": "\"app\" or \"fragment\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies what part of the app should rerun. If scope is "app"\n(default), the full app reruns. If scope is "fragment",\nStreamlit only reruns the fragment from which this command is called.

\n

Setting scope="fragment" is only valid inside a fragment during a\nfragment rerun. If st.rerun(scope="fragment") is called during a\nfull-app rerun or outside of a fragment, Streamlit will raise a\nStreamlitAPIException.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/commands/execution_control.py#L106" + }, + "streamlit.scatter_chart": { + "name": "scatter_chart", + "signature": "st.scatter_chart(data=None, *, x=None, y=None, x_label=None, y_label=None, color=None, size=None, width=None, height=None, use_container_width=True)", + "examples": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(np.random.randn(20, 3), columns=["a", "b", "c"])\n\nst.scatter_chart(chart_data)\n
\n

You can also choose different columns to use for x and y, as well as set\nthe color dynamically based on a 3rd column (assuming your dataframe is in\nlong format):

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(\n    np.random.randn(20, 3), columns=["col1", "col2", "col3"]\n)\nchart_data["col4"] = np.random.choice(["A", "B", "C"], 20)\n\nst.scatter_chart(\n    chart_data,\n    x="col1",\n    y="col2",\n    color="col4",\n    size="col3",\n)\n
\n

Finally, if your dataframe is in wide format, you can group multiple\ncolumns under the y argument to show multiple series with different\ncolors:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(\n    np.random.randn(20, 4), columns=["col1", "col2", "col3", "col4"]\n)\n\nst.scatter_chart(\n    chart_data,\n    x="col1",\n    y=["col2", "col3"],\n    size="col4",\n    color=["#FF0000", "#0000FF"],  # Optional\n)\n
\n
\n", + "description": "

Display a scatterplot chart.

\n

This is syntax-sugar around st.altair_chart. The main difference\nis this command uses the data's own column and indices to figure out\nthe chart's Altair spec. As a result this is easier to use for many\n"just plot this" scenarios, while being less customizable.

\n

If st.scatter_chart does not guess the data specification correctly,\ntry specifying your desired chart using st.altair_chart.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Styler, pyarrow.Table, numpy.ndarray, pyspark.sql.DataFrame, snowflake.snowpark.dataframe.DataFrame, snowflake.snowpark.table.Table, Iterable, dict or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Data to be plotted.

\n", + "default": null + }, + { + "name": "x", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column name or key associated to the x-axis data. If x is\nNone (default), Streamlit uses the data index for the x-axis\nvalues.

\n", + "default": null + }, + { + "name": "y", + "type_name": "str, Sequence of str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column name(s) or key(s) associated to the y-axis data. If this is\nNone (default), Streamlit draws the data of all remaining\ncolumns as data series. If this is a Sequence of strings,\nStreamlit draws several series on the same chart by melting your\nwide-format table into a long-format table behind the scenes.

\n", + "default": null + }, + { + "name": "x_label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The label for the x-axis. If this is None (default), Streamlit\nwill use the column name specified in x if available, or else\nno label will be displayed.

\n", + "default": null + }, + { + "name": "y_label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The label for the y-axis. If this is None (default), Streamlit\nwill use the column name(s) specified in y if available, or\nelse no label will be displayed.

\n", + "default": null + }, + { + "name": "color", + "type_name": "str, tuple, Sequence of str, Sequence of tuple, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The color of the circles representing each datapoint.

\n

This can be:

\n
    \n

  • None, to use the default color.

    \n
    • \n

  • A hex string like "#ffaa00" or "#ffaa0088".

    \n
    • \n

  • An RGB or RGBA tuple with the red, green, blue, and alpha\ncomponents specified as ints from 0 to 255 or floats from 0.0 to\n1.0.

    \n
    • \n

  • The name of a column in the dataset where the color of that\ndatapoint will come from.

    \n

    If the values in this column are in one of the color formats\nabove (hex string or color tuple), then that color will be used.

    \n

    Otherwise, the color will be automatically picked from the\ndefault palette.

    \n

    For example: if the dataset has 1000 rows, but this column only\ncontains the values "adult", "child", and "baby", then those 1000\ndatapoints be shown using three colors from the default palette.

    \n

    But if this column only contains floats or ints, then those\n1000 datapoints will be shown using a colors from a continuous\ncolor gradient.

    \n

    Finally, if this column only contains the values "#ffaa00",\n"#f0f", "#0000ff", then then each of those 1000 datapoints will\nbe assigned "#ffaa00", "#f0f", or "#0000ff" as appropriate.

    \n
    • \n
\n

If the dataframe is in wide format (that is, y is a Sequence of\ncolumns), this can also be:

\n
    \n
  • A list of string colors or color tuples to be used for each of\nthe series in the chart. This list should have the same length\nas the number of y values (e.g. color=["#fd0", "#f0f", "#04f"]\nfor three series).
    • \n
\n", + "default": "color" + }, + { + "name": "size", + "type_name": "str, float, int, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The size of the circles representing each point.

\n

This can be:

\n
    \n
  • A number like 100, to specify a single size to use for all\ndatapoints.
    • \n
  • The name of the column to use for the size. This allows each\ndatapoint to be represented by a circle of a different size.
    • \n
\n", + "default": null + }, + { + "name": "width", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired width of the chart expressed in pixels. If width is\nNone (default), Streamlit sets the width of the chart to fit\nits contents according to the plotting library, up to the width of\nthe parent container. If width is greater than the width of the\nparent container, Streamlit sets the chart width to match the width\nof the parent container.

\n

To use width, you must set use_container_width=False.

\n", + "default": null + }, + { + "name": "height", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Desired height of the chart expressed in pixels. If height is\nNone (default), Streamlit sets the height of the chart to fit\nits contents according to the plotting library.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to override width with the width of the parent\ncontainer. If use_container_width is True (default),\nStreamlit sets the width of the chart to match the width of the\nparent container. If use_container_width is False,\nStreamlit sets the chart's width according to width.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/vega_charts.py#L1253" + }, + "streamlit.select_slider": { + "name": "select_slider", + "signature": "st.select_slider(label, options=(), value=None, format_func=special_internal_function, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility=\"visible\")", + "examples": "
\nimport streamlit as st\n\ncolor = st.select_slider(\n    "Select a color of the rainbow",\n    options=[\n        "red",\n        "orange",\n        "yellow",\n        "green",\n        "blue",\n        "indigo",\n        "violet",\n    ],\n)\nst.write("My favorite color is", color)\n
\n

And here's an example of a range select slider:

\n
\nimport streamlit as st\n\nstart_color, end_color = st.select_slider(\n    "Select a range of color wavelength",\n    options=[\n        "red",\n        "orange",\n        "yellow",\n        "green",\n        "blue",\n        "indigo",\n        "violet",\n    ],\n    value=("red", "blue"),\n)\nst.write("You selected wavelengths between", start_color, "and", end_color)\n
\n", + "description": "

Display a slider widget to select items from a list.

\n

This also allows you to render a range slider by passing a two-element\ntuple or list as the value.

\n

The difference between st.select_slider and st.slider is that\nselect_slider accepts any datatype and takes an iterable set of\noptions, while st.slider only accepts numerical or date/time data and\ntakes a range as input.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this slider is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "options", + "type_name": "Iterable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Labels for the select options in an Iterable. For example, this can\nbe a list, numpy.ndarray, pandas.Series, pandas.DataFrame, or\npandas.Index. For pandas.DataFrame, the first column is used.\nEach label will be cast to str internally by default.

\n", + "default": null + }, + { + "name": "value", + "type_name": "a supported type or a tuple/list of supported types or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The value of the slider when it first renders. If a tuple/list\nof two values is passed here, then a range slider with those lower\nand upper bounds is rendered. For example, if set to (1, 10) the\nslider will have a selectable range between 1 and 10.\nDefaults to first option.

\n", + "default": "first" + }, + { + "name": "format_func", + "type_name": "function", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Function to modify the display of the labels from the options.\nargument. It receives the option as an argument and its output\nwill be cast to str.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the select slider.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this select_slider's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the select slider if set to True.\nThe default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "any value or tuple of any value", + "is_generator": false, + "description": "

The current value of the slider widget. The return type will match\nthe data type of the value parameter.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/select_slider.py#L105" + }, + "streamlit.selectbox": { + "name": "selectbox", + "signature": "st.selectbox(label, options, index=0, format_func=special_internal_function, key=None, help=None, on_change=None, args=None, kwargs=None, *, placeholder=\"Choose an option\", disabled=False, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\noption = st.selectbox(\n    "How would you like to be contacted?",\n    ("Email", "Home phone", "Mobile phone"),\n)\n\nst.write("You selected:", option)\n
\n

To initialize an empty selectbox, use None as the index value:

\n
\nimport streamlit as st\n\noption = st.selectbox(\n    "How would you like to be contacted?",\n    ("Email", "Home phone", "Mobile phone"),\n    index=None,\n    placeholder="Select contact method...",\n)\n\nst.write("You selected:", option)\n
\n
\n", + "description": "

Display a select widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this select widget is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "options", + "type_name": "Iterable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Labels for the select options in an Iterable. For example, this can\nbe a list, numpy.ndarray, pandas.Series, pandas.DataFrame, or\npandas.Index. For pandas.DataFrame, the first column is used.\nEach label will be cast to str internally by default.

\n", + "default": null + }, + { + "name": "index", + "type_name": "int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The index of the preselected option on first render. If None,\nwill initialize empty and return None until the user selects an option.\nDefaults to 0 (the first option).

\n", + "default": "0" + }, + { + "name": "format_func", + "type_name": "function", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Function to modify the display of the labels. It receives the option\nas an argument and its output will be cast to str.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the selectbox.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this selectbox's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "placeholder", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A string to display when no options are selected.\nDefaults to "Choose an option".

\n", + "default": "s" + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the selectbox if set to True.\nThe default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "any", + "is_generator": false, + "description": "

The selected option or None if no option is selected.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/selectbox.py#L77" + }, + "streamlit.set_option": { + "name": "set_option", + "signature": "st.set_option(key, value)", + "description": "

Set config option.

\n
\n
Currently, only the following config options can be set within the script itself:
\n
    \n
  • client.caching
    • \n
\n
\n
\n

Calling with any other options will raise StreamlitAPIException.

\n

Run streamlit config show in the terminal to see all available options.

\n", + "args": [ + { + "name": "key", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The config option key of the form "section.optionName". To see all\navailable options, run streamlit config show on a terminal.

\n", + "default": null + }, + { + "name": "value", + "type_name": null, + "is_optional": null, + "is_kwarg_only": false, + "description": "

The new value to assign to this config option.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/config.py#L93" + }, + "streamlit.set_page_config": { + "name": "set_page_config", + "signature": "st.set_page_config(page_title=None, page_icon=None, layout=\"centered\", initial_sidebar_state=\"auto\", menu_items=None)", + "example": "
\nimport streamlit as st\n\nst.set_page_config(\n    page_title="Ex-stream-ly Cool App",\n    page_icon="\ud83e\uddca",\n    layout="wide",\n    initial_sidebar_state="expanded",\n    menu_items={\n        'Get Help': 'https://www.extremelycoolapp.com/help',\n        'Report a bug': "https://www.extremelycoolapp.com/bug",\n        'About': "# This is a header. This is an *extremely* cool app!"\n    }\n)\n
\n", + "description": "

Configures the default settings of the page.

\n
\n

Note

\n

This must be the first Streamlit command used on an app page, and must only\nbe set once per page.

\n
\n", + "args": [ + { + "name": "page_title", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The page title, shown in the browser tab. If None, defaults to the\nfilename of the script ("app.py" would show "app \u2022 Streamlit").

\n", + "default": "the" + }, + { + "name": "page_icon", + "type_name": "Anything supported by st.image, str, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The page favicon. If page_icon is None (default), the favicon\nwill be a monochrome Streamlit logo.

\n

In addition to the types supported by st.image (like URLs or numpy\narrays), the following strings are valid:

\n
    \n

  • A single-character emoji. For example, you can set page_icon="\ud83e\udd88".

    \n
    • \n

  • An emoji short code. For example, you can set page_icon=":shark:".\nFor a list of all supported codes, see\nhttps://share.streamlit.io/streamlit/emoji-shortcodes.

    \n
    • \n

  • The string literal, "random". You can set page_icon="random"\nto set a random emoji from the supported list above. Emoji icons are\ncourtesy of Twemoji and loaded from MaxCDN.

    \n
    • \n

  • An icon from the Material Symbols library (rounded style) in the\nformat ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols\nfont library.

    \n
    • \n
\n
\n

Note

\n

Colors are not supported for Material icons. When you use a\nMaterial icon for favicon, it will be black, regardless of browser\ntheme.

\n
\n", + "default": null + }, + { + "name": "layout", + "type_name": "\"centered\" or \"wide\"", + "is_optional": false, + "is_kwarg_only": false, + "description": "

How the page content should be laid out. Defaults to "centered",\nwhich constrains the elements into a centered column of fixed width;\n"wide" uses the entire screen.

\n", + "default": "s" + }, + { + "name": "initial_sidebar_state", + "type_name": "\"auto\", \"expanded\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": false, + "description": "

How the sidebar should start out. Defaults to "auto",\nwhich hides the sidebar on small devices and shows it otherwise.\n"expanded" shows the sidebar initially; "collapsed" hides it.\nIn most cases, you should just use "auto", otherwise the app will\nlook bad when embedded and viewed on mobile.

\n", + "default": "s" + }, + { + "name": "menu_items", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Configure the menu that appears on the top-right side of this app.\nThe keys in this dict denote the menu item you'd like to configure:

\n
    \n
  • \n
    "Get help": str or None
    \n
    The URL this menu item should point to.\nIf None, hides this menu item.
    \n
    \n
    • \n
  • \n
    "Report a Bug": str or None
    \n
    The URL this menu item should point to.\nIf None, hides this menu item.
    \n
    \n
    • \n
  • \n
    "About": str or None
    \n
    A markdown string to show in the About dialog.\nIf None, only shows Streamlit's default About text.
    \n
    \n
    • \n
\n

The URL may also refer to an email address e.g. mailto:john@example.com.

\n", + "default": "About" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/commands/page_config.py#L119" + }, + "streamlit.slider": { + "name": "slider", + "signature": "st.slider(label, min_value=None, max_value=None, value=None, step=None, format=None, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility=\"visible\")", + "examples": "
\n
\nimport streamlit as st\n\nage = st.slider("How old are you?", 0, 130, 25)\nst.write("I'm ", age, "years old")\n
\n

And here's an example of a range slider:

\n
\nimport streamlit as st\n\nvalues = st.slider("Select a range of values", 0.0, 100.0, (25.0, 75.0))\nst.write("Values:", values)\n
\n

This is a range time slider:

\n
\nimport streamlit as st\nfrom datetime import time\n\nappointment = st.slider(\n    "Schedule your appointment:", value=(time(11, 30), time(12, 45))\n)\nst.write("You're scheduled for:", appointment)\n
\n

Finally, a datetime slider:

\n
\nimport streamlit as st\nfrom datetime import datetime\n\nstart_time = st.slider(\n    "When do you start?",\n    value=datetime(2020, 1, 1, 9, 30),\n    format="MM/DD/YY - hh:mm",\n)\nst.write("Start time:", start_time)\n
\n
\n", + "description": "

Display a slider widget.

\n

This supports int, float, date, time, and datetime types.

\n

This also allows you to render a range slider by passing a two-element\ntuple or list as the value.

\n

The difference between st.slider and st.select_slider is that\nslider only accepts numerical or date/time data and takes a range as\ninput, while select_slider accepts any datatype and takes an iterable\nset of options.

\n
\n

Note

\n

Integer values exceeding +/- (1<<53) - 1 cannot be accurately\nstored or returned by the widget due to serialization contstraints\nbetween the Python server and JavaScript client. You must handle\nsuch numbers as floats, leading to a loss in precision.

\n
\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this slider is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "min_value", + "type_name": "a supported type or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The minimum permitted value.\nDefaults to 0 if the value is an int, 0.0 if a float,\nvalue - timedelta(days=14) if a date/datetime, time.min if a time

\n", + "default": "0" + }, + { + "name": "max_value", + "type_name": "a supported type or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The maximum permitted value.\nDefaults to 100 if the value is an int, 1.0 if a float,\nvalue + timedelta(days=14) if a date/datetime, time.max if a time

\n", + "default": "100" + }, + { + "name": "value", + "type_name": "a supported type or a tuple/list of supported types or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The value of the slider when it first renders. If a tuple/list\nof two values is passed here, then a range slider with those lower\nand upper bounds is rendered. For example, if set to (1, 10) the\nslider will have a selectable range between 1 and 10.\nDefaults to min_value.

\n", + "default": "min_value" + }, + { + "name": "step", + "type_name": "int, float, timedelta, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The stepping interval.\nDefaults to 1 if the value is an int, 0.01 if a float,\ntimedelta(days=1) if a date/datetime, timedelta(minutes=15) if a time\n(or if max_value - min_value < 1 day)

\n", + "default": "1" + }, + { + "name": "format", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A printf-style format string controlling how the interface should\ndisplay numbers. This does not impact the return value.\nFormatter for int/float supports: %d %e %f %g %i\nFormatter for date/time/datetime uses Moment.js notation:\nhttps://momentjs.com/docs/#/displaying/format/

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the slider.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this slider's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the slider if set to True. The\ndefault is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "int/float/date/time/datetime or tuple of int/float/date/time/datetime", + "is_generator": false, + "description": "

The current value of the slider widget. The return type will match\nthe data type of the value parameter.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/slider.py#L169" + }, + "streamlit.snow": { + "name": "snow", + "signature": "st.snow()", + "example": "
\n
\nimport streamlit as st\n\nst.snow()\n
\n

...then watch your app and get ready for a cool celebration!

\n
\n", + "description": "

Draw celebratory snowfall.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/snow.py#L27" + }, + "streamlit.spinner": { + "name": "spinner", + "signature": "st.spinner(text=\"In progress...\")", + "example": "
\n
\nimport time\nimport streamlit as st\n\nwith st.spinner('Wait for it...'):\n    time.sleep(5)\nst.success("Done!")\n
\n
\n", + "description": "

Temporarily displays a message while executing a block of code.

\n", + "args": [ + { + "name": "text", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A message to display while executing that block

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/spinner.py#L25" + }, + "streamlit.status": { + "name": "status", + "signature": "st.status(label, *, expanded=False, state=\"running\")", + "examples": "
\n

You can use the with notation to insert any element into an status container:

\n
\nimport time\nimport streamlit as st\n\nwith st.status("Downloading data..."):\n    st.write("Searching for data...")\n    time.sleep(2)\n    st.write("Found URL.")\n    time.sleep(1)\n    st.write("Downloading data...")\n    time.sleep(1)\n\nst.button("Rerun")\n
\n

You can also use .update() on the container to change the label, state,\nor expanded state:

\n
\nimport time\nimport streamlit as st\n\nwith st.status("Downloading data...", expanded=True) as status:\n    st.write("Searching for data...")\n    time.sleep(2)\n    st.write("Found URL.")\n    time.sleep(1)\n    st.write("Downloading data...")\n    time.sleep(1)\n    status.update(\n        label="Download complete!", state="complete", expanded=False\n    )\n\nst.button("Rerun")\n
\n
\n", + "description": "

Insert a status container to display output from long-running tasks.

\n

Inserts a container into your app that is typically used to show the status and\ndetails of a process or task. The container can hold multiple elements and can\nbe expanded or collapsed by the user similar to st.expander.\nWhen collapsed, all that is visible is the status icon and label.

\n

The label, state, and expanded state can all be updated by calling .update()\non the returned object. To add elements to the returned container, you can\nuse with notation (preferred) or just call methods directly on the returned\nobject.

\n

By default, st.status() initializes in the "running" state. When called using\nwith notation, it automatically updates to the "complete" state at the end\nof the "with" block. See examples below for more details.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The initial label of the status container. The label can optionally\ncontain GitHub-flavored Markdown of the following types: Bold, Italics,\nStrikethroughs, Inline Code, and Links.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "expanded", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

If True, initializes the status container in "expanded" state. Defaults to\nFalse (collapsed).

\n", + "default": "s" + }, + { + "name": "state", + "type_name": "\"running\", \"complete\", or \"error\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The initial state of the status container which determines which icon is\nshown:

\n
    \n
  • running (default): A spinner icon is shown.
    • \n
  • complete: A checkmark icon is shown.
    • \n
  • error: An error icon is shown.
    • \n
\n", + "default": null + } + ], + "returns": [ + { + "type_name": "StatusContainer", + "is_generator": false, + "description": "

A mutable status container that can hold multiple elements. The label, state,\nand expanded state can be updated after creation via .update().

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/layouts.py#L662" + }, + "streamlit.stop": { + "name": "stop", + "signature": "st.stop()", + "example": "
\n
\nimport streamlit as st\n\nname = st.text_input("Name")\nif not name:\n  st.warning('Please input a name.')\n  st.stop()\nst.success("Thank you for inputting a name.")\n
\n
\n", + "description": "

Stops execution immediately.

\n

Streamlit will not run any statements after st.stop().\nWe recommend rendering a message to explain why the script has stopped.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/commands/execution_control.py#L36" + }, + "streamlit.subheader": { + "name": "subheader", + "signature": "st.subheader(body, anchor=None, *, help=None, divider=False)", + "examples": "
\n
\nimport streamlit as st\n\nst.subheader("_Streamlit_ is :blue[cool] :sunglasses:")\nst.subheader("This is a subheader with a divider", divider="gray")\nst.subheader("These subheaders have rotating dividers", divider=True)\nst.subheader("One", divider=True)\nst.subheader("Two", divider=True)\nst.subheader("Three", divider=True)\nst.subheader("Four", divider=True)\n
\n
\n", + "description": "

Display text in subheader formatting.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The text to display as GitHub-flavored Markdown. Syntax\ninformation can be found at: https://github.github.com/gfm.

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "anchor", + "type_name": "str or False", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The anchor name of the header that can be accessed with #anchor\nin the URL. If omitted, it generates an anchor using the body.\nIf False, the anchor is not shown in the UI.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed next to the subheader.

\n", + "default": null + }, + { + "name": "divider", + "type_name": "bool or \u201cblue\u201d, \u201cgreen\u201d, \u201corange\u201d, \u201cred\u201d, \u201cviolet\u201d, \u201cgray\u201d/\"grey\", or \u201crainbow\u201d", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Shows a colored divider below the header. If True, successive\nheaders will cycle through divider colors. That is, the first\nheader will have a blue line, the second header will have a\ngreen line, and so on. If a string, the color can be set to one of\nthe following: blue, green, orange, red, violet, gray/grey, or\nrainbow.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/heading.py#L110" + }, + "streamlit.success": { + "name": "success", + "signature": "st.success(body, *, icon=None)", + "example": "
\n
\nimport streamlit as st\n\nst.success('This is a success message!', icon="\u2705")\n
\n
\n", + "description": "

Display a success message.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The success text to display.

\n", + "default": null + }, + { + "name": "icon", + "type_name": "str, None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional emoji or icon to display next to the alert. If icon\nis None (default), no icon is displayed. If icon is a\nstring, the following options are valid:

\n
    \n

  • A single-character emoji. For example, you can set icon="\ud83d\udea8"\nor icon="\ud83d\udd25". Emoji short codes are not supported.

    \n
    • \n

  • An icon from the Material Symbols library (rounded style) in the\nformat ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols\nfont library.

    \n
    • \n
\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/alert.py#L160" + }, + "streamlit.switch_page": { + "name": "switch_page", + "signature": "st.switch_page(page)", + "example": "
\n

Consider the following example given this file structure:

\n
\nyour-repository/\n\u251c\u2500\u2500 pages/\n\u2502   \u251c\u2500\u2500 page_1.py\n\u2502   \u2514\u2500\u2500 page_2.py\n\u2514\u2500\u2500 your_app.py\n
\n
\nimport streamlit as st\n\nif st.button("Home"):\n    st.switch_page("your_app.py")\nif st.button("Page 1"):\n    st.switch_page("pages/page_1.py")\nif st.button("Page 2"):\n    st.switch_page("pages/page_2.py")\n
\n
\n", + "description": "

Programmatically switch the current page in a multipage app.

\n

When st.switch_page is called, the current page execution stops and\nthe specified page runs as if the user clicked on it in the sidebar\nnavigation. The specified page must be recognized by Streamlit's multipage\narchitecture (your main Python file or a Python file in a pages/\nfolder). Arbitrary Python scripts cannot be passed to st.switch_page.

\n", + "args": [ + { + "name": "page", + "type_name": "str or st.Page", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The file path (relative to the main script) or an st.Page indicating\nthe page to switch to.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/commands/execution_control.py#L153" + }, + "streamlit.table": { + "name": "table", + "signature": "st.table(data=None)", + "example": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\ndf = pd.DataFrame(\n    np.random.randn(10, 5), columns=("col %d" % i for i in range(5))\n)\n\nst.table(df)\n
\n
\n", + "description": "

Display a static table.

\n

This differs from st.dataframe in that the table in this case is\nstatic: its entire contents are laid out directly on the page.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Styler, pyarrow.Table, numpy.ndarray, pyspark.sql.DataFrame, snowflake.snowpark.dataframe.DataFrame, snowflake.snowpark.table.Table, Iterable, dict, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The table data.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/arrow.py#L572" + }, + "streamlit.tabs": { + "name": "tabs", + "signature": "st.tabs(tabs)", + "examples": "
\n

You can use the with notation to insert any element into a tab:

\n
\nimport streamlit as st\n\ntab1, tab2, tab3 = st.tabs(["Cat", "Dog", "Owl"])\n\nwith tab1:\n    st.header("A cat")\n    st.image("https://static.streamlit.io/examples/cat.jpg", width=200)\nwith tab2:\n    st.header("A dog")\n    st.image("https://static.streamlit.io/examples/dog.jpg", width=200)\nwith tab3:\n    st.header("An owl")\n    st.image("https://static.streamlit.io/examples/owl.jpg", width=200)\n
\n

Or you can just call methods directly on the returned objects:

\n
\nimport streamlit as st\nimport numpy as np\n\ntab1, tab2 = st.tabs(["\ud83d\udcc8 Chart", "\ud83d\uddc3 Data"])\ndata = np.random.randn(10, 1)\n\ntab1.subheader("A tab with a chart")\ntab1.line_chart(data)\n\ntab2.subheader("A tab with the data")\ntab2.write(data)\n
\n
\n", + "description": "

Insert containers separated into tabs.

\n

Inserts a number of multi-element containers as tabs.\nTabs are a navigational element that allows users to easily\nmove between groups of related content.

\n

To add elements to the returned containers, you can use the with notation\n(preferred) or just call methods directly on the returned object. See\nexamples below.

\n
\n

Warning

\n

All the content of every tab is always sent to and rendered on the frontend.\nConditional rendering is currently not supported.

\n
\n", + "args": [ + { + "name": "tabs", + "type_name": "list of str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Creates a tab for each string in the list. The first tab is selected\nby default. The string is used as the name of the tab and can\noptionally contain GitHub-flavored Markdown of the following types:\nBold, Italics, Strikethroughs, Inline Code, and Links.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "list of containers", + "is_generator": false, + "description": "

A list of container objects.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/layouts.py#L330" + }, + "streamlit.text": { + "name": "text", + "signature": "st.text(body, *, help=None)", + "example": "
\n
\nimport streamlit as st\n\nst.text("This is some text.")\n
\n
\n", + "description": "

Write fixed-width and preformatted text.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The string to display.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed next to the text.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/text.py#L29" + }, + "streamlit.text_area": { + "name": "text_area", + "signature": "st.text_area(label, value=\"\", height=None, max_chars=None, key=None, help=None, on_change=None, args=None, kwargs=None, *, placeholder=None, disabled=False, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\ntxt = st.text_area(\n    "Text to analyze",\n    "It was the best of times, it was the worst of times, it was the age of "\n    "wisdom, it was the age of foolishness, it was the epoch of belief, it "\n    "was the epoch of incredulity, it was the season of Light, it was the "\n    "season of Darkness, it was the spring of hope, it was the winter of "\n    "despair, (...)",\n)\n\nst.write(f"You wrote {len(txt)} characters.")\n
\n
\n", + "description": "

Display a multi-line text input widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this input is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "value", + "type_name": "object or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The text value of this widget when it first renders. This will be\ncast to str internally. If None, will initialize empty and\nreturn None until the user provides input. Defaults to empty string.

\n", + "default": "empty" + }, + { + "name": "height", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Desired height of the UI element expressed in pixels. If None, a\ndefault height is used.

\n", + "default": "height" + }, + { + "name": "max_chars", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Maximum number of characters allowed in text area.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the textarea.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this text_area's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "placeholder", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string displayed when the text area is empty. If None,\nno text is displayed.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the text area if set to True.\nThe default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "str or None", + "is_generator": false, + "description": "

The current value of the text area widget or None if no value has been\nprovided by the user.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/text_widgets.py#L393" + }, + "streamlit.text_input": { + "name": "text_input", + "signature": "st.text_input(label, value=\"\", max_chars=None, key=None, type=\"default\", help=None, autocomplete=None, on_change=None, args=None, kwargs=None, *, placeholder=None, disabled=False, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\ntitle = st.text_input("Movie title", "Life of Brian")\nst.write("The current movie title is", title)\n
\n
\n", + "description": "

Display a single-line text input widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this input is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "value", + "type_name": "object or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The text value of this widget when it first renders. This will be\ncast to str internally. If None, will initialize empty and\nreturn None until the user provides input. Defaults to empty string.

\n", + "default": "empty" + }, + { + "name": "max_chars", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Max number of characters allowed in text input.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "type", + "type_name": "\"default\" or \"password\"", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The type of the text input. This can be either "default" (for\na regular text input), or "password" (for a text input that\nmasks the user's typed value). Defaults to "default".

\n", + "default": "s" + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the input.

\n", + "default": null + }, + { + "name": "autocomplete", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional value that will be passed to the <input> element's\nautocomplete property. If unspecified, this value will be set to\n"new-password" for "password" inputs, and the empty string for\n"default" inputs. For more details, see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this text input's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "placeholder", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string displayed when the text input is empty. If None,\nno text is displayed.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the text input if set to True.\nThe default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "str or None", + "is_generator": false, + "description": "

The current value of the text input widget or None if no value has been\nprovided by the user.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/text_widgets.py#L117" + }, + "streamlit.time_input": { + "name": "time_input", + "signature": "st.time_input(label, value=\"now\", key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility=\"visible\", step=0:15:00)", + "example": "
\n
\nimport datetime\nimport streamlit as st\n\nt = st.time_input("Set an alarm for", datetime.time(8, 45))\nst.write("Alarm is set for", t)\n
\n

To initialize an empty time input, use None as the value:

\n
\nimport datetime\nimport streamlit as st\n\nt = st.time_input("Set an alarm for", value=None)\nst.write("Alarm is set for", t)\n
\n
\n", + "description": "

Display a time input widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this time input is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "value", + "type_name": "datetime.time/datetime.datetime, \"now\" or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The value of this widget when it first renders. This will be\ncast to str internally. If None, will initialize empty and\nreturn None until the user selects a time. If "now" (default),\nwill initialize with the current time.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the input.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this time_input's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the time input if set to True.\nThe default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it above the widget (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + }, + { + "name": "step", + "type_name": "int or timedelta", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The stepping interval in seconds. Defaults to 900, i.e. 15 minutes.\nYou can also pass a datetime.timedelta object.

\n", + "default": "900" + } + ], + "returns": [ + { + "type_name": "datetime.time or None", + "is_generator": false, + "description": "

The current value of the time input widget or None if no time has been\nselected.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/time_widgets.py#L293" + }, + "streamlit.title": { + "name": "title", + "signature": "st.title(body, anchor=None, *, help=None)", + "examples": "
\n
\nimport streamlit as st\n\nst.title("This is a title")\nst.title("_Streamlit_ is :blue[cool] :sunglasses:")\n
\n
\n", + "description": "

Display text in title formatting.

\n

Each document should have a single st.title(), although this is not\nenforced.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The text to display as GitHub-flavored Markdown. Syntax\ninformation can be found at: https://github.github.com/gfm.

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "anchor", + "type_name": "str or False", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The anchor name of the header that can be accessed with #anchor\nin the URL. If omitted, it generates an anchor using the body.\nIf False, the anchor is not shown in the UI.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed next to the title.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/heading.py#L177" + }, + "streamlit.toast": { + "name": "toast", + "signature": "st.toast(body, *, icon=None)", + "example": "
\n
\nimport streamlit as st\n\nst.toast('Your edited image was saved!', icon='\ud83d\ude0d')\n
\n
\n", + "description": "

Display a short message, known as a notification "toast".

\n

The toast appears in the app's bottom-right corner and disappears after four seconds.

\n
\n

Warning

\n

st.toast is not compatible with Streamlit's caching and\ncannot be called within a cached function.

\n
\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The string to display as GitHub-flavored Markdown. Syntax\ninformation can be found at: https://github.github.com/gfm.

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n", + "default": null + }, + { + "name": "icon", + "type_name": "str, None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional emoji or icon to display next to the alert. If icon\nis None (default), no icon is displayed. If icon is a\nstring, the following options are valid:

\n
    \n

  • A single-character emoji. For example, you can set icon="\ud83d\udea8"\nor icon="\ud83d\udd25". Emoji short codes are not supported.

    \n
    • \n

  • An icon from the Material Symbols library (rounded style) in the\nformat ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols\nfont library.

    \n
    • \n
\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/toast.py#L39" + }, + "streamlit.toggle": { + "name": "toggle", + "signature": "st.toggle(label, value=False, key=None, help=None, on_change=None, args=None, kwargs=None, *, disabled=False, label_visibility=\"visible\")", + "example": "
\n
\nimport streamlit as st\n\non = st.toggle("Activate feature")\n\nif on:\n    st.write("Feature activated!")\n
\n
\n", + "description": "

Display a toggle widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short label explaining to the user what this toggle is for.\nThe label can optionally contain GitHub-flavored Markdown of the\nfollowing types: Bold, Italics, Strikethroughs, Inline Code, and\nLinks.

\n

Unsupported Markdown elements are unwrapped so only their children\n(text contents) render. Display unsupported elements as literal\ncharacters by backslash-escaping them. E.g.,\n"1\\. Not an ordered list".

\n

See the body parameter of st.markdown for additional,\nsupported Markdown directives.

\n

For accessibility reasons, you should never set an empty label (label="")\nbut hide it with label_visibility if needed. In the future, we may disallow\nempty labels by raising an exception.

\n", + "default": null + }, + { + "name": "value", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Preselect the toggle when it first renders. This will be\ncast to bool internally.

\n", + "default": null + }, + { + "name": "key", + "type_name": "str or int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional string or integer to use as the unique key for the widget.\nIf this is omitted, a key will be generated for the widget\nbased on its content. Multiple widgets of the same type may\nnot share the same key.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tooltip that gets displayed next to the toggle.

\n", + "default": null + }, + { + "name": "on_change", + "type_name": "callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional callback invoked when this toggle's value changes.

\n", + "default": null + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional tuple of args to pass to the callback.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An optional dict of kwargs to pass to the callback.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional boolean, which disables the toggle if set to True.\nThe default is False.

\n", + "default": "False" + }, + { + "name": "label_visibility", + "type_name": "\"visible\", \"hidden\", or \"collapsed\"", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The visibility of the label. If "hidden", the label doesn't show but there\nis still empty space for it (equivalent to label="").\nIf "collapsed", both the label and the space are removed. Default is\n"visible".

\n", + "default": "is" + } + ], + "returns": [ + { + "type_name": "bool", + "is_generator": false, + "description": "

Whether or not the toggle is checked.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/widgets/checkbox.py#L164" + }, + "streamlit.vega_lite_chart": { + "name": "vega_lite_chart", + "signature": "st.vega_lite_chart(data=None, spec=None, *, use_container_width=False, theme=\"streamlit\", key=None, on_select=\"ignore\", selection_mode=None, **kwargs)", + "example": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nchart_data = pd.DataFrame(np.random.randn(200, 3), columns=["a", "b", "c"])\n\nst.vega_lite_chart(\n   chart_data,\n   {\n       "mark": {"type": "circle", "tooltip": True},\n       "encoding": {\n           "x": {"field": "a", "type": "quantitative"},\n           "y": {"field": "b", "type": "quantitative"},\n           "size": {"field": "c", "type": "quantitative"},\n           "color": {"field": "c", "type": "quantitative"},\n       },\n   },\n)\n
\n

Examples of Vega-Lite usage without Streamlit can be found at\nhttps://vega.github.io/vega-lite/examples/. Most of those can be easily\ntranslated to the syntax shown above.

\n
\n", + "description": "

Display a chart using the Vega-Lite library.

\n

Vega-Lite is a high-level\ngrammar for defining interactive graphics.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Styler, pyarrow.Table, numpy.ndarray, Iterable, dict, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Either the data to be plotted or a Vega-Lite spec containing the\ndata (which more closely follows the Vega-Lite API).

\n", + "default": null + }, + { + "name": "spec", + "type_name": "dict or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The Vega-Lite spec for the chart. If spec is None (default),\nStreamlit uses the spec passed in data. You cannot pass a spec\nto both data and spec. See\nhttps://vega.github.io/vega-lite/docs/ for more info.

\n", + "default": null + }, + { + "name": "use_container_width", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to override the figure's native width with the width of\nthe parent container. If use_container_width is False\n(default), Streamlit sets the width of the chart to fit its contents\naccording to the plotting library, up to the width of the parent\ncontainer. If use_container_width is True, Streamlit sets\nthe width of the figure to match the width of the parent container.

\n", + "default": null + }, + { + "name": "theme", + "type_name": "\"streamlit\" or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The theme of the chart. If theme is "streamlit" (default),\nStreamlit uses its own design default. If theme is None,\nStreamlit falls back to the default behavior of the library.

\n", + "default": "behavior" + }, + { + "name": "key", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional string to use for giving this element a stable\nidentity. If key is None (default), this element's identity\nwill be determined based on the values of the other parameters.

\n

Additionally, if selections are activated and key is provided,\nStreamlit will register the key in Session State to store the\nselection state. The selection state is read-only.

\n", + "default": null + }, + { + "name": "on_select", + "type_name": "\"ignore\", \"rerun\", or callable", + "is_optional": false, + "is_kwarg_only": true, + "description": "

How the figure should respond to user selection events. This\ncontrols whether or not the figure behaves like an input widget.\non_select can be one of the following:

\n
    \n
  • "ignore" (default): Streamlit will not react to any selection\nevents in the chart. The figure will not behave like an input\nwidget.
    • \n
  • "rerun": Streamlit will rerun the app when the user selects\ndata in the chart. In this case, st.vega_lite_chart will\nreturn the selection data as a dictionary.
    • \n
  • A callable: Streamlit will rerun the app and execute the\ncallable as a callback function before the rest of the app.\nIn this case, st.vega_lite_chart will return the selection data\nas a dictionary.
    • \n
\n

To use selection events, the Vega-Lite spec defined in data or\nspec must include selection parameters from the the charting\nlibrary. To learn about defining interactions in Vega-Lite, see\nDynamic Behaviors with Parameters\nin Vega-Lite's documentation.

\n", + "default": null + }, + { + "name": "selection_mode", + "type_name": "str or Iterable of str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The selection parameters Streamlit should use. If\nselection_mode is None (default), Streamlit will use all\nselection parameters defined in the chart's Vega-Lite spec.

\n

When Streamlit uses a selection parameter, selections from that\nparameter will trigger a rerun and be included in the selection\nstate. When Streamlit does not use a selection parameter,\nselections from that parameter will not trigger a rerun and not be\nincluded in the selection state.

\n

Selection parameters are identified by their name property.

\n", + "default": null + }, + { + "name": "**kwargs", + "type_name": "any", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The Vega-Lite spec for the chart as keywords. This is an alternative\nto spec.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "element or dict", + "is_generator": false, + "description": "

If on_select is "ignore" (default), this method returns an\ninternal placeholder for the chart element that can be used with\nthe .add_rows() method. Otherwise, this method returns a\ndictionary-like object that supports both key and attribute\nnotation. The attributes are described by the VegaLiteState\ndictionary schema.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/vega_charts.py#L1643" + }, + "streamlit.video": { + "name": "video", + "signature": "st.video(data, format=\"video/mp4\", start_time=0, *, subtitles=None, end_time=None, loop=False, autoplay=False, muted=False)", + "example": "
\n
\nimport streamlit as st\n\nvideo_file = open("myvideo.mp4", "rb")\nvideo_bytes = video_file.read()\n\nst.video(video_bytes)\n
\n

When you include subtitles, they will be turned on by default. A viewer\ncan turn off the subtitles (or captions) from the browser's default video\ncontrol menu, usually located in the lower-right corner of the video.

\n

Here is a simple VTT file (subtitles.vtt):

\n
\nWEBVTT\n\n0:00:01.000 --> 0:00:02.000\nLook!\n\n0:00:03.000 --> 0:00:05.000\nLook at the pretty stars!\n
\n

If the above VTT file lives in the same directory as your app, you can\nadd subtitles like so:

\n
\nimport streamlit as st\n\nVIDEO_URL = "https://example.com/not-youtube.mp4"\nst.video(VIDEO_URL, subtitles="subtitles.vtt")\n
\n

See additional examples of supported subtitle input types in our\nvideo subtitles feature demo.

\n
\n

Note

\n

Some videos may not display if they are encoded using MP4V (which is an export option in OpenCV), as this codec is\nnot widely supported by browsers. Converting your video to H.264 will allow the video to be displayed in Streamlit.\nSee this StackOverflow post or this\nStreamlit forum post\nfor more information.

\n
\n
\n", + "description": "

Display a video player.

\n", + "args": [ + { + "name": "data", + "type_name": "str, bytes, io.BytesIO, numpy.ndarray, or file", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Raw video data, filename, or URL pointing to a video to load.\nIncludes support for YouTube URLs.\nNumpy arrays and raw data formats must include all necessary file\nheaders to match specified file format.

\n", + "default": null + }, + { + "name": "format", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The mime type for the video file. Defaults to "video/mp4".\nSee https://tools.ietf.org/html/rfc4281 for more info.

\n", + "default": "s" + }, + { + "name": "start_time", + "type_name": "int, float, timedelta, str, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The time from which the element should start playing. This can be\none of the following:

\n
    \n
  • None (default): The element plays from the beginning.
    • \n
  • An int or float specifying the time in seconds. float\nvalues are rounded down to whole seconds.
    • \n
  • A string specifying the time in a format supported by Pandas'\nTimedelta constructor,\ne.g. "2 minute", "20s", or "1m14s".
    • \n
  • A timedelta object from Python's built-in datetime library,\ne.g. timedelta(seconds=70).
    • \n
\n", + "default": null + }, + { + "name": "subtitles", + "type_name": "str, bytes, Path, io.BytesIO, or dict", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Optional subtitle data for the video, supporting several input types:

\n
    \n
  • None (default): No subtitles.
    • \n
  • A string, bytes, or Path: File path to a subtitle file in .vtt or .srt formats, or\nthe raw content of subtitles conforming to these formats.\nIf providing raw content, the string must adhere to the WebVTT or SRT\nformat specifications.
    • \n
  • io.BytesIO: A BytesIO stream that contains valid .vtt or .srt\nformatted subtitle data.
    • \n
  • A dictionary: Pairs of labels and file paths or raw subtitle content in\n.vtt or .srt formats to enable multiple subtitle tracks.\nThe label will be shown in the video player. Example:\n{"English": "path/to/english.vtt", "French": "path/to/french.srt"}
    • \n
\n

When provided, subtitles are displayed by default. For multiple\ntracks, the first one is displayed by default. If you don't want any\nsubtitles displayed by default, use an empty string for the value\nin a dictrionary's first pair: {"None": "", "English": "path/to/english.vtt"}

\n

Not supported for YouTube videos.

\n", + "default": null + }, + { + "name": "end_time", + "type_name": "int, float, timedelta, str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The time at which the element should stop playing. This can be\none of the following:

\n
    \n
  • None (default): The element plays through to the end.
    • \n
  • An int or float specifying the time in seconds. float\nvalues are rounded down to whole seconds.
    • \n
  • A string specifying the time in a format supported by Pandas'\nTimedelta constructor,\ne.g. "2 minute", "20s", or "1m14s".
    • \n
  • A timedelta object from Python's built-in datetime library,\ne.g. timedelta(seconds=70).
    • \n
\n", + "default": null + }, + { + "name": "loop", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether the video should loop playback.

\n", + "default": null + }, + { + "name": "autoplay", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether the video should start playing automatically. This is\nFalse by default. Browsers will not autoplay unmuted videos\nif the user has not interacted with the page by clicking somewhere.\nTo enable autoplay without user interaction, you must also set\nmuted=True.

\n", + "default": null + }, + { + "name": "muted", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether the video should play with the audio silenced. This is\nFalse by default. Use this in conjunction with autoplay=True\nto enable autoplay without user interaction.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/media.py#L197" + }, + "streamlit.warning": { + "name": "warning", + "signature": "st.warning(body, *, icon=None)", + "example": "
\n
\nimport streamlit as st\n\nst.warning('This is a warning', icon="\u26a0\ufe0f")\n
\n
\n", + "description": "

Display warning message.

\n", + "args": [ + { + "name": "body", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The warning text to display.

\n", + "default": null + }, + { + "name": "icon", + "type_name": "str, None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional emoji or icon to display next to the alert. If icon\nis None (default), no icon is displayed. If icon is a\nstring, the following options are valid:

\n
    \n

  • A single-character emoji. For example, you can set icon="\ud83d\udea8"\nor icon="\ud83d\udd25". Emoji short codes are not supported.

    \n
    • \n

  • An icon from the Material Symbols library (rounded style) in the\nformat ":material/icon_name:" where "icon_name" is the name\nof the icon in snake case.

    \n

    For example, icon=":material/thumb_up:" will display the\nThumb Up icon. Find additional icons in the Material Symbols\nfont library.

    \n
    • \n
\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/alert.py#L73" + }, + "streamlit.write": { + "name": "write", + "signature": "st.write(*args, unsafe_allow_html=False, **kwargs)", + "example": "
\n

Its basic use case is to draw Markdown-formatted text, whenever the\ninput is a string:

\n
\nimport streamlit as st\n\nst.write("Hello, *World!* :sunglasses:")\n
\n

As mentioned earlier, st.write() also accepts other data formats, such as\nnumbers, data frames, styled data frames, and assorted objects:

\n
\nimport streamlit as st\nimport pandas as pd\n\nst.write(1234)\nst.write(\n    pd.DataFrame(\n        {\n            "first column": [1, 2, 3, 4],\n            "second column": [10, 20, 30, 40],\n        }\n    )\n)\n
\n

Finally, you can pass in multiple arguments to do things like:

\n
\nimport streamlit as st\n\nst.write("1 + 1 = ", 2)\nst.write("Below is a DataFrame:", data_frame, "Above is a dataframe.")\n
\n

Oh, one more thing: st.write accepts chart objects too! For example:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\nimport altair as alt\n\ndf = pd.DataFrame(np.random.randn(200, 3), columns=["a", "b", "c"])\nc = (\n    alt.Chart(df)\n    .mark_circle()\n    .encode(x="a", y="b", size="c", color="c", tooltip=["a", "b", "c"])\n)\n\nst.write(c)\n
\n
\n", + "description": "

Write arguments to the app.

\n

This is the Swiss Army knife of Streamlit commands: it does different\nthings depending on what you throw at it. Unlike other Streamlit commands,\nwrite() has some unique properties:

\n
    \n
  1. You can pass in multiple arguments, all of which will be written.
    2. \n
  2. Its behavior depends on the input types as follows.
    3. \n
  3. It returns None, so its "slot" in the App cannot be reused.
    4. \n
\n", + "args": [ + { + "name": "*args", + "type_name": "any", + "is_optional": false, + "is_kwarg_only": false, + "description": "

One or many objects to print to the App.

\n

Arguments are handled as follows:

\n
    \n
  • \n
    write(string) : Prints the formatted Markdown string, with
    \n
    support for LaTeX expression, emoji shortcodes, and colored text.\nSee docs for st.markdown for more.
    \n
    \n
    • \n
  • write(data_frame) : Displays the DataFrame as a table.
    • \n
  • write(error) : Prints an exception specially.
    • \n
  • write(func) : Displays information about a function.
    • \n
  • write(module) : Displays information about the module.
    • \n
  • write(class) : Displays information about a class.
    • \n
  • write(dict) : Displays dict in an interactive widget.
    • \n
  • write(mpl_fig) : Displays a Matplotlib figure.
    • \n
  • write(generator) : Streams the output of a generator.
    • \n
  • write(openai.Stream) : Streams the output of an OpenAI stream.
    • \n
  • write(altair) : Displays an Altair chart.
    • \n
  • write(PIL.Image) : Displays an image.
    • \n
  • write(keras) : Displays a Keras model.
    • \n
  • write(graphviz) : Displays a Graphviz graph.
    • \n
  • write(plotly_fig) : Displays a Plotly figure.
    • \n
  • write(bokeh_fig) : Displays a Bokeh figure.
    • \n
  • write(sympy_expr) : Prints SymPy expression using LaTeX.
    • \n
  • write(htmlable) : Prints _repr_html_() for the object if available.
    • \n
  • write(obj) : Prints str(obj) if otherwise unknown.
    • \n
\n", + "default": null + }, + { + "name": "unsafe_allow_html", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether to render HTML within *args. This only applies to\nstrings or objects falling back on _repr_html_(). If this is\nFalse (default), any HTML tags found in body will be\nescaped and therefore treated as raw text. If this is True, any\nHTML expressions within body will be rendered.

\n

Adding custom HTML to your app impacts safety, styling, and\nmaintainability.

\n
\n

Note

\n

If you only want to insert HTML or CSS without Markdown text,\nwe recommend using st.html instead.

\n
\n", + "default": null + }, + { + "name": "**kwargs", + "type_name": "any", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Keyword arguments. Not used.

\n", + "default": null, + "deprecated": { + "deprecated": true, + "deprecatedText": "

**kwargs is deprecated and will be removed in a later version.\nUse other, more specific Streamlit commands to pass additional\nkeyword arguments.

\n" + } + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/write.py#L233" + }, + "streamlit.write_stream": { + "name": "write_stream", + "signature": "st.write_stream(stream)", + "example": "
\n

You can pass an OpenAI stream as shown in our tutorial, Build a basic LLM chat app. Alternatively,\nyou can pass a generic generator function as input:

\n
\nimport time\nimport numpy as np\nimport pandas as pd\nimport streamlit as st\n\n_LOREM_IPSUM = """\nLorem ipsum dolor sit amet, **consectetur adipiscing** elit, sed do eiusmod tempor\nincididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis\nnostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n"""\n\n\ndef stream_data():\n    for word in _LOREM_IPSUM.split(" "):\n        yield word + " "\n        time.sleep(0.02)\n\n    yield pd.DataFrame(\n        np.random.randn(5, 10),\n        columns=["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"],\n    )\n\n    for word in _LOREM_IPSUM.split(" "):\n        yield word + " "\n        time.sleep(0.02)\n\n\nif st.button("Stream data"):\n    st.write_stream(stream_data)\n
\n
\n", + "description": "

Stream a generator, iterable, or stream-like sequence to the app.

\n

st.write_stream iterates through the given sequences and writes all\nchunks to the app. String chunks will be written using a typewriter effect.\nOther data types will be written using st.write.

\n", + "args": [ + { + "name": "stream", + "type_name": "Callable, Generator, Iterable, OpenAI Stream, or LangChain Stream", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The generator or iterable to stream.

\n
\n

Note

\n

To use additional LLM libraries, you can create a wrapper to\nmanually define a generator function and include custom output\nparsing.

\n
\n", + "default": null + } + ], + "returns": [ + { + "type_name": "str or list", + "is_generator": false, + "description": "

The full response. If the streamed output only contains text, this\nis a string. Otherwise, this is a list of all the streamed objects.\nThe return value is fully compatible as input for st.write.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/write.py#L59" + }, + "streamlit.cache_data.clear": { + "name": "cache_data.clear", + "signature": "st.cache_data.clear()", + "description": "

Clear all in-memory and on-disk data caches.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/caching/cache_data_api.py#L597" + }, + "streamlit.cache_resource.clear": { + "name": "cache_resource.clear", + "signature": "st.cache_resource.clear()", + "description": "

Clear all cache_resource caches.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/caching/cache_resource_api.py#L446" + }, + "streamlit.query_params.clear": { + "name": "clear", + "signature": "st.query_params.clear()", + "description": "

Clear all query parameters from the URL of the app.

\n", + "args": [], + "returns": [ + { + "type_name": "None", + "is_generator": false, + "description": "", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/state/query_params_proxy.py#L132" + }, + "streamlit.query_params.from_dict": { + "name": "from_dict", + "signature": "st.query_params.from_dict(params)", + "example": "
\nimport streamlit as st\n\nst.query_params.from_dict({"foo": "bar", "baz": [1, "two"]})\n
\n", + "description": "

Set all of the query parameters from a dictionary or dictionary-like object.

\n

This method primarily exists for advanced users who want to control\nmultiple query parameters in a single update. To set individual query\nparameters, use key or attribute notation instead.

\n

This method inherits limitations from st.query_params and can't be\nused to set embedding options as described in Embed your app.

\n

To handle repeated keys, the value in a key-value pair should be a list.

\n
\n

Note

\n

.from_dict() is not a direct inverse of .to_dict() if\nyou are working with repeated keys. A true inverse operation is\n{key: st.query_params.get_all(key) for key st.query_params}.

\n
\n", + "args": [ + { + "name": "params", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A dictionary used to replace the current query parameters.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/state/query_params_proxy.py#L174" + }, + "streamlit.query_params.get_all": { + "name": "get_all", + "signature": "st.query_params.get_all(key)", + "description": "

Get a list of all query parameter values associated to a given key.

\n

When a key is repeated as a query parameter within the URL, this method\nallows all values to be obtained. In contrast, dict-like methods only\nretrieve the last value when a key is repeated in the URL.

\n", + "args": [ + { + "name": "key", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label of the query parameter in the URL.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "List[str]", + "is_generator": false, + "description": "

A list of values associated to the given key. May return zero, one,\nor multiple values.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/state/query_params_proxy.py#L109" + }, + "streamlit.query_params.to_dict": { + "name": "to_dict", + "signature": "st.query_params.to_dict()", + "description": "

Get all query parameters as a dictionary.

\n

This method primarily exists for internal use and is not needed for\nmost cases. st.query_params returns an object that inherits from\ndict by default.

\n

When a key is repeated as a query parameter within the URL, this method\nwill return only the last value of each unique key.

\n", + "args": [], + "returns": [ + { + "type_name": "Dict[str,str]", + "is_generator": false, + "description": "

A dictionary of the current query paramters in the app's URL.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/state/query_params_proxy.py#L144" + }, + "streamlit.query_params.update": { + "name": "update", + "signature": "st.query_params.update(other=(), /, **kwds)", + "description": "

Update one or more values in query_params at once from a dictionary or

\n

dictionary-like object.

\n

See Mapping.update() from Python's collections library.

\n", + "args": [ + { + "name": "other", + "type_name": "SupportsKeysAndGetItem[str, str] | Iterable[tuple[str, str]]", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A dictionary or mapping of strings to strings.

\n", + "default": null + }, + { + "name": "**kwds", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Additional key/value pairs to update passed as keyword arguments.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/state/query_params_proxy.py#L87" + }, + "streamlit.connections.BaseConnection": { + "name": "BaseConnection", + "signature": "st.connections.BaseConnection(connection_name, **kwargs)", + "is_class": true, + "methods": [ + { + "name": "reset", + "signature": "st.connections.reset.reset()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("my_conn")\n\n# Reset the connection before using it if it isn't healthy\n# Note: is_healthy() isn't a real method and is just shown for example here.\nif not conn.is_healthy():\n    conn.reset()\n\n# Do stuff with conn...\n
\n
\n", + "description": "

Reset this connection so that it gets reinitialized the next time it's used.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L149" + } + ], + "properties": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L27", + "description": "

The abstract base class that all Streamlit Connections must inherit from.

\n

This base class provides connection authors with a standardized way to hook into the\nst.connection() factory function: connection authors are required to provide an\nimplementation for the abstract method _connect in their subclasses.

\n

Additionally, it also provides a few methods/properties designed to make\nimplementation of connections more convenient. See the docstrings for each of the\nmethods of this class for more information

\n
\n

Note

\n

While providing an implementation of _connect is technically all that's\nrequired to define a valid connection, connections should also provide the user\nwith context-specific ways of interacting with the underlying connection object.\nFor example, the first-party SQLConnection provides a query() method for\nreads and a session property for more complex operations.

\n
\n", + "args": [], + "returns": [] + }, + "streamlit.connections.ExperimentalBaseConnection": { + "name": "ExperimentalBaseConnection", + "signature": "st.connections.ExperimentalBaseConnection(connection_name, **kwargs)", + "is_class": true, + "methods": [ + { + "name": "reset", + "signature": "st.connections.reset.reset()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("my_conn")\n\n# Reset the connection before using it if it isn't healthy\n# Note: is_healthy() isn't a real method and is just shown for example here.\nif not conn.is_healthy():\n    conn.reset()\n\n# Do stuff with conn...\n
\n
\n", + "description": "

Reset this connection so that it gets reinitialized the next time it's used.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L149" + } + ], + "properties": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L27", + "description": "

The abstract base class that all Streamlit Connections must inherit from.

\n

This base class provides connection authors with a standardized way to hook into the\nst.connection() factory function: connection authors are required to provide an\nimplementation for the abstract method _connect in their subclasses.

\n

Additionally, it also provides a few methods/properties designed to make\nimplementation of connections more convenient. See the docstrings for each of the\nmethods of this class for more information

\n
\n

Note

\n

While providing an implementation of _connect is technically all that's\nrequired to define a valid connection, connections should also provide the user\nwith context-specific ways of interacting with the underlying connection object.\nFor example, the first-party SQLConnection provides a query() method for\nreads and a session property for more complex operations.

\n
\n", + "args": [], + "returns": [] + }, + "streamlit.connections.SQLConnection": { + "name": "SQLConnection", + "signature": "st.connections.SQLConnection(connection_name, **kwargs)", + "is_class": true, + "methods": [ + { + "name": "connect", + "signature": "st.connections.connect.connect()", + "description": "

Call .connect() on the underlying SQLAlchemy Engine, returning a new sqlalchemy.engine.Connection object.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L255" + }, + { + "name": "query", + "signature": "st.connections.query.query(sql, *, show_spinner=\"Running `sql.query(...)`.\", ttl=None, index_col=None, chunksize=None, params=None, **kwargs)", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("sql")\ndf = conn.query(\n    "select * from pet_owners where owner = :owner",\n    ttl=3600,\n    params={"owner": "barbara"},\n)\nst.dataframe(df)\n
\n
\n", + "description": "

Run a read-only query.

", + "args": [ + { + "name": "sql", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The read-only SQL query to execute.

\n", + "default": null + }, + { + "name": "show_spinner", + "type_name": "boolean or string", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Enable the spinner. The default is to show a spinner when there is a\n"cache miss" and the cached resource is being created. If a string, the value\nof the show_spinner param will be used for the spinner text.

\n", + "default": "to" + }, + { + "name": "ttl", + "type_name": "float, int, timedelta or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to keep results in the cache, or\nNone if cached results should not expire. The default is None.

\n", + "default": "None" + }, + { + "name": "index_col", + "type_name": "str, list of str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column(s) to set as index(MultiIndex). Default is None.

\n", + "default": "None" + }, + { + "name": "chunksize", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

If specified, return an iterator where chunksize is the number of\nrows to include in each chunk. Default is None.

\n", + "default": "None" + }, + { + "name": "params", + "type_name": "list, tuple, dict or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

List of parameters to pass to the execute method. The syntax used to pass\nparameters is database driver dependent. Check your database driver\ndocumentation for which of the five syntax styles, described in PEP 249\nparamstyle, is supported.\nDefault is None.

\n", + "default": "None" + }, + { + "name": "**kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Additional keyword arguments are passed to pandas.read_sql.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "pandas.DataFrame", + "is_generator": false, + "description": "

The result of running the query, formatted as a pandas DataFrame.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L125" + }, + { + "name": "reset", + "signature": "st.connections.reset.reset()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("my_conn")\n\n# Reset the connection before using it if it isn't healthy\n# Note: is_healthy() isn't a real method and is just shown for example here.\nif not conn.is_healthy():\n    conn.reset()\n\n# Do stuff with conn...\n
\n
\n", + "description": "

Reset this connection so that it gets reinitialized the next time it's used.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L149" + } + ], + "properties": [ + { + "name": "driver", + "signature": "st.connections.driver.driver", + "description": "

The name of the driver used by the underlying SQLAlchemy Engine.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L274" + }, + { + "name": "engine", + "signature": "st.connections.engine.engine", + "description": "

The underlying SQLAlchemy Engine.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L266" + }, + { + "name": "session", + "signature": "st.connections.session.session", + "example": "
\n
\nimport streamlit as st\nconn = st.connection("sql")\nn = st.slider("Pick a number")\nif st.button("Add the number!"):\n    with conn.session as session:\n        session.execute("INSERT INTO numbers (val) VALUES (:n);", {"n": n})\n        session.commit()\n
\n
\n", + "description": "

Return a SQLAlchemy Session.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L282" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L49", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("sql")\ndf = conn.query("select * from pet_owners")\nst.dataframe(df)\n
\n
\n", + "description": "

A connection to a SQL database using a SQLAlchemy Engine. Initialize using st.connection("<name>", type="sql").

\n

SQLConnection provides the query() convenience method, which can be used to\nrun simple read-only queries with both caching and simple error handling/retries.\nMore complex DB interactions can be performed by using the .session property\nto receive a regular SQLAlchemy Session.

\n

SQLConnections should always be created using st.connection(), not\ninitialized directly. Connection parameters for a SQLConnection can be specified\nusing either st.secrets or **kwargs. Some frequently used parameters include:

\n
    \n
  • url or arguments for sqlalchemy.engine.URL.create().\nMost commonly it includes a dialect, host, database, username and password.
    • \n
  • create_engine_kwargs can be passed via st.secrets, such as for\nsnowflake-sqlalchemy\nor Google BigQuery.\nThese can also be passed directly as **kwargs to connection().
    • \n
  • autocommit=True to run with isolation level AUTOCOMMIT. Default is False.
    • \n
\n", + "args": [], + "returns": [] + }, + "streamlit.connections.SnowflakeConnection": { + "name": "SnowflakeConnection", + "signature": "st.connections.SnowflakeConnection(connection_name, **kwargs)", + "is_class": true, + "methods": [ + { + "name": "cursor", + "signature": "st.connections.cursor.cursor()", + "description": "

Return a PEP 249-compliant cursor object.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L264" + }, + { + "name": "query", + "signature": "st.connections.query.query(sql, *, ttl=None, show_spinner=\"Running `snowflake.query(...)`.\", params=None, **kwargs)", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("snowflake")\ndf = conn.query("select * from pet_owners")\nst.dataframe(df)\n
\n
\n", + "description": "

Run a read-only SQL query.

", + "args": [ + { + "name": "sql", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The read-only SQL query to execute.

\n", + "default": null + }, + { + "name": "ttl", + "type_name": "float, int, timedelta or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to keep results in the cache, or\nNone if cached results should not expire. The default is None.

\n", + "default": "None" + }, + { + "name": "show_spinner", + "type_name": "boolean or string", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Enable the spinner. The default is to show a spinner when there is a\n"cache miss" and the cached resource is being created. If a string, the value\nof the show_spinner param will be used for the spinner text.

\n", + "default": "to" + }, + { + "name": "params", + "type_name": "list, tuple, dict or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

List of parameters to pass to the execute method. This connector supports\nbinding data to a SQL statement using qmark bindings. For more information\nand examples, see the Snowflake Python Connector documentation.\nDefault is None.

\n", + "default": "None" + } + ], + "returns": [ + { + "type_name": "pandas.DataFrame", + "is_generator": false, + "description": "

The result of running the query, formatted as a pandas DataFrame.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L121" + }, + { + "name": "reset", + "signature": "st.connections.reset.reset()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("my_conn")\n\n# Reset the connection before using it if it isn't healthy\n# Note: is_healthy() isn't a real method and is just shown for example here.\nif not conn.is_healthy():\n    conn.reset()\n\n# Do stuff with conn...\n
\n
\n", + "description": "

Reset this connection so that it gets reinitialized the next time it's used.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L149" + }, + { + "name": "session", + "signature": "st.connections.session.session()", + "description": "

Create a new Snowpark Session from this connection.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L281" + }, + { + "name": "write_pandas", + "signature": "st.connections.write_pandas.write_pandas(df, table_name, database=None, schema=None, chunk_size=None, **kwargs)", + "description": "

Call snowflake.connector.pandas_tools.write_pandas with this connection.

", + "args": [], + "returns": [ + { + "type_name": "tuple[bool, int, int]", + "is_generator": false, + "description": "
\n
A tuple containing three values:
\n
    \n
  1. A bool that is True if the write was successful.
    2. \n
  2. An int giving the number of chunks of data that were copied.
    3. \n
  3. An int giving the number of rows that were inserted.
    4. \n
\n
\n
\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L226" + } + ], + "properties": [ + { + "name": "raw_connection", + "signature": "st.connections.raw_connection.raw_connection", + "description": "

Access the underlying Snowflake Python connector object.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L272" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L42", + "description": "

A connection to Snowflake using the Snowflake Python Connector. Initialize using

\n

st.connection("<name>", type="snowflake").

\n

SnowflakeConnection supports direct SQL querying using .query("..."), access to\nthe underlying Snowflake Python Connector object with .raw_connection, and other\nconvenience functions. See the methods below for more information.\nSnowflakeConnections should always be created using st.connection(), not\ninitialized directly.

\n", + "args": [], + "returns": [] + }, + "streamlit.connections.SnowparkConnection": { + "name": "SnowparkConnection", + "signature": "st.connections.SnowparkConnection(connection_name, **kwargs)", + "is_class": true, + "methods": [ + { + "name": "query", + "signature": "st.connections.query.query(sql, ttl=None)", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("snowpark")\ndf = conn.query("select * from pet_owners")\nst.dataframe(df)\n
\n
\n", + "description": "

Run a read-only SQL query.

", + "args": [ + { + "name": "sql", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The read-only SQL query to execute.

\n", + "default": null + }, + { + "name": "ttl", + "type_name": "float, int, timedelta or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The maximum number of seconds to keep results in the cache, or\nNone if cached results should not expire. The default is None.

\n", + "default": "None" + } + ], + "returns": [ + { + "type_name": "pandas.DataFrame", + "is_generator": false, + "description": "

The result of running the query, formatted as a pandas DataFrame.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowpark_connection.py#L95" + }, + { + "name": "reset", + "signature": "st.connections.reset.reset()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("my_conn")\n\n# Reset the connection before using it if it isn't healthy\n# Note: is_healthy() isn't a real method and is just shown for example here.\nif not conn.is_healthy():\n    conn.reset()\n\n# Do stuff with conn...\n
\n
\n", + "description": "

Reset this connection so that it gets reinitialized the next time it's used.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L149" + }, + { + "name": "safe_session", + "signature": "st.connections.safe_session.safe_session()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("snowpark")\nwith conn.safe_session() as session:\n    df = session.table("mytable").limit(10).to_pandas()\n\nst.dataframe(df)\n
\n
\n", + "description": "

Grab the underlying Snowpark session in a thread-safe manner.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowpark_connection.py#L188" + } + ], + "properties": [ + { + "name": "session", + "signature": "st.connections.session.session", + "example": "
\n
\nimport streamlit as st\n\nsession = st.connection("snowpark").session\ndf = session.table("mytable").limit(10).to_pandas()\nst.dataframe(df)\n
\n
\n", + "description": "

Access the underlying Snowpark session.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowpark_connection.py#L165" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowpark_connection.py#L47", + "description": "

A connection to Snowpark using snowflake.snowpark.session.Session. Initialize using

\n

st.connection("<name>", type="snowpark").

\n

In addition to providing access to the Snowpark Session, SnowparkConnection supports\ndirect SQL querying using query("...") and thread safe access using\nwith conn.safe_session():. See methods below for more information.\nSnowparkConnections should always be created using st.connection(), not\ninitialized directly.

\n
\n

Note

\n

We don't expect this iteration of SnowparkConnection to be able to scale\nwell in apps with many concurrent users due to the lock contention that will occur\nover the single underlying Session object under high load.

\n
\n", + "args": [], + "returns": [] + }, + "streamlit.connections.SQLConnection.connect": { + "name": "connect", + "signature": "SQLConnection.connect()", + "description": "

Call .connect() on the underlying SQLAlchemy Engine, returning a new sqlalchemy.engine.Connection object.

\n

Calling this method is equivalent to calling self._instance.connect().

\n

NOTE: This method should not be confused with the internal _connect method used\nto implement a Streamlit Connection.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L255" + }, + "streamlit.connections.SQLConnection.driver": { + "name": "driver", + "signature": "SQLConnection.driver", + "description": "

The name of the driver used by the underlying SQLAlchemy Engine.

\n

This is equivalent to accessing self._instance.driver.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L274" + }, + "streamlit.connections.SQLConnection.engine": { + "name": "engine", + "signature": "SQLConnection.engine", + "description": "

The underlying SQLAlchemy Engine.

\n

This is equivalent to accessing self._instance.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L266" + }, + "streamlit.connections.SQLConnection.query": { + "name": "query", + "signature": "SQLConnection.query(sql, *, show_spinner=\"Running `sql.query(...)`.\", ttl=None, index_col=None, chunksize=None, params=None, **kwargs)", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("sql")\ndf = conn.query(\n    "select * from pet_owners where owner = :owner",\n    ttl=3600,\n    params={"owner": "barbara"},\n)\nst.dataframe(df)\n
\n
\n", + "description": "

Run a read-only query.

\n

This method implements both query result caching (with caching behavior\nidentical to that of using @st.cache_data) as well as simple error handling/retries.

\n
\n

Note

\n

Queries that are run without a specified ttl are cached indefinitely.

\n
\n

Aside from the ttl kwarg, all kwargs passed to this function are passed down\nto pandas.read_sql\nand have the behavior described in the pandas documentation.

\n", + "args": [ + { + "name": "sql", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The read-only SQL query to execute.

\n", + "default": null + }, + { + "name": "show_spinner", + "type_name": "boolean or string", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Enable the spinner. The default is to show a spinner when there is a\n"cache miss" and the cached resource is being created. If a string, the value\nof the show_spinner param will be used for the spinner text.

\n", + "default": "to" + }, + { + "name": "ttl", + "type_name": "float, int, timedelta or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to keep results in the cache, or\nNone if cached results should not expire. The default is None.

\n", + "default": "None" + }, + { + "name": "index_col", + "type_name": "str, list of str, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Column(s) to set as index(MultiIndex). Default is None.

\n", + "default": "None" + }, + { + "name": "chunksize", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

If specified, return an iterator where chunksize is the number of\nrows to include in each chunk. Default is None.

\n", + "default": "None" + }, + { + "name": "params", + "type_name": "list, tuple, dict or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

List of parameters to pass to the execute method. The syntax used to pass\nparameters is database driver dependent. Check your database driver\ndocumentation for which of the five syntax styles, described in PEP 249\nparamstyle, is supported.\nDefault is None.

\n", + "default": "None" + }, + { + "name": "**kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Additional keyword arguments are passed to pandas.read_sql.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "pandas.DataFrame", + "is_generator": false, + "description": "

The result of running the query, formatted as a pandas DataFrame.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L125" + }, + "streamlit.connections.SQLConnection.reset": { + "name": "reset", + "signature": "SQLConnection.reset()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("my_conn")\n\n# Reset the connection before using it if it isn't healthy\n# Note: is_healthy() isn't a real method and is just shown for example here.\nif not conn.is_healthy():\n    conn.reset()\n\n# Do stuff with conn...\n
\n
\n", + "description": "

Reset this connection so that it gets reinitialized the next time it's used.

\n

This method can be useful when a connection has become stale, an auth token has\nexpired, or in similar scenarios where a broken connection might be fixed by\nreinitializing it. Note that some connection methods may already use reset()\nin their error handling code.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L149" + }, + "streamlit.connections.SQLConnection.session": { + "name": "session", + "signature": "SQLConnection.session", + "example": "
\n
\nimport streamlit as st\nconn = st.connection("sql")\nn = st.slider("Pick a number")\nif st.button("Add the number!"):\n    with conn.session as session:\n        session.execute("INSERT INTO numbers (val) VALUES (:n);", {"n": n})\n        session.commit()\n
\n
\n", + "description": "

Return a SQLAlchemy Session.

\n

Users of this connection should use the contextmanager pattern for writes,\ntransactions, and anything more complex than simple read queries.

\n

See the usage example below, which assumes we have a table numbers with a\nsingle integer column val. The SQLAlchemy docs also contain\nmuch more information on the usage of sessions.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/sql_connection.py#L282" + }, + "streamlit.connections.SnowparkConnection.query": { + "name": "query", + "signature": "SnowparkConnection.query(sql, ttl=None)", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("snowpark")\ndf = conn.query("select * from pet_owners")\nst.dataframe(df)\n
\n
\n", + "description": "

Run a read-only SQL query.

\n

This method implements both query result caching (with caching behavior\nidentical to that of using @st.cache_data) as well as simple error handling/retries.

\n
\n

Note

\n

Queries that are run without a specified ttl are cached indefinitely.

\n
\n", + "args": [ + { + "name": "sql", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The read-only SQL query to execute.

\n", + "default": null + }, + { + "name": "ttl", + "type_name": "float, int, timedelta or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The maximum number of seconds to keep results in the cache, or\nNone if cached results should not expire. The default is None.

\n", + "default": "None" + } + ], + "returns": [ + { + "type_name": "pandas.DataFrame", + "is_generator": false, + "description": "

The result of running the query, formatted as a pandas DataFrame.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowpark_connection.py#L95" + }, + "streamlit.connections.SnowparkConnection.reset": { + "name": "reset", + "signature": "SnowparkConnection.reset()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("my_conn")\n\n# Reset the connection before using it if it isn't healthy\n# Note: is_healthy() isn't a real method and is just shown for example here.\nif not conn.is_healthy():\n    conn.reset()\n\n# Do stuff with conn...\n
\n
\n", + "description": "

Reset this connection so that it gets reinitialized the next time it's used.

\n

This method can be useful when a connection has become stale, an auth token has\nexpired, or in similar scenarios where a broken connection might be fixed by\nreinitializing it. Note that some connection methods may already use reset()\nin their error handling code.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L149" + }, + "streamlit.connections.SnowparkConnection.safe_session": { + "name": "safe_session", + "signature": "SnowparkConnection.safe_session()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("snowpark")\nwith conn.safe_session() as session:\n    df = session.table("mytable").limit(10).to_pandas()\n\nst.dataframe(df)\n
\n
\n", + "description": "

Grab the underlying Snowpark session in a thread-safe manner.

\n

As operations on a Snowpark session are not thread safe, we need to take care\nwhen using a session in the context of a Streamlit app where each script run\noccurs in its own thread. Using the contextmanager pattern to do this ensures\nthat access on this connection's underlying Session is done in a thread-safe\nmanner.

\n

Information on how to use Snowpark sessions can be found in the Snowpark documentation.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowpark_connection.py#L188" + }, + "streamlit.connections.SnowparkConnection.session": { + "name": "session", + "signature": "SnowparkConnection.session", + "example": "
\n
\nimport streamlit as st\n\nsession = st.connection("snowpark").session\ndf = session.table("mytable").limit(10).to_pandas()\nst.dataframe(df)\n
\n
\n", + "description": "

Access the underlying Snowpark session.

\n
\n

Note

\n

Snowpark sessions are not thread safe. Users of this method are\nresponsible for ensuring that access to the session returned by this method is\ndone in a thread-safe manner. For most users, we recommend using the thread-safe\nsafe_session() method and a with block.

\n
\n

Information on how to use Snowpark sessions can be found in the Snowpark documentation.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowpark_connection.py#L165" + }, + "streamlit.connections.SnowflakeConnection.cursor": { + "name": "cursor", + "signature": "SnowflakeConnection.cursor()", + "description": "

Return a PEP 249-compliant cursor object.

\n

For more information, see the Snowflake Python Connector documentation.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L264" + }, + "streamlit.connections.SnowflakeConnection.query": { + "name": "query", + "signature": "SnowflakeConnection.query(sql, *, ttl=None, show_spinner=\"Running `snowflake.query(...)`.\", params=None, **kwargs)", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("snowflake")\ndf = conn.query("select * from pet_owners")\nst.dataframe(df)\n
\n
\n", + "description": "

Run a read-only SQL query.

\n

This method implements both query result caching (with caching behavior\nidentical to that of using @st.cache_data) as well as simple error handling/retries.

\n
\n

Note

\n

Queries that are run without a specified ttl are cached indefinitely.

\n
\n", + "args": [ + { + "name": "sql", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The read-only SQL query to execute.

\n", + "default": null + }, + { + "name": "ttl", + "type_name": "float, int, timedelta or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to keep results in the cache, or\nNone if cached results should not expire. The default is None.

\n", + "default": "None" + }, + { + "name": "show_spinner", + "type_name": "boolean or string", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Enable the spinner. The default is to show a spinner when there is a\n"cache miss" and the cached resource is being created. If a string, the value\nof the show_spinner param will be used for the spinner text.

\n", + "default": "to" + }, + { + "name": "params", + "type_name": "list, tuple, dict or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

List of parameters to pass to the execute method. This connector supports\nbinding data to a SQL statement using qmark bindings. For more information\nand examples, see the Snowflake Python Connector documentation.\nDefault is None.

\n", + "default": "None" + } + ], + "returns": [ + { + "type_name": "pandas.DataFrame", + "is_generator": false, + "description": "

The result of running the query, formatted as a pandas DataFrame.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L121" + }, + "streamlit.connections.SnowflakeConnection.raw_connection": { + "name": "raw_connection", + "signature": "SnowflakeConnection.raw_connection", + "description": "

Access the underlying Snowflake Python connector object.

\n

Information on how to use the Snowflake Python Connector can be found in the\nSnowflake Python Connector documentation.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L272" + }, + "streamlit.connections.SnowflakeConnection.reset": { + "name": "reset", + "signature": "SnowflakeConnection.reset()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("my_conn")\n\n# Reset the connection before using it if it isn't healthy\n# Note: is_healthy() isn't a real method and is just shown for example here.\nif not conn.is_healthy():\n    conn.reset()\n\n# Do stuff with conn...\n
\n
\n", + "description": "

Reset this connection so that it gets reinitialized the next time it's used.

\n

This method can be useful when a connection has become stale, an auth token has\nexpired, or in similar scenarios where a broken connection might be fixed by\nreinitializing it. Note that some connection methods may already use reset()\nin their error handling code.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L149" + }, + "streamlit.connections.SnowflakeConnection.session": { + "name": "session", + "signature": "SnowflakeConnection.session()", + "description": "

Create a new Snowpark Session from this connection.

\n

Information on how to use Snowpark sessions can be found in the Snowpark documentation.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L281" + }, + "streamlit.connections.SnowflakeConnection.write_pandas": { + "name": "write_pandas", + "signature": "SnowflakeConnection.write_pandas(df, table_name, database=None, schema=None, chunk_size=None, **kwargs)", + "description": "

Call snowflake.connector.pandas_tools.write_pandas with this connection.

\n

This convenience method is simply a thin wrapper around the write_pandas\nfunction of the same name from snowflake.connector.pandas_tools. For more\ninformation, see the Snowflake Python Connector documentation.

\n", + "args": [], + "returns": [ + { + "type_name": "tuple[bool, int, int]", + "is_generator": false, + "description": "
\n
A tuple containing three values:
\n
    \n
  1. A bool that is True if the write was successful.
    2. \n
  2. An int giving the number of chunks of data that were copied.
    3. \n
  3. An int giving the number of rows that were inserted.
    4. \n
\n
\n
\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/snowflake_connection.py#L226" + }, + "streamlit.connections.BaseConnection.reset": { + "name": "reset", + "signature": "BaseConnection.reset()", + "example": "
\n
\nimport streamlit as st\n\nconn = st.connection("my_conn")\n\n# Reset the connection before using it if it isn't healthy\n# Note: is_healthy() isn't a real method and is just shown for example here.\nif not conn.is_healthy():\n    conn.reset()\n\n# Do stuff with conn...\n
\n
\n", + "description": "

Reset this connection so that it gets reinitialized the next time it's used.

\n

This method can be useful when a connection has become stale, an auth token has\nexpired, or in similar scenarios where a broken connection might be fixed by\nreinitializing it. Note that some connection methods may already use reset()\nin their error handling code.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/connections/base_connection.py#L149" + }, + "streamlit.column_config.AreaChartColumn": { + "name": "AreaChartColumn", + "signature": "st.column_config.AreaChartColumn(label=None, *, width=None, help=None, y_min=None, y_max=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "sales": [\n            [0, 4, 26, 80, 100, 40],\n            [80, 20, 80, 35, 40, 100],\n            [10, 20, 80, 80, 70, 0],\n            [10, 100, 20, 100, 30, 100],\n        ],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "sales": st.column_config.AreaChartColumn(\n            "Sales (last 6 months)",\n            width="medium",\n            help="The sales volume in the last 6 months",\n            y_min=0,\n            y_max=100,\n         ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure an area chart column in st.dataframe or st.data_editor.

\n

Cells need to contain a list of numbers. Chart columns are not editable\nat the moment. This command needs to be used in the column_config parameter\nof st.dataframe or st.data_editor.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "y_min", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The minimum value on the y-axis for all cells in the column.\nIf None (default), every cell will use the minimum of its data.

\n", + "default": null + }, + { + "name": "y_max", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum value on the y-axis for all cells in the column. If None (default),\nevery cell will use the maximum of its data.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L948" + }, + "streamlit.column_config.BarChartColumn": { + "name": "BarChartColumn", + "signature": "st.column_config.BarChartColumn(label=None, *, width=None, help=None, y_min=None, y_max=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "sales": [\n            [0, 4, 26, 80, 100, 40],\n            [80, 20, 80, 35, 40, 100],\n            [10, 20, 80, 80, 70, 0],\n            [10, 100, 20, 100, 30, 100],\n        ],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "sales": st.column_config.BarChartColumn(\n            "Sales (last 6 months)",\n            help="The sales volume in the last 6 months",\n            y_min=0,\n            y_max=100,\n        ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a bar chart column in st.dataframe or st.data_editor.

\n

Cells need to contain a list of numbers. Chart columns are not editable\nat the moment. This command needs to be used in the column_config parameter\nof st.dataframe or st.data_editor.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "y_min", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The minimum value on the y-axis for all cells in the column.\nIf None (default), every cell will use the minimum of its data.

\n", + "default": null + }, + { + "name": "y_max", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum value on the y-axis for all cells in the column. If None (default),\nevery cell will use the maximum of its data.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L787" + }, + "streamlit.column_config.CheckboxColumn": { + "name": "CheckboxColumn", + "signature": "st.column_config.CheckboxColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "widgets": ["st.selectbox", "st.number_input", "st.text_area", "st.button"],\n        "favorite": [True, False, False, True],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "favorite": st.column_config.CheckboxColumn(\n            "Your favorite?",\n            help="Select your **favorite** widgets",\n            default=False,\n        )\n    },\n    disabled=["widgets"],\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a checkbox column in st.dataframe or st.data_editor.

\n

This is the default column type for boolean values. This command needs to be used in\nthe column_config parameter of st.dataframe or st.data_editor.\nWhen used with st.data_editor, editing will be enabled with a checkbox widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether editing should be disabled for this column. Defaults to False.

\n", + "default": "False" + }, + { + "name": "required", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether edited cells in the column need to have a value. If True, an edited cell\ncan only be submitted if it has a value other than None. Defaults to False.

\n", + "default": "False" + }, + { + "name": "default", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies the default value in this column when a new row is added by the user.

\n", + "default": "value" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L606" + }, + "streamlit.column_config.Column": { + "name": "Column", + "signature": "st.column_config.Column(label=None, *, width=None, help=None, disabled=None, required=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "widgets": ["st.selectbox", "st.number_input", "st.text_area", "st.button"],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "widgets": st.column_config.Column(\n            "Streamlit Widgets",\n            help="Streamlit **widget** commands \ud83c\udf88",\n            width="medium",\n            required=True,\n        )\n    },\n    hide_index=True,\n    num_rows="dynamic",\n)\n
\n
\n", + "description": "

Configure a generic column in st.dataframe or st.data_editor.

\n

The type of the column will be automatically inferred from the data type.\nThis command needs to be used in the column_config parameter of st.dataframe\nor st.data_editor.

\n

To change the type of the column and enable type-specific configuration options,\nuse one of the column types in the st.column_config namespace,\ne.g. st.column_config.NumberColumn.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether editing should be disabled for this column. Defaults to False.

\n", + "default": "False" + }, + { + "name": "required", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether edited cells in the column need to have a value. If True, an edited cell\ncan only be submitted if it has a value other than None. Defaults to False.

\n", + "default": "False" + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L196" + }, + "streamlit.column_config.DateColumn": { + "name": "DateColumn", + "signature": "st.column_config.DateColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=None, format=None, min_value=None, max_value=None, step=None)", + "examples": "
\n
\nfrom datetime import date\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "birthday": [\n            date(1980, 1, 1),\n            date(1990, 5, 3),\n            date(1974, 5, 19),\n            date(2001, 8, 17),\n        ]\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "birthday": st.column_config.DateColumn(\n            "Birthday",\n            min_value=date(1900, 1, 1),\n            max_value=date(2005, 1, 1),\n            format="DD.MM.YYYY",\n            step=1,\n        ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a date column in st.dataframe or st.data_editor.

\n

This is the default column type for date values. This command needs to be used in\nthe column_config parameter of st.dataframe or st.data_editor. When used\nwith st.data_editor, editing will be enabled with a date picker widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether editing should be disabled for this column. Defaults to False.

\n", + "default": "False" + }, + { + "name": "required", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether edited cells in the column need to have a value. If True, an edited cell\ncan only be submitted if it has a value other than None. Defaults to False.

\n", + "default": "False" + }, + { + "name": "default", + "type_name": "datetime.date or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies the default value in this column when a new row is added by the user.

\n", + "default": "value" + }, + { + "name": "format", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A momentJS format string controlling how times are displayed. See\nmomentJS docs for available\nformats. If None (default), uses YYYY-MM-DD.

\n", + "default": null + }, + { + "name": "min_value", + "type_name": "datetime.date or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The minimum date that can be entered.\nIf None (default), there will be no minimum.

\n", + "default": null + }, + { + "name": "max_value", + "type_name": "datetime.date or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum date that can be entered.\nIf None (default), there will be no maximum.

\n", + "default": null + }, + { + "name": "step", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The stepping interval in days. If None (default), the step will be 1 day.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L1400" + }, + "streamlit.column_config.DatetimeColumn": { + "name": "DatetimeColumn", + "signature": "st.column_config.DatetimeColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=None, format=None, min_value=None, max_value=None, step=None, timezone=None)", + "examples": "
\n
\nfrom datetime import datetime\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "appointment": [\n            datetime(2024, 2, 5, 12, 30),\n            datetime(2023, 11, 10, 18, 0),\n            datetime(2024, 3, 11, 20, 10),\n            datetime(2023, 9, 12, 3, 0),\n        ]\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "appointment": st.column_config.DatetimeColumn(\n            "Appointment",\n            min_value=datetime(2023, 6, 1),\n            max_value=datetime(2025, 1, 1),\n            format="D MMM YYYY, h:mm a",\n            step=60,\n        ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a datetime column in st.dataframe or st.data_editor.

\n

This is the default column type for datetime values. This command needs to be\nused in the column_config parameter of st.dataframe or\nst.data_editor. When used with st.data_editor, editing will be enabled\nwith a datetime picker widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether editing should be disabled for this column. Defaults to False.

\n", + "default": "False" + }, + { + "name": "required", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether edited cells in the column need to have a value. If True, an edited cell\ncan only be submitted if it has a value other than None. Defaults to False.

\n", + "default": "False" + }, + { + "name": "default", + "type_name": "datetime.datetime or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies the default value in this column when a new row is added by the user.

\n", + "default": "value" + }, + { + "name": "format", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A momentJS format string controlling how datetimes are displayed. See\nmomentJS docs for available\nformats. If None (default), uses YYYY-MM-DD HH:mm:ss.

\n", + "default": null + }, + { + "name": "min_value", + "type_name": "datetime.datetime or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The minimum datetime that can be entered.\nIf None (default), there will be no minimum.

\n", + "default": null + }, + { + "name": "max_value", + "type_name": "datetime.datetime or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum datetime that can be entered.\nIf None (default), there will be no maximum.

\n", + "default": null + }, + { + "name": "step", + "type_name": "int, float, datetime.timedelta, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The stepping interval in seconds. If None (default), the step will be 1 second.

\n", + "default": null + }, + { + "name": "timezone", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The timezone of this column. If None (default),\nthe timezone is inferred from the underlying data.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L1165" + }, + "streamlit.column_config.ImageColumn": { + "name": "ImageColumn", + "signature": "st.column_config.ImageColumn(label=None, *, width=None, help=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "apps": [\n            "https://storage.googleapis.com/s4a-prod-share-preview/default/st_app_screenshot_image/5435b8cb-6c6c-490b-9608-799b543655d3/Home_Page.png",\n            "https://storage.googleapis.com/s4a-prod-share-preview/default/st_app_screenshot_image/ef9a7627-13f2-47e5-8f65-3f69bb38a5c2/Home_Page.png",\n            "https://storage.googleapis.com/s4a-prod-share-preview/default/st_app_screenshot_image/31b99099-8eae-4ff8-aa89-042895ed3843/Home_Page.png",\n            "https://storage.googleapis.com/s4a-prod-share-preview/default/st_app_screenshot_image/6a399b09-241e-4ae7-a31f-7640dc1d181e/Home_Page.png",\n        ],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "apps": st.column_config.ImageColumn(\n            "Preview Image", help="Streamlit app preview screenshots"\n        )\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure an image column in st.dataframe or st.data_editor.

\n

The cell values need to be one of:

\n
    \n
  • A URL to fetch the image from. This can also be a relative URL of an image\ndeployed via static file serving.\nNote that you can NOT use an arbitrary local image if it is not available through\na public URL.
    • \n
  • A data URL containing an SVG XML like data:image/svg+xml;utf8,<svg xmlns=...</svg>.
    • \n
  • A data URL containing a Base64 encoded image like data:image/png;base64,iVBO....
    • \n
\n

Image columns are not editable at the moment. This command needs to be used in the\ncolumn_config parameter of st.dataframe or st.data_editor.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L1029" + }, + "streamlit.column_config.LineChartColumn": { + "name": "LineChartColumn", + "signature": "st.column_config.LineChartColumn(label=None, *, width=None, help=None, y_min=None, y_max=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "sales": [\n            [0, 4, 26, 80, 100, 40],\n            [80, 20, 80, 35, 40, 100],\n            [10, 20, 80, 80, 70, 0],\n            [10, 100, 20, 100, 30, 100],\n        ],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "sales": st.column_config.LineChartColumn(\n            "Sales (last 6 months)",\n            width="medium",\n            help="The sales volume in the last 6 months",\n            y_min=0,\n            y_max=100,\n         ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a line chart column in st.dataframe or st.data_editor.

\n

Cells need to contain a list of numbers. Chart columns are not editable\nat the moment. This command needs to be used in the column_config parameter\nof st.dataframe or st.data_editor.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "y_min", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The minimum value on the y-axis for all cells in the column.\nIf None (default), every cell will use the minimum of its data.

\n", + "default": null + }, + { + "name": "y_max", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum value on the y-axis for all cells in the column. If None (default),\nevery cell will use the maximum of its data.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L867" + }, + "streamlit.column_config.LinkColumn": { + "name": "LinkColumn", + "signature": "st.column_config.LinkColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=None, max_chars=None, validate=None, display_text=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "apps": [\n            "https://roadmap.streamlit.app",\n            "https://extras.streamlit.app",\n            "https://issues.streamlit.app",\n            "https://30days.streamlit.app",\n        ],\n        "creator": [\n            "https://github.com/streamlit",\n            "https://github.com/arnaudmiribel",\n            "https://github.com/streamlit",\n            "https://github.com/streamlit",\n        ],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "apps": st.column_config.LinkColumn(\n            "Trending apps",\n            help="The top trending Streamlit apps",\n            validate="^https://[a-z]+\\.streamlit\\.app$",\n            max_chars=100,\n            display_text="https://(.*?)\\.streamlit\\.app"\n        ),\n        "creator": st.column_config.LinkColumn(\n            "App Creator", display_text="Open profile"\n        ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a link column in st.dataframe or st.data_editor.

\n

The cell values need to be string and will be shown as clickable links.\nThis command needs to be used in the column_config parameter of st.dataframe\nor st.data_editor. When used with st.data_editor, editing will be enabled\nwith a text input widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether editing should be disabled for this column. Defaults to False.

\n", + "default": "False" + }, + { + "name": "required", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether edited cells in the column need to have a value. If True, an edited cell\ncan only be submitted if it has a value other than None. Defaults to False.

\n", + "default": "False" + }, + { + "name": "default", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies the default value in this column when a new row is added by the user.

\n", + "default": "value" + }, + { + "name": "max_chars", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of characters that can be entered. If None (default),\nthere will be no maximum.

\n", + "default": null + }, + { + "name": "validate", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A regular expression (JS flavor, e.g. "^https://.+$") that edited values are validated against.\nIf the input is invalid, it will not be submitted.

\n", + "default": null + }, + { + "name": "display_text", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The text that is displayed in the cell. Can be one of:

\n
    \n
  • None (default) to display the URL itself.
    • \n
  • A string that is displayed in every cell, e.g. "Open link".
    • \n
  • A regular expression (JS flavor, detected by usage of parentheses)\nto extract a part of the URL via a capture group, e.g. "https://(.*?)\\.example\\.com"\nto extract the display text "foo" from the URL "https://foo.example.com".
    • \n
\n\n

For more complex cases, you may use Pandas Styler's format\nfunction on the underlying dataframe. Note that this makes the app slow,\ndoesn't work with editable columns, and might be removed in the future.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L475" + }, + "streamlit.column_config.ListColumn": { + "name": "ListColumn", + "signature": "st.column_config.ListColumn(label=None, *, width=None, help=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "sales": [\n            [0, 4, 26, 80, 100, 40],\n            [80, 20, 80, 35, 40, 100],\n            [10, 20, 80, 80, 70, 0],\n            [10, 100, 20, 100, 30, 100],\n        ],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "sales": st.column_config.ListColumn(\n            "Sales (last 6 months)",\n            help="The sales volume in the last 6 months",\n            width="medium",\n        ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a list column in st.dataframe or st.data_editor.

\n

This is the default column type for list-like values. List columns are not editable\nat the moment. This command needs to be used in the column_config parameter of\nst.dataframe or st.data_editor.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L1100" + }, + "streamlit.column_config.NumberColumn": { + "name": "NumberColumn", + "signature": "st.column_config.NumberColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=None, format=None, min_value=None, max_value=None, step=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "price": [20, 950, 250, 500],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "price": st.column_config.NumberColumn(\n            "Price (in USD)",\n            help="The price of the product in USD",\n            min_value=0,\n            max_value=1000,\n            step=1,\n            format="$%d",\n        )\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a number column in st.dataframe or st.data_editor.

\n

This is the default column type for integer and float values. This command needs to\nbe used in the column_config parameter of st.dataframe or st.data_editor.\nWhen used with st.data_editor, editing will be enabled with a numeric input widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether editing should be disabled for this column. Defaults to False.

\n", + "default": "False" + }, + { + "name": "required", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether edited cells in the column need to have a value. If True, an edited cell\ncan only be submitted if it has a value other than None. Defaults to False.

\n", + "default": "False" + }, + { + "name": "default", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies the default value in this column when a new row is added by the user.

\n", + "default": "value" + }, + { + "name": "format", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A printf-style format string controlling how numbers are displayed.\nThis does not impact the return value. Valid formatters: %d %e %f %g %i %u.\nYou can also add prefixes and suffixes, e.g. "$ %.2f" to show a dollar prefix.

\n", + "default": null + }, + { + "name": "min_value", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The minimum value that can be entered.\nIf None (default), there will be no minimum.

\n", + "default": null + }, + { + "name": "max_value", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum value that can be entered.\nIf None (default), there will be no maximum.

\n", + "default": null + }, + { + "name": "step", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The stepping interval. Specifies the precision of numbers that can be entered.\nIf None (default), uses 1 for integers and unrestricted precision for floats.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L271" + }, + "streamlit.column_config.ProgressColumn": { + "name": "ProgressColumn", + "signature": "st.column_config.ProgressColumn(label=None, *, width=None, help=None, format=None, min_value=None, max_value=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "sales": [200, 550, 1000, 80],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "sales": st.column_config.ProgressColumn(\n            "Sales volume",\n            help="The sales volume in USD",\n            format="$%f",\n            min_value=0,\n            max_value=1000,\n        ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a progress column in st.dataframe or st.data_editor.

\n

Cells need to contain a number. Progress columns are not editable at the moment.\nThis command needs to be used in the column_config parameter of st.dataframe\nor st.data_editor.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "format", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A printf-style format string controlling how numbers are displayed.\nValid formatters: %d %e %f %g %i %u. You can also add prefixes and suffixes,\ne.g. "$ %.2f" to show a dollar prefix.

\n", + "default": null + }, + { + "name": "min_value", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The minimum value of the progress bar.\nIf None (default), will be 0.

\n", + "default": null + }, + { + "name": "max_value", + "type_name": "int, float, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The minimum value of the progress bar. If None (default), will be 100 for\ninteger values and 1 for float values.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L1513" + }, + "streamlit.column_config.SelectboxColumn": { + "name": "SelectboxColumn", + "signature": "st.column_config.SelectboxColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=None, options=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "category": [\n            "\ud83d\udcca Data Exploration",\n            "\ud83d\udcc8 Data Visualization",\n            "\ud83e\udd16 LLM",\n            "\ud83d\udcca Data Exploration",\n        ],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "category": st.column_config.SelectboxColumn(\n            "App Category",\n            help="The category of the app",\n            width="medium",\n            options=[\n                "\ud83d\udcca Data Exploration",\n                "\ud83d\udcc8 Data Visualization",\n                "\ud83e\udd16 LLM",\n            ],\n            required=True,\n        )\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a selectbox column in st.dataframe or st.data_editor.

\n

This is the default column type for Pandas categorical values. This command needs to\nbe used in the column_config parameter of st.dataframe or st.data_editor.\nWhen used with st.data_editor, editing will be enabled with a selectbox widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether editing should be disabled for this column. Defaults to False.

\n", + "default": "False" + }, + { + "name": "required", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether edited cells in the column need to have a value. If True, an edited cell\ncan only be submitted if it has a value other than None. Defaults to False.

\n", + "default": "False" + }, + { + "name": "default", + "type_name": "str, int, float, bool, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies the default value in this column when a new row is added by the user.

\n", + "default": "value" + }, + { + "name": "options", + "type_name": "Iterable of str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The options that can be selected during editing. If None (default), this will be\ninferred from the underlying dataframe column if its dtype is "category"\n(see Pandas docs on categorical data).

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L688" + }, + "streamlit.column_config.TextColumn": { + "name": "TextColumn", + "signature": "st.column_config.TextColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=None, max_chars=None, validate=None)", + "examples": "
\n
\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "widgets": ["st.selectbox", "st.number_input", "st.text_area", "st.button"],\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "widgets": st.column_config.TextColumn(\n            "Widgets",\n            help="Streamlit **widget** commands \ud83c\udf88",\n            default="st.",\n            max_chars=50,\n            validate="^st\\.[a-z_]+$",\n        )\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a text column in st.dataframe or st.data_editor.

\n

This is the default column type for string values. This command needs to be used in the\ncolumn_config parameter of st.dataframe or st.data_editor. When used with\nst.data_editor, editing will be enabled with a text input widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether editing should be disabled for this column. Defaults to False.

\n", + "default": "False" + }, + { + "name": "required", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether edited cells in the column need to have a value. If True, an edited cell\ncan only be submitted if it has a value other than None. Defaults to False.

\n", + "default": "False" + }, + { + "name": "default", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies the default value in this column when a new row is added by the user.

\n", + "default": "value" + }, + { + "name": "max_chars", + "type_name": "int or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of characters that can be entered. If None (default),\nthere will be no maximum.

\n", + "default": null + }, + { + "name": "validate", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A regular expression (JS flavor, e.g. "^[a-z]+$") that edited values are validated against.\nIf the input is invalid, it will not be submitted.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L381" + }, + "streamlit.column_config.TimeColumn": { + "name": "TimeColumn", + "signature": "st.column_config.TimeColumn(label=None, *, width=None, help=None, disabled=None, required=None, default=None, format=None, min_value=None, max_value=None, step=None)", + "examples": "
\n
\nfrom datetime import time\nimport pandas as pd\nimport streamlit as st\n\ndata_df = pd.DataFrame(\n    {\n        "appointment": [\n            time(12, 30),\n            time(18, 0),\n            time(9, 10),\n            time(16, 25),\n        ]\n    }\n)\n\nst.data_editor(\n    data_df,\n    column_config={\n        "appointment": st.column_config.TimeColumn(\n            "Appointment",\n            min_value=time(8, 0, 0),\n            max_value=time(19, 0, 0),\n            format="hh:mm a",\n            step=60,\n        ),\n    },\n    hide_index=True,\n)\n
\n
\n", + "description": "

Configure a time column in st.dataframe or st.data_editor.

\n

This is the default column type for time values. This command needs to be used in\nthe column_config parameter of st.dataframe or st.data_editor. When\nused with st.data_editor, editing will be enabled with a time picker widget.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The label shown at the top of the column. If None (default),\nthe column name is used.

\n", + "default": null + }, + { + "name": "width", + "type_name": "\"small\", \"medium\", \"large\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The display width of the column. Can be one of "small", "medium", or "large".\nIf None (default), the column will be sized to fit the cell contents.

\n", + "default": null + }, + { + "name": "help", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tooltip that gets displayed when hovering over the column label.

\n", + "default": null + }, + { + "name": "disabled", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether editing should be disabled for this column. Defaults to False.

\n", + "default": "False" + }, + { + "name": "required", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Whether edited cells in the column need to have a value. If True, an edited cell\ncan only be submitted if it has a value other than None. Defaults to False.

\n", + "default": "False" + }, + { + "name": "default", + "type_name": "datetime.time or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Specifies the default value in this column when a new row is added by the user.

\n", + "default": "value" + }, + { + "name": "format", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A momentJS format string controlling how times are displayed. See\nmomentJS docs for available\nformats. If None (default), uses HH:mm:ss.

\n", + "default": null + }, + { + "name": "min_value", + "type_name": "datetime.time or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The minimum time that can be entered.\nIf None (default), there will be no minimum.

\n", + "default": null + }, + { + "name": "max_value", + "type_name": "datetime.time or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum time that can be entered.\nIf None (default), there will be no maximum.

\n", + "default": null + }, + { + "name": "step", + "type_name": "int, float, datetime.timedelta, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The stepping interval in seconds. If None (default), the step will be 1 second.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/column_types.py#L1286" + }, + "streamlit.components.v1.declare_component": { + "name": "declare_component", + "signature": "st.components.v1.declare_component(name, path=None, url=None)", + "description": "

Create a custom component and register it if there is a ScriptRunContext.

\n

The component is not registered when there is no ScriptRunContext.\nThis can happen when a CustomComponent is executed as standalone\ncommand (e.g. for testing).

\n

To use this function, import it from the streamlit.components.v1\nmodule.

\n
\n

Warning

\n

Using st.components.v1.declare_component directly (instead of\nimporting its module) is deprecated and will be disallowd in a later\nversion.

\n
\n", + "args": [ + { + "name": "name", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A short, descriptive name for the component, like "slider".

\n", + "default": null + }, + { + "name": "path", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The path to serve the component's frontend files from. If path is\nNone (default), Streamlit will server the component from the\nlocation in url. Either path or url must be specified, but\nnot both.

\n", + "default": null + }, + { + "name": "url", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The URL that the component is served from. If url is None\n(default), Streamlit will server the component from the location in\npath. Either path or url must be specified, but not both.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "CustomComponent", + "is_generator": false, + "description": "

A CustomComponent that can be called like a function.\nCalling the component will create a new instance of the component\nin the Streamlit app.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/components/v1/component_registry.py#L50" + }, + "streamlit.components.v1.html": { + "name": "html", + "signature": "st.components.v1.html(html, width=None, height=None, scrolling=False)", + "example": "
\n
\nimport streamlit.components.v1 as components\n\ncomponents.html(\n    "<p><span style='text-decoration: line-through double red;'>Oops</span>!</p>"\n)\n
\n
\n", + "description": "

Display an HTML string in an iframe.

\n

To use this function, import it from the streamlit.components.v1\nmodule.

\n

If you want to insert HTML text into your app without an iframe, try\nst.html instead.

\n
\n

Warning

\n

Using st.components.v1.html directly (instead of importing\nits module) is deprecated and will be disallowd in a later version.

\n
\n", + "args": [ + { + "name": "html", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The HTML string to embed in the iframe.

\n", + "default": null + }, + { + "name": "width", + "type_name": "int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The width of the iframe in CSS pixels. By default, this is the\napp's default element width.

\n", + "default": "element" + }, + { + "name": "height", + "type_name": "int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The height of the frame in CSS pixels. By default, this is 150.

\n", + "default": null + }, + { + "name": "scrolling", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to allow scrolling in the iframe. If this False\n(default), Streamlit crops any content larger than the iframe and\ndoes not show a scrollbar. If this is True, Streamlit shows a\nscrollbar when the content is larger than the iframe.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/iframe.py#L80" + }, + "streamlit.components.v1.iframe": { + "name": "iframe", + "signature": "st.components.v1.iframe(src, width=None, height=None, scrolling=False)", + "example": "
\n
\nimport streamlit.components.v1 as components\n\ncomponents.iframe("https://example.com", height=500)\n
\n
\n", + "description": "

Load a remote URL in an iframe.

\n

To use this function, import it from the streamlit.components.v1\nmodule.

\n
\n

Warning

\n

Using st.components.v1.iframe directly (instead of importing\nits module) is deprecated and will be disallowd in a later version.

\n
\n", + "args": [ + { + "name": "src", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The URL of the page to embed.

\n", + "default": null + }, + { + "name": "width", + "type_name": "int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The width of the iframe in CSS pixels. By default, this is the\napp's default element width.

\n", + "default": "element" + }, + { + "name": "height", + "type_name": "int", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The height of the frame in CSS pixels. By default, this is 150.

\n", + "default": null + }, + { + "name": "scrolling", + "type_name": "bool", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Whether to allow scrolling in the iframe. If this False\n(default), Streamlit crops any content larger than the iframe and\ndoes not show a scrollbar. If this is True, Streamlit shows a\nscrollbar when the content is larger than the iframe.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/iframe.py#L27" + }, + "DeltaGenerator.add_rows": { + "name": "add_rows", + "signature": "element.add_rows(data=None, **kwargs)", + "example": "
\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\ndf1 = pd.DataFrame(\n    np.random.randn(50, 20), columns=("col %d" % i for i in range(20))\n)\n\nmy_table = st.table(df1)\n\ndf2 = pd.DataFrame(\n    np.random.randn(50, 20), columns=("col %d" % i for i in range(20))\n)\n\nmy_table.add_rows(df2)\n# Now the table shown in the Streamlit app contains the data for\n# df1 followed by the data for df2.\n
\n

You can do the same thing with plots. For example, if you want to add\nmore data to a line chart:

\n
\n# Assuming df1 and df2 from the example above still exist...\nmy_chart = st.line_chart(df1)\nmy_chart.add_rows(df2)\n# Now the chart shown in the Streamlit app contains the data for\n# df1 followed by the data for df2.\n
\n

And for plots whose datasets are named, you can pass the data with a\nkeyword argument where the key is the name:

\n
\nmy_chart = st.vega_lite_chart(\n    {\n        "mark": "line",\n        "encoding": {"x": "a", "y": "b"},\n        "datasets": {\n            "some_fancy_name": df1,  # <-- named dataset\n        },\n        "data": {"name": "some_fancy_name"},\n    }\n)\nmy_chart.add_rows(some_fancy_name=df2)  # <-- name used as keyword\n
\n
\n", + "description": "

Concatenate a dataframe to the bottom of the current one.

\n", + "args": [ + { + "name": "data", + "type_name": "pandas.DataFrame, pandas.Styler, pyarrow.Table, numpy.ndarray, pyspark.sql.DataFrame, snowflake.snowpark.dataframe.DataFrame, Iterable, dict, or None", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Table to concat. Optional.

\n", + "default": null + }, + { + "name": "**kwargs", + "type_name": "pandas.DataFrame, numpy.ndarray, Iterable, dict, or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The named dataset to concat. Optional. You can only pass in 1\ndataset (including the one in the data parameter).

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/arrow.py#L619" + }, + "StatusContainer.update": { + "name": "update", + "signature": "StatusContainer.update(*, label=None, expanded=None, state=None)", + "description": "

Update the status container.

\n

Only specified arguments are updated. Container contents and unspecified\narguments remain unchanged.

\n", + "args": [ + { + "name": "label", + "type_name": "str or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

A new label of the status container. If None, the label is not\nchanged.

\n", + "default": null + }, + { + "name": "expanded", + "type_name": "bool or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The new expanded state of the status container. If None,\nthe expanded state is not changed.

\n", + "default": null + }, + { + "name": "state", + "type_name": "\"running\", \"complete\", \"error\", or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The new state of the status container. This mainly changes the\nicon. If None, the state is not changed.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/lib/mutable_status_container.py#L98" + }, + "streamlit.testing.v1.AppTest": { + "name": "AppTest", + "signature": "st.testing.v1.AppTest(script_path, *, default_timeout, args=None, kwargs=None)", + "is_class": true, + "methods": [ + { + "name": "get", + "signature": "st.testing.v1.get.get(element_type)", + "description": "

Get elements or widgets of the specified type.

", + "args": [ + { + "name": "element_type", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An element attribute of AppTest. For example, "button",\n"caption", or "chat_input".

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "Sequence of Elements", + "is_generator": false, + "description": "

Sequence of elements of the given type. Individual elements can\nbe accessed from a Sequence by index (order on the page). When\ngetting and element_type that is a widget, individual widgets\ncan be accessed by key. For example, at.get("text")[0] for the\nfirst st.text element or at.get("slider")(key="my_key") for\nthe st.slider widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L1024" + }, + { + "name": "run", + "signature": "st.testing.v1.run.run(*, timeout=None)", + "description": "

Run the script from the current state.

", + "args": [ + { + "name": "timeout", + "type_name": "float or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. If timeout is\nNone (default), Streamlit uses the default timeout set for the\ninstance of AppTest.

\n", + "default": "timeout" + } + ], + "returns": [ + { + "type_name": "AppTest", + "is_generator": false, + "description": "

self

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L368" + }, + { + "name": "switch_page", + "signature": "st.testing.v1.switch_page.switch_page(page_path)", + "description": "

Switch to another page of the app.

", + "args": [ + { + "name": "page_path", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Path of the page to switch to. The path must be relative to the\nmain script's location (e.g. "pages/my_page.py").

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "AppTest", + "is_generator": false, + "description": "

self

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L391" + } + ], + "properties": [ + { + "name": "button", + "signature": "st.testing.v1.button.button", + "description": "

Sequence of all st.button and st.form_submit_button widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Button", + "is_generator": false, + "description": "

Sequence of all st.button and st.form_submit_button\nwidgets. Individual widgets can be accessed from a WidgetList by\nindex (order on the page) or key. For example, at.button[0] for\nthe first widget or at.button(key="my_key") for a widget with a\ngiven key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L445" + }, + { + "name": "button_group", + "signature": "st.testing.v1.button_group.button_group", + "description": "

Sequence of all st.feedback widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of ButtonGroup", + "is_generator": false, + "description": "

Sequence of all st.feedback widgets. Individual widgets can be\naccessed from a WidgetList by index (order on the page) or key. For\nexample, at.button_group[0] for the first widget or\nat.button_group(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L460" + }, + { + "name": "caption", + "signature": "st.testing.v1.caption.caption", + "description": "

Sequence of all st.caption elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Caption", + "is_generator": false, + "description": "

Sequence of all st.caption elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.caption[0] for the first element. Caption is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L474" + }, + { + "name": "chat_input", + "signature": "st.testing.v1.chat_input.chat_input", + "description": "

Sequence of all st.chat_input widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of ChatInput", + "is_generator": false, + "description": "

Sequence of all st.chat_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.chat_input[0] for the first widget or\nat.chat_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L488" + }, + { + "name": "chat_message", + "signature": "st.testing.v1.chat_message.chat_message", + "description": "

Sequence of all st.chat_message elements.

", + "args": [], + "returns": [ + { + "type_name": "Sequence of ChatMessage", + "is_generator": false, + "description": "

Sequence of all st.chat_message elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.chat_message[0] for the first element. ChatMessage\nis an extension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L502" + }, + { + "name": "checkbox", + "signature": "st.testing.v1.checkbox.checkbox", + "description": "

Sequence of all st.checkbox widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Checkbox", + "is_generator": false, + "description": "

Sequence of all st.checkbox widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.checkbox[0] for the first widget or\nat.checkbox(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L516" + }, + { + "name": "code", + "signature": "st.testing.v1.code.code", + "description": "

Sequence of all st.code elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Code", + "is_generator": false, + "description": "

Sequence of all st.code elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.code[0] for the first element. Code is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L530" + }, + { + "name": "color_picker", + "signature": "st.testing.v1.color_picker.color_picker", + "description": "

Sequence of all st.color_picker widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of ColorPicker", + "is_generator": false, + "description": "

Sequence of all st.color_picker widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.color_picker[0] for the first widget or\nat.color_picker(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L544" + }, + { + "name": "columns", + "signature": "st.testing.v1.columns.columns", + "description": "

Sequence of all columns within st.columns elements.

", + "args": [], + "returns": [ + { + "type_name": "Sequence of Column", + "is_generator": false, + "description": "

Sequence of all columns within st.columns elements. Individual\ncolumns can be accessed from an ElementList by index (order on the\npage). For example, at.columns[0] for the first column. Column\nis an extension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L558" + }, + { + "name": "dataframe", + "signature": "st.testing.v1.dataframe.dataframe", + "description": "

Sequence of all st.dataframe elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Dataframe", + "is_generator": false, + "description": "

Sequence of all st.dataframe elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.dataframe[0] for the first element. Dataframe is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L575" + }, + { + "name": "date_input", + "signature": "st.testing.v1.date_input.date_input", + "description": "

Sequence of all st.date_input widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of DateInput", + "is_generator": false, + "description": "

Sequence of all st.date_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.date_input[0] for the first widget or\nat.date_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L589" + }, + { + "name": "divider", + "signature": "st.testing.v1.divider.divider", + "description": "

Sequence of all st.divider elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Divider", + "is_generator": false, + "description": "

Sequence of all st.divider elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.divider[0] for the first element. Divider is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L603" + }, + { + "name": "error", + "signature": "st.testing.v1.error.error", + "description": "

Sequence of all st.error elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Error", + "is_generator": false, + "description": "

Sequence of all st.error elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.error[0] for the first element. Error is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L617" + }, + { + "name": "exception", + "signature": "st.testing.v1.exception.exception", + "description": "

Sequence of all st.exception elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Exception", + "is_generator": false, + "description": "

Sequence of all st.exception elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.exception[0] for the first element. Exception is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L631" + }, + { + "name": "expander", + "signature": "st.testing.v1.expander.expander", + "description": "

Sequence of all st.expander elements.

", + "args": [], + "returns": [ + { + "type_name": "Sequence of Expandable", + "is_generator": false, + "description": "

Sequence of all st.expander elements. Individual elements can be\naccessed from a Sequence by index (order on the page). For\nexample, at.expander[0] for the first element. Expandable is an\nextension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L645" + }, + { + "name": "header", + "signature": "st.testing.v1.header.header", + "description": "

Sequence of all st.header elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Header", + "is_generator": false, + "description": "

Sequence of all st.header elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.header[0] for the first element. Header is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L659" + }, + { + "name": "info", + "signature": "st.testing.v1.info.info", + "description": "

Sequence of all st.info elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Info", + "is_generator": false, + "description": "

Sequence of all st.info elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.info[0] for the first element. Info is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L673" + }, + { + "name": "json", + "signature": "st.testing.v1.json.json", + "description": "

Sequence of all st.json elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Json", + "is_generator": false, + "description": "

Sequence of all st.json elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.json[0] for the first element. Json is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L687" + }, + { + "name": "latex", + "signature": "st.testing.v1.latex.latex", + "description": "

Sequence of all st.latex elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Latex", + "is_generator": false, + "description": "

Sequence of all st.latex elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.latex[0] for the first element. Latex is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L701" + }, + { + "name": "main", + "signature": "st.testing.v1.main.main", + "description": "

Sequence of elements within the main body of the app.

", + "args": [], + "returns": [ + { + "type_name": "Block", + "is_generator": false, + "description": "

A container of elements. Block can be queried for elements in the\nsame manner as AppTest. For example, Block.checkbox will\nreturn all st.checkbox within the associated container.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L419" + }, + { + "name": "markdown", + "signature": "st.testing.v1.markdown.markdown", + "description": "

Sequence of all st.markdown elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Markdown", + "is_generator": false, + "description": "

Sequence of all st.markdown elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.markdown[0] for the first element. Markdown is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L715" + }, + { + "name": "metric", + "signature": "st.testing.v1.metric.metric", + "description": "

Sequence of all st.metric elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Metric", + "is_generator": false, + "description": "

Sequence of all st.metric elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.metric[0] for the first element. Metric is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L729" + }, + { + "name": "multiselect", + "signature": "st.testing.v1.multiselect.multiselect", + "description": "

Sequence of all st.multiselect widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Multiselect", + "is_generator": false, + "description": "

Sequence of all st.multiselect widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.multiselect[0] for the first widget or\nat.multiselect(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L743" + }, + { + "name": "number_input", + "signature": "st.testing.v1.number_input.number_input", + "description": "

Sequence of all st.number_input widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of NumberInput", + "is_generator": false, + "description": "

Sequence of all st.number_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.number_input[0] for the first widget or\nat.number_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L757" + }, + { + "name": "radio", + "signature": "st.testing.v1.radio.radio", + "description": "

Sequence of all st.radio widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Radio", + "is_generator": false, + "description": "

Sequence of all st.radio widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.radio[0] for the first widget or\nat.radio(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L771" + }, + { + "name": "select_slider", + "signature": "st.testing.v1.select_slider.select_slider", + "description": "

Sequence of all st.select_slider widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of SelectSlider", + "is_generator": false, + "description": "

Sequence of all st.select_slider widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.select_slider[0] for the first widget or\nat.select_slider(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L785" + }, + { + "name": "selectbox", + "signature": "st.testing.v1.selectbox.selectbox", + "description": "

Sequence of all st.selectbox widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Selectbox", + "is_generator": false, + "description": "

Sequence of all st.selectbox widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.selectbox[0] for the first widget or\nat.selectbox(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L799" + }, + { + "name": "sidebar", + "signature": "st.testing.v1.sidebar.sidebar", + "description": "

Sequence of all elements within st.sidebar.

", + "args": [], + "returns": [ + { + "type_name": "Block", + "is_generator": false, + "description": "

A container of elements. Block can be queried for elements in the\nsame manner as AppTest. For example, Block.checkbox will\nreturn all st.checkbox within the associated container.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L432" + }, + { + "name": "slider", + "signature": "st.testing.v1.slider.slider", + "description": "

Sequence of all st.slider widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Slider", + "is_generator": false, + "description": "

Sequence of all st.slider widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.slider[0] for the first widget or\nat.slider(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L813" + }, + { + "name": "status", + "signature": "st.testing.v1.status.status", + "description": "

Sequence of all st.status elements.

", + "args": [], + "returns": [ + { + "type_name": "Sequence of Status", + "is_generator": false, + "description": "

Sequence of all st.status elements. Individual elements can be\naccessed from a Sequence by index (order on the page). For\nexample, at.status[0] for the first element. Status is an\nextension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L855" + }, + { + "name": "subheader", + "signature": "st.testing.v1.subheader.subheader", + "description": "

Sequence of all st.subheader elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Subheader", + "is_generator": false, + "description": "

Sequence of all st.subheader elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.subheader[0] for the first element. Subheader is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L827" + }, + { + "name": "success", + "signature": "st.testing.v1.success.success", + "description": "

Sequence of all st.success elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Success", + "is_generator": false, + "description": "

Sequence of all st.success elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.success[0] for the first element. Success is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L841" + }, + { + "name": "table", + "signature": "st.testing.v1.table.table", + "description": "

Sequence of all st.table elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Table", + "is_generator": false, + "description": "

Sequence of all st.table elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.table[0] for the first element. Table is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L869" + }, + { + "name": "tabs", + "signature": "st.testing.v1.tabs.tabs", + "description": "

Sequence of all tabs within st.tabs elements.

", + "args": [], + "returns": [ + { + "type_name": "Sequence of Tab", + "is_generator": false, + "description": "

Sequence of all tabs within st.tabs elements. Individual\ntabs can be accessed from an ElementList by index (order on the\npage). For example, at.tabs[0] for the first tab. Tab is an\nextension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L883" + }, + { + "name": "text", + "signature": "st.testing.v1.text.text", + "description": "

Sequence of all st.text elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Text", + "is_generator": false, + "description": "

Sequence of all st.text elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.text[0] for the first element. Text is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L903" + }, + { + "name": "text_area", + "signature": "st.testing.v1.text_area.text_area", + "description": "

Sequence of all st.text_area widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of TextArea", + "is_generator": false, + "description": "

Sequence of all st.text_area widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.text_area[0] for the first widget or\nat.text_area(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L917" + }, + { + "name": "text_input", + "signature": "st.testing.v1.text_input.text_input", + "description": "

Sequence of all st.text_input widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of TextInput", + "is_generator": false, + "description": "

Sequence of all st.text_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.text_input[0] for the first widget or\nat.text_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L931" + }, + { + "name": "time_input", + "signature": "st.testing.v1.time_input.time_input", + "description": "

Sequence of all st.time_input widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of TimeInput", + "is_generator": false, + "description": "

Sequence of all st.time_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.time_input[0] for the first widget or\nat.time_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L945" + }, + { + "name": "title", + "signature": "st.testing.v1.title.title", + "description": "

Sequence of all st.title elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Title", + "is_generator": false, + "description": "

Sequence of all st.title elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.title[0] for the first element. Title is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L959" + }, + { + "name": "toast", + "signature": "st.testing.v1.toast.toast", + "description": "

Sequence of all st.toast elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Toast", + "is_generator": false, + "description": "

Sequence of all st.toast elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.toast[0] for the first element. Toast is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L973" + }, + { + "name": "toggle", + "signature": "st.testing.v1.toggle.toggle", + "description": "

Sequence of all st.toggle widgets.

", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Toggle", + "is_generator": false, + "description": "

Sequence of all st.toggle widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.toggle[0] for the first widget or\nat.toggle(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L987" + }, + { + "name": "warning", + "signature": "st.testing.v1.warning.warning", + "description": "

Sequence of all st.warning elements.

", + "args": [], + "returns": [ + { + "type_name": "ElementList of Warning", + "is_generator": false, + "description": "

Sequence of all st.warning elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.warning[0] for the first element. Warning is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L1001" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L96", + "description": "

A simulated Streamlit app to check the correctness of displayed elements and outputs.

\n

An instance of AppTest simulates a running Streamlit app. This class\nprovides methods to set up, manipulate, and inspect the app contents via\nAPI instead of a browser UI. It can be used to write automated tests of an\napp in various scenarios. These can then be run using a tool like pytest.

\n

AppTest can be initialized by one of three class methods:

\n\n

Once initialized, Session State and widget values can be updated and the\nscript can be run. Unlike an actual live-running Streamlit app, you need to\ncall AppTest.run() explicitly to re-run the app after changing a widget\nvalue. Switching pages also requires an explicit, follow-up call to\nAppTest.run().

\n

AppTest enables developers to build tests on their app as-is, in the\nfamiliar python test format, without major refactoring or abstracting out\nlogic to be tested separately from the UI. Tests can run quickly with very\nlow overhead. A typical pattern is to build a suite of tests for an app\nthat ensure consistent functionality as the app evolves, and run the tests\nlocally and/or in a CI environment like Github Actions.

\n
\n

Note

\n

AppTest only supports testing a single page of an app per\ninstance. For multipage apps, each page will need to be tested\nseparately. No methods exist to programatically switch pages within\nAppTest.

\n
\n", + "args": [ + { + "name": "secrets", + "type_name": "dict[str, Any]", + "is_optional": false, + "description": "

Dictionary of secrets to be used the simulated app. Use dict-like\nsyntax to set secret values for the simulated app.

\n", + "default": null + }, + { + "name": "session_state", + "type_name": "SafeSessionState", + "is_optional": false, + "description": "

Session State for the simulated app. SafeSessionState object supports\nread and write operations as usual for Streamlit apps.

\n", + "default": null + }, + { + "name": "query_params", + "type_name": "dict[str, Any]", + "is_optional": false, + "description": "

Dictionary of query parameters to be used by the simluated app. Use\ndict-like syntax to set query_params values for the simulated app.

\n", + "default": null + } + ], + "returns": [] + }, + "AppTest.button": { + "name": "button", + "signature": "AppTest.button", + "description": "

Sequence of all st.button and st.form_submit_button widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Button", + "is_generator": false, + "description": "

Sequence of all st.button and st.form_submit_button\nwidgets. Individual widgets can be accessed from a WidgetList by\nindex (order on the page) or key. For example, at.button[0] for\nthe first widget or at.button(key="my_key") for a widget with a\ngiven key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L445" + }, + "AppTest.button_group": { + "name": "button_group", + "signature": "AppTest.button_group", + "description": "

Sequence of all st.feedback widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of ButtonGroup", + "is_generator": false, + "description": "

Sequence of all st.feedback widgets. Individual widgets can be\naccessed from a WidgetList by index (order on the page) or key. For\nexample, at.button_group[0] for the first widget or\nat.button_group(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L460" + }, + "AppTest.caption": { + "name": "caption", + "signature": "AppTest.caption", + "description": "

Sequence of all st.caption elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Caption", + "is_generator": false, + "description": "

Sequence of all st.caption elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.caption[0] for the first element. Caption is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L474" + }, + "AppTest.chat_input": { + "name": "chat_input", + "signature": "AppTest.chat_input", + "description": "

Sequence of all st.chat_input widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of ChatInput", + "is_generator": false, + "description": "

Sequence of all st.chat_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.chat_input[0] for the first widget or\nat.chat_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L488" + }, + "AppTest.chat_message": { + "name": "chat_message", + "signature": "AppTest.chat_message", + "description": "

Sequence of all st.chat_message elements.

\n", + "args": [], + "returns": [ + { + "type_name": "Sequence of ChatMessage", + "is_generator": false, + "description": "

Sequence of all st.chat_message elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.chat_message[0] for the first element. ChatMessage\nis an extension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L502" + }, + "AppTest.checkbox": { + "name": "checkbox", + "signature": "AppTest.checkbox", + "description": "

Sequence of all st.checkbox widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Checkbox", + "is_generator": false, + "description": "

Sequence of all st.checkbox widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.checkbox[0] for the first widget or\nat.checkbox(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L516" + }, + "AppTest.code": { + "name": "code", + "signature": "AppTest.code", + "description": "

Sequence of all st.code elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Code", + "is_generator": false, + "description": "

Sequence of all st.code elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.code[0] for the first element. Code is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L530" + }, + "AppTest.color_picker": { + "name": "color_picker", + "signature": "AppTest.color_picker", + "description": "

Sequence of all st.color_picker widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of ColorPicker", + "is_generator": false, + "description": "

Sequence of all st.color_picker widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.color_picker[0] for the first widget or\nat.color_picker(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L544" + }, + "AppTest.columns": { + "name": "columns", + "signature": "AppTest.columns", + "description": "

Sequence of all columns within st.columns elements.

\n

Each column within a single st.columns will be returned as a\nseparate Column in the Sequence.

\n", + "args": [], + "returns": [ + { + "type_name": "Sequence of Column", + "is_generator": false, + "description": "

Sequence of all columns within st.columns elements. Individual\ncolumns can be accessed from an ElementList by index (order on the\npage). For example, at.columns[0] for the first column. Column\nis an extension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L558" + }, + "AppTest.dataframe": { + "name": "dataframe", + "signature": "AppTest.dataframe", + "description": "

Sequence of all st.dataframe elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Dataframe", + "is_generator": false, + "description": "

Sequence of all st.dataframe elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.dataframe[0] for the first element. Dataframe is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L575" + }, + "AppTest.date_input": { + "name": "date_input", + "signature": "AppTest.date_input", + "description": "

Sequence of all st.date_input widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of DateInput", + "is_generator": false, + "description": "

Sequence of all st.date_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.date_input[0] for the first widget or\nat.date_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L589" + }, + "AppTest.divider": { + "name": "divider", + "signature": "AppTest.divider", + "description": "

Sequence of all st.divider elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Divider", + "is_generator": false, + "description": "

Sequence of all st.divider elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.divider[0] for the first element. Divider is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L603" + }, + "AppTest.error": { + "name": "error", + "signature": "AppTest.error", + "description": "

Sequence of all st.error elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Error", + "is_generator": false, + "description": "

Sequence of all st.error elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.error[0] for the first element. Error is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L617" + }, + "AppTest.exception": { + "name": "exception", + "signature": "AppTest.exception", + "description": "

Sequence of all st.exception elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Exception", + "is_generator": false, + "description": "

Sequence of all st.exception elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.exception[0] for the first element. Exception is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L631" + }, + "AppTest.expander": { + "name": "expander", + "signature": "AppTest.expander", + "description": "

Sequence of all st.expander elements.

\n", + "args": [], + "returns": [ + { + "type_name": "Sequence of Expandable", + "is_generator": false, + "description": "

Sequence of all st.expander elements. Individual elements can be\naccessed from a Sequence by index (order on the page). For\nexample, at.expander[0] for the first element. Expandable is an\nextension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L645" + }, + "AppTest.from_file": { + "name": "from_file", + "signature": "AppTest.from_file(cls, script_path, *, default_timeout=3)", + "description": "

Create an instance of AppTest to simulate an app page defined within a file.

\n

This option is most convenient for CI workflows and testing of\npublished apps. The script must be executable on its own and so must\ncontain all necessary imports.

\n", + "args": [ + { + "name": "script_path", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Path to a script file. The path should be absolute or relative to\nthe file calling .from_file.

\n", + "default": null + }, + { + "name": "default_timeout", + "type_name": "float", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Default time in seconds before a script run is timed out. Can be\noverridden for individual .run() calls.

\n", + "default": "time" + } + ], + "returns": [ + { + "type_name": "AppTest", + "is_generator": false, + "description": "

A simulated Streamlit app for testing. The simulated app can be\nexecuted via .run().

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L266" + }, + "AppTest.from_function": { + "name": "from_function", + "signature": "AppTest.from_function(cls, script, *, default_timeout=3, args=None, kwargs=None)", + "description": "

Create an instance of AppTest to simulate an app page defined within a function.

\n

This is similar to AppTest.from_string(), but more convenient to\nwrite with IDE assistance. The script must be executable on its own and\nso must contain all necessary imports.

\n", + "args": [ + { + "name": "script", + "type_name": "Callable", + "is_optional": false, + "is_kwarg_only": false, + "description": "

A function whose body will be used as a script. Must be runnable\nin isolation, so it must include any necessary imports.

\n", + "default": null + }, + { + "name": "default_timeout", + "type_name": "float", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Default time in seconds before a script run is timed out. Can be\noverridden for individual .run() calls.

\n", + "default": "time" + }, + { + "name": "args", + "type_name": "tuple", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional tuple of args to pass to the script function.

\n", + "default": null + }, + { + "name": "kwargs", + "type_name": "dict", + "is_optional": false, + "is_kwarg_only": true, + "description": "

An optional dict of kwargs to pass to the script function.

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "AppTest", + "is_generator": false, + "description": "

A simulated Streamlit app for testing. The simulated app can be\nexecuted via .run().

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L219" + }, + "AppTest.from_string": { + "name": "from_string", + "signature": "AppTest.from_string(cls, script, *, default_timeout=3)", + "description": "

Create an instance of AppTest to simulate an app page defined within a string.

\n

This is useful for testing short scripts that fit comfortably as an\ninline string in the test itself, without having to create a separate\nfile for it. The script must be executable on its own and so must\ncontain all necessary imports.

\n", + "args": [ + { + "name": "script", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

The string contents of the script to be run.

\n", + "default": null + }, + { + "name": "default_timeout", + "type_name": "float", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Default time in seconds before a script run is timed out. Can be\noverridden for individual .run() calls.

\n", + "default": "time" + } + ], + "returns": [ + { + "type_name": "AppTest", + "is_generator": false, + "description": "

A simulated Streamlit app for testing. The simulated app can be\nexecuted via .run().

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L176" + }, + "AppTest.get": { + "name": "get", + "signature": "AppTest.get(element_type)", + "description": "

Get elements or widgets of the specified type.

\n

This method returns the collection of all elements or widgets of\nthe specified type on the current page. Retrieve a specific element by\nusing its index (order on page) or key lookup.

\n", + "args": [ + { + "name": "element_type", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

An element attribute of AppTest. For example, "button",\n"caption", or "chat_input".

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "Sequence of Elements", + "is_generator": false, + "description": "

Sequence of elements of the given type. Individual elements can\nbe accessed from a Sequence by index (order on the page). When\ngetting and element_type that is a widget, individual widgets\ncan be accessed by key. For example, at.get("text")[0] for the\nfirst st.text element or at.get("slider")(key="my_key") for\nthe st.slider widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L1024" + }, + "AppTest.header": { + "name": "header", + "signature": "AppTest.header", + "description": "

Sequence of all st.header elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Header", + "is_generator": false, + "description": "

Sequence of all st.header elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.header[0] for the first element. Header is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L659" + }, + "AppTest.info": { + "name": "info", + "signature": "AppTest.info", + "description": "

Sequence of all st.info elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Info", + "is_generator": false, + "description": "

Sequence of all st.info elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.info[0] for the first element. Info is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L673" + }, + "AppTest.json": { + "name": "json", + "signature": "AppTest.json", + "description": "

Sequence of all st.json elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Json", + "is_generator": false, + "description": "

Sequence of all st.json elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.json[0] for the first element. Json is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L687" + }, + "AppTest.latex": { + "name": "latex", + "signature": "AppTest.latex", + "description": "

Sequence of all st.latex elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Latex", + "is_generator": false, + "description": "

Sequence of all st.latex elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.latex[0] for the first element. Latex is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L701" + }, + "AppTest.main": { + "name": "main", + "signature": "AppTest.main", + "description": "

Sequence of elements within the main body of the app.

\n", + "args": [], + "returns": [ + { + "type_name": "Block", + "is_generator": false, + "description": "

A container of elements. Block can be queried for elements in the\nsame manner as AppTest. For example, Block.checkbox will\nreturn all st.checkbox within the associated container.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L419" + }, + "AppTest.markdown": { + "name": "markdown", + "signature": "AppTest.markdown", + "description": "

Sequence of all st.markdown elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Markdown", + "is_generator": false, + "description": "

Sequence of all st.markdown elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.markdown[0] for the first element. Markdown is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L715" + }, + "AppTest.metric": { + "name": "metric", + "signature": "AppTest.metric", + "description": "

Sequence of all st.metric elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Metric", + "is_generator": false, + "description": "

Sequence of all st.metric elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.metric[0] for the first element. Metric is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L729" + }, + "AppTest.multiselect": { + "name": "multiselect", + "signature": "AppTest.multiselect", + "description": "

Sequence of all st.multiselect widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Multiselect", + "is_generator": false, + "description": "

Sequence of all st.multiselect widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.multiselect[0] for the first widget or\nat.multiselect(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L743" + }, + "AppTest.number_input": { + "name": "number_input", + "signature": "AppTest.number_input", + "description": "

Sequence of all st.number_input widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of NumberInput", + "is_generator": false, + "description": "

Sequence of all st.number_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.number_input[0] for the first widget or\nat.number_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L757" + }, + "AppTest.radio": { + "name": "radio", + "signature": "AppTest.radio", + "description": "

Sequence of all st.radio widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Radio", + "is_generator": false, + "description": "

Sequence of all st.radio widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.radio[0] for the first widget or\nat.radio(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L771" + }, + "AppTest.run": { + "name": "run", + "signature": "AppTest.run(*, timeout=None)", + "description": "

Run the script from the current state.

\n

This is equivalent to manually rerunning the app or the rerun that\noccurs upon user interaction. AppTest.run() must be manually called\nafter updating a widget value or switching pages as script reruns do\nnot occur automatically as they do for live-running Streamlit apps.

\n", + "args": [ + { + "name": "timeout", + "type_name": "float or None", + "is_optional": false, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. If timeout is\nNone (default), Streamlit uses the default timeout set for the\ninstance of AppTest.

\n", + "default": "timeout" + } + ], + "returns": [ + { + "type_name": "AppTest", + "is_generator": false, + "description": "

self

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L368" + }, + "AppTest.select_slider": { + "name": "select_slider", + "signature": "AppTest.select_slider", + "description": "

Sequence of all st.select_slider widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of SelectSlider", + "is_generator": false, + "description": "

Sequence of all st.select_slider widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.select_slider[0] for the first widget or\nat.select_slider(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L785" + }, + "AppTest.selectbox": { + "name": "selectbox", + "signature": "AppTest.selectbox", + "description": "

Sequence of all st.selectbox widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Selectbox", + "is_generator": false, + "description": "

Sequence of all st.selectbox widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.selectbox[0] for the first widget or\nat.selectbox(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L799" + }, + "AppTest.sidebar": { + "name": "sidebar", + "signature": "AppTest.sidebar", + "description": "

Sequence of all elements within st.sidebar.

\n", + "args": [], + "returns": [ + { + "type_name": "Block", + "is_generator": false, + "description": "

A container of elements. Block can be queried for elements in the\nsame manner as AppTest. For example, Block.checkbox will\nreturn all st.checkbox within the associated container.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L432" + }, + "AppTest.slider": { + "name": "slider", + "signature": "AppTest.slider", + "description": "

Sequence of all st.slider widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Slider", + "is_generator": false, + "description": "

Sequence of all st.slider widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.slider[0] for the first widget or\nat.slider(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L813" + }, + "AppTest.status": { + "name": "status", + "signature": "AppTest.status", + "description": "

Sequence of all st.status elements.

\n", + "args": [], + "returns": [ + { + "type_name": "Sequence of Status", + "is_generator": false, + "description": "

Sequence of all st.status elements. Individual elements can be\naccessed from a Sequence by index (order on the page). For\nexample, at.status[0] for the first element. Status is an\nextension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L855" + }, + "AppTest.subheader": { + "name": "subheader", + "signature": "AppTest.subheader", + "description": "

Sequence of all st.subheader elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Subheader", + "is_generator": false, + "description": "

Sequence of all st.subheader elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.subheader[0] for the first element. Subheader is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L827" + }, + "AppTest.success": { + "name": "success", + "signature": "AppTest.success", + "description": "

Sequence of all st.success elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Success", + "is_generator": false, + "description": "

Sequence of all st.success elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.success[0] for the first element. Success is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L841" + }, + "AppTest.switch_page": { + "name": "switch_page", + "signature": "AppTest.switch_page(page_path)", + "description": "

Switch to another page of the app.

\n

This method does not automatically rerun the app. Use a follow-up call\nto AppTest.run() to obtain the elements on the selected page.

\n", + "args": [ + { + "name": "page_path", + "type_name": "str", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Path of the page to switch to. The path must be relative to the\nmain script's location (e.g. "pages/my_page.py").

\n", + "default": null + } + ], + "returns": [ + { + "type_name": "AppTest", + "is_generator": false, + "description": "

self

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L391" + }, + "AppTest.table": { + "name": "table", + "signature": "AppTest.table", + "description": "

Sequence of all st.table elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Table", + "is_generator": false, + "description": "

Sequence of all st.table elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.table[0] for the first element. Table is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L869" + }, + "AppTest.tabs": { + "name": "tabs", + "signature": "AppTest.tabs", + "description": "

Sequence of all tabs within st.tabs elements.

\n

Each tab within a single st.tabs will be returned as a separate Tab\nin the Sequence. Additionally, the tab labels are forwarded to each\nTab element as a property. For example, st.tabs("A","B") will\nyield two Tab objects, with Tab.label returning "A" and "B",\nrespectively.

\n", + "args": [], + "returns": [ + { + "type_name": "Sequence of Tab", + "is_generator": false, + "description": "

Sequence of all tabs within st.tabs elements. Individual\ntabs can be accessed from an ElementList by index (order on the\npage). For example, at.tabs[0] for the first tab. Tab is an\nextension of the Block class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L883" + }, + "AppTest.text": { + "name": "text", + "signature": "AppTest.text", + "description": "

Sequence of all st.text elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Text", + "is_generator": false, + "description": "

Sequence of all st.text elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.text[0] for the first element. Text is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L903" + }, + "AppTest.text_area": { + "name": "text_area", + "signature": "AppTest.text_area", + "description": "

Sequence of all st.text_area widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of TextArea", + "is_generator": false, + "description": "

Sequence of all st.text_area widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.text_area[0] for the first widget or\nat.text_area(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L917" + }, + "AppTest.text_input": { + "name": "text_input", + "signature": "AppTest.text_input", + "description": "

Sequence of all st.text_input widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of TextInput", + "is_generator": false, + "description": "

Sequence of all st.text_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.text_input[0] for the first widget or\nat.text_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L931" + }, + "AppTest.time_input": { + "name": "time_input", + "signature": "AppTest.time_input", + "description": "

Sequence of all st.time_input widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of TimeInput", + "is_generator": false, + "description": "

Sequence of all st.time_input widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.time_input[0] for the first widget or\nat.time_input(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L945" + }, + "AppTest.title": { + "name": "title", + "signature": "AppTest.title", + "description": "

Sequence of all st.title elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Title", + "is_generator": false, + "description": "

Sequence of all st.title elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.title[0] for the first element. Title is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L959" + }, + "AppTest.toast": { + "name": "toast", + "signature": "AppTest.toast", + "description": "

Sequence of all st.toast elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Toast", + "is_generator": false, + "description": "

Sequence of all st.toast elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.toast[0] for the first element. Toast is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L973" + }, + "AppTest.toggle": { + "name": "toggle", + "signature": "AppTest.toggle", + "description": "

Sequence of all st.toggle widgets.

\n", + "args": [], + "returns": [ + { + "type_name": "WidgetList of Toggle", + "is_generator": false, + "description": "

Sequence of all st.toggle widgets. Individual widgets can\nbe accessed from a WidgetList by index (order on the page) or key.\nFor example, at.toggle[0] for the first widget or\nat.toggle(key="my_key") for a widget with a given key.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L987" + }, + "AppTest.warning": { + "name": "warning", + "signature": "AppTest.warning", + "description": "

Sequence of all st.warning elements.

\n", + "args": [], + "returns": [ + { + "type_name": "ElementList of Warning", + "is_generator": false, + "description": "

Sequence of all st.warning elements. Individual elements can be\naccessed from an ElementList by index (order on the page). For\nexample, at.warning[0] for the first element. Warning is an\nextension of the Element class.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/app_test.py#L1001" + }, + "streamlit.testing.v1.element_tree.Button": { + "name": "Button", + "signature": "st.testing.v1.element_tree.Button(proto, root)", + "is_class": true, + "methods": [ + { + "name": "click", + "signature": "st.testing.v1.element_tree.click.click()", + "description": "

Set the value of the button to True.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L341" + }, + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the button.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L336" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The value of the button. (bool)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L326" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L303", + "description": "

A representation of st.button and st.form_submit_button.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.ButtonGroup": { + "name": "ButtonGroup", + "signature": "st.testing.v1.element_tree.ButtonGroup(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "select", + "signature": "st.testing.v1.element_tree.select.select(v)", + "description": "

Add a selection to the widget. Do nothing if the value is already selected. If testing a multiselect widget with repeated options, use set_value instead.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L751" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the multiselect widget. (list)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L745" + }, + { + "name": "unselect", + "signature": "st.testing.v1.element_tree.unselect.unselect(v)", + "description": "

Remove a selection from the widget. Do nothing if the value is not already selected. If a value is selected multiple times, the first instance is removed.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L766" + } + ], + "properties": [ + { + "name": "format_func", + "signature": "st.testing.v1.element_tree.format_func.format_func", + "description": "

The widget's formatting function for displaying options. (callable)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L739" + }, + { + "name": "indices", + "signature": "st.testing.v1.element_tree.indices.indices", + "description": "

The indices of the currently selected values from the options. (list)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L734" + }, + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The currently selected values from the options. (list)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L724" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L698", + "description": "

A representation of button_group that is used by st.feedback.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.ChatInput": { + "name": "ChatInput", + "signature": "st.testing.v1.element_tree.ChatInput(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L358" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The value of the widget. (str)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L371" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L346", + "description": "

A representation of st.chat_input.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.Checkbox": { + "name": "Checkbox", + "signature": "st.testing.v1.element_tree.Checkbox(proto, root)", + "is_class": true, + "methods": [ + { + "name": "check", + "signature": "st.testing.v1.element_tree.check.check()", + "description": "

Set the value of the widget to True.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L419" + }, + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L414" + }, + { + "name": "uncheck", + "signature": "st.testing.v1.element_tree.uncheck.uncheck()", + "description": "

Set the value of the widget to False.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L423" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The value of the widget. (bool)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L404" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L382", + "description": "

A representation of st.checkbox.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.ColorPicker": { + "name": "ColorPicker", + "signature": "st.testing.v1.element_tree.ColorPicker(proto, root)", + "is_class": true, + "methods": [ + { + "name": "pick", + "signature": "st.testing.v1.element_tree.pick.pick(v)", + "description": "

Set the value of the widget as a hex string. May omit the "#" prefix.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L491" + }, + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the widget as a hex string.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L486" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The currently selected value as a hex string. (str)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L465" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L450", + "description": "

A representation of st.color_picker.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.DateInput": { + "name": "DateInput", + "signature": "st.testing.v1.element_tree.DateInput(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L537" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The value of the widget. (date or Tuple of date)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L551" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L517", + "description": "

A representation of st.date_input.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.Element": { + "name": "Element", + "signature": "st.testing.v1.element_tree.Element(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The value or contents of the element.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L134" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L105", + "description": "

Element base class for testing.

\n

This class's methods and attributes are universal for all elements\nimplemented in testing. For example, Caption, Code, Text, and\nTitle inherit from Element. All widget classes also\ninherit from Element, but have additional methods specific to each\nwidget type. See the AppTest class for the full list of supported\nelements.

\n

For all element classes, parameters of the original element can be obtained\nas properties. For example, Button.label, Caption.help, and\nToast.icon.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.Multiselect": { + "name": "Multiselect", + "signature": "st.testing.v1.element_tree.Multiselect(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "select", + "signature": "st.testing.v1.element_tree.select.select(v)", + "description": "

Add a selection to the widget. Do nothing if the value is already selected. If testing a multiselect widget with repeated options, use set_value instead.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L839" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the multiselect widget. (list)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L833" + }, + { + "name": "unselect", + "signature": "st.testing.v1.element_tree.unselect.unselect(v)", + "description": "

Remove a selection from the widget. Do nothing if the value is not already selected. If a value is selected multiple times, the first instance is removed.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L854" + } + ], + "properties": [ + { + "name": "format_func", + "signature": "st.testing.v1.element_tree.format_func.format_func", + "description": "

The widget's formatting function for displaying options. (callable)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L827" + }, + { + "name": "indices", + "signature": "st.testing.v1.element_tree.indices.indices", + "description": "

The indices of the currently selected values from the options. (list)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L822" + }, + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The currently selected values from the options. (list)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L812" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L783", + "description": "

A representation of st.multiselect.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.NumberInput": { + "name": "NumberInput", + "signature": "st.testing.v1.element_tree.NumberInput(proto, root)", + "is_class": true, + "methods": [ + { + "name": "decrement", + "signature": "st.testing.v1.element_tree.decrement.decrement()", + "description": "

Decrement the st.number_input widget as if the user clicked "-".

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L927" + }, + { + "name": "increment", + "signature": "st.testing.v1.element_tree.increment.increment()", + "description": "

Increment the st.number_input widget as if the user clicked "+".

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L919" + }, + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the st.number_input widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L894" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

Get the current value of the st.number_input widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L907" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L874", + "description": "

A representation of st.number_input.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.Radio": { + "name": "Radio", + "signature": "st.testing.v1.element_tree.Radio(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the selection by value.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L978" + } + ], + "properties": [ + { + "name": "format_func", + "signature": "st.testing.v1.element_tree.format_func.format_func", + "description": "

The widget's formatting function for displaying options. (callable)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L972" + }, + { + "name": "index", + "signature": "st.testing.v1.element_tree.index.index", + "description": "

The index of the current selection. (int)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L955" + }, + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The currently selected value from the options. (Any)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L962" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L936", + "description": "

A representation of st.radio.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.SelectSlider": { + "name": "SelectSlider", + "signature": "st.testing.v1.element_tree.SelectSlider(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_range", + "signature": "st.testing.v1.element_tree.set_range.set_range(lower, upper)", + "description": "

Set the ranged selection by values.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1124" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the (single) selection by value.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1086" + } + ], + "properties": [ + { + "name": "format_func", + "signature": "st.testing.v1.element_tree.format_func.format_func", + "description": "

The widget's formatting function for displaying options. (callable)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1118" + }, + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The currently selected value or range. (Any or Sequence of Any)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1107" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1068", + "description": "

A representation of st.select_slider.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.Selectbox": { + "name": "Selectbox", + "signature": "st.testing.v1.element_tree.Selectbox(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "select", + "signature": "st.testing.v1.element_tree.select.select(v)", + "description": "

Set the selection by value.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1045" + }, + { + "name": "select_index", + "signature": "st.testing.v1.element_tree.select_index.select_index(index)", + "description": "

Set the selection by index.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1049" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the selection by value.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1040" + } + ], + "properties": [ + { + "name": "format_func", + "signature": "st.testing.v1.element_tree.format_func.format_func", + "description": "

The widget's formatting function for displaying options. (callable)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1034" + }, + { + "name": "index", + "signature": "st.testing.v1.element_tree.index.index", + "description": "

The index of the current selection. (int)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1014" + }, + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The currently selected value from the options. (Any)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1024" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L996", + "description": "

A representation of st.selectbox.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.Slider": { + "name": "Slider", + "signature": "st.testing.v1.element_tree.Slider(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_range", + "signature": "st.testing.v1.element_tree.set_range.set_range(lower, upper)", + "description": "

Set the ranged value of the slider.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1177" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the (single) value of the slider.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1148" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The currently selected value or range. (Any or Sequence of Any)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1166" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1129", + "description": "

A representation of st.slider.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.TextArea": { + "name": "TextArea", + "signature": "st.testing.v1.element_tree.TextArea(proto, root)", + "is_class": true, + "methods": [ + { + "name": "input", + "signature": "st.testing.v1.element_tree.input.input(v)", + "description": "

Set the value of the widget only if the value does not exceed the maximum allowed characters.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1258" + }, + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1234" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The current value of the widget. (str)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1247" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1216", + "description": "

A representation of st.text_area.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.TextInput": { + "name": "TextInput", + "signature": "st.testing.v1.element_tree.TextInput(proto, root)", + "is_class": true, + "methods": [ + { + "name": "input", + "signature": "st.testing.v1.element_tree.input.input(v)", + "description": "

Set the value of the widget only if the value does not exceed the maximum allowed characters.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1311" + }, + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1287" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The current value of the widget. (str)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1300" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1269", + "description": "

A representation of st.text_input.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.TimeInput": { + "name": "TimeInput", + "signature": "st.testing.v1.element_tree.TimeInput(proto, root)", + "is_class": true, + "methods": [ + { + "name": "decrement", + "signature": "st.testing.v1.element_tree.decrement.decrement()", + "description": "

Select the previous available time.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1376" + }, + { + "name": "increment", + "signature": "st.testing.v1.element_tree.increment.increment()", + "description": "

Select the next available time.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1369" + }, + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1341" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The current value of the widget. (time)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1357" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1325", + "description": "

A representation of st.time_input.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.Toggle": { + "name": "Toggle", + "signature": "st.testing.v1.element_tree.Toggle(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1433" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The current value of the widget. (bool)

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1423" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L1400", + "description": "

A representation of st.toggle.

\n", + "args": [], + "returns": [] + }, + "streamlit.testing.v1.element_tree.Widget": { + "name": "Widget", + "signature": "st.testing.v1.element_tree.Widget(proto, root)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": "st.testing.v1.element_tree.run.run(*, timeout=None)", + "description": "

Run the AppTest script which contains the element.

", + "args": [ + { + "name": "timeout", + "type_name": null, + "is_optional": null, + "is_kwarg_only": true, + "description": "

The maximum number of seconds to run the script. None means\nuse the AppTest's default.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L144" + }, + { + "name": "set_value", + "signature": "st.testing.v1.element_tree.set_value.set_value(v)", + "description": "

Set the value of the widget.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L195" + } + ], + "properties": [ + { + "name": "value", + "signature": "st.testing.v1.element_tree.value.value", + "description": "

The value or contents of the element.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L134" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/testing/v1/element_tree.py#L180", + "description": "

Widget base class for testing.

\n", + "args": [], + "returns": [] + }, + "streamlit.experimental_user.to_dict": { + "name": "experimental_user.to_dict", + "signature": "st.experimental_user.to_dict()", + "description": "

Get user info as a dictionary.

\n

This method primarily exists for internal use and is not needed for\nmost cases. st.experimental_user returns an object that inherits from\ndict by default.

\n", + "args": [], + "returns": [ + { + "type_name": "Dict[str,str]", + "is_generator": false, + "description": "

A dictionary of the current user's information.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/user_info.py#L84" + }, + "context.cookies": { + "name": "cookies", + "signature": "context.cookies", + "examples": "
\n

Show a dictionary of cookies:

\n
\nimport streamlit as st\n\nst.context.cookies\n
\n

Show the value of a specific cookie:

\n
\nimport streamlit as st\n\nst.context.cookies["_ga"]\n
\n
\n", + "description": "

A read-only, dict-like object containing cookies sent in the initial request.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/context.py#L177" + }, + "context.headers": { + "name": "headers", + "signature": "context.headers", + "examples": "
\n

Show a dictionary of headers (with only the last instance of any\nrepeated key):

\n
\nimport streamlit as st\n\nst.context.headers\n
\n

Show the value of a specific header (or the last instance if it's\nrepeated):

\n
\nimport streamlit as st\n\nst.context.headers["host"]\n
\n

Show of list of all headers for a given key:

\n
\nimport streamlit as st\n\nst.context.headers.get_all("pragma")\n
\n
\n", + "description": "

A read-only, dict-like object containing headers sent in the initial request.

\n

Keys are case-insensitive and may be repeated. When keys are repeated,\ndict-like methods will only return the last instance of each key. Use\n.get_all(key="your_repeated_key") to see all values if the same\nheader is set multiple times.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/context.py#L135" + }, + "CachedFunc.clear": { + "name": "clear", + "signature": "CachedFunc.clear(*args, **kwargs)", + "example": "
\n
\nimport streamlit as st\nimport time\n\n@st.cache_data\ndef foo(bar):\n    time.sleep(2)\n    st.write(f"Executed foo({bar}).")\n    return bar\n\nif st.button("Clear all cached values for `foo`", on_click=foo.clear):\n    foo.clear()\n\nif st.button("Clear the cached value of `foo(1)`"):\n    foo.clear(1)\n\nfoo(1)\nfoo(2)\n
\n
\n", + "description": "

Clear the cached function's associated cache.

\n

If no arguments are passed, Streamlit will clear all values cached for\nthe function. If arguments are passed, Streamlit will clear the cached\nvalue for these arguments only.

\n", + "args": [ + { + "name": "*args", + "type_name": "Any", + "is_optional": false, + "is_kwarg_only": false, + "description": "

Arguments of the cached functions.

\n", + "default": null + }, + { + "name": "**kwargs", + "type_name": "Any", + "is_optional": false, + "is_kwarg_only": true, + "description": "

Keyword arguments of the cached function.

\n", + "default": null + } + ], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/caching/cache_utils.py#L306" + }, + "StreamlitPage": { + "name": "StreamlitPage", + "signature": "StreamlitPage(page, *, title=None, icon=None, url_path=None, default=False)", + "is_class": true, + "methods": [ + { + "name": "run", + "signature": ".run.run()", + "description": "

Execute the page.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L259" + } + ], + "properties": [ + { + "name": "icon", + "signature": ".icon.icon", + "description": "

The icon of the page.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L236" + }, + { + "name": "title", + "signature": ".title.title", + "description": "

The title of the page.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L225" + }, + { + "name": "url_path", + "signature": ".url_path.url_path", + "description": "

The page's URL pathname, which is the path relative to the app's root URL.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L244" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L132", + "description": "

A page within a multipage Streamlit app.

\n

Use st.Page to initialize a StreamlitPage object.

\n", + "args": [ + { + "name": "icon", + "type_name": "str", + "is_optional": false, + "description": "

The icon of the page.

\n

If no icon was declared in st.Page, this property returns "".

\n", + "default": null + }, + { + "name": "title", + "type_name": "str", + "is_optional": false, + "description": "

The title of the page.

\n

Unless declared otherwise in st.Page, the page title is inferred\nfrom the filename or callable name. For more information, see\nOverview of multipage apps.

\n", + "default": null + }, + { + "name": "url_path", + "type_name": "str", + "is_optional": false, + "description": "

The page's URL pathname, which is the path relative to the app's root\nURL.

\n

Unless declared otherwise in st.Page, the URL pathname is inferred\nfrom the filename or callable name. For more information, see\nOverview of multipage apps.

\n

The default page will always have a url_path of "" to indicate\nthe root URL (e.g. homepage).

\n", + "default": "page" + } + ], + "returns": [] + }, + "StreamlitPage.icon": { + "name": "icon", + "signature": "StreamlitPage.icon", + "description": "

The icon of the page.

\n

If no icon was declared in st.Page, this property returns "".

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L236" + }, + "StreamlitPage.run": { + "name": "run", + "signature": "StreamlitPage.run()", + "description": "

Execute the page.

\n

When a page is returned by st.navigation, use the .run() method\nwithin your entrypoint file to render the page. You can only call this\nmethod on the page returned by st.navigation. You can only call\nthis method once per run of your entrypoint file.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L259" + }, + "StreamlitPage.title": { + "name": "title", + "signature": "StreamlitPage.title", + "description": "

The title of the page.

\n

Unless declared otherwise in st.Page, the page title is inferred\nfrom the filename or callable name. For more information, see\nOverview of multipage apps.

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L225" + }, + "StreamlitPage.url_path": { + "name": "url_path", + "signature": "StreamlitPage.url_path", + "description": "

The page's URL pathname, which is the path relative to the app's root URL.

\n

Unless declared otherwise in st.Page, the URL pathname is inferred\nfrom the filename or callable name. For more information, see\nOverview of multipage apps.

\n

The default page will always have a url_path of "" to indicate\nthe root URL (e.g. homepage).

\n", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/navigation/page.py#L244" + }, + "streamlit.experimental_user": { + "name": "experimental_user", + "signature": "st.experimental_user()", + "is_class": true, + "methods": [ + { + "name": "to_dict", + "signature": "st.to_dict.to_dict()", + "description": "

Get user info as a dictionary.

", + "args": [], + "returns": [ + { + "type_name": "Dict[str,str]", + "is_generator": false, + "description": "

A dictionary of the current user's information.

\n", + "return_name": null + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/user_info.py#L84" + } + ], + "properties": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/user_info.py#L34", + "description": "

A read-only, dict-like object for accessing information about current user.

\n

st.experimental_user is dependant on the host platform running the\nStreamlit app. If the host platform has not configured the function, it\nwill behave as it does in a locally running app.

\n

Properties can by accessed via key or attribute notation. For example,\nst.experimental_user["email"] or st.experimental_user.email.

\n", + "args": [ + { + "name": "email", + "type_name": "str", + "is_optional": false, + "description": "

If running locally, this property returns the string literal\n"test@example.com".

\n

If running on Streamlit Community Cloud, this\nproperty returns one of two values:

\n
    \n
  • None if the user is not logged in or not a member of the app's workspace. Such users appear under anonymous pseudonyms in the app's analytics.
    • \n
  • The user's email if the the user is logged in and a member of the app's workspace. Such users are identified by their email in the app's analytics.
    • \n
\n", + "default": null + } + ], + "returns": [] + }, + "streamlit.context": { + "name": "context", + "signature": "st.context()", + "is_class": true, + "methods": [], + "properties": [ + { + "name": "cookies", + "signature": "st.cookies.cookies", + "examples": "
\n

Show a dictionary of cookies:

\n
\nimport streamlit as st\n\nst.context.cookies\n
\n

Show the value of a specific cookie:

\n
\nimport streamlit as st\n\nst.context.cookies["_ga"]\n
\n
\n", + "description": "

A read-only, dict-like object containing cookies sent in the initial request.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/context.py#L177" + }, + { + "name": "headers", + "signature": "st.headers.headers", + "examples": "
\n

Show a dictionary of headers (with only the last instance of any\nrepeated key):

\n
\nimport streamlit as st\n\nst.context.headers\n
\n

Show the value of a specific header (or the last instance if it's\nrepeated):

\n
\nimport streamlit as st\n\nst.context.headers["host"]\n
\n

Show of list of all headers for a given key:

\n
\nimport streamlit as st\n\nst.context.headers.get_all("pragma")\n
\n
\n", + "description": "

A read-only, dict-like object containing headers sent in the initial request.

", + "args": [], + "returns": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/context.py#L135" + } + ], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/runtime/context.py#L124", + "description": "

An interface to access user session context.

\n

st.context provides a read-only interface to access headers and cookies\nfor the current user session.

\n

Each property (st.context.headers and st.context.cookies) returns\na dictionary of named values.

\n", + "args": [], + "returns": [] + }, + "PlotlyState": { + "name": "PlotlyState", + "signature": "PlotlyState", + "is_class": true, + "methods": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/plotly_chart.py#L170", + "example": "

Try selecting points by any of the three available methods (direct click,\nbox, or lasso). The current selection state is available through Session\nState or as the output of the chart function.

\n
\nimport streamlit as st\nimport plotly.express as px\n\ndf = px.data.iris()  # iris is a pandas DataFrame\nfig = px.scatter(df, x="sepal_width", y="sepal_length")\n\nevent = st.plotly_chart(fig, key="iris", on_select="rerun")\n\nevent\n
\n", + "description": "

The schema for the Plotly chart event state.

\n

The event state is stored in a dictionary-like object that suports both\nkey and attribute notation. Event states cannot be programmatically\nchanged or set through Session State.

\n

Only selection events are supported at this time.

\n", + "args": [ + { + "name": "selection", + "type_name": "dict", + "is_optional": false, + "description": "

The state of the on_select event. This attribure returns a\ndictionary-like object that supports both key and attribute notation.\nThe attributes are described by the PlotlySelectionState dictionary\nschema.

\n", + "default": null + } + ], + "returns": [], + "is_attribute_dict": true + }, + "PlotlySelectionState": { + "name": "PlotlySelectionState", + "signature": "PlotlySelectionState", + "is_class": true, + "methods": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/plotly_chart.py#L82", + "example": "

When working with more complicated graphs, the points attribute\ndisplays additional information. Try selecting points in the following\nexample:

\n
\nimport streamlit as st\nimport plotly.express as px\n\ndf = px.data.iris()\nfig = px.scatter(\n    df,\n    x="sepal_width",\n    y="sepal_length",\n    color="species",\n    size="petal_length",\n    hover_data=["petal_width"],\n)\n\nevent = st.plotly_chart(fig, key="iris", on_select="rerun")\n\nevent.selection\n
\n

This is an example of the selection state when selecting a single point:

\n
\n{\n  "points": [\n    {\n      "curve_number": 2,\n      "point_number": 9,\n      "point_index": 9,\n      "x": 3.6,\n      "y": 7.2,\n      "customdata": [\n        2.5\n      ],\n      "marker_size": 6.1,\n      "legendgroup": "virginica"\n    }\n  ],\n  "point_indices": [\n    9\n  ],\n  "box": [],\n  "lasso": []\n}\n
\n", + "description": "

The schema for the Plotly chart selection state.

\n

The selection state is stored in a dictionary-like object that suports both\nkey and attribute notation. Selection states cannot be programmatically\nchanged or set through Session State.

\n", + "args": [ + { + "name": "points", + "type_name": "list[dict[str, Any]]", + "is_optional": false, + "description": "

The selected data points in the chart, including the data points\nselected by the box and lasso mode. The data includes the values\nassociated to each point and a point index used to populate\npoint_indices. If additional information has been assigned to your\npoints, such as size or legend group, this is also included.

\n", + "default": null + }, + { + "name": "point_indices", + "type_name": "list[int]", + "is_optional": false, + "description": "

The numerical indices of all selected data points in the chart. The\ndetails of each identified point are included in points.

\n", + "default": null + }, + { + "name": "box", + "type_name": "list[dict[str, Any]]", + "is_optional": false, + "description": "

The metadata related to the box selection. This includes the\ncoordinates of the selected area.

\n", + "default": null + }, + { + "name": "lasso", + "type_name": "list[dict[str, Any]]", + "is_optional": false, + "description": "

The metadata related to the lasso selection. This includes the\ncoordinates of the selected area.

\n", + "default": null + } + ], + "returns": [], + "is_attribute_dict": true + }, + "VegaLiteState": { + "name": "VegaLiteState", + "signature": "VegaLiteState", + "is_class": true, + "methods": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/vega_charts.py#L100", + "examples": "

The following two examples have equivalent definitions. Each one has a\npoint and interval selection parameter include in the chart definition.\nThe point seleciton parameter is named "point_selection". The interval\nor box selection parameter is named "interval_selection".

\n

The follow example uses st.altair_chart:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\nimport altair as alt\n\nif "data" not in st.session_state:\n    st.session_state.data = pd.DataFrame(\n        np.random.randn(20, 3), columns=["a", "b", "c"]\n    )\ndf = st.session_state.data\n\npoint_selector = alt.selection_point("point_selection")\ninterval_selector = alt.selection_interval("interval_selection")\nchart = (\n    alt.Chart(df)\n    .mark_circle()\n    .encode(\n        x="a",\n        y="b",\n        size="c",\n        color="c",\n        tooltip=["a", "b", "c"],\n        fillOpacity=alt.condition(point_selector, alt.value(1), alt.value(0.3)),\n    )\n    .add_params(point_selector, interval_selector)\n)\n\nevent = st.altair_chart(chart, key="alt_chart", on_select="rerun")\n\nevent\n
\n

The following example uses st.vega_lite_chart:

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nif "data" not in st.session_state:\n    st.session_state.data = pd.DataFrame(\n        np.random.randn(20, 3), columns=["a", "b", "c"]\n    )\n\nspec = {\n    "mark": {"type": "circle", "tooltip": True},\n    "params": [\n        {"name": "interval_selection", "select": "interval"},\n        {"name": "point_selection", "select": "point"},\n    ],\n    "encoding": {\n        "x": {"field": "a", "type": "quantitative"},\n        "y": {"field": "b", "type": "quantitative"},\n        "size": {"field": "c", "type": "quantitative"},\n        "color": {"field": "c", "type": "quantitative"},\n        "fillOpacity": {\n            "condition": {"param": "point_selection", "value": 1},\n            "value": 0.3,\n        },\n    },\n}\n\nevent = st.vega_lite_chart(\n    st.session_state.data, spec, key="vega_chart", on_select="rerun"\n)\n\nevent\n
\n

Try selecting points in this interactive example. When you click a point,\nthe selection will appear under the attribute, "point_selection", which\nis the name given to the point selection parameter. Similarly, when you\nmake an interval selection, it will appear under the attribute\n"interval_selection". You can give your selection parameters other\nnames if desired.

\n

If you hold Shift while selecting points, existing point selections\nwill be preserved. Interval selections are not preserved when making\nadditional selections.

\n", + "description": "

The schema for the Vega-Lite event state.

\n

The event state is stored in a dictionary-like object that suports both\nkey and attribute notation. Event states cannot be programmatically\nchanged or set through Session State.

\n

Only selection events are supported at this time.

\n", + "args": [ + { + "name": "selection", + "type_name": "dict", + "is_optional": false, + "description": "

The state of the on_select event. This attribure returns a\ndictionary-like object that supports both key and attribute notation.\nThe name of each Vega-Lite selection parameter becomes an attribute in\nthe selection dictionary. The format of the data within each\nattribute is determined by the selection parameter definition within\nVega-Lite.

\n", + "default": null + } + ], + "returns": [], + "is_attribute_dict": true + }, + "DataframeState": { + "name": "DataframeState", + "signature": "DataframeState", + "is_class": true, + "methods": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/arrow.py#L125", + "description": "

The schema for the dataframe event state.

\n

The event state is stored in a dictionary-like object that suports both\nkey and attribute notation. Event states cannot be programmatically\nchanged or set through Session State.

\n

Only selection events are supported at this time.

\n", + "args": [ + { + "name": "selection", + "type_name": "dict", + "is_optional": false, + "description": "

The state of the on_select event. This attribure returns a\ndictionary-like object that supports both key and attribute notation.\nThe attributes are described by the DataframeSelectionState\ndictionary schema.

\n", + "default": null + } + ], + "returns": [], + "is_attribute_dict": true + }, + "DataframeSelectionState": { + "name": "DataframeSelectionState", + "signature": "DataframeSelectionState", + "is_class": true, + "methods": [], + "source": "https://github.com/streamlit/streamlit/blob/1.37.0/lib/streamlit/elements/arrow.py#L67", + "example": "

The following example has multi-row and multi-column selections enabled.\nTry selecting some rows. To select multiple columns, hold Ctrl while\nselecting columns. Hold Shift to select a range of columns.

\n
\nimport streamlit as st\nimport pandas as pd\nimport numpy as np\n\nif "df" not in st.session_state:\n    st.session_state.df = pd.DataFrame(\n        np.random.randn(12, 5), columns=["a", "b", "c", "d", "e"]\n    )\n\nevent = st.dataframe(\n    st.session_state.df,\n    key="data",\n    on_select="rerun",\n    selection_mode=["multi-row", "multi-column"],\n)\n\nevent.selection\n
\n", + "description": "

The schema for the dataframe selection state.

\n

The selection state is stored in a dictionary-like object that suports both\nkey and attribute notation. Selection states cannot be programmatically\nchanged or set through Session State.

\n
\n

Warning

\n

If a user sorts a dataframe, row selections will be reset. If your\nusers need to sort and filter the dataframe to make selections, direct\nthem to use the search function in the dataframe toolbar instead.

\n
\n", + "args": [ + { + "name": "rows", + "type_name": "list[int]", + "is_optional": false, + "description": "

The selected rows, identified by their integer position. The integer\npositions match the original dataframe, even if the user sorts the\ndataframe in their browser. For a pandas.DataFrame, you can\nretrieve data from its interger position using methods like .iloc[]\nor .iat[].

\n", + "default": null + }, + { + "name": "columns", + "type_name": "list[str]", + "is_optional": false, + "description": "

The selected columns, identified by their names.

\n", + "default": null + } + ], + "returns": [], + "is_attribute_dict": true + } } } diff --git a/python/tutorial-source/llm-18-lines-of-code/requirements.txt b/python/tutorial-source/llm-18-lines-of-code/requirements.txt index c03758250..9ff083e81 100644 --- a/python/tutorial-source/llm-18-lines-of-code/requirements.txt +++ b/python/tutorial-source/llm-18-lines-of-code/requirements.txt @@ -1,3 +1,3 @@ -streamlit>=1.36.0 +streamlit>=1.37.0 openai langchain