mirror of
https://github.com/arsenetar/dupeguru.git
synced 2024-11-14 11:39:03 +00:00
Andrew Senetar
bacba3f0a5
- Add sphinx documentation generated from build to help - Add link to help (in english) in header - Add link to github in header
92 lines
4.4 KiB
HTML
92 lines
4.4 KiB
HTML
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
|
<head>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>hscommon.jobprogress.performer — dupeGuru 4.0.3 documentation</title>
|
|
<link rel="stylesheet" href="../../../_static/haiku.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
<script type="text/javascript" src="../../../_static/documentation_options.js"></script>
|
|
<script type="text/javascript" src="../../../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../../../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../../../_static/doctools.js"></script>
|
|
<script type="text/javascript" src="../../../_static/translations.js"></script>
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
<link rel="next" title="hscommon.jobprogress.qt" href="qt.html" />
|
|
<link rel="prev" title="hscommon.jobprogress.job" href="job.html" />
|
|
</head><body>
|
|
<div class="header" role="banner"><h1 class="heading"><a href="../../../index.html">
|
|
<span>dupeGuru 4.0.3 documentation</span></a></h1>
|
|
<h2 class="heading"><span>hscommon.jobprogress.performer</span></h2>
|
|
</div>
|
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
|
|
|
<p>
|
|
«  <a href="job.html">hscommon.jobprogress.job</a>
|
|
  ::  
|
|
<a class="uplink" href="../../../index.html">Contents</a>
|
|
  ::  
|
|
<a href="qt.html">hscommon.jobprogress.qt</a>  »
|
|
</p>
|
|
|
|
</div>
|
|
<div class="content">
|
|
|
|
|
|
<div class="section" id="module-hscommon.jobprogress.performer">
|
|
<span id="hscommon-jobprogress-performer"></span><h1>hscommon.jobprogress.performer<a class="headerlink" href="#module-hscommon.jobprogress.performer" title="Permalink to this headline">¶</a></h1>
|
|
<table border="1" class="longtable docutils">
|
|
<colgroup>
|
|
<col width="10%" />
|
|
<col width="90%" />
|
|
</colgroup>
|
|
<tbody valign="top">
|
|
<tr class="row-odd"><td><a class="reference internal" href="#hscommon.jobprogress.performer.ThreadedJobPerformer" title="hscommon.jobprogress.performer.ThreadedJobPerformer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ThreadedJobPerformer</span></code></a></td>
|
|
<td>Run threaded jobs and track progress.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="class">
|
|
<dt id="hscommon.jobprogress.performer.ThreadedJobPerformer">
|
|
<em class="property">class </em><code class="descclassname">hscommon.jobprogress.performer.</code><code class="descname">ThreadedJobPerformer</code><a class="headerlink" href="#hscommon.jobprogress.performer.ThreadedJobPerformer" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Run threaded jobs and track progress.</p>
|
|
<p>To run a threaded job, first create a job with _create_job(), then call _run_threaded(), with
|
|
your work function as a parameter.</p>
|
|
<p>Example:</p>
|
|
<p>j = self._create_job()
|
|
self._run_threaded(self.some_work_func, (arg1, arg2, j))</p>
|
|
<dl class="method">
|
|
<dt id="hscommon.jobprogress.performer.ThreadedJobPerformer.reraise_if_error">
|
|
<code class="descname">reraise_if_error</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hscommon.jobprogress.performer.ThreadedJobPerformer.reraise_if_error" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Reraises the error that happened in the thread if any.</p>
|
|
<p>Call this after the caller of run_threaded detected that self._job_running returned to False</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
|
|
|
<p>
|
|
«  <a href="job.html">hscommon.jobprogress.job</a>
|
|
  ::  
|
|
<a class="uplink" href="../../../index.html">Contents</a>
|
|
  ::  
|
|
<a href="qt.html">hscommon.jobprogress.qt</a>  »
|
|
</p>
|
|
|
|
</div>
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2016, Hardcoded Software.
|
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.1.
|
|
</div>
|
|
</body>
|
|
</html> |