<!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 shortcut functions — 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="Handling HTTP requests" href="index.html" /> <link rel="next" title="Generic views" href="generic-views.html" /> <link rel="prev" title="File Uploads" href="file-uploads.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="file-uploads.html" title="File Uploads">previous</a> | <a href="../index.html" title="Using Django" accesskey="U">up</a> | <a href="generic-views.html" title="Generic views">next</a> »</div> </div> <div id="bd"> <div id="yui-main"> <div class="yui-b"> <div class="yui-g" id="topics-http-shortcuts"> <div class="section" id="s-module-django.shortcuts"> <span id="s-django-shortcut-functions"></span><span id="module-django.shortcuts"></span><span id="django-shortcut-functions"></span><h1>Django shortcut functions<a class="headerlink" href="#module-django.shortcuts" title="Permalink to this headline">¶</a></h1> <p id="index-0">The package <code class="docutils literal"><span class="pre">django.shortcuts</span></code> collects helper functions and classes that “span” multiple levels of MVC. In other words, these functions/classes introduce controlled coupling for convenience’s sake.</p> <div class="section" id="s-render"> <span id="render"></span><h2><code class="docutils literal"><span class="pre">render</span></code><a class="headerlink" href="#render" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="django.shortcuts.render"> <code class="descname">render</code>(<em>request</em>, <em>template_name</em>, <em>context=None</em>, <em>context_instance=_context_instance_undefined</em>, <em>content_type=None</em>, <em>status=None</em>, <em>current_app=_current_app_undefined</em>, <em>dirs=_dirs_undefined</em>, <em>using=None</em>)<a class="reference internal" href="../../_modules/django/shortcuts.html#render"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.shortcuts.render" title="Permalink to this definition">¶</a></dt> <dd><p>Combines a given template with a given context dictionary and returns an <a class="reference internal" href="../../ref/request-response.html#django.http.HttpResponse" title="django.http.HttpResponse"><code class="xref py py-class docutils literal"><span class="pre">HttpResponse</span></code></a> object with that rendered text.</p> <p><a class="reference internal" href="#django.shortcuts.render" title="django.shortcuts.render"><code class="xref py py-func docutils literal"><span class="pre">render()</span></code></a> is the same as a call to <a class="reference internal" href="#django.shortcuts.render_to_response" title="django.shortcuts.render_to_response"><code class="xref py py-func docutils literal"><span class="pre">render_to_response()</span></code></a> with a <code class="docutils literal"><span class="pre">context_instance</span></code> argument that forces the use of a <a class="reference internal" href="../../ref/templates/api.html#django.template.RequestContext" title="django.template.RequestContext"><code class="xref py py-class docutils literal"><span class="pre">RequestContext</span></code></a>.</p> <p>Django does not provide a shortcut function which returns a <a class="reference internal" href="../../ref/template-response.html#django.template.response.TemplateResponse" title="django.template.response.TemplateResponse"><code class="xref py py-class docutils literal"><span class="pre">TemplateResponse</span></code></a> because the constructor of <a class="reference internal" href="../../ref/template-response.html#django.template.response.TemplateResponse" title="django.template.response.TemplateResponse"><code class="xref py py-class docutils literal"><span class="pre">TemplateResponse</span></code></a> offers the same level of convenience as <a class="reference internal" href="#django.shortcuts.render" title="django.shortcuts.render"><code class="xref py py-func docutils literal"><span class="pre">render()</span></code></a>.</p> </dd></dl> <div class="section" id="s-required-arguments"> <span id="required-arguments"></span><h3>Required arguments<a class="headerlink" href="#required-arguments" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt><code class="docutils literal"><span class="pre">request</span></code></dt> <dd>The request object used to generate this response.</dd> <dt><code class="docutils literal"><span class="pre">template_name</span></code></dt> <dd>The full name of a template to use or sequence of template names.</dd> </dl> </div> <div class="section" id="s-optional-arguments"> <span id="optional-arguments"></span><h3>Optional arguments<a class="headerlink" href="#optional-arguments" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt><code class="docutils literal"><span class="pre">context</span></code></dt> <dd><p class="first">A dictionary of values to add to the template context. By default, this is an empty dictionary. If a value in the dictionary is callable, the view will call it just before rendering the template.</p> <div class="last versionchanged"> <span class="title">Changed in Django 1.8:</span> <p>The <code class="docutils literal"><span class="pre">context</span></code> argument used to be called <code class="docutils literal"><span class="pre">dictionary</span></code>. That name is deprecated in Django 1.8 and will be removed in Django 1.10.</p> </div> </dd> <dt><code class="docutils literal"><span class="pre">context_instance</span></code></dt> <dd><p class="first">The context instance to render the template with. By default, the template will be rendered with a <code class="docutils literal"><span class="pre">RequestContext</span></code> instance (filled with values from <code class="docutils literal"><span class="pre">request</span></code> and <code class="docutils literal"><span class="pre">context</span></code>).</p> <div class="last deprecated"> <p><span class="versionmodified">Deprecated since version 1.8: </span>The <code class="docutils literal"><span class="pre">context_instance</span></code> argument is deprecated. Simply use <code class="docutils literal"><span class="pre">context</span></code>.</p> </div> </dd> <dt><code class="docutils literal"><span class="pre">content_type</span></code></dt> <dd>The MIME type to use for the resulting document. Defaults to the value of the <a class="reference internal" href="../../ref/settings.html#std:setting-DEFAULT_CONTENT_TYPE"><code class="xref std std-setting docutils literal"><span class="pre">DEFAULT_CONTENT_TYPE</span></code></a> setting.</dd> <dt><code class="docutils literal"><span class="pre">status</span></code></dt> <dd>The status code for the response. Defaults to <code class="docutils literal"><span class="pre">200</span></code>.</dd> <dt><code class="docutils literal"><span class="pre">current_app</span></code></dt> <dd><p class="first">A hint indicating which application contains the current view. See the <a class="reference internal" href="urls.html#topics-http-reversing-url-namespaces"><span class="std std-ref">namespaced URL resolution strategy</span></a> for more information.</p> <div class="last deprecated"> <p><span class="versionmodified">Deprecated since version 1.8: </span>The <code class="docutils literal"><span class="pre">current_app</span></code> argument is deprecated. Instead you should set <code class="docutils literal"><span class="pre">request.current_app</span></code>.</p> </div> </dd> <dt><code class="docutils literal"><span class="pre">using</span></code></dt> <dd>The <a class="reference internal" href="../../ref/settings.html#std:setting-TEMPLATES-NAME"><code class="xref std std-setting docutils literal"><span class="pre">NAME</span></code></a> of a template engine to use for loading the template.</dd> </dl> <div class="versionchanged"> <span class="title">Changed in Django 1.8:</span> <p>The <code class="docutils literal"><span class="pre">using</span></code> parameter was added.</p> </div> <div class="versionchanged"> <span class="title">Changed in Django 1.7:</span> <p>The <code class="docutils literal"><span class="pre">dirs</span></code> parameter was added.</p> </div> <div class="deprecated"> <p><span class="versionmodified">Deprecated since version 1.8: </span>The <code class="docutils literal"><span class="pre">dirs</span></code> parameter was deprecated.</p> </div> </div> <div class="section" id="s-example"> <span id="example"></span><h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3> <p>The following example renders the template <code class="docutils literal"><span class="pre">myapp/index.html</span></code> with the MIME type <em class="mimetype">application/xhtml+xml</em>:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.shortcuts</span> <span class="k">import</span> <span class="n">render</span> <span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="c1"># View code here...</span> <span class="k">return</span> <span class="n">render</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="s1">'myapp/index.html'</span><span class="p">,</span> <span class="p">{</span><span class="s2">"foo"</span><span class="p">:</span> <span class="s2">"bar"</span><span class="p">},</span> <span class="n">content_type</span><span class="o">=</span><span class="s2">"application/xhtml+xml"</span><span class="p">)</span> </pre></div> </div> <p>This example is equivalent to:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.http</span> <span class="k">import</span> <span class="n">HttpResponse</span> <span class="kn">from</span> <span class="nn">django.template</span> <span class="k">import</span> <span class="n">loader</span> <span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="c1"># View code here...</span> <span class="n">t</span> <span class="o">=</span> <span class="n">loader</span><span class="o">.</span><span class="n">get_template</span><span class="p">(</span><span class="s1">'myapp/index.html'</span><span class="p">)</span> <span class="n">c</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'foo'</span><span class="p">:</span> <span class="s1">'bar'</span><span class="p">}</span> <span class="k">return</span> <span class="n">HttpResponse</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">request</span><span class="p">),</span> <span class="n">content_type</span><span class="o">=</span><span class="s2">"application/xhtml+xml"</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="s-render-to-response"> <span id="render-to-response"></span><h2><code class="docutils literal"><span class="pre">render_to_response</span></code><a class="headerlink" href="#render-to-response" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="django.shortcuts.render_to_response"> <code class="descname">render_to_response</code>(<em>template_name</em>, <em>context=None</em>, <em>context_instance=_context_instance_undefined</em>, <em>content_type=None</em>, <em>status=None</em>, <em>dirs=_dirs_undefined</em>, <em>using=None</em>)<a class="reference internal" href="../../_modules/django/shortcuts.html#render_to_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.shortcuts.render_to_response" title="Permalink to this definition">¶</a></dt> <dd><p>Renders a given template with a given context dictionary and returns an <a class="reference internal" href="../../ref/request-response.html#django.http.HttpResponse" title="django.http.HttpResponse"><code class="xref py py-class docutils literal"><span class="pre">HttpResponse</span></code></a> object with that rendered text.</p> </dd></dl> <div class="section" id="s-id1"> <span id="id1"></span><h3>Required arguments<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt><code class="docutils literal"><span class="pre">template_name</span></code></dt> <dd>The full name of a template to use or sequence of template names. If a sequence is given, the first template that exists will be used. See the <a class="reference internal" href="../templates.html#template-loading"><span class="std std-ref">template loading documentation</span></a> for more information on how templates are found.</dd> </dl> </div> <div class="section" id="s-id2"> <span id="id2"></span><h3>Optional arguments<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt><code class="docutils literal"><span class="pre">context</span></code></dt> <dd><p class="first">A dictionary of values to add to the template context. By default, this is an empty dictionary. If a value in the dictionary is callable, the view will call it just before rendering the template.</p> <div class="last versionchanged"> <span class="title">Changed in Django 1.8:</span> <p>The <code class="docutils literal"><span class="pre">context</span></code> argument used to be called <code class="docutils literal"><span class="pre">dictionary</span></code>. That name is deprecated in Django 1.8 and will be removed in Django 1.10.</p> </div> </dd> <dt><code class="docutils literal"><span class="pre">context_instance</span></code></dt> <dd><p class="first">The context instance to render the template with. By default, the template will be rendered with a <a class="reference internal" href="../../ref/templates/api.html#django.template.Context" title="django.template.Context"><code class="xref py py-class docutils literal"><span class="pre">Context</span></code></a> instance (filled with values from <code class="docutils literal"><span class="pre">context</span></code>). If you need to use <a class="reference internal" href="../../ref/templates/api.html#subclassing-context-requestcontext"><span class="std std-ref">context processors</span></a>, render the template with a <a class="reference internal" href="../../ref/templates/api.html#django.template.RequestContext" title="django.template.RequestContext"><code class="xref py py-class docutils literal"><span class="pre">RequestContext</span></code></a> instance instead. Your code might look something like this:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">return</span> <span class="n">render_to_response</span><span class="p">(</span><span class="s1">'my_template.html'</span><span class="p">,</span> <span class="n">my_context</span><span class="p">,</span> <span class="n">context_instance</span><span class="o">=</span><span class="n">RequestContext</span><span class="p">(</span><span class="n">request</span><span class="p">))</span> </pre></div> </div> <div class="last deprecated"> <p><span class="versionmodified">Deprecated since version 1.8: </span>The <code class="docutils literal"><span class="pre">context_instance</span></code> argument is deprecated. Use the <a class="reference internal" href="#django.shortcuts.render" title="django.shortcuts.render"><code class="xref py py-func docutils literal"><span class="pre">render()</span></code></a> function instead which always makes <code class="docutils literal"><span class="pre">RequestContext</span></code> available.</p> </div> </dd> <dt><code class="docutils literal"><span class="pre">content_type</span></code></dt> <dd>The MIME type to use for the resulting document. Defaults to the value of the <a class="reference internal" href="../../ref/settings.html#std:setting-DEFAULT_CONTENT_TYPE"><code class="xref std std-setting docutils literal"><span class="pre">DEFAULT_CONTENT_TYPE</span></code></a> setting.</dd> <dt><code class="docutils literal"><span class="pre">status</span></code></dt> <dd>The status code for the response. Defaults to <code class="docutils literal"><span class="pre">200</span></code>.</dd> <dt><code class="docutils literal"><span class="pre">using</span></code></dt> <dd>The <a class="reference internal" href="../../ref/settings.html#std:setting-TEMPLATES-NAME"><code class="xref std std-setting docutils literal"><span class="pre">NAME</span></code></a> of a template engine to use for loading the template.</dd> </dl> <div class="versionchanged"> <span class="title">Changed in Django 1.8:</span> <p>The <code class="docutils literal"><span class="pre">status</span></code> and <code class="docutils literal"><span class="pre">using</span></code> parameters were added.</p> </div> <div class="versionchanged"> <span class="title">Changed in Django 1.7:</span> <p>The <code class="docutils literal"><span class="pre">dirs</span></code> parameter was added.</p> </div> <div class="deprecated"> <p><span class="versionmodified">Deprecated since version 1.8: </span>The <code class="docutils literal"><span class="pre">dirs</span></code> parameter was deprecated.</p> </div> </div> <div class="section" id="s-id3"> <span id="id3"></span><h3>Example<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3> <p>The following example renders the template <code class="docutils literal"><span class="pre">myapp/index.html</span></code> with the MIME type <em class="mimetype">application/xhtml+xml</em>:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.shortcuts</span> <span class="k">import</span> <span class="n">render_to_response</span> <span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="c1"># View code here...</span> <span class="k">return</span> <span class="n">render_to_response</span><span class="p">(</span><span class="s1">'myapp/index.html'</span><span class="p">,</span> <span class="p">{</span><span class="s2">"foo"</span><span class="p">:</span> <span class="s2">"bar"</span><span class="p">},</span> <span class="n">content_type</span><span class="o">=</span><span class="s2">"application/xhtml+xml"</span><span class="p">)</span> </pre></div> </div> <p>This example is equivalent to:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.http</span> <span class="k">import</span> <span class="n">HttpResponse</span> <span class="kn">from</span> <span class="nn">django.template</span> <span class="k">import</span> <span class="n">Context</span><span class="p">,</span> <span class="n">loader</span> <span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="c1"># View code here...</span> <span class="n">t</span> <span class="o">=</span> <span class="n">loader</span><span class="o">.</span><span class="n">get_template</span><span class="p">(</span><span class="s1">'myapp/index.html'</span><span class="p">)</span> <span class="n">c</span> <span class="o">=</span> <span class="n">Context</span><span class="p">({</span><span class="s1">'foo'</span><span class="p">:</span> <span class="s1">'bar'</span><span class="p">})</span> <span class="k">return</span> <span class="n">HttpResponse</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">c</span><span class="p">),</span> <span class="n">content_type</span><span class="o">=</span><span class="s2">"application/xhtml+xml"</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="s-redirect"> <span id="redirect"></span><h2><code class="docutils literal"><span class="pre">redirect</span></code><a class="headerlink" href="#redirect" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="django.shortcuts.redirect"> <code class="descname">redirect</code>(<em>to</em>, <em>permanent=False</em>, <em>*args</em>, <em>**kwargs</em>)<a class="reference internal" href="../../_modules/django/shortcuts.html#redirect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.shortcuts.redirect" title="Permalink to this definition">¶</a></dt> <dd><p>Returns an <a class="reference internal" href="../../ref/request-response.html#django.http.HttpResponseRedirect" title="django.http.HttpResponseRedirect"><code class="xref py py-class docutils literal"><span class="pre">HttpResponseRedirect</span></code></a> to the appropriate URL for the arguments passed.</p> <p>The arguments could be:</p> <ul class="simple"> <li>A model: the model’s <a class="reference internal" href="../../ref/models/instances.html#django.db.models.Model.get_absolute_url" title="django.db.models.Model.get_absolute_url"><code class="xref py py-meth docutils literal"><span class="pre">get_absolute_url()</span></code></a> function will be called.</li> <li>A view name, possibly with arguments: <a class="reference internal" href="../../ref/urlresolvers.html#django.core.urlresolvers.reverse" title="django.core.urlresolvers.reverse"><code class="xref py py-func docutils literal"><span class="pre">urlresolvers.reverse</span></code></a> will be used to reverse-resolve the name.</li> <li>An absolute or relative URL, which will be used as-is for the redirect location.</li> </ul> <p>By default issues a temporary redirect; pass <code class="docutils literal"><span class="pre">permanent=True</span></code> to issue a permanent redirect.</p> <div class="versionchanged"> <span class="title">Changed in Django 1.7:</span> <p>The ability to use relative URLs was added.</p> </div> </dd></dl> <div class="section" id="s-examples"> <span id="examples"></span><h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3> <p>You can use the <a class="reference internal" href="#django.shortcuts.redirect" title="django.shortcuts.redirect"><code class="xref py py-func docutils literal"><span class="pre">redirect()</span></code></a> function in a number of ways.</p> <ol class="arabic"> <li><p class="first">By passing some object; that object’s <a class="reference internal" href="../../ref/models/instances.html#django.db.models.Model.get_absolute_url" title="django.db.models.Model.get_absolute_url"><code class="xref py py-meth docutils literal"><span class="pre">get_absolute_url()</span></code></a> method will be called to figure out the redirect URL:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.shortcuts</span> <span class="k">import</span> <span class="n">redirect</span> <span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="o">...</span> <span class="nb">object</span> <span class="o">=</span> <span class="n">MyModel</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">...</span><span class="p">)</span> <span class="k">return</span> <span class="n">redirect</span><span class="p">(</span><span class="nb">object</span><span class="p">)</span> </pre></div> </div> </li> <li><p class="first">By passing the name of a view and optionally some positional or keyword arguments; the URL will be reverse resolved using the <a class="reference internal" href="../../ref/urlresolvers.html#django.core.urlresolvers.reverse" title="django.core.urlresolvers.reverse"><code class="xref py py-func docutils literal"><span class="pre">reverse()</span></code></a> method:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="o">...</span> <span class="k">return</span> <span class="n">redirect</span><span class="p">(</span><span class="s1">'some-view-name'</span><span class="p">,</span> <span class="n">foo</span><span class="o">=</span><span class="s1">'bar'</span><span class="p">)</span> </pre></div> </div> </li> <li><p class="first">By passing a hardcoded URL to redirect to:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="o">...</span> <span class="k">return</span> <span class="n">redirect</span><span class="p">(</span><span class="s1">'/some/url/'</span><span class="p">)</span> </pre></div> </div> <p>This also works with full URLs:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="o">...</span> <span class="k">return</span> <span class="n">redirect</span><span class="p">(</span><span class="s1">'http://example.com/'</span><span class="p">)</span> </pre></div> </div> </li> </ol> <p>By default, <a class="reference internal" href="#django.shortcuts.redirect" title="django.shortcuts.redirect"><code class="xref py py-func docutils literal"><span class="pre">redirect()</span></code></a> returns a temporary redirect. All of the above forms accept a <code class="docutils literal"><span class="pre">permanent</span></code> argument; if set to <code class="docutils literal"><span class="pre">True</span></code> a permanent redirect will be returned:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="o">...</span> <span class="nb">object</span> <span class="o">=</span> <span class="n">MyModel</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">...</span><span class="p">)</span> <span class="k">return</span> <span class="n">redirect</span><span class="p">(</span><span class="nb">object</span><span class="p">,</span> <span class="n">permanent</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="s-get-object-or-404"> <span id="get-object-or-404"></span><h2><code class="docutils literal"><span class="pre">get_object_or_404</span></code><a class="headerlink" href="#get-object-or-404" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="django.shortcuts.get_object_or_404"> <code class="descname">get_object_or_404</code>(<em>klass</em>, <em>*args</em>, <em>**kwargs</em>)<a class="reference internal" href="../../_modules/django/shortcuts.html#get_object_or_404"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.shortcuts.get_object_or_404" title="Permalink to this definition">¶</a></dt> <dd><p>Calls <a class="reference internal" href="../../ref/models/querysets.html#django.db.models.query.QuerySet.get" title="django.db.models.query.QuerySet.get"><code class="xref py py-meth docutils literal"><span class="pre">get()</span></code></a> on a given model manager, but it raises <a class="reference internal" href="views.html#django.http.Http404" title="django.http.Http404"><code class="xref py py-class docutils literal"><span class="pre">Http404</span></code></a> instead of the model’s <a class="reference internal" href="../../ref/models/instances.html#django.db.models.Model.DoesNotExist" title="django.db.models.Model.DoesNotExist"><code class="xref py py-class docutils literal"><span class="pre">DoesNotExist</span></code></a> exception.</p> </dd></dl> <div class="section" id="s-id4"> <span id="id4"></span><h3>Required arguments<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt><code class="docutils literal"><span class="pre">klass</span></code></dt> <dd>A <a class="reference internal" href="../../ref/models/instances.html#django.db.models.Model" title="django.db.models.Model"><code class="xref py py-class docutils literal"><span class="pre">Model</span></code></a> class, a <a class="reference internal" href="../db/managers.html#django.db.models.Manager" title="django.db.models.Manager"><code class="xref py py-class docutils literal"><span class="pre">Manager</span></code></a>, or a <a class="reference internal" href="../../ref/models/querysets.html#django.db.models.query.QuerySet" title="django.db.models.query.QuerySet"><code class="xref py py-class docutils literal"><span class="pre">QuerySet</span></code></a> instance from which to get the object.</dd> <dt><code class="docutils literal"><span class="pre">**kwargs</span></code></dt> <dd>Lookup parameters, which should be in the format accepted by <code class="docutils literal"><span class="pre">get()</span></code> and <code class="docutils literal"><span class="pre">filter()</span></code>.</dd> </dl> </div> <div class="section" id="s-id5"> <span id="id5"></span><h3>Example<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3> <p>The following example gets the object with the primary key of 1 from <code class="docutils literal"><span class="pre">MyModel</span></code>:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.shortcuts</span> <span class="k">import</span> <span class="n">get_object_or_404</span> <span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="n">my_object</span> <span class="o">=</span> <span class="n">get_object_or_404</span><span class="p">(</span><span class="n">MyModel</span><span class="p">,</span> <span class="n">pk</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> </pre></div> </div> <p>This example is equivalent to:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.http</span> <span class="k">import</span> <span class="n">Http404</span> <span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="k">try</span><span class="p">:</span> <span class="n">my_object</span> <span class="o">=</span> <span class="n">MyModel</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">pk</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="k">except</span> <span class="n">MyModel</span><span class="o">.</span><span class="n">DoesNotExist</span><span class="p">:</span> <span class="k">raise</span> <span class="n">Http404</span><span class="p">(</span><span class="s2">"No MyModel matches the given query."</span><span class="p">)</span> </pre></div> </div> <p>The most common use case is to pass a <a class="reference internal" href="../../ref/models/instances.html#django.db.models.Model" title="django.db.models.Model"><code class="xref py py-class docutils literal"><span class="pre">Model</span></code></a>, as shown above. However, you can also pass a <a class="reference internal" href="../../ref/models/querysets.html#django.db.models.query.QuerySet" title="django.db.models.query.QuerySet"><code class="xref py py-class docutils literal"><span class="pre">QuerySet</span></code></a> instance:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">queryset</span> <span class="o">=</span> <span class="n">Book</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">title__startswith</span><span class="o">=</span><span class="s1">'M'</span><span class="p">)</span> <span class="n">get_object_or_404</span><span class="p">(</span><span class="n">queryset</span><span class="p">,</span> <span class="n">pk</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> </pre></div> </div> <p>The above example is a bit contrived since it’s equivalent to doing:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">get_object_or_404</span><span class="p">(</span><span class="n">Book</span><span class="p">,</span> <span class="n">title__startswith</span><span class="o">=</span><span class="s1">'M'</span><span class="p">,</span> <span class="n">pk</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> </pre></div> </div> <p>but it can be useful if you are passed the <code class="docutils literal"><span class="pre">queryset</span></code> variable from somewhere else.</p> <p>Finally, you can also use a <a class="reference internal" href="../db/managers.html#django.db.models.Manager" title="django.db.models.Manager"><code class="xref py py-class docutils literal"><span class="pre">Manager</span></code></a>. This is useful for example if you have a <a class="reference internal" href="../db/managers.html#custom-managers"><span class="std std-ref">custom manager</span></a>:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">get_object_or_404</span><span class="p">(</span><span class="n">Book</span><span class="o">.</span><span class="n">dahl_objects</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s1">'Matilda'</span><span class="p">)</span> </pre></div> </div> <p>You can also use <a class="reference internal" href="../../ref/models/relations.html#django.db.models.fields.related.RelatedManager" title="django.db.models.fields.related.RelatedManager"><code class="xref py py-class docutils literal"><span class="pre">related</span> <span class="pre">managers</span></code></a>:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">author</span> <span class="o">=</span> <span class="n">Author</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'Roald Dahl'</span><span class="p">)</span> <span class="n">get_object_or_404</span><span class="p">(</span><span class="n">author</span><span class="o">.</span><span class="n">book_set</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s1">'Matilda'</span><span class="p">)</span> </pre></div> </div> <p>Note: As with <code class="docutils literal"><span class="pre">get()</span></code>, a <a class="reference internal" href="../../ref/exceptions.html#django.core.exceptions.MultipleObjectsReturned" title="django.core.exceptions.MultipleObjectsReturned"><code class="xref py py-class docutils literal"><span class="pre">MultipleObjectsReturned</span></code></a> exception will be raised if more than one object is found.</p> </div> </div> <div class="section" id="s-get-list-or-404"> <span id="get-list-or-404"></span><h2><code class="docutils literal"><span class="pre">get_list_or_404</span></code><a class="headerlink" href="#get-list-or-404" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="django.shortcuts.get_list_or_404"> <code class="descname">get_list_or_404</code>(<em>klass</em>, <em>*args</em>, <em>**kwargs</em>)<a class="reference internal" href="../../_modules/django/shortcuts.html#get_list_or_404"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.shortcuts.get_list_or_404" title="Permalink to this definition">¶</a></dt> <dd><p>Returns the result of <a class="reference internal" href="../../ref/models/querysets.html#django.db.models.query.QuerySet.filter" title="django.db.models.query.QuerySet.filter"><code class="xref py py-meth docutils literal"><span class="pre">filter()</span></code></a> on a given model manager cast to a list, raising <a class="reference internal" href="views.html#django.http.Http404" title="django.http.Http404"><code class="xref py py-class docutils literal"><span class="pre">Http404</span></code></a> if the resulting list is empty.</p> </dd></dl> <div class="section" id="s-id6"> <span id="id6"></span><h3>Required arguments<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt><code class="docutils literal"><span class="pre">klass</span></code></dt> <dd>A <a class="reference internal" href="../../ref/models/instances.html#django.db.models.Model" title="django.db.models.Model"><code class="xref py py-class docutils literal"><span class="pre">Model</span></code></a>, <a class="reference internal" href="../db/managers.html#django.db.models.Manager" title="django.db.models.Manager"><code class="xref py py-class docutils literal"><span class="pre">Manager</span></code></a> or <a class="reference internal" href="../../ref/models/querysets.html#django.db.models.query.QuerySet" title="django.db.models.query.QuerySet"><code class="xref py py-class docutils literal"><span class="pre">QuerySet</span></code></a> instance from which to get the list.</dd> <dt><code class="docutils literal"><span class="pre">**kwargs</span></code></dt> <dd>Lookup parameters, which should be in the format accepted by <code class="docutils literal"><span class="pre">get()</span></code> and <code class="docutils literal"><span class="pre">filter()</span></code>.</dd> </dl> </div> <div class="section" id="s-id7"> <span id="id7"></span><h3>Example<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3> <p>The following example gets all published objects from <code class="docutils literal"><span class="pre">MyModel</span></code>:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.shortcuts</span> <span class="k">import</span> <span class="n">get_list_or_404</span> <span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="n">my_objects</span> <span class="o">=</span> <span class="n">get_list_or_404</span><span class="p">(</span><span class="n">MyModel</span><span class="p">,</span> <span class="n">published</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> </pre></div> </div> <p>This example is equivalent to:</p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.http</span> <span class="k">import</span> <span class="n">Http404</span> <span class="k">def</span> <span class="nf">my_view</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="n">my_objects</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">MyModel</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">published</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">my_objects</span><span class="p">:</span> <span class="k">raise</span> <span class="n">Http404</span><span class="p">(</span><span class="s2">"No MyModel matches the given query."</span><span class="p">)</span> </pre></div> </div> </div> </div> </div> </div> </div> </div> <div class="yui-b" id="sidebar"> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Django shortcut functions</a><ul> <li><a class="reference internal" href="#render"><code class="docutils literal"><span class="pre">render</span></code></a><ul> <li><a class="reference internal" href="#required-arguments">Required arguments</a></li> <li><a class="reference internal" href="#optional-arguments">Optional arguments</a></li> <li><a class="reference internal" href="#example">Example</a></li> </ul> </li> <li><a class="reference internal" href="#render-to-response"><code class="docutils literal"><span class="pre">render_to_response</span></code></a><ul> <li><a class="reference internal" href="#id1">Required arguments</a></li> <li><a class="reference internal" href="#id2">Optional arguments</a></li> <li><a class="reference internal" href="#id3">Example</a></li> </ul> </li> <li><a class="reference internal" href="#redirect"><code class="docutils literal"><span class="pre">redirect</span></code></a><ul> <li><a class="reference internal" href="#examples">Examples</a></li> </ul> </li> <li><a class="reference internal" href="#get-object-or-404"><code class="docutils literal"><span class="pre">get_object_or_404</span></code></a><ul> <li><a class="reference internal" href="#id4">Required arguments</a></li> <li><a class="reference internal" href="#id5">Example</a></li> </ul> </li> <li><a class="reference internal" href="#get-list-or-404"><code class="docutils literal"><span class="pre">get_list_or_404</span></code></a><ul> <li><a class="reference internal" href="#id6">Required arguments</a></li> <li><a class="reference internal" href="#id7">Example</a></li> </ul> </li> </ul> </li> </ul> <h3>Browse</h3> <ul> <li>Prev: <a href="file-uploads.html">File Uploads</a></li> <li>Next: <a href="generic-views.html">Generic views</a></li> </ul> <h3>You are here:</h3> <ul> <li> <a href="../../index.html">Django 1.8.19 documentation</a> <ul><li><a href="../index.html">Using Django</a> <ul><li><a href="index.html">Handling HTTP requests</a> <ul><li>Django shortcut functions</li></ul> </li></ul></li></ul> </li> </ul> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/topics/http/shortcuts.txt" rel="nofollow">Show Source</a></li> </ul> </div> <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="file-uploads.html" title="File Uploads">previous</a> | <a href="../index.html" title="Using Django" accesskey="U">up</a> | <a href="generic-views.html" title="Generic views">next</a> »</div> </div> </div> <div class="clearer"></div> </div> </body> </html>