django.contrib.messages.api: 34 total statements, 0.0% covered

Generated: Wed 2013-03-13 10:33 CET

Source file: /media/Envs/Envs/filer-gallery/lib/python2.7/site-packages/django/contrib/messages/api.py

Stats: 0 executed, 32 missed, 2 excluded, 68 ignored

  1. from django.contrib.messages import constants
  2. from django.contrib.messages.storage import default_storage
  3. __all__ = (
  4. 'add_message', 'get_messages',
  5. 'get_level', 'set_level',
  6. 'debug', 'info', 'success', 'warning', 'error',
  7. )
  8. class MessageFailure(Exception):
  9. pass
  10. def add_message(request, level, message, extra_tags='', fail_silently=False):
  11. """
  12. Attempts to add a message to the request using the 'messages' app.
  13. """
  14. if hasattr(request, '_messages'):
  15. return request._messages.add(level, message, extra_tags)
  16. if not fail_silently:
  17. raise MessageFailure('You cannot add messages without installing '
  18. 'django.contrib.messages.middleware.MessageMiddleware')
  19. def get_messages(request):
  20. """
  21. Returns the message storage on the request if it exists, otherwise returns
  22. an empty list.
  23. """
  24. if hasattr(request, '_messages'):
  25. return request._messages
  26. else:
  27. return []
  28. def get_level(request):
  29. """
  30. Returns the minimum level of messages to be recorded.
  31. The default level is the ``MESSAGE_LEVEL`` setting. If this is not found,
  32. the ``INFO`` level is used.
  33. """
  34. if hasattr(request, '_messages'):
  35. storage = request._messages
  36. else:
  37. storage = default_storage(request)
  38. return storage.level
  39. def set_level(request, level):
  40. """
  41. Sets the minimum level of messages to be recorded, returning ``True`` if
  42. the level was recorded successfully.
  43. If set to ``None``, the default level will be used (see the ``get_level``
  44. method).
  45. """
  46. if not hasattr(request, '_messages'):
  47. return False
  48. request._messages.level = level
  49. return True
  50. def debug(request, message, extra_tags='', fail_silently=False):
  51. """
  52. Adds a message with the ``DEBUG`` level.
  53. """
  54. add_message(request, constants.DEBUG, message, extra_tags=extra_tags,
  55. fail_silently=fail_silently)
  56. def info(request, message, extra_tags='', fail_silently=False):
  57. """
  58. Adds a message with the ``INFO`` level.
  59. """
  60. add_message(request, constants.INFO, message, extra_tags=extra_tags,
  61. fail_silently=fail_silently)
  62. def success(request, message, extra_tags='', fail_silently=False):
  63. """
  64. Adds a message with the ``SUCCESS`` level.
  65. """
  66. add_message(request, constants.SUCCESS, message, extra_tags=extra_tags,
  67. fail_silently=fail_silently)
  68. def warning(request, message, extra_tags='', fail_silently=False):
  69. """
  70. Adds a message with the ``WARNING`` level.
  71. """
  72. add_message(request, constants.WARNING, message, extra_tags=extra_tags,
  73. fail_silently=fail_silently)
  74. def error(request, message, extra_tags='', fail_silently=False):
  75. """
  76. Adds a message with the ``ERROR`` level.
  77. """
  78. add_message(request, constants.ERROR, message, extra_tags=extra_tags,
  79. fail_silently=fail_silently)