|
1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>pyams_utils.interfaces package — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
28 <!--[if lte IE 6]> |
|
29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
30 <![endif]--> |
|
31 |
|
32 </head> |
|
33 <body> |
|
34 |
|
35 <div class="related" role="navigation" aria-label="related navigation"> |
|
36 <h3>Navigation</h3> |
|
37 <ul> |
|
38 <li class="right" style="margin-right: 10px"> |
|
39 <a href="genindex.html" title="General Index" |
|
40 accesskey="I">index</a></li> |
|
41 <li class="right" > |
|
42 <a href="py-modindex.html" title="Python Module Index" |
|
43 >modules</a> |</li> |
|
44 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
45 </ul> |
|
46 </div> |
|
47 |
|
48 <div class="document"> |
|
49 <div class="documentwrapper"> |
|
50 <div class="bodywrapper"> |
|
51 <div class="body" role="main"> |
|
52 |
|
53 <div class="section" id="pyams-utils-interfaces-package"> |
|
54 <h1>pyams_utils.interfaces package<a class="headerlink" href="#pyams-utils-interfaces-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="module-pyams_utils.interfaces"> |
|
56 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_utils.interfaces" title="Permalink to this headline">¶</a></h2> |
|
57 <dl class="data"> |
|
58 <dt id="pyams_utils.interfaces.FORBIDDEN_PERMISSION"> |
|
59 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">FORBIDDEN_PERMISSION</code><em class="property"> = 'system.forbidden'</em><a class="headerlink" href="#pyams_utils.interfaces.FORBIDDEN_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
60 <dd><p>Custom permission which is never granted to any user</p> |
|
61 </dd></dl> |
|
62 |
|
63 <dl class="data"> |
|
64 <dt id="pyams_utils.interfaces.MANAGE_PERMISSION"> |
|
65 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_PERMISSION</code><em class="property"> = 'manage'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
66 <dd><p>Permission used to manage basic information; this permission is generally not used by custom contents</p> |
|
67 </dd></dl> |
|
68 |
|
69 <dl class="data"> |
|
70 <dt id="pyams_utils.interfaces.MANAGE_ROLES_PERMISSION"> |
|
71 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_ROLES_PERMISSION</code><em class="property"> = 'pyams.ManageRoles'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_ROLES_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
72 <dd><p>Permission used to manage roles</p> |
|
73 </dd></dl> |
|
74 |
|
75 <dl class="data"> |
|
76 <dt id="pyams_utils.interfaces.MANAGE_SECURITY_PERMISSION"> |
|
77 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_SECURITY_PERMISSION</code><em class="property"> = 'pyams.ManageSecurity'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_SECURITY_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
78 <dd><p>Permission used to manage security settings</p> |
|
79 </dd></dl> |
|
80 |
|
81 <dl class="data"> |
|
82 <dt id="pyams_utils.interfaces.MANAGE_SKIN_PERMISSION"> |
|
83 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_SKIN_PERMISSION</code><em class="property"> = 'pyams.ManageSkin'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_SKIN_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
84 <dd><p>Permission used to manage skin</p> |
|
85 </dd></dl> |
|
86 |
|
87 <dl class="data"> |
|
88 <dt id="pyams_utils.interfaces.MANAGE_SYSTEM_PERMISSION"> |
|
89 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MANAGE_SYSTEM_PERMISSION</code><em class="property"> = 'pyams.ManageSystem'</em><a class="headerlink" href="#pyams_utils.interfaces.MANAGE_SYSTEM_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
90 <dd><p>Permission used to manage system settings</p> |
|
91 </dd></dl> |
|
92 |
|
93 <dl class="exception"> |
|
94 <dt id="pyams_utils.interfaces.MissingRequestError"> |
|
95 <em class="property">exception </em><code class="descclassname">pyams_utils.interfaces.</code><code class="descname">MissingRequestError</code><a class="headerlink" href="#pyams_utils.interfaces.MissingRequestError" title="Permalink to this definition">¶</a></dt> |
|
96 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></p> |
|
97 <p>Error raised when no request is available</p> |
|
98 </dd></dl> |
|
99 |
|
100 <dl class="data"> |
|
101 <dt id="pyams_utils.interfaces.PUBLIC_PERMISSION"> |
|
102 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">PUBLIC_PERMISSION</code><em class="property"> = 'public'</em><a class="headerlink" href="#pyams_utils.interfaces.PUBLIC_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
103 <dd><p>Public permission which is granted to every principal</p> |
|
104 </dd></dl> |
|
105 |
|
106 <dl class="data"> |
|
107 <dt id="pyams_utils.interfaces.PYAMS_APPLICATION_DEFAULT_NAME"> |
|
108 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">PYAMS_APPLICATION_DEFAULT_NAME</code><em class="property"> = 'application'</em><a class="headerlink" href="#pyams_utils.interfaces.PYAMS_APPLICATION_DEFAULT_NAME" title="Permalink to this definition">¶</a></dt> |
|
109 <dd><p>ZODB default application name</p> |
|
110 </dd></dl> |
|
111 |
|
112 <dl class="data"> |
|
113 <dt id="pyams_utils.interfaces.PYAMS_APPLICATION_FACTORY_KEY"> |
|
114 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">PYAMS_APPLICATION_FACTORY_KEY</code><em class="property"> = 'pyams.application_factory'</em><a class="headerlink" href="#pyams_utils.interfaces.PYAMS_APPLICATION_FACTORY_KEY" title="Permalink to this definition">¶</a></dt> |
|
115 <dd><p>Settings key to define site root factory</p> |
|
116 </dd></dl> |
|
117 |
|
118 <dl class="data"> |
|
119 <dt id="pyams_utils.interfaces.PYAMS_APPLICATION_SETTINGS_KEY"> |
|
120 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">PYAMS_APPLICATION_SETTINGS_KEY</code><em class="property"> = 'pyams.application_name'</em><a class="headerlink" href="#pyams_utils.interfaces.PYAMS_APPLICATION_SETTINGS_KEY" title="Permalink to this definition">¶</a></dt> |
|
121 <dd><p>ZODB application name settings key</p> |
|
122 </dd></dl> |
|
123 |
|
124 <dl class="data"> |
|
125 <dt id="pyams_utils.interfaces.VIEW_PERMISSION"> |
|
126 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">VIEW_PERMISSION</code><em class="property"> = 'view'</em><a class="headerlink" href="#pyams_utils.interfaces.VIEW_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
127 <dd><p>View permission is a custom permission used to view contents</p> |
|
128 </dd></dl> |
|
129 |
|
130 <dl class="data"> |
|
131 <dt id="pyams_utils.interfaces.VIEW_SYSTEM_PERMISSION"> |
|
132 <code class="descclassname">pyams_utils.interfaces.</code><code class="descname">VIEW_SYSTEM_PERMISSION</code><em class="property"> = 'pyams.ViewSystem'</em><a class="headerlink" href="#pyams_utils.interfaces.VIEW_SYSTEM_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
133 <dd><p>Permission used to access management screens</p> |
|
134 </dd></dl> |
|
135 |
|
136 </div> |
|
137 <div class="section" id="submodules"> |
|
138 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
139 <div class="section" id="module-pyams_utils.interfaces.data"> |
|
140 <span id="pyams-utils-interfaces-data-module"></span><h3>pyams_utils.interfaces.data module<a class="headerlink" href="#module-pyams_utils.interfaces.data" title="Permalink to this headline">¶</a></h3> |
|
141 </div> |
|
142 <div class="section" id="module-pyams_utils.interfaces.intids"> |
|
143 <span id="pyams-utils-interfaces-intids-module"></span><h3>pyams_utils.interfaces.intids module<a class="headerlink" href="#module-pyams_utils.interfaces.intids" title="Permalink to this headline">¶</a></h3> |
|
144 </div> |
|
145 <div class="section" id="module-pyams_utils.interfaces.site"> |
|
146 <span id="pyams-utils-interfaces-site-module"></span><h3>pyams_utils.interfaces.site module<a class="headerlink" href="#module-pyams_utils.interfaces.site" title="Permalink to this headline">¶</a></h3> |
|
147 </div> |
|
148 <div class="section" id="module-pyams_utils.interfaces.size"> |
|
149 <span id="pyams-utils-interfaces-size-module"></span><h3>pyams_utils.interfaces.size module<a class="headerlink" href="#module-pyams_utils.interfaces.size" title="Permalink to this headline">¶</a></h3> |
|
150 </div> |
|
151 <div class="section" id="module-pyams_utils.interfaces.tales"> |
|
152 <span id="pyams-utils-interfaces-tales-module"></span><h3>pyams_utils.interfaces.tales module<a class="headerlink" href="#module-pyams_utils.interfaces.tales" title="Permalink to this headline">¶</a></h3> |
|
153 </div> |
|
154 <div class="section" id="module-pyams_utils.interfaces.text"> |
|
155 <span id="pyams-utils-interfaces-text-module"></span><h3>pyams_utils.interfaces.text module<a class="headerlink" href="#module-pyams_utils.interfaces.text" title="Permalink to this headline">¶</a></h3> |
|
156 </div> |
|
157 <div class="section" id="module-pyams_utils.interfaces.timezone"> |
|
158 <span id="pyams-utils-interfaces-timezone-module"></span><h3>pyams_utils.interfaces.timezone module<a class="headerlink" href="#module-pyams_utils.interfaces.timezone" title="Permalink to this headline">¶</a></h3> |
|
159 <dl class="class"> |
|
160 <dt id="pyams_utils.interfaces.timezone.Timezone"> |
|
161 <em class="property">class </em><code class="descclassname">pyams_utils.interfaces.timezone.</code><code class="descname">Timezone</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.interfaces.timezone.Timezone" title="Permalink to this definition">¶</a></dt> |
|
162 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._field.Choice</span></code></p> |
|
163 <p>Timezone choice field</p> |
|
164 </dd></dl> |
|
165 |
|
166 </div> |
|
167 <div class="section" id="module-pyams_utils.interfaces.traversing"> |
|
168 <span id="pyams-utils-interfaces-traversing-module"></span><h3>pyams_utils.interfaces.traversing module<a class="headerlink" href="#module-pyams_utils.interfaces.traversing" title="Permalink to this headline">¶</a></h3> |
|
169 </div> |
|
170 <div class="section" id="module-pyams_utils.interfaces.tree"> |
|
171 <span id="pyams-utils-interfaces-tree-module"></span><h3>pyams_utils.interfaces.tree module<a class="headerlink" href="#module-pyams_utils.interfaces.tree" title="Permalink to this headline">¶</a></h3> |
|
172 </div> |
|
173 <div class="section" id="module-pyams_utils.interfaces.zeo"> |
|
174 <span id="pyams-utils-interfaces-zeo-module"></span><h3>pyams_utils.interfaces.zeo module<a class="headerlink" href="#module-pyams_utils.interfaces.zeo" title="Permalink to this headline">¶</a></h3> |
|
175 </div> |
|
176 </div> |
|
177 </div> |
|
178 |
|
179 |
|
180 </div> |
|
181 </div> |
|
182 </div> |
|
183 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
184 <div class="sphinxsidebarwrapper"> |
|
185 <h3><a href="index.html">Table Of Contents</a></h3> |
|
186 <ul> |
|
187 <li><a class="reference internal" href="#">pyams_utils.interfaces package</a><ul> |
|
188 <li><a class="reference internal" href="#module-pyams_utils.interfaces">Module contents</a></li> |
|
189 <li><a class="reference internal" href="#submodules">Submodules</a><ul> |
|
190 <li><a class="reference internal" href="#module-pyams_utils.interfaces.data">pyams_utils.interfaces.data module</a></li> |
|
191 <li><a class="reference internal" href="#module-pyams_utils.interfaces.intids">pyams_utils.interfaces.intids module</a></li> |
|
192 <li><a class="reference internal" href="#module-pyams_utils.interfaces.site">pyams_utils.interfaces.site module</a></li> |
|
193 <li><a class="reference internal" href="#module-pyams_utils.interfaces.size">pyams_utils.interfaces.size module</a></li> |
|
194 <li><a class="reference internal" href="#module-pyams_utils.interfaces.tales">pyams_utils.interfaces.tales module</a></li> |
|
195 <li><a class="reference internal" href="#module-pyams_utils.interfaces.text">pyams_utils.interfaces.text module</a></li> |
|
196 <li><a class="reference internal" href="#module-pyams_utils.interfaces.timezone">pyams_utils.interfaces.timezone module</a></li> |
|
197 <li><a class="reference internal" href="#module-pyams_utils.interfaces.traversing">pyams_utils.interfaces.traversing module</a></li> |
|
198 <li><a class="reference internal" href="#module-pyams_utils.interfaces.tree">pyams_utils.interfaces.tree module</a></li> |
|
199 <li><a class="reference internal" href="#module-pyams_utils.interfaces.zeo">pyams_utils.interfaces.zeo module</a></li> |
|
200 </ul> |
|
201 </li> |
|
202 </ul> |
|
203 </li> |
|
204 </ul> |
|
205 |
|
206 <div id="searchbox" style="display: none" role="search"> |
|
207 <h3>Quick search</h3> |
|
208 <form class="search" action="search.html" method="get"> |
|
209 <div><input type="text" name="q" /></div> |
|
210 <div><input type="submit" value="Go" /></div> |
|
211 <input type="hidden" name="check_keywords" value="yes" /> |
|
212 <input type="hidden" name="area" value="default" /> |
|
213 </form> |
|
214 </div> |
|
215 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
216 </div> |
|
217 </div> |
|
218 <div class="clearer"></div> |
|
219 </div> |
|
220 <div class="related" role="navigation" aria-label="related navigation"> |
|
221 <h3>Navigation</h3> |
|
222 <ul> |
|
223 <li class="right" style="margin-right: 10px"> |
|
224 <a href="genindex.html" title="General Index" |
|
225 >index</a></li> |
|
226 <li class="right" > |
|
227 <a href="py-modindex.html" title="Python Module Index" |
|
228 >modules</a> |</li> |
|
229 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
230 </ul> |
|
231 </div> |
|
232 <div class="footer" role="contentinfo"> |
|
233 © Copyright 2017, Thierry Florac. |
|
234 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
235 </div> |
|
236 </body> |
|
237 </html> |