<!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.views.decorators.debug — 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-views-decorators-debug"> <h1>Source code for django.views.decorators.debug</h1><div class="highlight"><pre> <span></span><span class="kn">import</span> <span class="nn">functools</span> <span class="kn">from</span> <span class="nn">django.http</span> <span class="k">import</span> <span class="n">HttpRequest</span> <div class="viewcode-block" id="sensitive_variables"><a class="viewcode-back" href="../../../../howto/error-reporting.html#django.views.decorators.debug.sensitive_variables">[docs]</a><span class="k">def</span> <span class="nf">sensitive_variables</span><span class="p">(</span><span class="o">*</span><span class="n">variables</span><span class="p">):</span> <span class="sd">"""</span> <span class="sd"> Indicates which variables used in the decorated function are sensitive, so</span> <span class="sd"> that those variables can later be treated in a special way, for example</span> <span class="sd"> by hiding them when logging unhandled exceptions.</span> <span class="sd"> Two forms are accepted:</span> <span class="sd"> * with specified variable names:</span> <span class="sd"> @sensitive_variables('user', 'password', 'credit_card')</span> <span class="sd"> def my_function(user):</span> <span class="sd"> password = user.pass_word</span> <span class="sd"> credit_card = user.credit_card_number</span> <span class="sd"> ...</span> <span class="sd"> * without any specified variable names, in which case it is assumed that</span> <span class="sd"> all variables are considered sensitive:</span> <span class="sd"> @sensitive_variables()</span> <span class="sd"> def my_function()</span> <span class="sd"> ...</span> <span class="sd"> """</span> <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">func</span><span class="p">):</span> <span class="nd">@functools</span><span class="o">.</span><span class="n">wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span> <span class="k">def</span> <span class="nf">sensitive_variables_wrapper</span><span class="p">(</span><span class="o">*</span><span class="n">func_args</span><span class="p">,</span> <span class="o">**</span><span class="n">func_kwargs</span><span class="p">):</span> <span class="k">if</span> <span class="n">variables</span><span class="p">:</span> <span class="n">sensitive_variables_wrapper</span><span class="o">.</span><span class="n">sensitive_variables</span> <span class="o">=</span> <span class="n">variables</span> <span class="k">else</span><span class="p">:</span> <span class="n">sensitive_variables_wrapper</span><span class="o">.</span><span class="n">sensitive_variables</span> <span class="o">=</span> <span class="s1">'__ALL__'</span> <span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">func_args</span><span class="p">,</span> <span class="o">**</span><span class="n">func_kwargs</span><span class="p">)</span> <span class="k">return</span> <span class="n">sensitive_variables_wrapper</span> <span class="k">return</span> <span class="n">decorator</span></div> <div class="viewcode-block" id="sensitive_post_parameters"><a class="viewcode-back" href="../../../../howto/error-reporting.html#django.views.decorators.debug.sensitive_post_parameters">[docs]</a><span class="k">def</span> <span class="nf">sensitive_post_parameters</span><span class="p">(</span><span class="o">*</span><span class="n">parameters</span><span class="p">):</span> <span class="sd">"""</span> <span class="sd"> Indicates which POST parameters used in the decorated view are sensitive,</span> <span class="sd"> so that those parameters can later be treated in a special way, for example</span> <span class="sd"> by hiding them when logging unhandled exceptions.</span> <span class="sd"> Two forms are accepted:</span> <span class="sd"> * with specified parameters:</span> <span class="sd"> @sensitive_post_parameters('password', 'credit_card')</span> <span class="sd"> def my_view(request):</span> <span class="sd"> pw = request.POST['password']</span> <span class="sd"> cc = request.POST['credit_card']</span> <span class="sd"> ...</span> <span class="sd"> * without any specified parameters, in which case it is assumed that</span> <span class="sd"> all parameters are considered sensitive:</span> <span class="sd"> @sensitive_post_parameters()</span> <span class="sd"> def my_view(request)</span> <span class="sd"> ...</span> <span class="sd"> """</span> <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">view</span><span class="p">):</span> <span class="nd">@functools</span><span class="o">.</span><span class="n">wraps</span><span class="p">(</span><span class="n">view</span><span class="p">)</span> <span class="k">def</span> <span class="nf">sensitive_post_parameters_wrapper</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> <span class="k">assert</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="p">(</span> <span class="s2">"sensitive_post_parameters didn't receive an HttpRequest. "</span> <span class="s2">"If you are decorating a classmethod, be sure to use "</span> <span class="s2">"@method_decorator."</span> <span class="p">)</span> <span class="k">if</span> <span class="n">parameters</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">sensitive_post_parameters</span> <span class="o">=</span> <span class="n">parameters</span> <span class="k">else</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">sensitive_post_parameters</span> <span class="o">=</span> <span class="s1">'__ALL__'</span> <span class="k">return</span> <span class="n">view</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="k">return</span> <span class="n">sensitive_post_parameters_wrapper</span> <span class="k">return</span> <span class="n">decorator</span></div> </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.views.decorators.debug</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">Jan 06, 2019</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>