/usr/share/doc/python-django-registration/html/signals.html is in python-django-registration 2.0.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Signals used by django-registration — django-registration 2.0.4 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="django-registration 2.0.4 documentation" href="index.html"/>
<link rel="next" title="Upgrading from previous versions" href="upgrade.html"/>
<link rel="prev" title="Custom settings" href="settings.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> django-registration
</a>
<div class="version">
2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Installation and configuration</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick start guide</a></li>
</ul>
<p class="caption"><span class="caption-text">Built-in registration workflows</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="hmac.html">The HMAC activation workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="simple-workflow.html">The simple one-step workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="model-workflow.html">The model-based activation workflow</a></li>
</ul>
<p class="caption"><span class="caption-text">For developers</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="views.html">Base view classes</a></li>
<li class="toctree-l1"><a class="reference internal" href="forms.html">Base form classes</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom-user.html">Custom user models</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Custom settings</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Signals used by django-registration</a></li>
</ul>
<p class="caption"><span class="caption-text">Other documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="upgrade.html">Upgrading from previous versions</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently-asked questions</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">django-registration</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Signals used by django-registration</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/signals.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<span class="target" id="module-registration.signals"><span id="signals"></span></span><div class="section" id="signals-used-by-django-registration">
<h1>Signals used by django-registration<a class="headerlink" href="#signals-used-by-django-registration" title="Permalink to this headline">¶</a></h1>
<p>Much of <code class="docutils literal"><span class="pre">django-registration</span></code>‘s customizability comes through the
ability to write and use different workflows for user
registration. However, there are many cases where only a small bit of
additional logic needs to be injected into the registration process,
and writing a custom workflow to support this represents an
unnecessary amount of work. A more lightweight customization option is
provided through two custom signals which the built-in registration
workflows send, and custom workflows are encouraged to send, at
specific points during the registration process; functions listening
for these signals can then add whatever logic is needed.</p>
<p>For general documentation on signals and the Django dispatcher,
consult <a class="reference external" href="http://docs.djangoproject.com/en/stable/topics/signals/">Django’s signals documentation</a>. This
documentation assumes that you are familiar with how signals work and
the process of writing and connecting functions which will listen for
signals.</p>
<dl class="data">
<dt id="registration.signals.user_activated">
<code class="descclassname">registration.signals.</code><code class="descname">user_activated</code><a class="headerlink" href="#registration.signals.user_activated" title="Permalink to this definition">¶</a></dt>
<dd><p>Sent when a user account is activated (not applicable to all
workflows). Provides the following arguments:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">sender</span></code></dt>
<dd>The <a class="reference internal" href="views.html#registration.views.ActivationView" title="registration.views.ActivationView"><code class="xref py py-class docutils literal"><span class="pre">ActivationView</span></code></a> subclass used
to activate the user.</dd>
<dt><code class="docutils literal"><span class="pre">user</span></code></dt>
<dd>A user-model instance representing the activated account.</dd>
<dt><code class="docutils literal"><span class="pre">request</span></code></dt>
<dd>The <code class="docutils literal"><span class="pre">HttpRequest</span></code> in which the account was activated.</dd>
</dl>
</dd></dl>
<dl class="data">
<dt id="registration.signals.user_registered">
<code class="descclassname">registration.signals.</code><code class="descname">user_registered</code><a class="headerlink" href="#registration.signals.user_registered" title="Permalink to this definition">¶</a></dt>
<dd><p>Sent when a new user account is registered. Provides the following
arguments:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">sender</span></code></dt>
<dd>The <a class="reference internal" href="views.html#registration.views.RegistrationView" title="registration.views.RegistrationView"><code class="xref py py-class docutils literal"><span class="pre">RegistrationView</span></code></a> subclass used
to register the account.</dd>
<dt><code class="docutils literal"><span class="pre">user</span></code></dt>
<dd>A user-model instance representing the new account.</dd>
<dt><code class="docutils literal"><span class="pre">request</span></code></dt>
<dd>The <code class="docutils literal"><span class="pre">HttpRequest</span></code> in which the new account was registered.</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="upgrade.html" class="btn btn-neutral float-right" title="Upgrading from previous versions" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="settings.html" class="btn btn-neutral" title="Custom settings" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2007-2015, James Bennett.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'2.0.4',
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>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|