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