Skip to content

Commit 468e014

Browse files
committed
Update to v2.0.4
1 parent 7e84f6c commit 468e014

File tree

9 files changed

+114
-18
lines changed

9 files changed

+114
-18
lines changed

docs/fireworks.core.html

Lines changed: 31 additions & 12 deletions
Large diffs are not rendered by default.

docs/fireworks.core.tests.html

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
853853
<span class="sig-name descname"><span class="pre">test_except_details_on_rerun</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_except_details_on_rerun" title="Link to this definition"></a></dt>
854854
<dd></dd></dl>
855855

856+
<dl class="py method">
857+
<dt class="sig sig-object py" id="fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_get_recovery_wrong_launch_id">
858+
<span class="sig-name descname"><span class="pre">test_get_recovery_wrong_launch_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_get_recovery_wrong_launch_id" title="Link to this definition"></a></dt>
859+
<dd></dd></dl>
860+
856861
<dl class="py method">
857862
<dt class="sig sig-object py" id="fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun">
858863
<span class="sig-name descname"><span class="pre">test_task_level_rerun</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun" title="Link to this definition"></a></dt>
@@ -863,11 +868,36 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
863868
<span class="sig-name descname"><span class="pre">test_task_level_rerun_cp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_cp" title="Link to this definition"></a></dt>
864869
<dd></dd></dl>
865870

871+
<dl class="py method">
872+
<dt class="sig sig-object py" id="fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_no_recovery_info">
873+
<span class="sig-name descname"><span class="pre">test_task_level_rerun_no_recovery_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_no_recovery_info" title="Link to this definition"></a></dt>
874+
<dd></dd></dl>
875+
866876
<dl class="py method">
867877
<dt class="sig sig-object py" id="fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_prev_dir">
868878
<span class="sig-name descname"><span class="pre">test_task_level_rerun_prev_dir</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_prev_dir" title="Link to this definition"></a></dt>
869879
<dd></dd></dl>
870880

881+
<dl class="py method">
882+
<dt class="sig sig-object py" id="fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_recover_launch_id">
883+
<span class="sig-name descname"><span class="pre">test_task_level_rerun_recover_launch_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_recover_launch_id" title="Link to this definition"></a></dt>
884+
<dd></dd></dl>
885+
886+
<dl class="py method">
887+
<dt class="sig sig-object py" id="fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_fw_id">
888+
<span class="sig-name descname"><span class="pre">test_task_level_rerun_wrong_fw_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_fw_id" title="Link to this definition"></a></dt>
889+
<dd></dd></dl>
890+
891+
<dl class="py method">
892+
<dt class="sig sig-object py" id="fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_launch_id">
893+
<span class="sig-name descname"><span class="pre">test_task_level_rerun_wrong_launch_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_launch_id" title="Link to this definition"></a></dt>
894+
<dd></dd></dl>
895+
896+
<dl class="py method">
897+
<dt class="sig sig-object py" id="fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_state">
898+
<span class="sig-name descname"><span class="pre">test_task_level_rerun_wrong_state</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_state" title="Link to this definition"></a></dt>
899+
<dd></dd></dl>
900+
871901
</dd></dl>
872902

873903
<dl class="py class">
@@ -1302,9 +1332,15 @@ <h3><a href="index.html">Table of Contents</a></h3>
13021332
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.tearDown"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.tearDown()</span></code></a></li>
13031333
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.tearDownClass"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.tearDownClass()</span></code></a></li>
13041334
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_except_details_on_rerun"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_except_details_on_rerun()</span></code></a></li>
1335+
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_get_recovery_wrong_launch_id"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_get_recovery_wrong_launch_id()</span></code></a></li>
13051336
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_task_level_rerun()</span></code></a></li>
13061337
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_cp"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_task_level_rerun_cp()</span></code></a></li>
1338+
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_no_recovery_info"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_task_level_rerun_no_recovery_info()</span></code></a></li>
13071339
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_prev_dir"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_task_level_rerun_prev_dir()</span></code></a></li>
1340+
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_recover_launch_id"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_task_level_rerun_recover_launch_id()</span></code></a></li>
1341+
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_fw_id"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_fw_id()</span></code></a></li>
1342+
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_launch_id"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_launch_id()</span></code></a></li>
1343+
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_state"><code class="docutils literal notranslate"><span class="pre">LaunchPadRerunExceptionTest.test_task_level_rerun_wrong_state()</span></code></a></li>
13081344
</ul>
13091345
</li>
13101346
<li><a class="reference internal" href="#fireworks.core.tests.test_launchpad.LaunchPadTest"><code class="docutils literal notranslate"><span class="pre">LaunchPadTest</span></code></a><ul>

docs/fireworks.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -754,6 +754,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
754754
<li class="toctree-l2"><a class="reference internal" href="fireworks.utilities.html#module-fireworks.utilities.filepad">fireworks.utilities.filepad module</a><ul>
755755
<li class="toctree-l3"><a class="reference internal" href="fireworks.utilities.html#fireworks.utilities.filepad.FilePad"><code class="docutils literal notranslate"><span class="pre">FilePad</span></code></a><ul>
756756
<li class="toctree-l4"><a class="reference internal" href="fireworks.utilities.html#fireworks.utilities.filepad.FilePad.__init__"><code class="docutils literal notranslate"><span class="pre">FilePad.__init__()</span></code></a></li>
757+
<li class="toctree-l4"><a class="reference internal" href="fireworks.utilities.html#fireworks.utilities.filepad.FilePad.add_contents"><code class="docutils literal notranslate"><span class="pre">FilePad.add_contents()</span></code></a></li>
757758
<li class="toctree-l4"><a class="reference internal" href="fireworks.utilities.html#fireworks.utilities.filepad.FilePad.add_file"><code class="docutils literal notranslate"><span class="pre">FilePad.add_file()</span></code></a></li>
758759
<li class="toctree-l4"><a class="reference internal" href="fireworks.utilities.html#fireworks.utilities.filepad.FilePad.auto_load"><code class="docutils literal notranslate"><span class="pre">FilePad.auto_load()</span></code></a></li>
759760
<li class="toctree-l4"><a class="reference internal" href="fireworks.utilities.html#fireworks.utilities.filepad.FilePad.build_indexes"><code class="docutils literal notranslate"><span class="pre">FilePad.build_indexes()</span></code></a></li>

docs/fireworks.utilities.html

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,30 @@ <h2>fireworks.utilities.dagflow module<a class="headerlink" href="#fireworks-uti
197197
</dl>
198198
</dd></dl>
199199

200+
<dl class="py method">
201+
<dt class="sig sig-object py" id="fireworks.utilities.filepad.FilePad.add_contents">
202+
<span class="sig-name descname"><span class="pre">add_contents</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">contents</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">identifier</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.utilities.filepad.FilePad.add_contents" title="Link to this definition"></a></dt>
203+
<dd><p>Insert the file specified by the path into gridfs. The gridfs id and identifier are returned.
204+
Note: identifier must be unique, i.e, no insertion if the identifier already exists in the db.</p>
205+
<dl class="field-list simple">
206+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
207+
<dd class="field-odd"><ul class="simple">
208+
<li><p><strong>contents</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.14)"><em>bytes</em></a>) – bytes object to insert</p></li>
209+
<li><p><strong>identifier</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – file identifier. If identifier = None then the identifier is set to the object id
210+
returned by gridfs insertion.</p></li>
211+
<li><p><strong>compress</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – compress or not</p></li>
212+
<li><p><strong>metadata</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a>) – file metadata</p></li>
213+
</ul>
214+
</dd>
215+
<dt class="field-even">Returns<span class="colon">:</span></dt>
216+
<dd class="field-even"><p>the id returned by gridfs, identifier</p>
217+
</dd>
218+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
219+
<dd class="field-odd"><p>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a>)</p>
220+
</dd>
221+
</dl>
222+
</dd></dl>
223+
200224
<dl class="py method">
201225
<dt class="sig sig-object py" id="fireworks.utilities.filepad.FilePad.add_file">
202226
<span class="sig-name descname"><span class="pre">add_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">identifier</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.utilities.filepad.FilePad.add_file" title="Link to this definition"></a></dt>
@@ -808,7 +832,8 @@ <h2>fireworks.utilities.dagflow module<a class="headerlink" href="#fireworks-uti
808832
<dl class="py function">
809833
<dt class="sig sig-object py" id="fireworks.utilities.fw_utilities.redirect_local">
810834
<span class="sig-prename descclassname"><span class="pre">fireworks.utilities.fw_utilities.</span></span><span class="sig-name descname"><span class="pre">redirect_local</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">out_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'FW_job.out'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">err_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'FW_job.error'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.utilities.fw_utilities.redirect_local" title="Link to this definition"></a></dt>
811-
<dd><p>Temporarily redirect stdout or stderr to fws.error and fws.out.</p>
835+
<dd><p>Temporarily redirect stdout and stderr to files with names
836+
out_file and err_file, respectively.</p>
812837
</dd></dl>
813838

814839
</section>
@@ -940,6 +965,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
940965
<li><a class="reference internal" href="#module-fireworks.utilities.filepad">fireworks.utilities.filepad module</a><ul>
941966
<li><a class="reference internal" href="#fireworks.utilities.filepad.FilePad"><code class="docutils literal notranslate"><span class="pre">FilePad</span></code></a><ul>
942967
<li><a class="reference internal" href="#fireworks.utilities.filepad.FilePad.__init__"><code class="docutils literal notranslate"><span class="pre">FilePad.__init__()</span></code></a></li>
968+
<li><a class="reference internal" href="#fireworks.utilities.filepad.FilePad.add_contents"><code class="docutils literal notranslate"><span class="pre">FilePad.add_contents()</span></code></a></li>
943969
<li><a class="reference internal" href="#fireworks.utilities.filepad.FilePad.add_file"><code class="docutils literal notranslate"><span class="pre">FilePad.add_file()</span></code></a></li>
944970
<li><a class="reference internal" href="#fireworks.utilities.filepad.FilePad.auto_load"><code class="docutils literal notranslate"><span class="pre">FilePad.auto_load()</span></code></a></li>
945971
<li><a class="reference internal" href="#fireworks.utilities.filepad.FilePad.build_indexes"><code class="docutils literal notranslate"><span class="pre">FilePad.build_indexes()</span></code></a></li>

0 commit comments

Comments
 (0)