<!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">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>What’s new in PyTables 1.0 — PyTables 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/cloud.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '3.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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/jquery.cookie.js"></script>
<script type="text/javascript" src="../_static/toggle_sections.js"></script>
<script type="text/javascript" src="../_static/toggle_sidebar.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="PyTables 3.0.0 documentation" href="../index.html" />
<link rel="up" title="PyTables Release Notes" href="../release_notes.html" />
<link rel="next" title="What’s new in PyTables 0.9.1" href="RELEASE_NOTES_v0.9.1.html" />
<link rel="prev" title="What’s new in PyTables 1.1" href="RELEASE_NOTES_v1.1.html" />
</head>
<body>
<div class="relbar-top">
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="../np-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="RELEASE_NOTES_v0.9.1.html" title="What’s new in PyTables 0.9.1"
accesskey="N">next</a> </li>
<li class="right" >
<a href="RELEASE_NOTES_v1.1.html" title="What’s new in PyTables 1.1"
accesskey="P">previous</a> </li>
<li><a href="../index.html">PyTables 3.0.0 documentation</a> »</li>
<li><a href="../release_notes.html" accesskey="U">PyTables Release Notes</a> »</li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="what-s-new-in-pytables-1-0">
<h1>What’s new in PyTables 1.0<a class="headerlink" href="#what-s-new-in-pytables-1-0" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body">Francesc Altet</td>
</tr>
<tr class="field-even field"><th class="field-name">Contact:</th><td class="field-body"><a class="reference external" href="mailto:faltet%40carabos.com">faltet<span>@</span>carabos<span>.</span>com</a></td>
</tr>
<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body">Ivan Vilata i Balaguer</td>
</tr>
<tr class="field-even field"><th class="field-name">Contact:</th><td class="field-body"><a class="reference external" href="mailto:ivilata%40carabos.com">ivilata<span>@</span>carabos<span>.</span>com</a></td>
</tr>
</tbody>
</table>
<p>This document details the modifications to PyTables since version 0.9.1. Its
main purpose is help you ensure that your programs will be runnable when you
switch from PyTables 0.9.1 to PyTables 1.0.</p>
<div class="section" id="api-additions">
<h2>API additions<a class="headerlink" href="#api-additions" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>The new <tt class="docutils literal"><span class="pre">Table.col()</span></tt> method can be used to get a column from a table as a
<tt class="docutils literal"><span class="pre">NumArray</span></tt> or <tt class="docutils literal"><span class="pre">CharArray</span></tt> object. This is preferred over the syntax
<tt class="docutils literal"><span class="pre">table['colname']</span></tt>.</li>
<li>The new <tt class="docutils literal"><span class="pre">Table.readCoordinates()</span></tt> method reads a set of rows given their
indexes into an in-memory object.</li>
<li>The new <tt class="docutils literal"><span class="pre">Table.readAppend()</span></tt> method Append rows fullfilling the condition
to a destination table.</li>
</ul>
</div>
<div class="section" id="backward-incompatible-changes">
<h2>Backward-incompatible changes<a class="headerlink" href="#backward-incompatible-changes" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Trying to open a nonexistent file or a file of unknown type raises
<tt class="docutils literal"><span class="pre">IOError</span></tt> instead of <tt class="docutils literal"><span class="pre">RuntimeError</span></tt>. Using an invalid mode raises
<tt class="docutils literal"><span class="pre">ValueError</span></tt> instead of <tt class="docutils literal"><span class="pre">RuntimeError</span></tt>.</li>
<li>Getting a child node from a closed group raises <tt class="docutils literal"><span class="pre">ValueError</span></tt> instead of
<tt class="docutils literal"><span class="pre">RuntimeError</span></tt>.</li>
<li>Running an action on the wrong type of node now (i.e. using
<tt class="docutils literal"><span class="pre">file.listNodes()</span></tt> on a leaf) raises a <tt class="docutils literal"><span class="pre">TypeError</span></tt> instead of a
<tt class="docutils literal"><span class="pre">NodeError</span></tt>.</li>
<li>Removing a non-existing child now raises a <tt class="docutils literal"><span class="pre">NoSuchNodeError</span></tt>, instead of
doing nothing.</li>
<li>Removing a non-empty child group using <tt class="docutils literal"><span class="pre">del</span> <span class="pre">group.child</span></tt> fails with a
<tt class="docutils literal"><span class="pre">NodeError</span></tt> instead of recursively doing the removal. This is because of
the potential damage it may cause when used inadvertently. If a recursive
behavior is needed, use the <tt class="docutils literal"><span class="pre">_f_remove()</span></tt> method of the child node.</li>
<li>The <cite>recursive</cite> flag of <tt class="docutils literal"><span class="pre">Group._f_walkNodes()</span></tt> is <tt class="docutils literal"><span class="pre">True</span></tt> by default now.
Before it was <tt class="docutils literal"><span class="pre">False</span></tt>.</li>
<li>Now, deleting and getting a non-existing attribute raises an
<tt class="docutils literal"><span class="pre">AttributeError</span></tt> instead of a <tt class="docutils literal"><span class="pre">RuntimeError</span></tt>.</li>
<li>Swapped last two arguments of <tt class="docutils literal"><span class="pre">File.copyAttrs()</span></tt> to match the other
methods. Please use <tt class="docutils literal"><span class="pre">File.copyNodeAttrs()</span></tt> anyway.</li>
<li>Failing to infer the size of a string column raises <tt class="docutils literal"><span class="pre">ValueError</span></tt> instead
of <tt class="docutils literal"><span class="pre">RuntimeError</span></tt>.</li>
<li>Excessive table column name length and number of columns now raise
<tt class="docutils literal"><span class="pre">ValueError</span></tt> instead of <tt class="docutils literal"><span class="pre">IndexError</span></tt> and <tt class="docutils literal"><span class="pre">NameError</span></tt>.</li>
<li>Excessive table row length now raises <tt class="docutils literal"><span class="pre">ValueError</span></tt> instead of
<tt class="docutils literal"><span class="pre">RuntimeError</span></tt>.</li>
<li><tt class="docutils literal"><span class="pre">table[integer]</span></tt> returns a <tt class="docutils literal"><span class="pre">numarray.records.Record</span></tt> object instead of a
tuple. This was the original behavior before PyTables 0.9 and proved to be
more consistent than the last one (tables do not have an explicit ordering
of columns).</li>
<li>Specifying a nonexistent column in <tt class="docutils literal"><span class="pre">Table.read()</span></tt> raises a <tt class="docutils literal"><span class="pre">ValueError</span></tt>
instead of a <tt class="docutils literal"><span class="pre">LookupError</span></tt>.</li>
<li>When <tt class="docutils literal"><span class="pre">start</span> <span class="pre">>=</span> <span class="pre">stop</span></tt> an empty iterator is returned by <tt class="docutils literal"><span class="pre">Table.iterrows()</span></tt>
instead of an empty <tt class="docutils literal"><span class="pre">RecArray</span></tt>. Thanks to Ashley Walsh for noting this.</li>
<li>The interface of <tt class="docutils literal"><span class="pre">isHDF5File()</span></tt> and <tt class="docutils literal"><span class="pre">isPyTablesFile()</span></tt> file has been
unified so that they both return true or false values on success and raise
<tt class="docutils literal"><span class="pre">HDF5ExtError</span></tt> or errors. The true value in <tt class="docutils literal"><span class="pre">isPyTablesFile()</span></tt> is the
format version string of the file.</li>
<li><tt class="docutils literal"><span class="pre">Table.whereIndexed()</span></tt> and <tt class="docutils literal"><span class="pre">Table.whereInRange()</span></tt> are now <em>private</em>
methods, since the <tt class="docutils literal"><span class="pre">Table.where()</span></tt> method is able to choose the most
adequate option.</li>
<li>The global variables <tt class="docutils literal"><span class="pre">ExtVersion</span></tt> and <tt class="docutils literal"><span class="pre">HDF5Version</span></tt> have been renamed to
<tt class="docutils literal"><span class="pre">extVersion</span></tt> and <tt class="docutils literal"><span class="pre">hdf5Version</span></tt>, respectively.</li>
<li><tt class="docutils literal"><span class="pre">whichLibVersion()</span></tt> returns <tt class="docutils literal"><span class="pre">None</span></tt> on querying unavailable libraries,
and raises <tt class="docutils literal"><span class="pre">ValueError</span></tt> on unknown ones.</li>
</ul>
<p>The following modifications, though being (strictly speaking) modifications of
the API, will most probably not cause compatibility problems (but your mileage
may vary):</p>
<ul>
<li><p class="first">The default values for <tt class="docutils literal"><span class="pre">name</span></tt> and <tt class="docutils literal"><span class="pre">classname</span></tt> arguments in
<tt class="docutils literal"><span class="pre">File.getNode()</span></tt> are now <tt class="docutils literal"><span class="pre">None</span></tt>, although the empty string is still
allowed for backwards compatibility. File hierarchy manipulation and
attribute handling operations using those arguments have changed to reflect
this.</p>
</li>
<li><p class="first">Copy operations (<tt class="docutils literal"><span class="pre">Group._f_copyChildren()</span></tt>, <tt class="docutils literal"><span class="pre">File.copyChildren()</span></tt>,
<tt class="docutils literal"><span class="pre">File.copyNode()</span></tt>...) do no longer return a tuple with the new node and
statistics. Instead, they only return the new node, and statistics are
collected via an optional keyword argument.</p>
</li>
<li><p class="first">The <tt class="docutils literal"><span class="pre">copyFile()</span></tt> function in <tt class="docutils literal"><span class="pre">File.py</span></tt> has changed its signature from:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">copyFile</span><span class="p">(</span><span class="n">srcfilename</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">dstfilename</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
<span class="n">copyuserattrs</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">overwrite</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">stats</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
</pre></div>
</div>
<p>to:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">copyFile</span><span class="p">(</span><span class="n">srcfilename</span><span class="p">,</span> <span class="n">dstfilename</span><span class="p">,</span> <span class="n">overwrite</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>Thus, the function allows the same options as <tt class="docutils literal"><span class="pre">File.copyFile()</span></tt>.</p>
</li>
<li><p class="first">The <tt class="docutils literal"><span class="pre">File.copyFile()</span></tt> method has changed its signature from:</p>
<div class="highlight-python"><pre>copyFile(self, dstfilename=None, title=None, filters=None,
copyuserattrs=1, overwrite=0, stats=None):</pre>
</div>
<p>to:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">copyFile</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dstfilename</span><span class="p">,</span> <span class="n">overwrite</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>This enables this method to pass on arbitrary flags and options supported by
copying methods of inner nodes in the hierarchy.</p>
</li>
<li><p class="first">The <tt class="docutils literal"><span class="pre">File.copyChildren()</span></tt> method has changed its signature from:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">copyChildren</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wheresrc</span><span class="p">,</span> <span class="n">wheredst</span><span class="p">,</span> <span class="n">recursive</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
<span class="n">copyuserattrs</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">stop</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">step</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">overwrite</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">stats</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
</pre></div>
</div>
<p>to:</p>
<div class="highlight-python"><pre>copyChildren(self, srcgroup, dstgroup, overwrite=False, recursive=False,
**kwargs):</pre>
</div>
<p>Thus, the function allows the same options as <tt class="docutils literal"><span class="pre">Group._f_copyChildren()</span></tt>.</p>
</li>
<li><p class="first">The <tt class="docutils literal"><span class="pre">Group._f_copyChildren()</span></tt> method has changed its signature from:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">_f_copyChildren</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span> <span class="n">recursive</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
<span class="n">copyuserattrs</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">stop</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">step</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">overwrite</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">stats</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
</pre></div>
</div>
<p>to:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">_f_copyChildren</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dstgroup</span><span class="p">,</span> <span class="n">overwrite</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">recursive</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>This enables this method to pass on arbitrary flags and options supported by
copying methods of inner nodes in the group.</p>
</li>
<li><p class="first">Renamed <tt class="docutils literal"><span class="pre">srcFilename</span></tt> and <tt class="docutils literal"><span class="pre">dstFilename</span></tt> arguments in <tt class="docutils literal"><span class="pre">copyFile()</span></tt> and
<tt class="docutils literal"><span class="pre">File.copyFile()</span></tt> to <tt class="docutils literal"><span class="pre">srcfilename</span></tt> and <tt class="docutils literal"><span class="pre">dstfilename</span></tt>, respectively.
Renamed <tt class="docutils literal"><span class="pre">whereSrc</span></tt> and <tt class="docutils literal"><span class="pre">whereDst</span></tt> arguments in <tt class="docutils literal"><span class="pre">File.copyChildren()</span></tt>
to <tt class="docutils literal"><span class="pre">wheresrc</span></tt> and <tt class="docutils literal"><span class="pre">wheredst</span></tt>, respectively. Renamed <tt class="docutils literal"><span class="pre">dstNode</span></tt>
argument in <tt class="docutils literal"><span class="pre">File.copyAttrs()</span></tt> to <tt class="docutils literal"><span class="pre">dstnode</span></tt>. Tose arguments should be
easier to type in interactive sessions (although 99% of the time it is not
necessary to specify them).</p>
</li>
<li><p class="first">Renamed <tt class="docutils literal"><span class="pre">object</span></tt> argument in <tt class="docutils literal"><span class="pre">EArray.append()</span></tt> to <tt class="docutils literal"><span class="pre">sequence</span></tt>.</p>
</li>
<li><p class="first">The <tt class="docutils literal"><span class="pre">rows</span></tt> argument in <tt class="docutils literal"><span class="pre">Table.append()</span></tt> is now compulsory.</p>
</li>
<li><p class="first">The <tt class="docutils literal"><span class="pre">start</span></tt> argument in <tt class="docutils literal"><span class="pre">Table.removeRows()</span></tt> is now compulsory.</p>
</li>
</ul>
</div>
<div class="section" id="api-refinements">
<h2>API refinements<a class="headerlink" href="#api-refinements" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">The <tt class="docutils literal"><span class="pre">isHDF5()</span></tt> function has been deprecated in favor of <tt class="docutils literal"><span class="pre">isHDF5File()</span></tt>.</p>
</li>
<li><p class="first">Node attribute-handling methods in <tt class="docutils literal"><span class="pre">File</span></tt> have been renamed for a better
coherence and understanding of their purpose:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">getAttrNode()</span></tt> is now called <tt class="docutils literal"><span class="pre">getNodeAttr()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setAttrNode()</span></tt> is now called <tt class="docutils literal"><span class="pre">setNodeAttr()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">delAttrNode()</span></tt> is now called <tt class="docutils literal"><span class="pre">delNodeAttr()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">copyAttrs()</span></tt> is now called <tt class="docutils literal"><span class="pre">copyNodeAttrs()</span></tt></li>
</ul>
<p>They keep their respective signatures, and the old versions still exist for
backwards compatibility, though they issue a <tt class="docutils literal"><span class="pre">DeprecationWarning</span></tt>.</p>
</li>
<li><p class="first">Using <tt class="docutils literal"><span class="pre">VLArray.append()</span></tt> with multiple arguments is now deprecated for its
ambiguity. You should put the arguments in a single sequence object (list,
tuple, array...) and pass it as the only argument.</p>
</li>
<li><p class="first">Using <tt class="docutils literal"><span class="pre">table['colname']</span></tt> is deprecated. Using <tt class="docutils literal"><span class="pre">table.col('colname')</span></tt>
(with the new <tt class="docutils literal"><span class="pre">col()</span></tt> method) is preferred.</p>
</li>
</ul>
</div>
<div class="section" id="bug-fixes-affecting-api">
<h2>Bug fixes (affecting API)<a class="headerlink" href="#bug-fixes-affecting-api" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">Table.iterrows()</span></tt> returns an empty iterator when no rows are selected,
instead of returning <tt class="docutils literal"><span class="pre">None</span></tt>.</li>
</ul>
<hr class="docutils" />
<blockquote>
<div><p><strong>Enjoy data!</strong></p>
<p class="attribution">—The PyTables Team</p>
</div></blockquote>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/logo-pytables-small.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">What’s new in PyTables 1.0</a><ul>
<li><a class="reference internal" href="#api-additions">API additions</a></li>
<li><a class="reference internal" href="#backward-incompatible-changes">Backward-incompatible changes</a></li>
<li><a class="reference internal" href="#api-refinements">API refinements</a></li>
<li><a class="reference internal" href="#bug-fixes-affecting-api">Bug fixes (affecting API)</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="RELEASE_NOTES_v1.1.html"
title="previous chapter">What’s new in PyTables 1.1</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="RELEASE_NOTES_v0.9.1.html"
title="next chapter">What’s new in PyTables 0.9.1</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/release-notes/RELEASE_NOTES_v1.0.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="relbar-bottom">
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="../np-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="RELEASE_NOTES_v0.9.1.html" title="What’s new in PyTables 0.9.1"
>next</a> </li>
<li class="right" >
<a href="RELEASE_NOTES_v1.1.html" title="What’s new in PyTables 1.1"
>previous</a> </li>
<li><a href="../index.html">PyTables 3.0.0 documentation</a> »</li>
<li><a href="../release_notes.html" >PyTables Release Notes</a> »</li>
</ul>
</div>
</div>
<div class="footer">
© Copyright 2011-2013, PyTables maintainers.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<!-- cloud_sptheme 1.3 -->
</body>
</html>
