pylib/task
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs update

Browse Source
This commit is contained in:
Dirk Alders 2025-08-17 11:18:48 +02:00
parent 93ada5fc6d
commit 8cffe7cc96
8 changed files with 62 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_docs_/.buildinfo
View File

@ -1,4 +0,0 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 46324f91ebc57ad852cf2085852ad2cd
tags: 645f666f9bcd5a90fca523b33c5a78b7

0
_docs_/_downloads/1f4b349fd04a20c080dbbb7745ac37af/unittest.pdf → _docs_/_downloads/bb4c2a79217a913e45739a98cfffa1e0/unittest.pdf
View File

0
_docs_/_sources/index.rst.txt → _docs_/_sources/task.rst.txt
View File

56
_docs_/genindex.html
View File

@ -141,11 +141,11 @@
<h2 id="A">A</h2> <h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.crontab.add_cronjob">add_cronjob() (task.crontab method)</a> <li><a href="task.html#task.crontab.add_cronjob">add_cronjob() (task.crontab method)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.crontab.ANY">ANY (task.crontab attribute)</a> <li><a href="task.html#task.crontab.ANY">ANY (task.crontab attribute)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -153,17 +153,17 @@
<h2 id="C">C</h2> <h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.queue.clean_queue">clean_queue() (task.queue method)</a> <li><a href="task.html#task.queue.clean_queue">clean_queue() (task.queue method)</a>
</li> </li>
<li><a href="index.html#task.crontab.cronjob.cron_execution">cron_execution() (task.crontab.cronjob method)</a> <li><a href="task.html#task.crontab.cronjob.cron_execution">cron_execution() (task.crontab.cronjob method)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.crontab">crontab (class in task)</a> <li><a href="task.html#task.crontab">crontab (class in task)</a>
</li> </li>
<li><a href="index.html#task.crontab.cronjob">crontab.cronjob (class in task)</a> <li><a href="task.html#task.crontab.cronjob">crontab.cronjob (class in task)</a>
</li> </li>
<li><a href="index.html#task.crontab.cronjob.all_match">crontab.cronjob.all_match (class in task)</a> <li><a href="task.html#task.crontab.cronjob.all_match">crontab.cronjob.all_match (class in task)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -171,7 +171,7 @@
<h2 id="D">D</h2> <h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.delayed">delayed (class in task)</a> <li><a href="task.html#task.delayed">delayed (class in task)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -179,11 +179,11 @@
<h2 id="E">E</h2> <h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.queue.enqueue">enqueue() (task.queue method)</a> <li><a href="task.html#task.queue.enqueue">enqueue() (task.queue method)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.queue.expire">expire() (task.queue method)</a> <li><a href="task.html#task.queue.expire">expire() (task.queue method)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -191,10 +191,10 @@
<h2 id="J">J</h2> <h2 id="J">J</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.periodic.join">join() (task.periodic method)</a> <li><a href="task.html#task.periodic.join">join() (task.periodic method)</a>
<ul> <ul>
<li><a href="index.html#task.threaded_queue.join">(task.threaded_queue method)</a> <li><a href="task.html#task.threaded_queue.join">(task.threaded_queue method)</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -207,7 +207,7 @@
module module
<ul> <ul>
<li><a href="index.html#module-task">task</a> <li><a href="task.html#module-task">task</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -216,7 +216,7 @@
<h2 id="P">P</h2> <h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.periodic">periodic (class in task)</a> <li><a href="task.html#task.periodic">periodic (class in task)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -224,13 +224,13 @@
<h2 id="Q">Q</h2> <h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.queue.qsize">qsize() (task.queue method)</a> <li><a href="task.html#task.queue.qsize">qsize() (task.queue method)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.queue">queue (class in task)</a> <li><a href="task.html#task.queue">queue (class in task)</a>
</li> </li>
<li><a href="index.html#task.queue.job">queue.job (class in task)</a> <li><a href="task.html#task.queue.job">queue.job (class in task)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -238,16 +238,16 @@
<h2 id="R">R</h2> <h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.delayed.run">run() (task.delayed method)</a> <li><a href="task.html#task.delayed.run">run() (task.delayed method)</a>
<ul> <ul>
<li><a href="index.html#task.periodic.run">(task.periodic method)</a> <li><a href="task.html#task.periodic.run">(task.periodic method)</a>
</li> </li>
<li><a href="index.html#task.queue.run">(task.queue method)</a> <li><a href="task.html#task.queue.run">(task.queue method)</a>
</li> </li>
<li><a href="index.html#task.queue.job.run">(task.queue.job method)</a> <li><a href="task.html#task.queue.job.run">(task.queue.job method)</a>
</li> </li>
<li><a href="index.html#task.threaded_queue.run">(task.threaded_queue method)</a> <li><a href="task.html#task.threaded_queue.run">(task.threaded_queue method)</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -256,14 +256,14 @@
<h2 id="S">S</h2> <h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.crontab.cronjob.set_trigger_conditions">set_trigger_conditions() (task.crontab.cronjob method)</a> <li><a href="task.html#task.crontab.cronjob.set_trigger_conditions">set_trigger_conditions() (task.crontab.cronjob method)</a>
</li> </li>
<li><a href="index.html#task.periodic.stop">stop() (task.periodic method)</a> <li><a href="task.html#task.periodic.stop">stop() (task.periodic method)</a>
<ul> <ul>
<li><a href="index.html#task.queue.stop">(task.queue method)</a> <li><a href="task.html#task.queue.stop">(task.queue method)</a>
</li> </li>
<li><a href="index.html#task.threaded_queue.stop">(task.threaded_queue method)</a> <li><a href="task.html#task.threaded_queue.stop">(task.threaded_queue method)</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -276,12 +276,12 @@
task task
<ul> <ul>
<li><a href="index.html#module-task">module</a> <li><a href="task.html#module-task">module</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#task.threaded_queue">threaded_queue (class in task)</a> <li><a href="task.html#task.threaded_queue">threaded_queue (class in task)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>

BIN
_docs_/objects.inv
View File

Binary file not shown.

2
_docs_/py-modindex.html
View File

@ -142,7 +142,7 @@
<tr> <tr>
<td></td> <td></td>
<td> <td>
<a href="index.html#module-task"><code class="xref">task</code></a></td><td> <a href="task.html#module-task"><code class="xref">task</code></a></td><td>
<em></em></td></tr> <em></em></td></tr>
</table> </table>

2
_docs_/searchindex.js
View File

File diff suppressed because one or more lines are too long

64
_docs_/index.html → _docs_/task.html
View File

@ -111,7 +111,7 @@
<div role="note" aria-label="source link"> <div role="note" aria-label="source link">
<h3>This Page</h3> <h3>This Page</h3>
<ul class="this-page-menu"> <ul class="this-page-menu">
<li><a href="_sources/index.rst.txt" <li><a href="_sources/task.rst.txt"
rel="nofollow">Show Source</a></li> rel="nofollow">Show Source</a></li>
</ul> </ul>
</div> </div>
@ -146,7 +146,7 @@
</li> </li>
<li> <li>
<a href="#">task documentation</a> &#187; <a href="index.html">task documentation</a> &#187;
</li> </li>
<li class="nav-item nav-item-this"><a href="">task package</a></li> <li class="nav-item nav-item-this"><a href="">task package</a></li>
@ -201,7 +201,7 @@
</ul> </ul>
<p><strong>Unittest:</strong></p> <p><strong>Unittest:</strong></p>
<blockquote> <blockquote>
<div><p>See also the <a class="reference download internal" download="" href="_downloads/1f4b349fd04a20c080dbbb7745ac37af/unittest.pdf"><code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code></a> documentation.</p> <div><p>See also the <a class="reference download internal" download="" href="_downloads/bb4c2a79217a913e45739a98cfffa1e0/unittest.pdf"><code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code></a> documentation.</p>
</div></blockquote> </div></blockquote>
<p><strong>Module Documentation:</strong></p> <p><strong>Module Documentation:</strong></p>
</section> </section>
@ -243,11 +243,11 @@
</pre></div> </pre></div>
</div> </div>
<p>Will result to the following output:</p> <p>Will result to the following output:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Cronjob</span> <span class="n">added</span> <span class="k">for</span> <span class="n">Minute</span><span class="p">:</span> <span class="mi">52</span><span class="p">,</span> <span class="mi">54</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Cronjob</span> <span class="n">added</span> <span class="k">for</span> <span class="n">Minute</span><span class="p">:</span> <span class="mi">03</span><span class="p">,</span> <span class="mi">05</span>
<span class="o">--------------------------------</span> <span class="o">--------------------------------</span>
<span class="n">time</span><span class="o">.</span><span class="n">struct_time</span><span class="p">(</span><span class="n">tm_year</span><span class="o">=</span><span class="mi">2025</span><span class="p">,</span> <span class="n">tm_mon</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span> <span class="n">tm_mday</span><span class="o">=</span><span class="mi">15</span><span class="p">,</span> <span class="n">tm_hour</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">tm_min</span><span class="o">=</span><span class="mi">52</span><span class="p">,</span> <span class="n">tm_sec</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">tm_wday</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">tm_yday</span><span class="o">=</span><span class="mi">227</span><span class="p">,</span> <span class="n">tm_isdst</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="n">time</span><span class="o">.</span><span class="n">struct_time</span><span class="p">(</span><span class="n">tm_year</span><span class="o">=</span><span class="mi">2025</span><span class="p">,</span> <span class="n">tm_mon</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span> <span class="n">tm_mday</span><span class="o">=</span><span class="mi">17</span><span class="p">,</span> <span class="n">tm_hour</span><span class="o">=</span><span class="mi">11</span><span class="p">,</span> <span class="n">tm_min</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">tm_sec</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">tm_wday</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">tm_yday</span><span class="o">=</span><span class="mi">229</span><span class="p">,</span> <span class="n">tm_isdst</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="n">time</span><span class="o">.</span><span class="n">struct_time</span><span class="p">(</span><span class="n">tm_year</span><span class="o">=</span><span class="mi">2025</span><span class="p">,</span> <span class="n">tm_mon</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span> <span class="n">tm_mday</span><span class="o">=</span><span class="mi">15</span><span class="p">,</span> <span class="n">tm_hour</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">tm_min</span><span class="o">=</span><span class="mi">54</span><span class="p">,</span> <span class="n">tm_sec</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">tm_wday</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">tm_yday</span><span class="o">=</span><span class="mi">227</span><span class="p">,</span> <span class="n">tm_isdst</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="n">time</span><span class="o">.</span><span class="n">struct_time</span><span class="p">(</span><span class="n">tm_year</span><span class="o">=</span><span class="mi">2025</span><span class="p">,</span> <span class="n">tm_mon</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span> <span class="n">tm_mday</span><span class="o">=</span><span class="mi">17</span><span class="p">,</span> <span class="n">tm_hour</span><span class="o">=</span><span class="mi">11</span><span class="p">,</span> <span class="n">tm_min</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">tm_sec</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">tm_wday</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">tm_yday</span><span class="o">=</span><span class="mi">229</span><span class="p">,</span> <span class="n">tm_isdst</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</pre></div> </pre></div>
</div> </div>
<dl class="py attribute"> <dl class="py attribute">
@ -381,8 +381,8 @@ The given Arguments (<code class="xref py py-data docutils literal notranslate">
<p>Will result to the following output:</p> <p>Will result to the following output:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>task.delayed example: <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>task.delayed example:
--------------------- ---------------------
Fri Aug 15 20:54:55 2025: starting... Sun Aug 17 11:05:40 2025: starting...
Fri Aug 15 20:55:00 2025: A delayed hello! Sun Aug 17 11:05:45 2025: A delayed hello!
</pre></div> </pre></div>
</div> </div>
<dl class="py method"> <dl class="py method">
@ -452,15 +452,15 @@ Fri Aug 15 20:55:00 2025: A delayed hello!
<p>Will result to the following output:</p> <p>Will result to the following output:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>task.periodic example: <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>task.periodic example:
---------------------- ----------------------
Fri Aug 15 20:55:01 2025: starting... Sun Aug 17 11:05:45 2025: starting...
Fri Aug 15 20:55:01 2025: (Task 1) Hello from periodic example! Sun Aug 17 11:05:45 2025: (Task 1) Hello from periodic example!
Fri Aug 15 20:55:03 2025: (Task 2) Hello from periodic example! Sun Aug 17 11:05:47 2025: (Task 2) Hello from periodic example!
Fri Aug 15 20:55:04 2025: (Task 1) Ende! Sun Aug 17 11:05:49 2025: (Task 1) Ende!
Fri Aug 15 20:55:05 2025: (Task 3) Hello from periodic example! Sun Aug 17 11:05:49 2025: (Task 3) Hello from periodic example!
Fri Aug 15 20:55:06 2025: (Task 2) Ende! Sun Aug 17 11:05:51 2025: (Task 2) Ende!
Fri Aug 15 20:55:07 2025: (Task 4) Hello from periodic example! Sun Aug 17 11:05:51 2025: (Task 4) Hello from periodic example!
Fri Aug 15 20:55:08 2025: (Task 3) Ende! Sun Aug 17 11:05:53 2025: (Task 3) Ende!
Fri Aug 15 20:55:09 2025: (Task 5) Hello from periodic example! Sun Aug 17 11:05:53 2025: (Task 5) Hello from periodic example!
</pre></div> </pre></div>
</div> </div>
<dl class="py method"> <dl class="py method">
@ -535,12 +535,12 @@ Fri Aug 15 20:55:09 2025: (Task 5) Hello from periodic example!
<p>Will result to the following output:</p> <p>Will result to the following output:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>task.queue example: <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>task.queue example:
---------------------- ----------------------
Fri Aug 15 20:55:20 2025: (Task 1) Hello from queue example (4)! Sun Aug 17 11:06:05 2025: (Task 1) Hello from queue example (4)!
Fri Aug 15 20:55:24 2025: (Task 1) Ende! Sun Aug 17 11:06:09 2025: (Task 1) Ende!
Fri Aug 15 20:55:24 2025: (Task 2) Hello from queue example (5)! Sun Aug 17 11:06:09 2025: (Task 2) Hello from queue example (5)!
Fri Aug 15 20:55:28 2025: (Task 2) Ende! Sun Aug 17 11:06:13 2025: (Task 2) Ende!
Fri Aug 15 20:55:28 2025: (Task 3) Hello from queue example (6)! Sun Aug 17 11:06:13 2025: (Task 3) Hello from queue example (6)!
Fri Aug 15 20:55:32 2025: (Task 3) Ende! Sun Aug 17 11:06:16 2025: (Task 3) Ende!
</pre></div> </pre></div>
</div> </div>
<dl class="py method"> <dl class="py method">
@ -662,13 +662,13 @@ Fri Aug 15 20:55:32 2025: (Task 3) Ende!
<p>Will result to the following output:</p> <p>Will result to the following output:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>task.threaded_queue example: <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>task.threaded_queue example:
------------------------------- -------------------------------
Fri Aug 15 20:55:09 2025: (Task 1) Hello from queue example (4)! Sun Aug 17 11:05:53 2025: (Task 1) Hello from queue example (4)!
Fri Aug 15 20:55:09 2025: starting... Sun Aug 17 11:05:53 2025: starting...
Fri Aug 15 20:55:13 2025: (Task 1) Ende! Sun Aug 17 11:05:57 2025: (Task 1) Ende!
Fri Aug 15 20:55:13 2025: (Task 2) Hello from queue example (5)! Sun Aug 17 11:05:57 2025: (Task 2) Hello from queue example (5)!
Fri Aug 15 20:55:16 2025: (Task 2) Ende! Sun Aug 17 11:06:01 2025: (Task 2) Ende!
Fri Aug 15 20:55:16 2025: (Task 3) Hello from queue example (6)! Sun Aug 17 11:06:01 2025: (Task 3) Hello from queue example (6)!
Fri Aug 15 20:55:20 2025: (Task 3) Ende! Sun Aug 17 11:06:05 2025: (Task 3) Ende!
</pre></div> </pre></div>
</div> </div>
<dl class="py method"> <dl class="py method">
@ -757,7 +757,7 @@ Fri Aug 15 20:55:20 2025: (Task 3) Ende!
<div role="note" aria-label="source link"> <div role="note" aria-label="source link">
<h3>This Page</h3> <h3>This Page</h3>
<ul class="this-page-menu"> <ul class="this-page-menu">
<li><a href="_sources/index.rst.txt" <li><a href="_sources/task.rst.txt"
rel="nofollow">Show Source</a></li> rel="nofollow">Show Source</a></li>
</ul> </ul>
</div> </div>
@ -792,7 +792,7 @@ Fri Aug 15 20:55:20 2025: (Task 3) Ende!
</li> </li>
<li> <li>
<a href="#">task documentation</a> &#187; <a href="index.html">task documentation</a> &#187;
</li> </li>
<li class="nav-item nav-item-this"><a href="">task package</a></li> <li class="nav-item nav-item-this"><a href="">task package</a></li>