Source.Python/docs/_modules/auth/base.html at master · Source-Python-Dev-Team/Source.Python · GitHub

Repository navigation

History

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

<!DOCTYPE html>

<head>

<title>auth.base — Source.Python v743 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

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

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

<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> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>

</ul>

</div>

<h1>Source code for auth.base</h1><div class="highlight"><pre>

<span class="sd">"""Provides the base class for every backend."""</span>

<span class="c1"># >> ALL DECLARATION</span>

<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'Backend'</span><span class="p">,</span>

<span class="c1"># >> CLASSES</span>

<span class="k">class</span><span class="w"> </span><span class="nc">Backend</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>

<span class="n">options</span> <span class="o">=</span> <span class="p">{}</span>

<span class="w"> </span><span class="sd">"""Called when the backend is loaded."""</span>

<span class="k">def</span><span class="w"> </span><span class="nf">unload</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

<span class="w"> </span><span class="sd">"""Called when the backend is unloaded."""</span>

<span class="k">def</span><span class="w"> </span><span class="nf">permission_added</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node</span><span class="p">,</span> <span class="n">permission</span><span class="p">,</span> <span class="n">server_id</span><span class="p">):</span>

<span class="w"> </span><span class="sd">"""Called when a permission has been added."""</span>

<span class="k">def</span><span class="w"> </span><span class="nf">permission_removed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node</span><span class="p">,</span> <span class="n">permission</span><span class="p">,</span> <span class="n">server_id</span><span class="p">):</span>

<span class="w"> </span><span class="sd">"""Called when a permission has been removed."""</span>

<span class="k">def</span><span class="w"> </span><span class="nf">group_added</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node</span><span class="p">,</span> <span class="n">group_name</span><span class="p">):</span>

<span class="w"> </span><span class="sd">"""Called when a group has been added."""</span>

<span class="k">def</span><span class="w"> </span><span class="nf">group_removed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node</span><span class="p">,</span> <span class="n">group_name</span><span class="p">):</span>

<span class="w"> </span><span class="sd">"""Called when a group has been removed."""</span>

<span class="w"> </span><span class="sd">"""Synchronize the auth_manager with the backend."""</span>

<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'Backend must define a sync method.'</span><span class="p">)</span></div>

<span class="nd">@property</span>

<span class="w"> </span><span class="sd">"""Return the name of the backend."""</span>

<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'Every backend must define a name.'</span><span class="p">)</span></div>

</pre></div>

</div>

</a></p>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

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

>index</a></li>

<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> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

</ul>

</div>

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

</div>

</body>

</html>

Source.Python/docs/_modules/auth/base.html at master · Source-Python-Dev-Team/Source.Python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

base.html

Latest commit

History

Breadcrumbs

base.html

File metadata and controls