python/fastapi-users
1
0
Fork 0
mirror of https://github.com/fastapi-users/fastapi-users.git synced 2026-03-13 07:49:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 3bb3728 to dev with MkDocs 1.2.4 and mike 1.1.2

Browse Source
This commit is contained in:
fastapi-users-ci
2022-06-20 11:27:19 +00:00
parent 1e81e63ee3
commit 0ae4751032
4 changed files with 66 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
dev/configuration/user-manager/index.html
View File

@@ -710,6 +710,20 @@
on_after_reset_password
</a>
</li>
<li class="md-nav__item">
<a href="#on_before_delete" class="md-nav__link">
on_before_delete
</a>
</li>
<li class="md-nav__item">
<a href="#on_after_delete" class="md-nav__link">
on_after_delete
</a>
</li>
</ul>
@@ -1323,6 +1337,20 @@
on_after_reset_password
</a>
</li>
<li class="md-nav__item">
<a href="#on_before_delete" class="md-nav__link">
on_before_delete
</a>
</li>
<li class="md-nav__item">
<a href="#on_after_delete" class="md-nav__link">
on_after_delete
</a>
</li>
</ul>
@@ -1613,6 +1641,41 @@
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a> <span class="c1"># ...</span>
<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a> <span class="k">async</span> <span class="k">def</span> <span class="nf">on_after_reset_password</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">:</span> <span class="n">User</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Request</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;User </span><span class="si">{</span><span class="n">user</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2"> has reset their password.&quot;</span><span class="p">)</span>
</code></pre></div>
<h4 id="on_before_delete"><code>on_before_delete</code><a class="headerlink" href="#on_before_delete" title="Permanent link">&para;</a></h4>
<p>Perform logic before user delete.</p>
<p>For example, you may want to <strong>valide user resource integrity</strong> to see if any related user resource need to be marked inactive, or delete
them recursively.</p>
<p><strong>Arguments</strong></p>
<ul>
<li><code>user</code> (<code>User</code>): the user to be deleted.</li>
<li><code>request</code> (<code>Optional[Request]</code>): optional FastAPI request object that triggered the operation. Defaults to None.</li>
</ul>
<p><strong>Example</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="kn">from</span> <span class="nn">fastapi_users</span> <span class="kn">import</span> <span class="n">BaseUserManager</span><span class="p">,</span> <span class="n">UUIDIDMixin</span>
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a>
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="k">class</span> <span class="nc">UserManager</span><span class="p">(</span><span class="n">UUIDIDMixin</span><span class="p">,</span> <span class="n">BaseUserManager</span><span class="p">[</span><span class="n">User</span><span class="p">,</span> <span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">]):</span>
<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a> <span class="c1"># ...</span>
<a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a> <span class="k">async</span> <span class="k">def</span> <span class="nf">on_before_delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">:</span> <span class="n">User</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Request</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;User </span><span class="si">{</span><span class="n">user</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2"> is going to be deleted&quot;</span><span class="p">)</span>
</code></pre></div>
<h4 id="on_after_delete"><code>on_after_delete</code><a class="headerlink" href="#on_after_delete" title="Permanent link">&para;</a></h4>
<p>Perform logic after user delete.</p>
<p>For example, you may want to <strong>send an email</strong> to the administrator about the event.</p>
<p><strong>Arguments</strong></p>
<ul>
<li><code>user</code> (<code>User</code>): the user to be deleted.</li>
<li><code>request</code> (<code>Optional[Request]</code>): optional FastAPI request object that triggered the operation. Defaults to None.</li>
</ul>
<p><strong>Example</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="kn">from</span> <span class="nn">fastapi_users</span> <span class="kn">import</span> <span class="n">BaseUserManager</span><span class="p">,</span> <span class="n">UUIDIDMixin</span>
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a>
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a>
<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="k">class</span> <span class="nc">UserManager</span><span class="p">(</span><span class="n">UUIDIDMixin</span><span class="p">,</span> <span class="n">BaseUserManager</span><span class="p">[</span><span class="n">User</span><span class="p">,</span> <span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">]):</span>
<a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a> <span class="c1"># ...</span>
<a id="__codelineno-11-6" name="__codelineno-11-6" href="#__codelineno-11-6"></a> <span class="k">async</span> <span class="k">def</span> <span class="nf">on_after_delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">:</span> <span class="n">User</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Request</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<a id="__codelineno-11-7" name="__codelineno-11-7" href="#__codelineno-11-7"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;User </span><span class="si">{</span><span class="n">user</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2"> is successfully deleted&quot;</span><span class="p">)</span>
</code></pre></div>