src/build/html/pyams_scheduler.html
changeset 11 ba0b83b57c0c
parent 10 1d12ff3f036a
child 12 f1f1e99a6572
equal deleted inserted replaced
10:1d12ff3f036a 11:ba0b83b57c0c
     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_scheduler package &#8212; 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&amp;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&amp;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> &#187;</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-scheduler-package">
       
    54 <h1>pyams_scheduler package<a class="headerlink" href="#pyams-scheduler-package" title="Permalink to this headline">¶</a></h1>
       
    55 <div class="section" id="subpackages">
       
    56 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
       
    57 <div class="toctree-wrapper compound">
       
    58 <ul>
       
    59 <li class="toctree-l1"><a class="reference internal" href="pyams_scheduler.interfaces.html">pyams_scheduler.interfaces package</a><ul>
       
    60 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.interfaces.html#submodules">Submodules</a></li>
       
    61 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.interfaces.html#module-pyams_scheduler.interfaces.ssh">pyams_scheduler.interfaces.ssh module</a></li>
       
    62 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.interfaces.html#module-pyams_scheduler.interfaces.url">pyams_scheduler.interfaces.url module</a></li>
       
    63 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.interfaces.html#module-pyams_scheduler.interfaces.zodb">pyams_scheduler.interfaces.zodb module</a></li>
       
    64 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.interfaces.html#module-pyams_scheduler.interfaces">Module contents</a></li>
       
    65 </ul>
       
    66 </li>
       
    67 <li class="toctree-l1"><a class="reference internal" href="pyams_scheduler.tests.html">pyams_scheduler.tests package</a><ul>
       
    68 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.tests.html#submodules">Submodules</a></li>
       
    69 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.tests.html#module-pyams_scheduler.tests.test_utilsdocs">pyams_scheduler.tests.test_utilsdocs module</a></li>
       
    70 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.tests.html#module-pyams_scheduler.tests.test_utilsdocstrings">pyams_scheduler.tests.test_utilsdocstrings module</a></li>
       
    71 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.tests.html#module-pyams_scheduler.tests">Module contents</a></li>
       
    72 </ul>
       
    73 </li>
       
    74 <li class="toctree-l1"><a class="reference internal" href="pyams_scheduler.zmi.html">pyams_scheduler.zmi package</a><ul>
       
    75 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.zmi.html#submodules">Submodules</a></li>
       
    76 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.zmi.html#module-pyams_scheduler.zmi.interfaces">pyams_scheduler.zmi.interfaces module</a></li>
       
    77 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.zmi.html#module-pyams_scheduler.zmi.scheduler">pyams_scheduler.zmi.scheduler module</a></li>
       
    78 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.zmi.html#module-pyams_scheduler.zmi.ssh">pyams_scheduler.zmi.ssh module</a></li>
       
    79 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.zmi.html#module-pyams_scheduler.zmi.task">pyams_scheduler.zmi.task module</a></li>
       
    80 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.zmi.html#module-pyams_scheduler.zmi.url">pyams_scheduler.zmi.url module</a></li>
       
    81 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.zmi.html#module-pyams_scheduler.zmi.zodb">pyams_scheduler.zmi.zodb module</a></li>
       
    82 <li class="toctree-l2"><a class="reference internal" href="pyams_scheduler.zmi.html#module-pyams_scheduler.zmi">Module contents</a></li>
       
    83 </ul>
       
    84 </li>
       
    85 </ul>
       
    86 </div>
       
    87 </div>
       
    88 <div class="section" id="submodules">
       
    89 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
       
    90 </div>
       
    91 <div class="section" id="module-pyams_scheduler.include">
       
    92 <span id="pyams-scheduler-include-module"></span><h2>pyams_scheduler.include module<a class="headerlink" href="#module-pyams_scheduler.include" title="Permalink to this headline">¶</a></h2>
       
    93 <dl class="function">
       
    94 <dt id="pyams_scheduler.include.handle_new_application">
       
    95 <code class="descclassname">pyams_scheduler.include.</code><code class="descname">handle_new_application</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.include.handle_new_application" title="Permalink to this definition">¶</a></dt>
       
    96 <dd><p>Start scheduler process when application is created</p>
       
    97 </dd></dl>
       
    98 
       
    99 <dl class="function">
       
   100 <dt id="pyams_scheduler.include.include_package">
       
   101 <code class="descclassname">pyams_scheduler.include.</code><code class="descname">include_package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.include.include_package" title="Permalink to this definition">¶</a></dt>
       
   102 <dd><p>Pyramid package include</p>
       
   103 </dd></dl>
       
   104 
       
   105 </div>
       
   106 <div class="section" id="module-pyams_scheduler.process">
       
   107 <span id="pyams-scheduler-process-module"></span><h2>pyams_scheduler.process module<a class="headerlink" href="#module-pyams_scheduler.process" title="Permalink to this headline">¶</a></h2>
       
   108 <dl class="class">
       
   109 <dt id="pyams_scheduler.process.BaseTaskThread">
       
   110 <em class="property">class </em><code class="descclassname">pyams_scheduler.process.</code><code class="descname">BaseTaskThread</code><span class="sig-paren">(</span><em>process</em>, <em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.BaseTaskThread" title="Permalink to this definition">¶</a></dt>
       
   111 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">threading.Thread</span></code></p>
       
   112 </dd></dl>
       
   113 
       
   114 <dl class="class">
       
   115 <dt id="pyams_scheduler.process.SchedulerHandler">
       
   116 <em class="property">class </em><code class="descclassname">pyams_scheduler.process.</code><code class="descname">SchedulerHandler</code><a class="headerlink" href="#pyams_scheduler.process.SchedulerHandler" title="Permalink to this definition">¶</a></dt>
       
   117 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   118 <p>Scheduler handler</p>
       
   119 <dl class="method">
       
   120 <dt id="pyams_scheduler.process.SchedulerHandler.get_jobs">
       
   121 <code class="descname">get_jobs</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.SchedulerHandler.get_jobs" title="Permalink to this definition">¶</a></dt>
       
   122 <dd></dd></dl>
       
   123 
       
   124 <dl class="method">
       
   125 <dt id="pyams_scheduler.process.SchedulerHandler.remove_task">
       
   126 <code class="descname">remove_task</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.SchedulerHandler.remove_task" title="Permalink to this definition">¶</a></dt>
       
   127 <dd></dd></dl>
       
   128 
       
   129 <dl class="method">
       
   130 <dt id="pyams_scheduler.process.SchedulerHandler.reset_task">
       
   131 <code class="descname">reset_task</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.SchedulerHandler.reset_task" title="Permalink to this definition">¶</a></dt>
       
   132 <dd></dd></dl>
       
   133 
       
   134 <dl class="method">
       
   135 <dt id="pyams_scheduler.process.SchedulerHandler.run_task">
       
   136 <code class="descname">run_task</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.SchedulerHandler.run_task" title="Permalink to this definition">¶</a></dt>
       
   137 <dd></dd></dl>
       
   138 
       
   139 <dl class="method">
       
   140 <dt id="pyams_scheduler.process.SchedulerHandler.test">
       
   141 <code class="descname">test</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.SchedulerHandler.test" title="Permalink to this definition">¶</a></dt>
       
   142 <dd></dd></dl>
       
   143 
       
   144 </dd></dl>
       
   145 
       
   146 <dl class="class">
       
   147 <dt id="pyams_scheduler.process.SchedulerMessageHandler">
       
   148 <em class="property">class </em><code class="descclassname">pyams_scheduler.process.</code><code class="descname">SchedulerMessageHandler</code><span class="sig-paren">(</span><em>process</em>, <em>stream</em>, <em>stop</em>, <em>handler=None</em>, <em>json_load=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.SchedulerMessageHandler" title="Permalink to this definition">¶</a></dt>
       
   149 <dd><p>Bases: <a class="reference internal" href="pyams_zmq.html#pyams_zmq.handler.ZMQMessageHandler" title="pyams_zmq.handler.ZMQMessageHandler"><code class="xref py py-class docutils literal"><span class="pre">pyams_zmq.handler.ZMQMessageHandler</span></code></a></p>
       
   150 <p>ØMQ scheduler messages handler</p>
       
   151 <dl class="attribute">
       
   152 <dt id="pyams_scheduler.process.SchedulerMessageHandler.handler">
       
   153 <code class="descname">handler</code><a class="headerlink" href="#pyams_scheduler.process.SchedulerMessageHandler.handler" title="Permalink to this definition">¶</a></dt>
       
   154 <dd><p>alias of <a class="reference internal" href="#pyams_scheduler.process.SchedulerHandler" title="pyams_scheduler.process.SchedulerHandler"><code class="xref py py-class docutils literal"><span class="pre">SchedulerHandler</span></code></a></p>
       
   155 </dd></dl>
       
   156 
       
   157 </dd></dl>
       
   158 
       
   159 <dl class="class">
       
   160 <dt id="pyams_scheduler.process.SchedulerProcess">
       
   161 <em class="property">class </em><code class="descclassname">pyams_scheduler.process.</code><code class="descname">SchedulerProcess</code><span class="sig-paren">(</span><em>zmq_address</em>, <em>handler</em>, <em>registry</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.SchedulerProcess" title="Permalink to this definition">¶</a></dt>
       
   162 <dd><p>Bases: <a class="reference internal" href="pyams_zmq.html#pyams_zmq.process.ZMQProcess" title="pyams_zmq.process.ZMQProcess"><code class="xref py py-class docutils literal"><span class="pre">pyams_zmq.process.ZMQProcess</span></code></a></p>
       
   163 <p>ØMQ tasks scheduler process</p>
       
   164 <dl class="method">
       
   165 <dt id="pyams_scheduler.process.SchedulerProcess.run">
       
   166 <code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.SchedulerProcess.run" title="Permalink to this definition">¶</a></dt>
       
   167 <dd></dd></dl>
       
   168 
       
   169 </dd></dl>
       
   170 
       
   171 <dl class="class">
       
   172 <dt id="pyams_scheduler.process.TaskRemoverThread">
       
   173 <em class="property">class </em><code class="descclassname">pyams_scheduler.process.</code><code class="descname">TaskRemoverThread</code><span class="sig-paren">(</span><em>process</em>, <em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.TaskRemoverThread" title="Permalink to this definition">¶</a></dt>
       
   174 <dd><p>Bases: <a class="reference internal" href="#pyams_scheduler.process.BaseTaskThread" title="pyams_scheduler.process.BaseTaskThread"><code class="xref py py-class docutils literal"><span class="pre">pyams_scheduler.process.BaseTaskThread</span></code></a></p>
       
   175 <p>Task remover thread</p>
       
   176 <dl class="method">
       
   177 <dt id="pyams_scheduler.process.TaskRemoverThread.run">
       
   178 <code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.TaskRemoverThread.run" title="Permalink to this definition">¶</a></dt>
       
   179 <dd></dd></dl>
       
   180 
       
   181 </dd></dl>
       
   182 
       
   183 <dl class="class">
       
   184 <dt id="pyams_scheduler.process.TaskResettingThread">
       
   185 <em class="property">class </em><code class="descclassname">pyams_scheduler.process.</code><code class="descname">TaskResettingThread</code><span class="sig-paren">(</span><em>process</em>, <em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.TaskResettingThread" title="Permalink to this definition">¶</a></dt>
       
   186 <dd><p>Bases: <a class="reference internal" href="#pyams_scheduler.process.BaseTaskThread" title="pyams_scheduler.process.BaseTaskThread"><code class="xref py py-class docutils literal"><span class="pre">pyams_scheduler.process.BaseTaskThread</span></code></a></p>
       
   187 <p>Task resetting thread</p>
       
   188 <p>Task reset is run in another thread, so that:
       
   189 - other transactions applied on updated tasks are visible
       
   190 - ØMQ request returns immediately to calling process</p>
       
   191 <dl class="method">
       
   192 <dt id="pyams_scheduler.process.TaskResettingThread.run">
       
   193 <code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.TaskResettingThread.run" title="Permalink to this definition">¶</a></dt>
       
   194 <dd></dd></dl>
       
   195 
       
   196 </dd></dl>
       
   197 
       
   198 <dl class="class">
       
   199 <dt id="pyams_scheduler.process.TaskRunnerThread">
       
   200 <em class="property">class </em><code class="descclassname">pyams_scheduler.process.</code><code class="descname">TaskRunnerThread</code><span class="sig-paren">(</span><em>process</em>, <em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.TaskRunnerThread" title="Permalink to this definition">¶</a></dt>
       
   201 <dd><p>Bases: <a class="reference internal" href="#pyams_scheduler.process.BaseTaskThread" title="pyams_scheduler.process.BaseTaskThread"><code class="xref py py-class docutils literal"><span class="pre">pyams_scheduler.process.BaseTaskThread</span></code></a></p>
       
   202 <p>Task immediate runner thread</p>
       
   203 <dl class="method">
       
   204 <dt id="pyams_scheduler.process.TaskRunnerThread.run">
       
   205 <code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.process.TaskRunnerThread.run" title="Permalink to this definition">¶</a></dt>
       
   206 <dd></dd></dl>
       
   207 
       
   208 </dd></dl>
       
   209 
       
   210 </div>
       
   211 <div class="section" id="module-pyams_scheduler.scheduler">
       
   212 <span id="pyams-scheduler-scheduler-module"></span><h2>pyams_scheduler.scheduler module<a class="headerlink" href="#module-pyams_scheduler.scheduler" title="Permalink to this headline">¶</a></h2>
       
   213 <dl class="class">
       
   214 <dt id="pyams_scheduler.scheduler.Scheduler">
       
   215 <em class="property">class </em><code class="descclassname">pyams_scheduler.scheduler.</code><code class="descname">Scheduler</code><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler" title="Permalink to this definition">¶</a></dt>
       
   216 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
       
   217 <p>Scheduler utility</p>
       
   218 <dl class="method">
       
   219 <dt id="pyams_scheduler.scheduler.Scheduler.get_jobs">
       
   220 <code class="descname">get_jobs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler.get_jobs" title="Permalink to this definition">¶</a></dt>
       
   221 <dd></dd></dl>
       
   222 
       
   223 <dl class="method">
       
   224 <dt id="pyams_scheduler.scheduler.Scheduler.get_task">
       
   225 <code class="descname">get_task</code><span class="sig-paren">(</span><em>task_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler.get_task" title="Permalink to this definition">¶</a></dt>
       
   226 <dd></dd></dl>
       
   227 
       
   228 <dl class="attribute">
       
   229 <dt id="pyams_scheduler.scheduler.Scheduler.history">
       
   230 <code class="descname">history</code><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler.history" title="Permalink to this definition">¶</a></dt>
       
   231 <dd></dd></dl>
       
   232 
       
   233 <dl class="attribute">
       
   234 <dt id="pyams_scheduler.scheduler.Scheduler.internal_id">
       
   235 <code class="descname">internal_id</code><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler.internal_id" title="Permalink to this definition">¶</a></dt>
       
   236 <dd></dd></dl>
       
   237 
       
   238 <dl class="attribute">
       
   239 <dt id="pyams_scheduler.scheduler.Scheduler.report_mailer">
       
   240 <code class="descname">report_mailer</code><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler.report_mailer" title="Permalink to this definition">¶</a></dt>
       
   241 <dd><p>Computed attributes based on schema fields</p>
       
   242 <p>Field properties provide default values, data validation and error messages
       
   243 based on data found in field meta-data.</p>
       
   244 <p>Note that FieldProperties cannot be used with slots. They can only
       
   245 be used for attributes stored in instance dictionaries.</p>
       
   246 </dd></dl>
       
   247 
       
   248 <dl class="attribute">
       
   249 <dt id="pyams_scheduler.scheduler.Scheduler.report_source">
       
   250 <code class="descname">report_source</code><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler.report_source" title="Permalink to this definition">¶</a></dt>
       
   251 <dd><p>Computed attributes based on schema fields</p>
       
   252 <p>Field properties provide default values, data validation and error messages
       
   253 based on data found in field meta-data.</p>
       
   254 <p>Note that FieldProperties cannot be used with slots. They can only
       
   255 be used for attributes stored in instance dictionaries.</p>
       
   256 </dd></dl>
       
   257 
       
   258 <dl class="attribute">
       
   259 <dt id="pyams_scheduler.scheduler.Scheduler.tasks">
       
   260 <code class="descname">tasks</code><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler.tasks" title="Permalink to this definition">¶</a></dt>
       
   261 <dd></dd></dl>
       
   262 
       
   263 <dl class="method">
       
   264 <dt id="pyams_scheduler.scheduler.Scheduler.test_process">
       
   265 <code class="descname">test_process</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler.test_process" title="Permalink to this definition">¶</a></dt>
       
   266 <dd><p>Send test request to scheduler process</p>
       
   267 </dd></dl>
       
   268 
       
   269 <dl class="attribute">
       
   270 <dt id="pyams_scheduler.scheduler.Scheduler.zodb_name">
       
   271 <code class="descname">zodb_name</code><a class="headerlink" href="#pyams_scheduler.scheduler.Scheduler.zodb_name" title="Permalink to this definition">¶</a></dt>
       
   272 <dd><p>Computed attributes based on schema fields</p>
       
   273 <p>Field properties provide default values, data validation and error messages
       
   274 based on data found in field meta-data.</p>
       
   275 <p>Note that FieldProperties cannot be used with slots. They can only
       
   276 be used for attributes stored in instance dictionaries.</p>
       
   277 </dd></dl>
       
   278 
       
   279 </dd></dl>
       
   280 
       
   281 <dl class="class">
       
   282 <dt id="pyams_scheduler.scheduler.SchedulerHandler">
       
   283 <em class="property">class </em><code class="descclassname">pyams_scheduler.scheduler.</code><code class="descname">SchedulerHandler</code><a class="headerlink" href="#pyams_scheduler.scheduler.SchedulerHandler" title="Permalink to this definition">¶</a></dt>
       
   284 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   285 <p>Scheduler handler utility</p>
       
   286 <p>This is just a ‘marker’ utility which is used to mark nodes in a cluster
       
   287 which should run the scheduler</p>
       
   288 </dd></dl>
       
   289 
       
   290 </div>
       
   291 <div class="section" id="module-pyams_scheduler.site">
       
   292 <span id="pyams-scheduler-site-module"></span><h2>pyams_scheduler.site module<a class="headerlink" href="#module-pyams_scheduler.site" title="Permalink to this headline">¶</a></h2>
       
   293 <dl class="class">
       
   294 <dt id="pyams_scheduler.site.SchedulerGenerationsChecker">
       
   295 <em class="property">class </em><code class="descclassname">pyams_scheduler.site.</code><code class="descname">SchedulerGenerationsChecker</code><a class="headerlink" href="#pyams_scheduler.site.SchedulerGenerationsChecker" title="Permalink to this definition">¶</a></dt>
       
   296 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   297 <p>Scheduler generations checker</p>
       
   298 <dl class="method">
       
   299 <dt id="pyams_scheduler.site.SchedulerGenerationsChecker.evolve">
       
   300 <code class="descname">evolve</code><span class="sig-paren">(</span><em>site</em>, <em>current=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.site.SchedulerGenerationsChecker.evolve" title="Permalink to this definition">¶</a></dt>
       
   301 <dd><p>Check for required utilities</p>
       
   302 </dd></dl>
       
   303 
       
   304 <dl class="attribute">
       
   305 <dt id="pyams_scheduler.site.SchedulerGenerationsChecker.generation">
       
   306 <code class="descname">generation</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_scheduler.site.SchedulerGenerationsChecker.generation" title="Permalink to this definition">¶</a></dt>
       
   307 <dd></dd></dl>
       
   308 
       
   309 </dd></dl>
       
   310 
       
   311 <dl class="function">
       
   312 <dt id="pyams_scheduler.site.handle_new_local_site">
       
   313 <code class="descclassname">pyams_scheduler.site.</code><code class="descname">handle_new_local_site</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.site.handle_new_local_site" title="Permalink to this definition">¶</a></dt>
       
   314 <dd><p>Create a new scheduler when a site is created</p>
       
   315 </dd></dl>
       
   316 
       
   317 </div>
       
   318 <div class="section" id="module-pyams_scheduler.ssh">
       
   319 <span id="pyams-scheduler-ssh-module"></span><h2>pyams_scheduler.ssh module<a class="headerlink" href="#module-pyams_scheduler.ssh" title="Permalink to this headline">¶</a></h2>
       
   320 <dl class="class">
       
   321 <dt id="pyams_scheduler.ssh.SSHCallerTask">
       
   322 <em class="property">class </em><code class="descclassname">pyams_scheduler.ssh.</code><code class="descname">SSHCallerTask</code><a class="headerlink" href="#pyams_scheduler.ssh.SSHCallerTask" title="Permalink to this definition">¶</a></dt>
       
   323 <dd><p>Bases: <a class="reference internal" href="#pyams_scheduler.task.Task" title="pyams_scheduler.task.Task"><code class="xref py py-class docutils literal"><span class="pre">pyams_scheduler.task.Task</span></code></a></p>
       
   324 <p>SSH caller task</p>
       
   325 <dl class="attribute">
       
   326 <dt id="pyams_scheduler.ssh.SSHCallerTask.cmdline">
       
   327 <code class="descname">cmdline</code><a class="headerlink" href="#pyams_scheduler.ssh.SSHCallerTask.cmdline" title="Permalink to this definition">¶</a></dt>
       
   328 <dd><p>Computed attributes based on schema fields</p>
       
   329 <p>Field properties provide default values, data validation and error messages
       
   330 based on data found in field meta-data.</p>
       
   331 <p>Note that FieldProperties cannot be used with slots. They can only
       
   332 be used for attributes stored in instance dictionaries.</p>
       
   333 </dd></dl>
       
   334 
       
   335 <dl class="attribute">
       
   336 <dt id="pyams_scheduler.ssh.SSHCallerTask.hostname">
       
   337 <code class="descname">hostname</code><a class="headerlink" href="#pyams_scheduler.ssh.SSHCallerTask.hostname" title="Permalink to this definition">¶</a></dt>
       
   338 <dd><p>Computed attributes based on schema fields</p>
       
   339 <p>Field properties provide default values, data validation and error messages
       
   340 based on data found in field meta-data.</p>
       
   341 <p>Note that FieldProperties cannot be used with slots. They can only
       
   342 be used for attributes stored in instance dictionaries.</p>
       
   343 </dd></dl>
       
   344 
       
   345 <dl class="attribute">
       
   346 <dt id="pyams_scheduler.ssh.SSHCallerTask.password">
       
   347 <code class="descname">password</code><a class="headerlink" href="#pyams_scheduler.ssh.SSHCallerTask.password" title="Permalink to this definition">¶</a></dt>
       
   348 <dd><p>Computed attributes based on schema fields</p>
       
   349 <p>Field properties provide default values, data validation and error messages
       
   350 based on data found in field meta-data.</p>
       
   351 <p>Note that FieldProperties cannot be used with slots. They can only
       
   352 be used for attributes stored in instance dictionaries.</p>
       
   353 </dd></dl>
       
   354 
       
   355 <dl class="attribute">
       
   356 <dt id="pyams_scheduler.ssh.SSHCallerTask.port">
       
   357 <code class="descname">port</code><a class="headerlink" href="#pyams_scheduler.ssh.SSHCallerTask.port" title="Permalink to this definition">¶</a></dt>
       
   358 <dd><p>Computed attributes based on schema fields</p>
       
   359 <p>Field properties provide default values, data validation and error messages
       
   360 based on data found in field meta-data.</p>
       
   361 <p>Note that FieldProperties cannot be used with slots. They can only
       
   362 be used for attributes stored in instance dictionaries.</p>
       
   363 </dd></dl>
       
   364 
       
   365 <dl class="attribute">
       
   366 <dt id="pyams_scheduler.ssh.SSHCallerTask.private_key">
       
   367 <code class="descname">private_key</code><a class="headerlink" href="#pyams_scheduler.ssh.SSHCallerTask.private_key" title="Permalink to this definition">¶</a></dt>
       
   368 <dd><p>Computed attributes based on schema fields</p>
       
   369 <p>Field properties provide default values, data validation and error messages
       
   370 based on data found in field meta-data.</p>
       
   371 <p>Note that FieldProperties cannot be used with slots. They can only
       
   372 be used for attributes stored in instance dictionaries.</p>
       
   373 </dd></dl>
       
   374 
       
   375 <dl class="method">
       
   376 <dt id="pyams_scheduler.ssh.SSHCallerTask.run">
       
   377 <code class="descname">run</code><span class="sig-paren">(</span><em>report</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.ssh.SSHCallerTask.run" title="Permalink to this definition">¶</a></dt>
       
   378 <dd></dd></dl>
       
   379 
       
   380 <dl class="attribute">
       
   381 <dt id="pyams_scheduler.ssh.SSHCallerTask.username">
       
   382 <code class="descname">username</code><a class="headerlink" href="#pyams_scheduler.ssh.SSHCallerTask.username" title="Permalink to this definition">¶</a></dt>
       
   383 <dd><p>Computed attributes based on schema fields</p>
       
   384 <p>Field properties provide default values, data validation and error messages
       
   385 based on data found in field meta-data.</p>
       
   386 <p>Note that FieldProperties cannot be used with slots. They can only
       
   387 be used for attributes stored in instance dictionaries.</p>
       
   388 </dd></dl>
       
   389 
       
   390 </dd></dl>
       
   391 
       
   392 </div>
       
   393 <div class="section" id="module-pyams_scheduler.task">
       
   394 <span id="pyams-scheduler-task-module"></span><h2>pyams_scheduler.task module<a class="headerlink" href="#module-pyams_scheduler.task" title="Permalink to this headline">¶</a></h2>
       
   395 <dl class="class">
       
   396 <dt id="pyams_scheduler.task.ImmediateTaskTrigger">
       
   397 <em class="property">class </em><code class="descclassname">pyams_scheduler.task.</code><code class="descname">ImmediateTaskTrigger</code><a class="headerlink" href="#pyams_scheduler.task.ImmediateTaskTrigger" title="Permalink to this definition">¶</a></dt>
       
   398 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">apscheduler.triggers.base.BaseTrigger</span></code></p>
       
   399 <p>Immediate-style task scheduler</p>
       
   400 <dl class="method">
       
   401 <dt id="pyams_scheduler.task.ImmediateTaskTrigger.get_next_fire_time">
       
   402 <code class="descname">get_next_fire_time</code><span class="sig-paren">(</span><em>previous_fire_time</em>, <em>now</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.ImmediateTaskTrigger.get_next_fire_time" title="Permalink to this definition">¶</a></dt>
       
   403 <dd></dd></dl>
       
   404 
       
   405 </dd></dl>
       
   406 
       
   407 <dl class="class">
       
   408 <dt id="pyams_scheduler.task.Task">
       
   409 <em class="property">class </em><code class="descclassname">pyams_scheduler.task.</code><code class="descname">Task</code><a class="headerlink" href="#pyams_scheduler.task.Task" title="Permalink to this definition">¶</a></dt>
       
   410 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
       
   411 <p>Task definition persistent class</p>
       
   412 <dl class="method">
       
   413 <dt id="pyams_scheduler.task.Task.check_history">
       
   414 <code class="descname">check_history</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.Task.check_history" title="Permalink to this definition">¶</a></dt>
       
   415 <dd></dd></dl>
       
   416 
       
   417 <dl class="attribute">
       
   418 <dt id="pyams_scheduler.task.Task.errors_target">
       
   419 <code class="descname">errors_target</code><a class="headerlink" href="#pyams_scheduler.task.Task.errors_target" title="Permalink to this definition">¶</a></dt>
       
   420 <dd><p>Computed attributes based on schema fields</p>
       
   421 <p>Field properties provide default values, data validation and error messages
       
   422 based on data found in field meta-data.</p>
       
   423 <p>Note that FieldProperties cannot be used with slots. They can only
       
   424 be used for attributes stored in instance dictionaries.</p>
       
   425 </dd></dl>
       
   426 
       
   427 <dl class="method">
       
   428 <dt id="pyams_scheduler.task.Task.get_scheduling_info">
       
   429 <code class="descname">get_scheduling_info</code><span class="sig-paren">(</span><em>registry</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.Task.get_scheduling_info" title="Permalink to this definition">¶</a></dt>
       
   430 <dd></dd></dl>
       
   431 
       
   432 <dl class="method">
       
   433 <dt id="pyams_scheduler.task.Task.get_trigger">
       
   434 <code class="descname">get_trigger</code><span class="sig-paren">(</span><em>registry</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.Task.get_trigger" title="Permalink to this definition">¶</a></dt>
       
   435 <dd></dd></dl>
       
   436 
       
   437 <dl class="attribute">
       
   438 <dt id="pyams_scheduler.task.Task.history_duration">
       
   439 <code class="descname">history_duration</code><a class="headerlink" href="#pyams_scheduler.task.Task.history_duration" title="Permalink to this definition">¶</a></dt>
       
   440 <dd></dd></dl>
       
   441 
       
   442 <dl class="attribute">
       
   443 <dt id="pyams_scheduler.task.Task.history_length">
       
   444 <code class="descname">history_length</code><a class="headerlink" href="#pyams_scheduler.task.Task.history_length" title="Permalink to this definition">¶</a></dt>
       
   445 <dd></dd></dl>
       
   446 
       
   447 <dl class="attribute">
       
   448 <dt id="pyams_scheduler.task.Task.internal_id">
       
   449 <code class="descname">internal_id</code><a class="headerlink" href="#pyams_scheduler.task.Task.internal_id" title="Permalink to this definition">¶</a></dt>
       
   450 <dd></dd></dl>
       
   451 
       
   452 <dl class="method">
       
   453 <dt id="pyams_scheduler.task.Task.is_runnable">
       
   454 <code class="descname">is_runnable</code><span class="sig-paren">(</span><em>registry</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.Task.is_runnable" title="Permalink to this definition">¶</a></dt>
       
   455 <dd></dd></dl>
       
   456 
       
   457 <dl class="attribute">
       
   458 <dt id="pyams_scheduler.task.Task.keep_empty_reports">
       
   459 <code class="descname">keep_empty_reports</code><a class="headerlink" href="#pyams_scheduler.task.Task.keep_empty_reports" title="Permalink to this definition">¶</a></dt>
       
   460 <dd><p>Computed attributes based on schema fields</p>
       
   461 <p>Field properties provide default values, data validation and error messages
       
   462 based on data found in field meta-data.</p>
       
   463 <p>Note that FieldProperties cannot be used with slots. They can only
       
   464 be used for attributes stored in instance dictionaries.</p>
       
   465 </dd></dl>
       
   466 
       
   467 <dl class="method">
       
   468 <dt id="pyams_scheduler.task.Task.launch">
       
   469 <code class="descname">launch</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.Task.launch" title="Permalink to this definition">¶</a></dt>
       
   470 <dd></dd></dl>
       
   471 
       
   472 <dl class="attribute">
       
   473 <dt id="pyams_scheduler.task.Task.name">
       
   474 <code class="descname">name</code><a class="headerlink" href="#pyams_scheduler.task.Task.name" title="Permalink to this definition">¶</a></dt>
       
   475 <dd><p>Computed attributes based on schema fields</p>
       
   476 <p>Field properties provide default values, data validation and error messages
       
   477 based on data found in field meta-data.</p>
       
   478 <p>Note that FieldProperties cannot be used with slots. They can only
       
   479 be used for attributes stored in instance dictionaries.</p>
       
   480 </dd></dl>
       
   481 
       
   482 <dl class="attribute">
       
   483 <dt id="pyams_scheduler.task.Task.report_errors_only">
       
   484 <code class="descname">report_errors_only</code><a class="headerlink" href="#pyams_scheduler.task.Task.report_errors_only" title="Permalink to this definition">¶</a></dt>
       
   485 <dd><p>Computed attributes based on schema fields</p>
       
   486 <p>Field properties provide default values, data validation and error messages
       
   487 based on data found in field meta-data.</p>
       
   488 <p>Note that FieldProperties cannot be used with slots. They can only
       
   489 be used for attributes stored in instance dictionaries.</p>
       
   490 </dd></dl>
       
   491 
       
   492 <dl class="attribute">
       
   493 <dt id="pyams_scheduler.task.Task.report_target">
       
   494 <code class="descname">report_target</code><a class="headerlink" href="#pyams_scheduler.task.Task.report_target" title="Permalink to this definition">¶</a></dt>
       
   495 <dd><p>Computed attributes based on schema fields</p>
       
   496 <p>Field properties provide default values, data validation and error messages
       
   497 based on data found in field meta-data.</p>
       
   498 <p>Note that FieldProperties cannot be used with slots. They can only
       
   499 be used for attributes stored in instance dictionaries.</p>
       
   500 </dd></dl>
       
   501 
       
   502 <dl class="method">
       
   503 <dt id="pyams_scheduler.task.Task.reset">
       
   504 <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.Task.reset" title="Permalink to this definition">¶</a></dt>
       
   505 <dd></dd></dl>
       
   506 
       
   507 <dl class="method">
       
   508 <dt id="pyams_scheduler.task.Task.run">
       
   509 <code class="descname">run</code><span class="sig-paren">(</span><em>report</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.Task.run" title="Permalink to this definition">¶</a></dt>
       
   510 <dd></dd></dl>
       
   511 
       
   512 <dl class="attribute">
       
   513 <dt id="pyams_scheduler.task.Task.schedule_mode">
       
   514 <code class="descname">schedule_mode</code><a class="headerlink" href="#pyams_scheduler.task.Task.schedule_mode" title="Permalink to this definition">¶</a></dt>
       
   515 <dd></dd></dl>
       
   516 
       
   517 <dl class="attribute">
       
   518 <dt id="pyams_scheduler.task.Task.send_empty_reports">
       
   519 <code class="descname">send_empty_reports</code><a class="headerlink" href="#pyams_scheduler.task.Task.send_empty_reports" title="Permalink to this definition">¶</a></dt>
       
   520 <dd><p>Computed attributes based on schema fields</p>
       
   521 <p>Field properties provide default values, data validation and error messages
       
   522 based on data found in field meta-data.</p>
       
   523 <p>Note that FieldProperties cannot be used with slots. They can only
       
   524 be used for attributes stored in instance dictionaries.</p>
       
   525 </dd></dl>
       
   526 
       
   527 <dl class="method">
       
   528 <dt id="pyams_scheduler.task.Task.send_report">
       
   529 <code class="descname">send_report</code><span class="sig-paren">(</span><em>report</em>, <em>status</em>, <em>registry</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.Task.send_report" title="Permalink to this definition">¶</a></dt>
       
   530 <dd></dd></dl>
       
   531 
       
   532 <dl class="attribute">
       
   533 <dt id="pyams_scheduler.task.Task.settings_view_name">
       
   534 <code class="descname">settings_view_name</code><a class="headerlink" href="#pyams_scheduler.task.Task.settings_view_name" title="Permalink to this definition">¶</a></dt>
       
   535 <dd><p>Computed attributes based on schema fields</p>
       
   536 <p>Field properties provide default values, data validation and error messages
       
   537 based on data found in field meta-data.</p>
       
   538 <p>Note that FieldProperties cannot be used with slots. They can only
       
   539 be used for attributes stored in instance dictionaries.</p>
       
   540 </dd></dl>
       
   541 
       
   542 <dl class="method">
       
   543 <dt id="pyams_scheduler.task.Task.store_report">
       
   544 <code class="descname">store_report</code><span class="sig-paren">(</span><em>report</em>, <em>status</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.Task.store_report" title="Permalink to this definition">¶</a></dt>
       
   545 <dd></dd></dl>
       
   546 
       
   547 </dd></dl>
       
   548 
       
   549 <dl class="class">
       
   550 <dt id="pyams_scheduler.task.TaskHistoryContainer">
       
   551 <em class="property">class </em><code class="descclassname">pyams_scheduler.task.</code><code class="descname">TaskHistoryContainer</code><a class="headerlink" href="#pyams_scheduler.task.TaskHistoryContainer" title="Permalink to this definition">¶</a></dt>
       
   552 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
       
   553 <p>Task history container</p>
       
   554 <dl class="method">
       
   555 <dt id="pyams_scheduler.task.TaskHistoryContainer.check_history">
       
   556 <code class="descname">check_history</code><span class="sig-paren">(</span><em>duration</em>, <em>length</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.TaskHistoryContainer.check_history" title="Permalink to this definition">¶</a></dt>
       
   557 <dd></dd></dl>
       
   558 
       
   559 </dd></dl>
       
   560 
       
   561 <dl class="class">
       
   562 <dt id="pyams_scheduler.task.TaskHistoryItem">
       
   563 <em class="property">class </em><code class="descclassname">pyams_scheduler.task.</code><code class="descname">TaskHistoryItem</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.TaskHistoryItem" title="Permalink to this definition">¶</a></dt>
       
   564 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
       
   565 <p>Task history item</p>
       
   566 <dl class="attribute">
       
   567 <dt id="pyams_scheduler.task.TaskHistoryItem.date">
       
   568 <code class="descname">date</code><a class="headerlink" href="#pyams_scheduler.task.TaskHistoryItem.date" title="Permalink to this definition">¶</a></dt>
       
   569 <dd><p>Computed attributes based on schema fields</p>
       
   570 <p>Field properties provide default values, data validation and error messages
       
   571 based on data found in field meta-data.</p>
       
   572 <p>Note that FieldProperties cannot be used with slots. They can only
       
   573 be used for attributes stored in instance dictionaries.</p>
       
   574 </dd></dl>
       
   575 
       
   576 <dl class="attribute">
       
   577 <dt id="pyams_scheduler.task.TaskHistoryItem.report">
       
   578 <code class="descname">report</code><a class="headerlink" href="#pyams_scheduler.task.TaskHistoryItem.report" title="Permalink to this definition">¶</a></dt>
       
   579 <dd><p>Computed attributes based on schema fields</p>
       
   580 <p>Field properties provide default values, data validation and error messages
       
   581 based on data found in field meta-data.</p>
       
   582 <p>Note that FieldProperties cannot be used with slots. They can only
       
   583 be used for attributes stored in instance dictionaries.</p>
       
   584 </dd></dl>
       
   585 
       
   586 <dl class="attribute">
       
   587 <dt id="pyams_scheduler.task.TaskHistoryItem.status">
       
   588 <code class="descname">status</code><a class="headerlink" href="#pyams_scheduler.task.TaskHistoryItem.status" title="Permalink to this definition">¶</a></dt>
       
   589 <dd><p>Computed attributes based on schema fields</p>
       
   590 <p>Field properties provide default values, data validation and error messages
       
   591 based on data found in field meta-data.</p>
       
   592 <p>Note that FieldProperties cannot be used with slots. They can only
       
   593 be used for attributes stored in instance dictionaries.</p>
       
   594 </dd></dl>
       
   595 
       
   596 </dd></dl>
       
   597 
       
   598 <dl class="function">
       
   599 <dt id="pyams_scheduler.task.handle_modified_task">
       
   600 <code class="descclassname">pyams_scheduler.task.</code><code class="descname">handle_modified_task</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.handle_modified_task" title="Permalink to this definition">¶</a></dt>
       
   601 <dd><p>Handle modified task</p>
       
   602 </dd></dl>
       
   603 
       
   604 <dl class="function">
       
   605 <dt id="pyams_scheduler.task.handle_new_task">
       
   606 <code class="descclassname">pyams_scheduler.task.</code><code class="descname">handle_new_task</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.handle_new_task" title="Permalink to this definition">¶</a></dt>
       
   607 <dd><p>Handle new task</p>
       
   608 </dd></dl>
       
   609 
       
   610 <dl class="function">
       
   611 <dt id="pyams_scheduler.task.handle_removed_task">
       
   612 <code class="descclassname">pyams_scheduler.task.</code><code class="descname">handle_removed_task</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.task.handle_removed_task" title="Permalink to this definition">¶</a></dt>
       
   613 <dd><p>Handle removed task</p>
       
   614 </dd></dl>
       
   615 
       
   616 </div>
       
   617 <div class="section" id="module-pyams_scheduler.trigger">
       
   618 <span id="pyams-scheduler-trigger-module"></span><h2>pyams_scheduler.trigger module<a class="headerlink" href="#module-pyams_scheduler.trigger" title="Permalink to this headline">¶</a></h2>
       
   619 <dl class="class">
       
   620 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo">
       
   621 <em class="property">class </em><code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">CronTaskScheduleInfo</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo" title="Permalink to this definition">¶</a></dt>
       
   622 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p>
       
   623 <p>Cron-style schedule info</p>
       
   624 <dl class="attribute">
       
   625 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.active">
       
   626 <code class="descname">active</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.active" title="Permalink to this definition">¶</a></dt>
       
   627 <dd><p>Computed attributes based on schema fields</p>
       
   628 <p>Field properties provide default values, data validation and error messages
       
   629 based on data found in field meta-data.</p>
       
   630 <p>Note that FieldProperties cannot be used with slots. They can only
       
   631 be used for attributes stored in instance dictionaries.</p>
       
   632 </dd></dl>
       
   633 
       
   634 <dl class="attribute">
       
   635 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.day">
       
   636 <code class="descname">day</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.day" title="Permalink to this definition">¶</a></dt>
       
   637 <dd><p>Computed attributes based on schema fields</p>
       
   638 <p>Field properties provide default values, data validation and error messages
       
   639 based on data found in field meta-data.</p>
       
   640 <p>Note that FieldProperties cannot be used with slots. They can only
       
   641 be used for attributes stored in instance dictionaries.</p>
       
   642 </dd></dl>
       
   643 
       
   644 <dl class="attribute">
       
   645 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.day_of_week">
       
   646 <code class="descname">day_of_week</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.day_of_week" title="Permalink to this definition">¶</a></dt>
       
   647 <dd><p>Computed attributes based on schema fields</p>
       
   648 <p>Field properties provide default values, data validation and error messages
       
   649 based on data found in field meta-data.</p>
       
   650 <p>Note that FieldProperties cannot be used with slots. They can only
       
   651 be used for attributes stored in instance dictionaries.</p>
       
   652 </dd></dl>
       
   653 
       
   654 <dl class="attribute">
       
   655 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.end_date">
       
   656 <code class="descname">end_date</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.end_date" title="Permalink to this definition">¶</a></dt>
       
   657 <dd><p>Computed attributes based on schema fields</p>
       
   658 <p>Field properties provide default values, data validation and error messages
       
   659 based on data found in field meta-data.</p>
       
   660 <p>Note that FieldProperties cannot be used with slots. They can only
       
   661 be used for attributes stored in instance dictionaries.</p>
       
   662 </dd></dl>
       
   663 
       
   664 <dl class="attribute">
       
   665 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.hour">
       
   666 <code class="descname">hour</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.hour" title="Permalink to this definition">¶</a></dt>
       
   667 <dd><p>Computed attributes based on schema fields</p>
       
   668 <p>Field properties provide default values, data validation and error messages
       
   669 based on data found in field meta-data.</p>
       
   670 <p>Note that FieldProperties cannot be used with slots. They can only
       
   671 be used for attributes stored in instance dictionaries.</p>
       
   672 </dd></dl>
       
   673 
       
   674 <dl class="attribute">
       
   675 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.minute">
       
   676 <code class="descname">minute</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.minute" title="Permalink to this definition">¶</a></dt>
       
   677 <dd><p>Computed attributes based on schema fields</p>
       
   678 <p>Field properties provide default values, data validation and error messages
       
   679 based on data found in field meta-data.</p>
       
   680 <p>Note that FieldProperties cannot be used with slots. They can only
       
   681 be used for attributes stored in instance dictionaries.</p>
       
   682 </dd></dl>
       
   683 
       
   684 <dl class="attribute">
       
   685 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.month">
       
   686 <code class="descname">month</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.month" title="Permalink to this definition">¶</a></dt>
       
   687 <dd><p>Computed attributes based on schema fields</p>
       
   688 <p>Field properties provide default values, data validation and error messages
       
   689 based on data found in field meta-data.</p>
       
   690 <p>Note that FieldProperties cannot be used with slots. They can only
       
   691 be used for attributes stored in instance dictionaries.</p>
       
   692 </dd></dl>
       
   693 
       
   694 <dl class="attribute">
       
   695 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.second">
       
   696 <code class="descname">second</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.second" title="Permalink to this definition">¶</a></dt>
       
   697 <dd><p>Computed attributes based on schema fields</p>
       
   698 <p>Field properties provide default values, data validation and error messages
       
   699 based on data found in field meta-data.</p>
       
   700 <p>Note that FieldProperties cannot be used with slots. They can only
       
   701 be used for attributes stored in instance dictionaries.</p>
       
   702 </dd></dl>
       
   703 
       
   704 <dl class="attribute">
       
   705 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.start_date">
       
   706 <code class="descname">start_date</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.start_date" title="Permalink to this definition">¶</a></dt>
       
   707 <dd><p>Computed attributes based on schema fields</p>
       
   708 <p>Field properties provide default values, data validation and error messages
       
   709 based on data found in field meta-data.</p>
       
   710 <p>Note that FieldProperties cannot be used with slots. They can only
       
   711 be used for attributes stored in instance dictionaries.</p>
       
   712 </dd></dl>
       
   713 
       
   714 <dl class="attribute">
       
   715 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.week">
       
   716 <code class="descname">week</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.week" title="Permalink to this definition">¶</a></dt>
       
   717 <dd><p>Computed attributes based on schema fields</p>
       
   718 <p>Field properties provide default values, data validation and error messages
       
   719 based on data found in field meta-data.</p>
       
   720 <p>Note that FieldProperties cannot be used with slots. They can only
       
   721 be used for attributes stored in instance dictionaries.</p>
       
   722 </dd></dl>
       
   723 
       
   724 <dl class="attribute">
       
   725 <dt id="pyams_scheduler.trigger.CronTaskScheduleInfo.year">
       
   726 <code class="descname">year</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduleInfo.year" title="Permalink to this definition">¶</a></dt>
       
   727 <dd><p>Computed attributes based on schema fields</p>
       
   728 <p>Field properties provide default values, data validation and error messages
       
   729 based on data found in field meta-data.</p>
       
   730 <p>Note that FieldProperties cannot be used with slots. They can only
       
   731 be used for attributes stored in instance dictionaries.</p>
       
   732 </dd></dl>
       
   733 
       
   734 </dd></dl>
       
   735 
       
   736 <dl class="class">
       
   737 <dt id="pyams_scheduler.trigger.CronTaskScheduler">
       
   738 <em class="property">class </em><code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">CronTaskScheduler</code><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduler" title="Permalink to this definition">¶</a></dt>
       
   739 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   740 <p>Cron-style scheduler mode</p>
       
   741 <dl class="method">
       
   742 <dt id="pyams_scheduler.trigger.CronTaskScheduler.get_trigger">
       
   743 <code class="descname">get_trigger</code><span class="sig-paren">(</span><em>task</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduler.get_trigger" title="Permalink to this definition">¶</a></dt>
       
   744 <dd></dd></dl>
       
   745 
       
   746 <dl class="attribute">
       
   747 <dt id="pyams_scheduler.trigger.CronTaskScheduler.marker_interface">
       
   748 <code class="descname">marker_interface</code><em class="property"> = &lt;InterfaceClass pyams_scheduler.interfaces.ICronTask&gt;</em><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduler.marker_interface" title="Permalink to this definition">¶</a></dt>
       
   749 <dd></dd></dl>
       
   750 
       
   751 <dl class="attribute">
       
   752 <dt id="pyams_scheduler.trigger.CronTaskScheduler.schema">
       
   753 <code class="descname">schema</code><em class="property"> = &lt;InterfaceClass pyams_scheduler.interfaces.ICronTaskScheduling&gt;</em><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskScheduler.schema" title="Permalink to this definition">¶</a></dt>
       
   754 <dd></dd></dl>
       
   755 
       
   756 </dd></dl>
       
   757 
       
   758 <dl class="function">
       
   759 <dt id="pyams_scheduler.trigger.CronTaskSchedulerInfoFactory">
       
   760 <code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">CronTaskSchedulerInfoFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.trigger.CronTaskSchedulerInfoFactory" title="Permalink to this definition">¶</a></dt>
       
   761 <dd><p>Cron-style task scheduling info factory</p>
       
   762 </dd></dl>
       
   763 
       
   764 <dl class="class">
       
   765 <dt id="pyams_scheduler.trigger.DateTaskScheduleInfo">
       
   766 <em class="property">class </em><code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">DateTaskScheduleInfo</code><a class="headerlink" href="#pyams_scheduler.trigger.DateTaskScheduleInfo" title="Permalink to this definition">¶</a></dt>
       
   767 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p>
       
   768 <p>Date-style schedule info</p>
       
   769 <dl class="attribute">
       
   770 <dt id="pyams_scheduler.trigger.DateTaskScheduleInfo.active">
       
   771 <code class="descname">active</code><a class="headerlink" href="#pyams_scheduler.trigger.DateTaskScheduleInfo.active" title="Permalink to this definition">¶</a></dt>
       
   772 <dd><p>Computed attributes based on schema fields</p>
       
   773 <p>Field properties provide default values, data validation and error messages
       
   774 based on data found in field meta-data.</p>
       
   775 <p>Note that FieldProperties cannot be used with slots. They can only
       
   776 be used for attributes stored in instance dictionaries.</p>
       
   777 </dd></dl>
       
   778 
       
   779 <dl class="attribute">
       
   780 <dt id="pyams_scheduler.trigger.DateTaskScheduleInfo.start_date">
       
   781 <code class="descname">start_date</code><a class="headerlink" href="#pyams_scheduler.trigger.DateTaskScheduleInfo.start_date" title="Permalink to this definition">¶</a></dt>
       
   782 <dd><p>Computed attributes based on schema fields</p>
       
   783 <p>Field properties provide default values, data validation and error messages
       
   784 based on data found in field meta-data.</p>
       
   785 <p>Note that FieldProperties cannot be used with slots. They can only
       
   786 be used for attributes stored in instance dictionaries.</p>
       
   787 </dd></dl>
       
   788 
       
   789 </dd></dl>
       
   790 
       
   791 <dl class="class">
       
   792 <dt id="pyams_scheduler.trigger.DateTaskScheduler">
       
   793 <em class="property">class </em><code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">DateTaskScheduler</code><a class="headerlink" href="#pyams_scheduler.trigger.DateTaskScheduler" title="Permalink to this definition">¶</a></dt>
       
   794 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   795 <p>Date-style scheduler mode</p>
       
   796 <dl class="method">
       
   797 <dt id="pyams_scheduler.trigger.DateTaskScheduler.get_trigger">
       
   798 <code class="descname">get_trigger</code><span class="sig-paren">(</span><em>task</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.trigger.DateTaskScheduler.get_trigger" title="Permalink to this definition">¶</a></dt>
       
   799 <dd></dd></dl>
       
   800 
       
   801 <dl class="attribute">
       
   802 <dt id="pyams_scheduler.trigger.DateTaskScheduler.marker_interface">
       
   803 <code class="descname">marker_interface</code><em class="property"> = &lt;InterfaceClass pyams_scheduler.interfaces.IDateTask&gt;</em><a class="headerlink" href="#pyams_scheduler.trigger.DateTaskScheduler.marker_interface" title="Permalink to this definition">¶</a></dt>
       
   804 <dd></dd></dl>
       
   805 
       
   806 <dl class="attribute">
       
   807 <dt id="pyams_scheduler.trigger.DateTaskScheduler.schema">
       
   808 <code class="descname">schema</code><em class="property"> = &lt;InterfaceClass pyams_scheduler.interfaces.IDateTaskScheduling&gt;</em><a class="headerlink" href="#pyams_scheduler.trigger.DateTaskScheduler.schema" title="Permalink to this definition">¶</a></dt>
       
   809 <dd></dd></dl>
       
   810 
       
   811 </dd></dl>
       
   812 
       
   813 <dl class="function">
       
   814 <dt id="pyams_scheduler.trigger.DateTaskSchedulerInfoFactory">
       
   815 <code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">DateTaskSchedulerInfoFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.trigger.DateTaskSchedulerInfoFactory" title="Permalink to this definition">¶</a></dt>
       
   816 <dd><p>Date-style task scheduling info factory</p>
       
   817 </dd></dl>
       
   818 
       
   819 <dl class="class">
       
   820 <dt id="pyams_scheduler.trigger.LoopTaskScheduleInfo">
       
   821 <em class="property">class </em><code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">LoopTaskScheduleInfo</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduleInfo" title="Permalink to this definition">¶</a></dt>
       
   822 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p>
       
   823 <p>Loop-style schedule info</p>
       
   824 <dl class="attribute">
       
   825 <dt id="pyams_scheduler.trigger.LoopTaskScheduleInfo.active">
       
   826 <code class="descname">active</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduleInfo.active" title="Permalink to this definition">¶</a></dt>
       
   827 <dd><p>Computed attributes based on schema fields</p>
       
   828 <p>Field properties provide default values, data validation and error messages
       
   829 based on data found in field meta-data.</p>
       
   830 <p>Note that FieldProperties cannot be used with slots. They can only
       
   831 be used for attributes stored in instance dictionaries.</p>
       
   832 </dd></dl>
       
   833 
       
   834 <dl class="attribute">
       
   835 <dt id="pyams_scheduler.trigger.LoopTaskScheduleInfo.days">
       
   836 <code class="descname">days</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduleInfo.days" title="Permalink to this definition">¶</a></dt>
       
   837 <dd><p>Computed attributes based on schema fields</p>
       
   838 <p>Field properties provide default values, data validation and error messages
       
   839 based on data found in field meta-data.</p>
       
   840 <p>Note that FieldProperties cannot be used with slots. They can only
       
   841 be used for attributes stored in instance dictionaries.</p>
       
   842 </dd></dl>
       
   843 
       
   844 <dl class="attribute">
       
   845 <dt id="pyams_scheduler.trigger.LoopTaskScheduleInfo.end_date">
       
   846 <code class="descname">end_date</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduleInfo.end_date" title="Permalink to this definition">¶</a></dt>
       
   847 <dd><p>Computed attributes based on schema fields</p>
       
   848 <p>Field properties provide default values, data validation and error messages
       
   849 based on data found in field meta-data.</p>
       
   850 <p>Note that FieldProperties cannot be used with slots. They can only
       
   851 be used for attributes stored in instance dictionaries.</p>
       
   852 </dd></dl>
       
   853 
       
   854 <dl class="attribute">
       
   855 <dt id="pyams_scheduler.trigger.LoopTaskScheduleInfo.hours">
       
   856 <code class="descname">hours</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduleInfo.hours" title="Permalink to this definition">¶</a></dt>
       
   857 <dd><p>Computed attributes based on schema fields</p>
       
   858 <p>Field properties provide default values, data validation and error messages
       
   859 based on data found in field meta-data.</p>
       
   860 <p>Note that FieldProperties cannot be used with slots. They can only
       
   861 be used for attributes stored in instance dictionaries.</p>
       
   862 </dd></dl>
       
   863 
       
   864 <dl class="attribute">
       
   865 <dt id="pyams_scheduler.trigger.LoopTaskScheduleInfo.minutes">
       
   866 <code class="descname">minutes</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduleInfo.minutes" title="Permalink to this definition">¶</a></dt>
       
   867 <dd><p>Computed attributes based on schema fields</p>
       
   868 <p>Field properties provide default values, data validation and error messages
       
   869 based on data found in field meta-data.</p>
       
   870 <p>Note that FieldProperties cannot be used with slots. They can only
       
   871 be used for attributes stored in instance dictionaries.</p>
       
   872 </dd></dl>
       
   873 
       
   874 <dl class="attribute">
       
   875 <dt id="pyams_scheduler.trigger.LoopTaskScheduleInfo.seconds">
       
   876 <code class="descname">seconds</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduleInfo.seconds" title="Permalink to this definition">¶</a></dt>
       
   877 <dd><p>Computed attributes based on schema fields</p>
       
   878 <p>Field properties provide default values, data validation and error messages
       
   879 based on data found in field meta-data.</p>
       
   880 <p>Note that FieldProperties cannot be used with slots. They can only
       
   881 be used for attributes stored in instance dictionaries.</p>
       
   882 </dd></dl>
       
   883 
       
   884 <dl class="attribute">
       
   885 <dt id="pyams_scheduler.trigger.LoopTaskScheduleInfo.start_date">
       
   886 <code class="descname">start_date</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduleInfo.start_date" title="Permalink to this definition">¶</a></dt>
       
   887 <dd><p>Computed attributes based on schema fields</p>
       
   888 <p>Field properties provide default values, data validation and error messages
       
   889 based on data found in field meta-data.</p>
       
   890 <p>Note that FieldProperties cannot be used with slots. They can only
       
   891 be used for attributes stored in instance dictionaries.</p>
       
   892 </dd></dl>
       
   893 
       
   894 <dl class="attribute">
       
   895 <dt id="pyams_scheduler.trigger.LoopTaskScheduleInfo.weeks">
       
   896 <code class="descname">weeks</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduleInfo.weeks" title="Permalink to this definition">¶</a></dt>
       
   897 <dd><p>Computed attributes based on schema fields</p>
       
   898 <p>Field properties provide default values, data validation and error messages
       
   899 based on data found in field meta-data.</p>
       
   900 <p>Note that FieldProperties cannot be used with slots. They can only
       
   901 be used for attributes stored in instance dictionaries.</p>
       
   902 </dd></dl>
       
   903 
       
   904 </dd></dl>
       
   905 
       
   906 <dl class="class">
       
   907 <dt id="pyams_scheduler.trigger.LoopTaskScheduler">
       
   908 <em class="property">class </em><code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">LoopTaskScheduler</code><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduler" title="Permalink to this definition">¶</a></dt>
       
   909 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   910 <p>Loop-style scheduler mode</p>
       
   911 <dl class="method">
       
   912 <dt id="pyams_scheduler.trigger.LoopTaskScheduler.get_trigger">
       
   913 <code class="descname">get_trigger</code><span class="sig-paren">(</span><em>task</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduler.get_trigger" title="Permalink to this definition">¶</a></dt>
       
   914 <dd></dd></dl>
       
   915 
       
   916 <dl class="attribute">
       
   917 <dt id="pyams_scheduler.trigger.LoopTaskScheduler.marker_interface">
       
   918 <code class="descname">marker_interface</code><em class="property"> = &lt;InterfaceClass pyams_scheduler.interfaces.ILoopTask&gt;</em><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduler.marker_interface" title="Permalink to this definition">¶</a></dt>
       
   919 <dd></dd></dl>
       
   920 
       
   921 <dl class="attribute">
       
   922 <dt id="pyams_scheduler.trigger.LoopTaskScheduler.schema">
       
   923 <code class="descname">schema</code><em class="property"> = &lt;InterfaceClass pyams_scheduler.interfaces.ILoopTaskScheduling&gt;</em><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskScheduler.schema" title="Permalink to this definition">¶</a></dt>
       
   924 <dd></dd></dl>
       
   925 
       
   926 </dd></dl>
       
   927 
       
   928 <dl class="function">
       
   929 <dt id="pyams_scheduler.trigger.LoopTaskSchedulerInfoFactory">
       
   930 <code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">LoopTaskSchedulerInfoFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.trigger.LoopTaskSchedulerInfoFactory" title="Permalink to this definition">¶</a></dt>
       
   931 <dd><p>Loop-style task scheduling info factory</p>
       
   932 </dd></dl>
       
   933 
       
   934 <dl class="class">
       
   935 <dt id="pyams_scheduler.trigger.SchedulingModesVocabulary">
       
   936 <em class="property">class </em><code class="descclassname">pyams_scheduler.trigger.</code><code class="descname">SchedulingModesVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.trigger.SchedulingModesVocabulary" title="Permalink to this definition">¶</a></dt>
       
   937 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p>
       
   938 <p>Scheduling modes vocabulary</p>
       
   939 <dl class="attribute">
       
   940 <dt id="pyams_scheduler.trigger.SchedulingModesVocabulary.interface">
       
   941 <code class="descname">interface</code><em class="property"> = &lt;InterfaceClass pyams_scheduler.interfaces.ITaskSchedulingMode&gt;</em><a class="headerlink" href="#pyams_scheduler.trigger.SchedulingModesVocabulary.interface" title="Permalink to this definition">¶</a></dt>
       
   942 <dd></dd></dl>
       
   943 
       
   944 <dl class="attribute">
       
   945 <dt id="pyams_scheduler.trigger.SchedulingModesVocabulary.nameOnly">
       
   946 <code class="descname">nameOnly</code><em class="property"> = True</em><a class="headerlink" href="#pyams_scheduler.trigger.SchedulingModesVocabulary.nameOnly" title="Permalink to this definition">¶</a></dt>
       
   947 <dd></dd></dl>
       
   948 
       
   949 </dd></dl>
       
   950 
       
   951 </div>
       
   952 <div class="section" id="module-pyams_scheduler.url">
       
   953 <span id="pyams-scheduler-url-module"></span><h2>pyams_scheduler.url module<a class="headerlink" href="#module-pyams_scheduler.url" title="Permalink to this headline">¶</a></h2>
       
   954 <dl class="class">
       
   955 <dt id="pyams_scheduler.url.URLCallerTask">
       
   956 <em class="property">class </em><code class="descclassname">pyams_scheduler.url.</code><code class="descname">URLCallerTask</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask" title="Permalink to this definition">¶</a></dt>
       
   957 <dd><p>Bases: <a class="reference internal" href="#pyams_scheduler.task.Task" title="pyams_scheduler.task.Task"><code class="xref py py-class docutils literal"><span class="pre">pyams_scheduler.task.Task</span></code></a></p>
       
   958 <p>URL caller task</p>
       
   959 <dl class="attribute">
       
   960 <dt id="pyams_scheduler.url.URLCallerTask.connection_timeout">
       
   961 <code class="descname">connection_timeout</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.connection_timeout" title="Permalink to this definition">¶</a></dt>
       
   962 <dd><p>Computed attributes based on schema fields</p>
       
   963 <p>Field properties provide default values, data validation and error messages
       
   964 based on data found in field meta-data.</p>
       
   965 <p>Note that FieldProperties cannot be used with slots. They can only
       
   966 be used for attributes stored in instance dictionaries.</p>
       
   967 </dd></dl>
       
   968 
       
   969 <dl class="attribute">
       
   970 <dt id="pyams_scheduler.url.URLCallerTask.password">
       
   971 <code class="descname">password</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.password" title="Permalink to this definition">¶</a></dt>
       
   972 <dd><p>Computed attributes based on schema fields</p>
       
   973 <p>Field properties provide default values, data validation and error messages
       
   974 based on data found in field meta-data.</p>
       
   975 <p>Note that FieldProperties cannot be used with slots. They can only
       
   976 be used for attributes stored in instance dictionaries.</p>
       
   977 </dd></dl>
       
   978 
       
   979 <dl class="attribute">
       
   980 <dt id="pyams_scheduler.url.URLCallerTask.proxy_password">
       
   981 <code class="descname">proxy_password</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.proxy_password" title="Permalink to this definition">¶</a></dt>
       
   982 <dd><p>Computed attributes based on schema fields</p>
       
   983 <p>Field properties provide default values, data validation and error messages
       
   984 based on data found in field meta-data.</p>
       
   985 <p>Note that FieldProperties cannot be used with slots. They can only
       
   986 be used for attributes stored in instance dictionaries.</p>
       
   987 </dd></dl>
       
   988 
       
   989 <dl class="attribute">
       
   990 <dt id="pyams_scheduler.url.URLCallerTask.proxy_port">
       
   991 <code class="descname">proxy_port</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.proxy_port" title="Permalink to this definition">¶</a></dt>
       
   992 <dd><p>Computed attributes based on schema fields</p>
       
   993 <p>Field properties provide default values, data validation and error messages
       
   994 based on data found in field meta-data.</p>
       
   995 <p>Note that FieldProperties cannot be used with slots. They can only
       
   996 be used for attributes stored in instance dictionaries.</p>
       
   997 </dd></dl>
       
   998 
       
   999 <dl class="attribute">
       
  1000 <dt id="pyams_scheduler.url.URLCallerTask.proxy_server">
       
  1001 <code class="descname">proxy_server</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.proxy_server" title="Permalink to this definition">¶</a></dt>
       
  1002 <dd><p>Computed attributes based on schema fields</p>
       
  1003 <p>Field properties provide default values, data validation and error messages
       
  1004 based on data found in field meta-data.</p>
       
  1005 <p>Note that FieldProperties cannot be used with slots. They can only
       
  1006 be used for attributes stored in instance dictionaries.</p>
       
  1007 </dd></dl>
       
  1008 
       
  1009 <dl class="attribute">
       
  1010 <dt id="pyams_scheduler.url.URLCallerTask.proxy_username">
       
  1011 <code class="descname">proxy_username</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.proxy_username" title="Permalink to this definition">¶</a></dt>
       
  1012 <dd><p>Computed attributes based on schema fields</p>
       
  1013 <p>Field properties provide default values, data validation and error messages
       
  1014 based on data found in field meta-data.</p>
       
  1015 <p>Note that FieldProperties cannot be used with slots. They can only
       
  1016 be used for attributes stored in instance dictionaries.</p>
       
  1017 </dd></dl>
       
  1018 
       
  1019 <dl class="attribute">
       
  1020 <dt id="pyams_scheduler.url.URLCallerTask.remote_dns">
       
  1021 <code class="descname">remote_dns</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.remote_dns" title="Permalink to this definition">¶</a></dt>
       
  1022 <dd><p>Computed attributes based on schema fields</p>
       
  1023 <p>Field properties provide default values, data validation and error messages
       
  1024 based on data found in field meta-data.</p>
       
  1025 <p>Note that FieldProperties cannot be used with slots. They can only
       
  1026 be used for attributes stored in instance dictionaries.</p>
       
  1027 </dd></dl>
       
  1028 
       
  1029 <dl class="method">
       
  1030 <dt id="pyams_scheduler.url.URLCallerTask.run">
       
  1031 <code class="descname">run</code><span class="sig-paren">(</span><em>report</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.run" title="Permalink to this definition">¶</a></dt>
       
  1032 <dd></dd></dl>
       
  1033 
       
  1034 <dl class="attribute">
       
  1035 <dt id="pyams_scheduler.url.URLCallerTask.url">
       
  1036 <code class="descname">url</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.url" title="Permalink to this definition">¶</a></dt>
       
  1037 <dd><p>Computed attributes based on schema fields</p>
       
  1038 <p>Field properties provide default values, data validation and error messages
       
  1039 based on data found in field meta-data.</p>
       
  1040 <p>Note that FieldProperties cannot be used with slots. They can only
       
  1041 be used for attributes stored in instance dictionaries.</p>
       
  1042 </dd></dl>
       
  1043 
       
  1044 <dl class="attribute">
       
  1045 <dt id="pyams_scheduler.url.URLCallerTask.username">
       
  1046 <code class="descname">username</code><a class="headerlink" href="#pyams_scheduler.url.URLCallerTask.username" title="Permalink to this definition">¶</a></dt>
       
  1047 <dd><p>Computed attributes based on schema fields</p>
       
  1048 <p>Field properties provide default values, data validation and error messages
       
  1049 based on data found in field meta-data.</p>
       
  1050 <p>Note that FieldProperties cannot be used with slots. They can only
       
  1051 be used for attributes stored in instance dictionaries.</p>
       
  1052 </dd></dl>
       
  1053 
       
  1054 </dd></dl>
       
  1055 
       
  1056 </div>
       
  1057 <div class="section" id="module-pyams_scheduler.zodb">
       
  1058 <span id="pyams-scheduler-zodb-module"></span><h2>pyams_scheduler.zodb module<a class="headerlink" href="#module-pyams_scheduler.zodb" title="Permalink to this headline">¶</a></h2>
       
  1059 <dl class="class">
       
  1060 <dt id="pyams_scheduler.zodb.ZODBPackingTask">
       
  1061 <em class="property">class </em><code class="descclassname">pyams_scheduler.zodb.</code><code class="descname">ZODBPackingTask</code><a class="headerlink" href="#pyams_scheduler.zodb.ZODBPackingTask" title="Permalink to this definition">¶</a></dt>
       
  1062 <dd><p>Bases: <a class="reference internal" href="#pyams_scheduler.task.Task" title="pyams_scheduler.task.Task"><code class="xref py py-class docutils literal"><span class="pre">pyams_scheduler.task.Task</span></code></a></p>
       
  1063 <p>ZODB packing task</p>
       
  1064 <dl class="attribute">
       
  1065 <dt id="pyams_scheduler.zodb.ZODBPackingTask.pack_time">
       
  1066 <code class="descname">pack_time</code><a class="headerlink" href="#pyams_scheduler.zodb.ZODBPackingTask.pack_time" title="Permalink to this definition">¶</a></dt>
       
  1067 <dd><p>Computed attributes based on schema fields</p>
       
  1068 <p>Field properties provide default values, data validation and error messages
       
  1069 based on data found in field meta-data.</p>
       
  1070 <p>Note that FieldProperties cannot be used with slots. They can only
       
  1071 be used for attributes stored in instance dictionaries.</p>
       
  1072 </dd></dl>
       
  1073 
       
  1074 <dl class="method">
       
  1075 <dt id="pyams_scheduler.zodb.ZODBPackingTask.run">
       
  1076 <code class="descname">run</code><span class="sig-paren">(</span><em>report</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.zodb.ZODBPackingTask.run" title="Permalink to this definition">¶</a></dt>
       
  1077 <dd></dd></dl>
       
  1078 
       
  1079 <dl class="attribute">
       
  1080 <dt id="pyams_scheduler.zodb.ZODBPackingTask.zeo_connection">
       
  1081 <code class="descname">zeo_connection</code><a class="headerlink" href="#pyams_scheduler.zodb.ZODBPackingTask.zeo_connection" title="Permalink to this definition">¶</a></dt>
       
  1082 <dd><p>Computed attributes based on schema fields</p>
       
  1083 <p>Field properties provide default values, data validation and error messages
       
  1084 based on data found in field meta-data.</p>
       
  1085 <p>Note that FieldProperties cannot be used with slots. They can only
       
  1086 be used for attributes stored in instance dictionaries.</p>
       
  1087 </dd></dl>
       
  1088 
       
  1089 </dd></dl>
       
  1090 
       
  1091 </div>
       
  1092 <div class="section" id="module-pyams_scheduler">
       
  1093 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_scheduler" title="Permalink to this headline">¶</a></h2>
       
  1094 <dl class="function">
       
  1095 <dt id="pyams_scheduler.includeme">
       
  1096 <code class="descclassname">pyams_scheduler.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_scheduler.includeme" title="Permalink to this definition">¶</a></dt>
       
  1097 <dd><p>Pyramid include</p>
       
  1098 <p>Split in another package to remove cyclic dependencies with TranslationStringFactory</p>
       
  1099 </dd></dl>
       
  1100 
       
  1101 </div>
       
  1102 </div>
       
  1103 
       
  1104 
       
  1105           </div>
       
  1106         </div>
       
  1107       </div>
       
  1108       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
       
  1109         <div class="sphinxsidebarwrapper">
       
  1110   <h3><a href="index.html">Table Of Contents</a></h3>
       
  1111   <ul>
       
  1112 <li><a class="reference internal" href="#">pyams_scheduler package</a><ul>
       
  1113 <li><a class="reference internal" href="#subpackages">Subpackages</a></li>
       
  1114 <li><a class="reference internal" href="#submodules">Submodules</a></li>
       
  1115 <li><a class="reference internal" href="#module-pyams_scheduler.include">pyams_scheduler.include module</a></li>
       
  1116 <li><a class="reference internal" href="#module-pyams_scheduler.process">pyams_scheduler.process module</a></li>
       
  1117 <li><a class="reference internal" href="#module-pyams_scheduler.scheduler">pyams_scheduler.scheduler module</a></li>
       
  1118 <li><a class="reference internal" href="#module-pyams_scheduler.site">pyams_scheduler.site module</a></li>
       
  1119 <li><a class="reference internal" href="#module-pyams_scheduler.ssh">pyams_scheduler.ssh module</a></li>
       
  1120 <li><a class="reference internal" href="#module-pyams_scheduler.task">pyams_scheduler.task module</a></li>
       
  1121 <li><a class="reference internal" href="#module-pyams_scheduler.trigger">pyams_scheduler.trigger module</a></li>
       
  1122 <li><a class="reference internal" href="#module-pyams_scheduler.url">pyams_scheduler.url module</a></li>
       
  1123 <li><a class="reference internal" href="#module-pyams_scheduler.zodb">pyams_scheduler.zodb module</a></li>
       
  1124 <li><a class="reference internal" href="#module-pyams_scheduler">Module contents</a></li>
       
  1125 </ul>
       
  1126 </li>
       
  1127 </ul>
       
  1128 
       
  1129 <div id="searchbox" style="display: none" role="search">
       
  1130   <h3>Quick search</h3>
       
  1131     <form class="search" action="search.html" method="get">
       
  1132       <div><input type="text" name="q" /></div>
       
  1133       <div><input type="submit" value="Go" /></div>
       
  1134       <input type="hidden" name="check_keywords" value="yes" />
       
  1135       <input type="hidden" name="area" value="default" />
       
  1136     </form>
       
  1137 </div>
       
  1138 <script type="text/javascript">$('#searchbox').show(0);</script>
       
  1139         </div>
       
  1140       </div>
       
  1141       <div class="clearer"></div>
       
  1142     </div>
       
  1143     <div class="related" role="navigation" aria-label="related navigation">
       
  1144       <h3>Navigation</h3>
       
  1145       <ul>
       
  1146         <li class="right" style="margin-right: 10px">
       
  1147           <a href="genindex.html" title="General Index"
       
  1148              >index</a></li>
       
  1149         <li class="right" >
       
  1150           <a href="py-modindex.html" title="Python Module Index"
       
  1151              >modules</a> |</li>
       
  1152         <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
       
  1153       </ul>
       
  1154     </div>
       
  1155     <div class="footer" role="contentinfo">
       
  1156         &#169; Copyright 2017, Thierry Florac.
       
  1157       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
       
  1158     </div>
       
  1159   </body>
       
  1160 </html>