Skip to content

Commit

Permalink
Update to PyTables v3.10.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@avalentino
avalentino committed Aug 17, 2024
1 parent 8179d70 commit b4054e3
Show file tree
Hide file tree
Showing 123 changed files with 3,687 additions and 16,440 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 418fccdf9c73067ab1e1f0a09e54b921
config: 2fdf1fd3f80e419371699124137c3e59
tags: 645f666f9bcd5a90fca523b33c5a78b7
133 changes: 65 additions & 68 deletions FAQ.html
View file

Large diffs are not rendered by default.

49 changes: 23 additions & 26 deletions MIGRATING_TO_2.x.html
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,22 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Migrating from PyTables 1.x to 2.x &mdash; PyTables 3.10.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<title>Migrating from PyTables 1.x to 2.x &mdash; PyTables 3.10.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/documentation_options.js?v=5ca81ab5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -52,7 +49,7 @@
<img src="_static/logo-pytables-small.png" class="logo" alt="Logo"/>
</a>
<div class="version">
3.10.0
3.10.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -125,7 +122,7 @@
<div itemprop="articleBody">

<section id="migrating-from-pytables-1-x-to-2-x">
<h1>Migrating from PyTables 1.x to 2.x<a class="headerlink" href="#migrating-from-pytables-1-x-to-2-x" title="Permalink to this heading"></a></h1>
<h1>Migrating from PyTables 1.x to 2.x<a class="headerlink" href="#migrating-from-pytables-1-x-to-2-x" title="Link to this heading"></a></h1>
<dl class="field-list simple">
<dt class="field-odd">Author<span class="colon">:</span></dt>
<dd class="field-odd"><p>Francesc Alted i Abad</p>
Expand All @@ -143,7 +140,7 @@ <h1>Migrating from PyTables 1.x to 2.x<a class="headerlink" href="#migrating-fro
<p>Next are described a series of issues that you must have in mind when
migrating from PyTables 1.x to PyTables 2.x series.</p>
<section id="new-type-system">
<h2>New type system<a class="headerlink" href="#new-type-system" title="Permalink to this heading"></a></h2>
<h2>New type system<a class="headerlink" href="#new-type-system" title="Link to this heading"></a></h2>
<p>In PyTables 2.x all the data types for leaves are described through a couple
of classes:</p>
<ul class="simple">
Expand Down Expand Up @@ -177,7 +174,7 @@ <h2>New type system<a class="headerlink" href="#new-type-system" title="Permalin
information on the new PyTables types.</p>
</section>
<section id="important-changes-in-atom-specification">
<h2>Important changes in <code class="docutils literal notranslate"><span class="pre">Atom</span></code> specification<a class="headerlink" href="#important-changes-in-atom-specification" title="Permalink to this heading"></a></h2>
<h2>Important changes in <code class="docutils literal notranslate"><span class="pre">Atom</span></code> specification<a class="headerlink" href="#important-changes-in-atom-specification" title="Link to this heading"></a></h2>
<ul>
<li><p>The <code class="docutils literal notranslate"><span class="pre">dtype</span></code> argument of <code class="docutils literal notranslate"><span class="pre">EnumAtom</span></code> and <code class="docutils literal notranslate"><span class="pre">EnumCol</span></code> constructors
has been replaced by the <code class="docutils literal notranslate"><span class="pre">base</span></code> argument, which can take a
Expand Down Expand Up @@ -207,7 +204,7 @@ <h2>Important changes in <code class="docutils literal notranslate"><span class=
</ul>
</section>
<section id="new-query-system">
<h2>New query system<a class="headerlink" href="#new-query-system" title="Permalink to this heading"></a></h2>
<h2>New query system<a class="headerlink" href="#new-query-system" title="Link to this heading"></a></h2>
<ul>
<li><p>In-kernel conditions, since they are based now in Numexpr, must be written
<em>as strings</em>. For example, a condition that in 1.x was stated as:</p>
Expand All @@ -229,7 +226,7 @@ <h2>New query system<a class="headerlink" href="#new-query-system" title="Permal
</ul>
</section>
<section id="new-indexing-system">
<h2>New indexing system<a class="headerlink" href="#new-indexing-system" title="Permalink to this heading"></a></h2>
<h2>New indexing system<a class="headerlink" href="#new-indexing-system" title="Link to this heading"></a></h2>
<p>The indexing system has been totally rewritten from scratch for PyTables 2.0
Pro Edition. The new indexing system has been included into PyTables with
release 2.3. Due to this, your existing indexes created with PyTables 1.x
Expand All @@ -241,7 +238,7 @@ <h2>New indexing system<a class="headerlink" href="#new-indexing-system" title="
utility.</p>
</section>
<section id="new-meanings-for-atom-shape-and-array-shape-argument">
<h2>New meanings for atom shape and <code class="docutils literal notranslate"><span class="pre">*Array</span></code> shape argument<a class="headerlink" href="#new-meanings-for-atom-shape-and-array-shape-argument" title="Permalink to this heading"></a></h2>
<h2>New meanings for atom shape and <code class="docutils literal notranslate"><span class="pre">*Array</span></code> shape argument<a class="headerlink" href="#new-meanings-for-atom-shape-and-array-shape-argument" title="Link to this heading"></a></h2>
<p>With PyTables 1.x, the atom shape was used for different goals depending on
the context it was used. For example, in <code class="docutils literal notranslate"><span class="pre">createEArray()</span></code>, the shape of the
atom was used to specify the <em>dataset shape</em> of the object on disk, while in
Expand All @@ -264,7 +261,7 @@ <h2>New meanings for atom shape and <code class="docutils literal notranslate"><
types in PyTables. See the Users’ Manual for more info on this.</p>
</section>
<section id="new-argument-chunkshape-of-chunked-leaves">
<h2>New argument <code class="docutils literal notranslate"><span class="pre">chunkshape</span></code> of chunked leaves<a class="headerlink" href="#new-argument-chunkshape-of-chunked-leaves" title="Permalink to this heading"></a></h2>
<h2>New argument <code class="docutils literal notranslate"><span class="pre">chunkshape</span></code> of chunked leaves<a class="headerlink" href="#new-argument-chunkshape-of-chunked-leaves" title="Link to this heading"></a></h2>
<p>It is possible now to specify the chunk shape for all the chunked leaves in
PyTables (all except <code class="docutils literal notranslate"><span class="pre">Array</span></code>). With PyTables 1.x this value was
automatically calculated so as to achieve decent results in most of the
Expand All @@ -278,7 +275,7 @@ <h2>New argument <code class="docutils literal notranslate"><span class="pre">ch
but it can be useful for inspection by advanced users.</p>
</section>
<section id="new-flavor-specification">
<h2>New flavor specification<a class="headerlink" href="#new-flavor-specification" title="Permalink to this heading"></a></h2>
<h2>New flavor specification<a class="headerlink" href="#new-flavor-specification" title="Link to this heading"></a></h2>
<p>As of 2.x, flavors can <em>only</em> be set through the <code class="docutils literal notranslate"><span class="pre">flavor</span></code> attribute of
leaves, and they are <em>persistent</em>, so changing a flavor requires that the file
be writable.</p>
Expand All @@ -287,15 +284,15 @@ <h2>New flavor specification<a class="headerlink" href="#new-flavor-specificatio
<code class="docutils literal notranslate"><span class="pre">Atom</span></code> constructors or the <code class="docutils literal notranslate"><span class="pre">_v_flavor</span></code> attribute of descriptions.</p>
</section>
<section id="system-attributes-can-be-deleted-now">
<h2>System attributes can be deleted now<a class="headerlink" href="#system-attributes-can-be-deleted-now" title="Permalink to this heading"></a></h2>
<h2>System attributes can be deleted now<a class="headerlink" href="#system-attributes-can-be-deleted-now" title="Link to this heading"></a></h2>
<p>The protection against removing system attributes (like <code class="docutils literal notranslate"><span class="pre">FILTERS</span></code>,
<code class="docutils literal notranslate"><span class="pre">FLAVOR</span></code> or <code class="docutils literal notranslate"><span class="pre">CLASS</span></code>, to name only a few) has been completely removed. It
is now the responsibility of the user to make a proper use of this freedom.
With this, users can get rid of all proprietary PyTables attributes if they
want to (for example, for making a file to look more like an HDF5 native one).</p>
</section>
<section id="byteorder-issues">
<h2>Byteorder issues<a class="headerlink" href="#byteorder-issues" title="Permalink to this heading"></a></h2>
<h2>Byteorder issues<a class="headerlink" href="#byteorder-issues" title="Link to this heading"></a></h2>
<p>Now, all the data coming from reads and internal buffers is always converted
on-the-fly, if needed, to the <em>native</em> byteorder. This represents a big
advantage in terms of speed when operating with objects coming from files that
Expand All @@ -306,7 +303,7 @@ <h2>Byteorder issues<a class="headerlink" href="#byteorder-issues" title="Permal
should use the aforementioned <code class="docutils literal notranslate"><span class="pre">byteorder</span></code> parameter.</p>
</section>
<section id="tunable-internal-buffer-sizes">
<h2>Tunable internal buffer sizes<a class="headerlink" href="#tunable-internal-buffer-sizes" title="Permalink to this heading"></a></h2>
<h2>Tunable internal buffer sizes<a class="headerlink" href="#tunable-internal-buffer-sizes" title="Link to this heading"></a></h2>
<p>You can change the size of the internal buffers for I/O purposes of PyTables
by changing the value of the new public attribute <code class="docutils literal notranslate"><span class="pre">nrowsinbuf</span></code> that is
present in all leaves. By default, this contains a sensible value so as to
Expand All @@ -315,7 +312,7 @@ <h2>Tunable internal buffer sizes<a class="headerlink" href="#tunable-internal-b
memory consumption…).</p>
</section>
<section id="changes-to-module-names">
<h2>Changes to module names<a class="headerlink" href="#changes-to-module-names" title="Permalink to this heading"></a></h2>
<h2>Changes to module names<a class="headerlink" href="#changes-to-module-names" title="Link to this heading"></a></h2>
<p>If your application is directly accessing modules under the <code class="docutils literal notranslate"><span class="pre">tables</span></code>
package, you need to know that <em>the names of all modules are now all in
lowercase</em>. This allows one to tell apart the <code class="docutils literal notranslate"><span class="pre">tables.Array</span></code> <em>class</em> from
Expand All @@ -332,7 +329,7 @@ <h2>Changes to module names<a class="headerlink" href="#changes-to-module-names"
on PyTables.</p>
</section>
<section id="other-changes">
<h2>Other changes<a class="headerlink" href="#other-changes" title="Permalink to this heading"></a></h2>
<h2>Other changes<a class="headerlink" href="#other-changes" title="Link to this heading"></a></h2>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">Filters.complib</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code> for filter properties created with
<code class="docutils literal notranslate"><span class="pre">complevel=0</span></code> (i.e. disabled compression, which is the default).</p></li>
Expand Down
Loading

0 comments on commit b4054e3

Please sign in to comment.