<!DOCTYPE html>

<html lang="en" data-content_root="../../../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>django.views.decorators.debug &#8212; Django 5.2 documentation</title>
    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=34bb78ad" />
    <link rel="stylesheet" type="text/css" href="../../../../_static/default.css?v=bf4d74af" />
    <script src="../../../../_static/documentation_options.js?v=6593ad68"></script>
    <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="index" title="Index" href="../../../../genindex.html" />
    <link rel="search" title="Search" href="../../../../search.html" />



 
<script src="../../../../templatebuiltins.js"></script>
<script>
(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>

    <div class="document">
  <div id="custom-doc" class="yui-t6">
    <div id="hd">
      <h1><a href="../../../../index.html">Django 5.2 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="w"> </span><span class="nn">inspect</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">wraps</span>

<span class="kn">from</span><span class="w"> </span><span class="nn">asgiref.sync</span><span class="w"> </span><span class="kn">import</span> <span class="n">iscoroutinefunction</span>

<span class="kn">from</span><span class="w"> </span><span class="nn">django.http</span><span class="w"> </span><span class="kn">import</span> <span class="n">HttpRequest</span>

<span class="n">coroutine_functions_to_sensitive_variables</span> <span class="o">=</span> <span class="p">{}</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="w"> </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="w">    </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Indicate 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">    Accept two forms:</span>

<span class="sd">    * with specified variable names:</span>

<span class="sd">        @sensitive_variables(&#39;user&#39;, &#39;password&#39;, &#39;credit_card&#39;)</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 consider all</span>
<span class="sd">      variables are sensitive:</span>

<span class="sd">        @sensitive_variables()</span>
<span class="sd">        def my_function()</span>
<span class="sd">            ...</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">variables</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="nb">callable</span><span class="p">(</span><span class="n">variables</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
            <span class="s2">&quot;sensitive_variables() must be called to use it as a decorator, &quot;</span>
            <span class="s2">&quot;e.g., use @sensitive_variables(), not @sensitive_variables.&quot;</span>
        <span class="p">)</span>

    <span class="k">def</span><span class="w"> </span><span class="nf">decorator</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
        <span class="k">if</span> <span class="n">iscoroutinefunction</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
            <span class="n">sensitive_variables_wrapper</span> <span class="o">=</span> <span class="n">func</span>

            <span class="n">wrapped_func</span> <span class="o">=</span> <span class="n">func</span>
            <span class="k">while</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">wrapped_func</span><span class="p">,</span> <span class="s2">&quot;__wrapped__&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                <span class="n">wrapped_func</span> <span class="o">=</span> <span class="n">wrapped_func</span><span class="o">.</span><span class="n">__wrapped__</span>

            <span class="k">try</span><span class="p">:</span>
                <span class="n">file_path</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getfile</span><span class="p">(</span><span class="n">wrapped_func</span><span class="p">)</span>
            <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>  <span class="c1"># Raises for builtins or native functions.</span>
                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
                    <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">func</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2"> cannot safely be wrapped by &quot;</span>
                    <span class="s2">&quot;@sensitive_variables, make it either non-async or defined in a &quot;</span>
                    <span class="s2">&quot;Python file (not a builtin or from a native extension).&quot;</span>
                <span class="p">)</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="c1"># A source file may not be available (e.g. in .pyc-only builds),</span>
                <span class="c1"># use the first line number instead.</span>
                <span class="n">first_line_number</span> <span class="o">=</span> <span class="n">wrapped_func</span><span class="o">.</span><span class="vm">__code__</span><span class="o">.</span><span class="n">co_firstlineno</span>
                <span class="n">key</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">file_path</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">first_line_number</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>

            <span class="k">if</span> <span class="n">variables</span><span class="p">:</span>
                <span class="n">coroutine_functions_to_sensitive_variables</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">variables</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">coroutine_functions_to_sensitive_variables</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;__ALL__&quot;</span>

        <span class="k">else</span><span class="p">:</span>

            <span class="nd">@wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
            <span class="k">def</span><span class="w"> </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="s2">&quot;__ALL__&quot;</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="w"> </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="w">    </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Indicate 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">    Accept two forms:</span>

<span class="sd">    * with specified parameters:</span>

<span class="sd">        @sensitive_post_parameters(&#39;password&#39;, &#39;credit_card&#39;)</span>
<span class="sd">        def my_view(request):</span>
<span class="sd">            pw = request.POST[&#39;password&#39;]</span>
<span class="sd">            cc = request.POST[&#39;credit_card&#39;]</span>
<span class="sd">            ...</span>

<span class="sd">    * without any specified parameters, in which case consider all</span>
<span class="sd">      variables are sensitive:</span>

<span class="sd">        @sensitive_post_parameters()</span>
<span class="sd">        def my_view(request)</span>
<span class="sd">            ...</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">parameters</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="nb">callable</span><span class="p">(</span><span class="n">parameters</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
            <span class="s2">&quot;sensitive_post_parameters() must be called to use it as a &quot;</span>
            <span class="s2">&quot;decorator, e.g., use @sensitive_post_parameters(), not &quot;</span>
            <span class="s2">&quot;@sensitive_post_parameters.&quot;</span>
        <span class="p">)</span>

    <span class="k">def</span><span class="w"> </span><span class="nf">decorator</span><span class="p">(</span><span class="n">view</span><span class="p">):</span>
        <span class="k">if</span> <span class="n">iscoroutinefunction</span><span class="p">(</span><span class="n">view</span><span class="p">):</span>

            <span class="nd">@wraps</span><span class="p">(</span><span class="n">view</span><span class="p">)</span>
            <span class="k">async</span> <span class="k">def</span><span class="w"> </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">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">&quot;sensitive_post_parameters didn&#39;t receive an HttpRequest &quot;</span>
                        <span class="s2">&quot;object. If you are decorating a classmethod, make sure to use &quot;</span>
                        <span class="s2">&quot;@method_decorator.&quot;</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="s2">&quot;__ALL__&quot;</span>
                <span class="k">return</span> <span class="k">await</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">else</span><span class="p">:</span>

            <span class="nd">@wraps</span><span class="p">(</span><span class="n">view</span><span class="p">)</span>
            <span class="k">def</span><span class="w"> </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">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">&quot;sensitive_post_parameters didn&#39;t receive an HttpRequest &quot;</span>
                        <span class="s2">&quot;object. If you are decorating a classmethod, make sure to use &quot;</span>
                        <span class="s2">&quot;@method_decorator.&quot;</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="s2">&quot;__ALL__&quot;</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">
        <div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
              <h3>Last update:</h3>
              <p class="topless">Oct 01, 2025</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>