Skip to content

Update Documentation for 5.1.0 #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaronayres35 merged 1 commit into from
Jan 13, 2021
Merged

Update Documentation for 5.1.0 #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
443 changes: 443 additions & 0 deletions 5.1/_modules/apptools/io/file.html
View file
Open in desktop

Large diffs are not rendered by default.

362 changes: 362 additions & 0 deletions 5.1/_modules/apptools/io/h5/dict_node.html
View file
Open in desktop

Large diffs are not rendered by default.

671 changes: 671 additions & 0 deletions 5.1/_modules/apptools/io/h5/file.html
View file
Open in desktop

Large diffs are not rendered by default.

287 changes: 287 additions & 0 deletions 5.1/_modules/apptools/io/h5/table_node.html
View file
Open in desktop

Large diffs are not rendered by default.

72 changes: 30 additions & 42 deletions ...les/apptools/undo/action/redo_action.html → 5.1/_modules/apptools/io/h5/utils.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8">

<title>apptools.undo.action.redo_action &mdash; Apptools Documentation</title>
<title>apptools.io.h5.utils &mdash; Apptools Documentation</title>

<link rel="stylesheet" type="text/css" href="../../../../_static/css/spc-bootstrap.css">
<link rel="stylesheet" type="text/css" href="../../../../_static/css/spc-extend.css">
Expand Down Expand Up @@ -76,56 +76,44 @@
<div class="bodywrapper">
<div class="body" id="spc-section-body" role="main">

<h1>Source code for apptools.undo.action.redo_action</h1><div class="highlight"><pre>
<span></span><span class="c1"># ------------------------------------------------------------------------------</span>
<span class="c1"># Copyright (c) 2007, Riverbank Computing Limited</span>
<h1>Source code for apptools.io.h5.utils</h1><div class="highlight"><pre>
<span></span><span class="c1"># (C) Copyright 2005-2021 Enthought, Inc., Austin, TX</span>
<span class="c1"># All rights reserved.</span>
<span class="c1">#</span>
<span class="c1"># This software is provided without warranty under the terms of the BSD</span>
<span class="c1"># license included in enthought/LICENSE.txt and may be redistributed only</span>
<span class="c1"># under the conditions described in the aforementioned license. The license</span>
<span class="c1"># license included in LICENSE.txt and may be redistributed only under</span>
<span class="c1"># the conditions described in the aforementioned license. The license</span>
<span class="c1"># is also available online at http://www.enthought.com/licenses/BSD.txt</span>
<span class="c1"># Thanks for using Enthought open source!</span>
<span class="c1">#</span>
<span class="c1"># Author: Riverbank Computing Limited</span>
<span class="c1"># Description: &lt;Enthought undo package component&gt;</span>
<span class="c1"># ------------------------------------------------------------------------------</span>

<span class="c1"># Local imports.</span>
<span class="kn">from</span> <span class="nn">.abstract_command_stack_action</span> <span class="k">import</span> <span class="n">AbstractCommandStackAction</span>


<div class="viewcode-block" id="RedoAction"><a class="viewcode-back" href="../../../../api/apptools.undo.action.html#apptools.undo.action.redo_action.RedoAction">[docs]</a><span class="k">class</span> <span class="nc">RedoAction</span><span class="p">(</span><span class="n">AbstractCommandStackAction</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;An action that redos the last command undone of the active command</span>
<span class="sd"> stack.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="c1">###########################################################################</span>
<span class="c1"># &#39;Action&#39; interface.</span>
<span class="c1">###########################################################################</span>

<div class="viewcode-block" id="RedoAction.perform"><a class="viewcode-back" href="../../../../api/apptools.undo.action.html#apptools.undo.action.redo_action.RedoAction.perform">[docs]</a> <span class="k">def</span> <span class="nf">perform</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Perform the action. &quot;&quot;&quot;</span>
<span class="c1"># Thanks for using Enthought open source!</span>
<span class="kn">from</span> <span class="nn">contextlib</span> <span class="k">import</span> <span class="n">contextmanager</span>

<span class="bp">self</span><span class="o">.</span><span class="n">undo_manager</span><span class="o">.</span><span class="n">redo</span><span class="p">()</span></div>
<span class="kn">from</span> <span class="nn">.file</span> <span class="k">import</span> <span class="n">H5File</span>

<span class="c1">###########################################################################</span>
<span class="c1"># &#39;AbstractUndoAction&#39; interface.</span>
<span class="c1">###########################################################################</span>

<span class="k">def</span> <span class="nf">_update_action</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Update the state of the action. &quot;&quot;&quot;</span>
<div class="viewcode-block" id="open_h5file"><a class="viewcode-back" href="../../../../api/apptools.io.h5.utils.html#apptools.io.h5.utils.open_h5file">[docs]</a><span class="nd">@contextmanager</span>
<span class="k">def</span> <span class="nf">open_h5file</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">&quot;r+&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Context manager for reading an HDF5 file as an H5File object.</span>

<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">undo_manager</span><span class="o">.</span><span class="n">redo_name</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> filename : str</span>
<span class="sd"> HDF5 file name.</span>
<span class="sd"> mode : str</span>
<span class="sd"> Mode to open the file:</span>

<span class="k">if</span> <span class="n">name</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;&amp;Redo &quot;</span> <span class="o">+</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">enabled</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;&amp;Redo&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">enabled</span> <span class="o">=</span> <span class="kc">False</span>
<span class="sd"> &#39;r&#39; : Read-only</span>
<span class="sd"> &#39;w&#39; : Write; create new file (an existing file would be deleted).</span>
<span class="sd"> &#39;a&#39; : Read and write to file; create if not existing</span>
<span class="sd"> &#39;r+&#39;: Read and write to file; must already exist</span>

<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span></div>
<span class="sd"> See `H5File` for additional keyword arguments.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">h5</span> <span class="o">=</span> <span class="n">H5File</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="n">mode</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">h5</span>
<span class="k">finally</span><span class="p">:</span>
<span class="n">h5</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div>
</pre></div>

</div>
Expand Down Expand Up @@ -162,10 +150,10 @@ <h3 id="searchlabel">Quick search</h3>
<div class="row-fluid">
<ul class="inline pull-left">
<li>
&copy; Copyright 2008-2020, Enthought
&copy; Copyright 2008-2021, Enthought
</li>
<li>
Last updated on Dec 17, 2020.
Last updated on Jan 13, 2021.
</li>
<li>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 2.3.1.
Expand Down
Loading