starlette_flash

Starlette-flash

Starletteフレームワークのフラッシュメッセージ。

インストール

PIPまたは詩を使用してstarlette_flashをインストールします：

pip install starlette_flash
# or
poetry add starlette_flash

クイックスタート

このリポジトリの例/ディレクトリのアプリケーションの例を参照してください。

設定

Flashメッセージを使用するには、SessionMiddlewareをインストールする必要があります。

フラッシュメッセージ

メッセージをフラッシュするには、 flashヘルパーを使用します。

 from starlette_flash import flash


def index_view ( request ):
    flash ( request ). add ( 'This is a message.' , 'success' )

ヘルパーを使用します

カテゴリを自動的に設定する事前定義されたヘルパーがいくつかあります。

• 成功
• エラー
• 情報
• デバッグ

 from starlette_flash import flash


def index_view ( request ):
    flash ( request ). success ( 'This is a message.' )
    flash ( request ). error ( 'This is a message.' )
    flash ( request ). info ( 'This is a message.' )
    flash ( request ). debug ( 'This is a message.' )

メッセージを読む

セッションから削除せずに現在のフラッシュメッセージを取得するには、 all方法を使用します。

 from starlette_flash import flash


def index_view ( request ):
    flash ( request ). success ( 'This is a message.' )

    messages = flash ( request ). all ()
    print ( messages )  # {'category': 'success', 'message': 'This is a message.'} 

メッセージの消費

メッセージを1つずつ読み取り、 consumeメソッドを使用してストレージをクリアできます。

 from starlette_flash import flash


def index_view ( request ):
    flash ( request ). success ( 'This is a message.' )

    messages = []
    for message in flash ( request ). consume ():
        messages . append ( message )
    print ( messages )  # {'category': 'success', 'message': 'This is a message.'}
    print ( flash ( request ). all ())  # empty, messages has been consumed

フラッシュバッグを反復してメッセージを消費することもできます。

 from starlette_flash import flash


def index_view ( request ):
    flash ( request ). success ( 'This is a message.' )

    messages = []
    for message in flash ( request ):
        messages . append ( message )
    print ( messages )  # {'category': 'success', 'message': 'This is a message.'}
    print ( flash ( request ). all ())  # empty, messages has been consumed