<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>django.contrib.messages.api — Django 1.8.19 documentation</title>
<link rel="stylesheet" href="../../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../../',
VERSION: '1.8.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<link rel="top" title="Django 1.8.19 documentation" href="../../../../contents.html" />
<link rel="up" title="django" href="../../../django.html" />
<script type="text/javascript" src="../../../../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "../../../../ref/templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body role="document">
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../../../../index.html">Django 1.8.19 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../../../../index.html">Home</a> |
<a title="Table of contents" href="../../../../contents.html">Table of contents</a> |
<a title="Global index" href="../../../../genindex.html">Index</a> |
<a title="Module index" href="../../../../py-modindex.html">Modules</a>
</div>
<div class="nav">
<a href="../../../index.html" title="Module code" accesskey="U">up</a></div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="_modules-django-contrib-messages-api">
<h1>Source code for django.contrib.messages.api</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">django.contrib.messages</span> <span class="k">import</span> <span class="n">constants</span>
<span class="kn">from</span> <span class="nn">django.contrib.messages.storage</span> <span class="k">import</span> <span class="n">default_storage</span>
<span class="kn">from</span> <span class="nn">django.http</span> <span class="k">import</span> <span class="n">HttpRequest</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">'add_message'</span><span class="p">,</span> <span class="s1">'get_messages'</span><span class="p">,</span>
<span class="s1">'get_level'</span><span class="p">,</span> <span class="s1">'set_level'</span><span class="p">,</span>
<span class="s1">'debug'</span><span class="p">,</span> <span class="s1">'info'</span><span class="p">,</span> <span class="s1">'success'</span><span class="p">,</span> <span class="s1">'warning'</span><span class="p">,</span> <span class="s1">'error'</span><span class="p">,</span>
<span class="s1">'MessageFailure'</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">class</span> <span class="nc">MessageFailure</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="k">pass</span>
<div class="viewcode-block" id="add_message"><a class="viewcode-back" href="../../../../ref/contrib/messages.html#django.contrib.messages.add_message">[docs]</a><span class="k">def</span> <span class="nf">add_message</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">fail_silently</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Attempts to add a message to the request using the 'messages' app.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">HttpRequest</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"add_message() argument must be an HttpRequest object, "</span>
<span class="s2">"not '</span><span class="si">%s</span><span class="s2">'."</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="s1">'_messages'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">request</span><span class="o">.</span><span class="n">_messages</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">level</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">fail_silently</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">MessageFailure</span><span class="p">(</span><span class="s1">'You cannot add messages without installing '</span>
<span class="s1">'django.contrib.messages.middleware.MessageMiddleware'</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_messages"><a class="viewcode-back" href="../../../../ref/contrib/messages.html#django.contrib.messages.get_messages">[docs]</a><span class="k">def</span> <span class="nf">get_messages</span><span class="p">(</span><span class="n">request</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the message storage on the request if it exists, otherwise returns</span>
<span class="sd"> an empty list.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="s1">'_messages'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">request</span><span class="o">.</span><span class="n">_messages</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[]</span></div>
<span class="k">def</span> <span class="nf">get_level</span><span class="p">(</span><span class="n">request</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the minimum level of messages to be recorded.</span>
<span class="sd"> The default level is the ``MESSAGE_LEVEL`` setting. If this is not found,</span>
<span class="sd"> the ``INFO`` level is used.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="s1">'_messages'</span><span class="p">):</span>
<span class="n">storage</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">_messages</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">storage</span> <span class="o">=</span> <span class="n">default_storage</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="k">return</span> <span class="n">storage</span><span class="o">.</span><span class="n">level</span>
<span class="k">def</span> <span class="nf">set_level</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">level</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Sets the minimum level of messages to be recorded, returning ``True`` if</span>
<span class="sd"> the level was recorded successfully.</span>
<span class="sd"> If set to ``None``, the default level will be used (see the ``get_level``</span>
<span class="sd"> method).</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="s1">'_messages'</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="n">request</span><span class="o">.</span><span class="n">_messages</span><span class="o">.</span><span class="n">level</span> <span class="o">=</span> <span class="n">level</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">def</span> <span class="nf">debug</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">fail_silently</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds a message with the ``DEBUG`` level.</span>
<span class="sd"> """</span>
<span class="n">add_message</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">constants</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="n">extra_tags</span><span class="p">,</span>
<span class="n">fail_silently</span><span class="o">=</span><span class="n">fail_silently</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">info</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">fail_silently</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds a message with the ``INFO`` level.</span>
<span class="sd"> """</span>
<span class="n">add_message</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">constants</span><span class="o">.</span><span class="n">INFO</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="n">extra_tags</span><span class="p">,</span>
<span class="n">fail_silently</span><span class="o">=</span><span class="n">fail_silently</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">success</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">fail_silently</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds a message with the ``SUCCESS`` level.</span>
<span class="sd"> """</span>
<span class="n">add_message</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">constants</span><span class="o">.</span><span class="n">SUCCESS</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="n">extra_tags</span><span class="p">,</span>
<span class="n">fail_silently</span><span class="o">=</span><span class="n">fail_silently</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">warning</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">fail_silently</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds a message with the ``WARNING`` level.</span>
<span class="sd"> """</span>
<span class="n">add_message</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">constants</span><span class="o">.</span><span class="n">WARNING</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="n">extra_tags</span><span class="p">,</span>
<span class="n">fail_silently</span><span class="o">=</span><span class="n">fail_silently</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">error</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">fail_silently</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds a message with the ``ERROR`` level.</span>
<span class="sd"> """</span>
<span class="n">add_message</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">constants</span><span class="o">.</span><span class="n">ERROR</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">extra_tags</span><span class="o">=</span><span class="n">extra_tags</span><span class="p">,</span>
<span class="n">fail_silently</span><span class="o">=</span><span class="n">fail_silently</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Browse</h3>
<ul>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../../../../index.html">Django 1.8.19 documentation</a>
<ul><li><a href="../../../index.html">Module code</a>
<ul><li><a href="../../../django.html">django</a>
<ul><li>django.contrib.messages.api</li></ul>
</li></ul></li></ul>
</li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Mar 10, 2018</p>
</div>
</div>
<div id="ft">
<div class="nav">
<a href="../../../index.html" title="Module code" accesskey="U">up</a></div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
