<html lang="en" data-content_root="../../">

<head>

<meta charset="utf-8" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>auth.base module &#8212; Source.Python v743 documentation</title>

<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />

<link rel="stylesheet" type="text/css" href="../../_static/classic.css?v=2780edc4" />

<script src="../../_static/documentation_options.js?v=b6beb2eb"></script>

<script src="../../_static/doctools.js?v=9bcbadda"></script>

<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>

<link rel="icon" href="../../_static/sp_wiki_favicon.png"/>

<link rel="index" title="Index" href="../../genindex.html" />

<link rel="search" title="Search" href="../../search.html" />

</head><body>

<div class="related" role="navigation" aria-label="Related">

<h3>Navigation</h3>

<ul>

<li class="right" style="margin-right: 10px">

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<li class="right" >

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> &#187;</li>

<li class="nav-item nav-item-this"><a href="">auth.base module</a></li>

</ul>

</div>

<div class="document">

<div class="documentwrapper">

<div class="bodywrapper">

<div class="body" role="main">

<section id="module-auth.base">

<span id="auth-base-module"></span><h1>auth.base module<a class="headerlink" href="#module-auth.base" title="Link to this heading">¶</a></h1>

<p>Provides the base class for every backend.</p>

<dl class="py class">

<dt class="sig sig-object py" id="auth.base.Backend">

<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">auth.base.</span></span><span class="sig-name descname"><span class="pre">Backend</span></span><a class="reference internal" href="../../_modules/auth/base.html#Backend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#auth.base.Backend" title="Link to this definition">¶</a></dt>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3.13/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<dl class="py method">

<dt class="sig sig-object py" id="auth.base.Backend.group_added">

<span class="sig-name descname"><span class="pre">group_added</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/auth/base.html#Backend.group_added"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#auth.base.Backend.group_added" title="Link to this definition">¶</a></dt>

<dd><p>Called when a group has been added.</p>

<dl class="py method">

<dt class="sig sig-object py" id="auth.base.Backend.group_removed">

<span class="sig-name descname"><span class="pre">group_removed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/auth/base.html#Backend.group_removed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#auth.base.Backend.group_removed" title="Link to this definition">¶</a></dt>

<dd><p>Called when a group has been removed.</p>

<dl class="py method">

<dt class="sig sig-object py" id="auth.base.Backend.load">

<span class="sig-name descname"><span class="pre">load</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/auth/base.html#Backend.load"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#auth.base.Backend.load" title="Link to this definition">¶</a></dt>

<dd><p>Called when the backend is loaded.</p>

<dl class="py method">

<dt class="sig sig-object py" id="auth.base.Backend.permission_added">

<span class="sig-name descname"><span class="pre">permission_added</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permission</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/auth/base.html#Backend.permission_added"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#auth.base.Backend.permission_added" title="Link to this definition">¶</a></dt>

<dd><p>Called when a permission has been added.</p>

<dl class="py method">

<dt class="sig sig-object py" id="auth.base.Backend.permission_removed">

<span class="sig-name descname"><span class="pre">permission_removed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permission</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/auth/base.html#Backend.permission_removed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#auth.base.Backend.permission_removed" title="Link to this definition">¶</a></dt>

<dd><p>Called when a permission has been removed.</p>

<dl class="py method">

<dt class="sig sig-object py" id="auth.base.Backend.sync">

<span class="sig-name descname"><span class="pre">sync</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/auth/base.html#Backend.sync"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#auth.base.Backend.sync" title="Link to this definition">¶</a></dt>

<dd><p>Synchronize the auth_manager with the backend.</p>

<dl class="py method">

<dt class="sig sig-object py" id="auth.base.Backend.unload">

<span class="sig-name descname"><span class="pre">unload</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/auth/base.html#Backend.unload"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#auth.base.Backend.unload" title="Link to this definition">¶</a></dt>

<dd><p>Called when the backend is unloaded.</p>

<dl class="py property">

<dt class="sig sig-object py" id="auth.base.Backend.name">

<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#auth.base.Backend.name" title="Link to this definition">¶</a></dt>

<dd><p>Return the name of the backend.</p>

<dl class="py attribute">

<dt class="sig sig-object py" id="auth.base.Backend.options">

<span class="sig-name descname"><span class="pre">options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#auth.base.Backend.options" title="Link to this definition">¶</a></dt>

<div class="clearer"></div>

</div>

</div>

</div>

<div class="sphinxsidebar" role="navigation" aria-label="Main">

<div class="sphinxsidebarwrapper">

<p class="logo"><a href="../../index.html">

<img class="logo" src="../../_static/sp_wiki_banner.png" alt="Logo of Source.Python"/>

</a></p>

<div>

<h3><a href="../../index.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">auth.base module</a><ul>

<li><a class="reference internal" href="#auth.base.Backend"><code class="docutils literal notranslate"><span class="pre">Backend</span></code></a><ul>

<li><a class="reference internal" href="#auth.base.Backend.group_added"><code class="docutils literal notranslate"><span class="pre">Backend.group_added()</span></code></a></li>

<li><a class="reference internal" href="#auth.base.Backend.group_removed"><code class="docutils literal notranslate"><span class="pre">Backend.group_removed()</span></code></a></li>

<li><a class="reference internal" href="#auth.base.Backend.load"><code class="docutils literal notranslate"><span class="pre">Backend.load()</span></code></a></li>

<li><a class="reference internal" href="#auth.base.Backend.permission_added"><code class="docutils literal notranslate"><span class="pre">Backend.permission_added()</span></code></a></li>

<li><a class="reference internal" href="#auth.base.Backend.permission_removed"><code class="docutils literal notranslate"><span class="pre">Backend.permission_removed()</span></code></a></li>

<li><a class="reference internal" href="#auth.base.Backend.sync"><code class="docutils literal notranslate"><span class="pre">Backend.sync()</span></code></a></li>

<li><a class="reference internal" href="#auth.base.Backend.unload"><code class="docutils literal notranslate"><span class="pre">Backend.unload()</span></code></a></li>

<li><a class="reference internal" href="#auth.base.Backend.name"><code class="docutils literal notranslate"><span class="pre">Backend.name</span></code></a></li>

<li><a class="reference internal" href="#auth.base.Backend.options"><code class="docutils literal notranslate"><span class="pre">Backend.options</span></code></a></li>

</div>

<div role="note" aria-label="source link">

<h3>This Page</h3>

<ul class="this-page-menu">

<li><a href="../../_sources/developing/modules/auth.base.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<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>

<script>document.getElementById('searchbox').style.display = "block"</script>

</div>

</div>

<div class="clearer"></div>

</div>

<div class="related" role="navigation" aria-label="Related">

<h3>Navigation</h3>

<ul>

<li class="right" style="margin-right: 10px">

<a href="../../genindex.html" title="General Index"

>index</a></li>

<li class="right" >

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> &#187;</li>

<li class="nav-item nav-item-this"><a href="">auth.base module</a></li>

</ul>

</div>

<div class="footer" role="contentinfo">

&#169; Copyright 2025, Source.Python Development Team.

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>