Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(724)

Unified Diff: venv/Lib/site-packages/django/contrib/messages/api.py

Issue 554060043: testMe
Patch Set: Created 2 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: venv/Lib/site-packages/django/contrib/messages/api.py
===================================================================
new file mode 100644
--- /dev/null
+++ b/venv/Lib/site-packages/django/contrib/messages/api.py
@@ -0,0 +1,107 @@
+from django.contrib.messages import constants
+from django.contrib.messages.storage import default_storage
+
+__all__ = (
+ 'add_message', 'get_messages',
+ 'get_level', 'set_level',
+ 'debug', 'info', 'success', 'warning', 'error',
+ 'MessageFailure',
+)
+
+
+class MessageFailure(Exception):
+ pass
+
+
+def add_message(request, level, message, extra_tags='', fail_silently=False):
+ """
+ Attempts to add a message to the request using the 'messages' app.
+ """
+ try:
+ messages = request._messages
+ except AttributeError:
+ if not hasattr(request, 'META'):
+ raise TypeError(
+ "add_message() argument must be an HttpRequest object, not "
+ "'%s'." % request.__class__.__name__
+ )
+ if not fail_silently:
+ raise MessageFailure(
+ 'You cannot add messages without installing '
+ 'django.contrib.messages.middleware.MessageMiddleware'
+ )
+ else:
+ return messages.add(level, message, extra_tags)
+
+
+def get_messages(request):
+ """
+ Returns the message storage on the request if it exists, otherwise returns
+ an empty list.
+ """
+ return getattr(request, '_messages', [])
+
+
+def get_level(request):
+ """
+ Returns the minimum level of messages to be recorded.
+
+ The default level is the ``MESSAGE_LEVEL`` setting. If this is not found,
+ the ``INFO`` level is used.
+ """
+ storage = getattr(request, '_messages', default_storage(request))
+ return storage.level
+
+
+def set_level(request, level):
+ """
+ Sets the minimum level of messages to be recorded, returning ``True`` if
+ the level was recorded successfully.
+
+ If set to ``None``, the default level will be used (see the ``get_level``
+ method).
+ """
+ if not hasattr(request, '_messages'):
+ return False
+ request._messages.level = level
+ return True
+
+
+def debug(request, message, extra_tags='', fail_silently=False):
+ """
+ Adds a message with the ``DEBUG`` level.
+ """
+ add_message(request, constants.DEBUG, message, extra_tags=extra_tags,
+ fail_silently=fail_silently)
+
+
+def info(request, message, extra_tags='', fail_silently=False):
+ """
+ Adds a message with the ``INFO`` level.
+ """
+ add_message(request, constants.INFO, message, extra_tags=extra_tags,
+ fail_silently=fail_silently)
+
+
+def success(request, message, extra_tags='', fail_silently=False):
+ """
+ Adds a message with the ``SUCCESS`` level.
+ """
+ add_message(request, constants.SUCCESS, message, extra_tags=extra_tags,
+ fail_silently=fail_silently)
+
+
+def warning(request, message, extra_tags='', fail_silently=False):
+ """
+ Adds a message with the ``WARNING`` level.
+ """
+ add_message(request, constants.WARNING, message, extra_tags=extra_tags,
+ fail_silently=fail_silently)
+
+
+def error(request, message, extra_tags='', fail_silently=False):
+ """
+ Adds a message with the ``ERROR`` level.
+ """
+ add_message(request, constants.ERROR, message, extra_tags=extra_tags,
+ fail_silently=fail_silently)
« no previous file with comments | « venv/Lib/site-packages/django/contrib/humanize/apps.py ('k') | venv/Lib/site-packages/django/contrib/messages/apps.py » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b