こんにちは、JS2IIUです。
StreamlitでWebアプリを開発する際、重要なメッセージを分かりやすく伝えたい場合がありますよね？Streamlitには、メッセージを強調するための便利なメソッドが用意されています。いくつか紹介していきます。今回もよろしくお願いします。
Simple callout message
それが、st.success()、st.info()、st.warning()、st.error()、st.exception()です。
これらのメソッドを使うことで、メッセージの種類に応じて色分けやアイコンを表示し、ユーザーに視覚的に情報を伝えることができます。
今回は、それぞれのメソッドの機能と使い方、そしてサンプルプログラムを交えて詳しく解説していきます。
1. st.success() – 成功メッセージを表示
st.success()は、成功メッセージを表示するためのメソッドです。処理が成功したことをユーザーに知らせたい時に使用します。
Function Signature:
st.success(body, icon=None)Parameters:
body: メッセージの本文 (str)icon: 表示するアイコン (str, optional)。デフォルトはチェックマーク。
サンプルプログラム:
import streamlit as st
st.success('データのアップロードが完了しました！', icon="✅")2. st.info() – 情報メッセージを表示
st.info()は、情報メッセージを表示するためのメソッドです。ユーザーに何かを知らせたい時、ヒントや追加情報を提供したい時に使用します。
Function Signature:
st.info(body, icon=None)Parameters:
body: メッセージの本文 (str)icon: 表示するアイコン (str, optional)。デフォルトは情報アイコン。
サンプルプログラム:
import streamlit as st
st.info('このボタンをクリックすると、処理が開始されます。', icon="ℹ️")3. st.warning() – 警告メッセージを表示
st.warning()は、警告メッセージを表示するためのメソッドです。ユーザーに潜在的な問題や注意を促したい時に使用します。
Function Signature:
st.warning(body, icon=None)Parameters:
body: メッセージの本文 (str)icon: 表示するアイコン (str, optional)。デフォルトは警告アイコン。
サンプルプログラム:
import streamlit as st
st.warning('この操作は取り消せません。本当に実行しますか？', icon="⚠️")4. st.error() – エラーメッセージを表示
st.error()は、エラーメッセージを表示するためのメソッドです。処理が失敗した時や、エラーが発生した時に使用します。
Function Signature:
st.error(body, icon=None)Parameters:
body: メッセージの本文 (str)icon: 表示するアイコン (str, optional)。デフォルトはエラーアイコン。
サンプルプログラム:
import streamlit as st
st.error('ファイルが見つかりません。', icon="🚨")5. st.exception() – 例外情報を表示
st.exception()は、例外情報を表示するためのメソッドです。try-exceptブロックで捕捉した例外を表示したい時に使用します。
Function Signature:
st.exception(exception, icon=None)Parameters:
exception: 表示する例外 (Exception)icon: 表示するアイコン (str, optional)。デフォルトはエラーアイコン。
サンプルプログラム:
import streamlit as st
try:
# 何らかの処理
result = 10 / 0
except ZeroDivisionError as e:
st.exception(e)まとめ
これらのメソッドを効果的に使用することで、ユーザーに分かりやすく情報を伝えることができます。
状況に応じて適切なメソッドを選び、Streamlitアプリをよりユーザーフレンドリーなものにしましょう。
関連リンク
- st.success – Streamlit Docs
- st.info – Streamlit Docs
- st.warning – Streamlit Docs
- st.error – Streamlit Docs
- st.exception – Streamlit Docs
- Streamlit公式ドキュメント
注記:
- 各メソッドのアイコンは、バージョンによって異なる場合があります。
- 上記のサンプルプログラムは、Streamlitのバージョンがであることを前提としています。
最後に、書籍のPRです。
最新のOpenAIのチャットAPIの使い方もしっかりと解説されている良書です。2024年11月初版発行、「LangChainとLangGraphによるRAG・AIエージェント[実践]入門」西見、吉田、大嶋著。
最後まで読んでいただきありがとうございます。73
コメント