starlette_flash

星际闪烁

星际框架的闪存消息。

安装

使用PIP或诗歌安装starlette_flash ：

pip install starlette_flash
# or
poetry add starlette_flash

快速开始

请参阅此存储库的示例/目录中的示例应用程序。

设置

您必须安装SessionMiddleware以使用Flash消息。

闪烁的消息

要闪烁消息，请使用flash Helper。

 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.'} 

消耗消息

您可以一一读取消息，然后使用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