Source code for bag.web.pyramid.flash_msg

"""Advanced flash messages scheme for Pyramid.

This module integrates :py:mod:`bag.web.flash_msg` into Pyramid.
(That module can be used with any web framework.)


It is natural to have a single class that knows:

- the content of a flash message in either plain or rich form(s)
- the level (color) of the message, such as info, danger, success etc.
- different ways of rendering the message on the page
- whatever else you want.

The queue problem

Some Pyramid applications have used flash message queues to separate
them by level (danger, warning, info or success) in code such as this::

    request.session.flash(str(e), 'danger')

The problem with this is that messages won't appear in the order in which
they were created. Because each queue is processed separately in the
template, order is lost and messages are grouped by level.
This is undesirable and confusing to the user.

Our solution stores the level *with* the message, so you can add all
messages to the default queue and process only that queue in templates.


At web server startup time, add this simple line::



Add messages to the queue like this::

        plain="Your password has been changed, thanks.",
        close=False,  # user will NOT see an X button to close the alert
        allow_duplicate=False,  # do not bother the user with repeated text

Then you can simply do, in templates:

    ${render_flash_messages()} render the messages with Bootstrap styling.
The Jinja2 version is ``{{ render_flash_messages() | safe }}``.

If you don't like the result in any way, just loop over the flash messages
yourself and do what you want -- no need to use this feature.

from bag.web.flash_msg import FlashMessage, bootstrap_alert

[docs]def add_flash(request, allow_duplicate: bool=False, **kw) -> None: """Add a flash message to the user's session. For convenience.""" msg = FlashMessage(**kw) request.session.flash(msg, allow_duplicate=allow_duplicate)
[docs]def render_flash_messages(request) -> str: msgs = request.session.pop_flash() # Pops from the '' queue return ''.join(( bootstrap_alert(m) if isinstance(m, str) else m.bootstrap_alert for m in msgs))
[docs]def render_flash_messages_from_queues(request) -> str: """Avoid. This method is for compatibility with other systems only. Some developers are using queues named after bootstrap message flavours. I think my system (using only the default queue '') is better, because FlashMessage already supports a ``level`` attribute, but this function provides a way to display their flash messages, too. You can set QUEUES to something else if you like, from user code. """ msgs = [] for q in QUEUES: for m in request.session.pop_flash(q): html = m.bootstrap_alert if isinstance(m, FlashMessage) \ else bootstrap_alert(m, q) msgs.append(html) return ''.join(msgs)
QUEUES = set(['error', 'warning', 'info', 'success', ''])
[docs]def make_templates_able_to_render_flash_msgs(config) -> None: """Make a render_flash_messages() function available to every template. Also make available in templates a function ``flash_msgs_as_dicts()`` which returns a list of the flash messages, each one represented as a dictionary. This is useful to turn the flash messages into JSON. If you want to use the queues feature (not recommended), add this configuration setting: bag.flash.use_queues = true """ if hasattr(config, 'bag_flash_msg_included'): return # Include only once per config config.bag_flash_msg_included = True from import BeforeRender from bag.settings import asbool use_queues = config.registry.settings.get('bag.flash.use_queues', False) fn = render_flash_messages_from_queues if asbool(use_queues) \ else render_flash_messages def on_before_render(event): event['render_flash_messages'] = lambda: fn(event['request']) event['flash_msgs_as_dicts'] = \ lambda: [f.to_dict() for f in event['request'].session.pop_flash()] config.add_subscriber(on_before_render, BeforeRender)
[docs]def includeme(config) -> None: """Integrate into Pyramid web apps.""" config.add_request_method(add_flash, 'add_flash') make_templates_able_to_render_flash_msgs(config)