Skip to content

Commit

Permalink
Update to PyTables v3.9.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@ivilata
ivilata committed Oct 5, 2023
1 parent 1dffd1e commit 940eb37
Show file tree
Hide file tree
Showing 140 changed files with 6,715 additions and 16,699 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: a5b20a9794c7e6a5f2c6c6d8fe8a932e
config: 2c681a2b95066441eb2d9f0fc4baf8b7
tags: 645f666f9bcd5a90fca523b33c5a78b7
229 changes: 59 additions & 170 deletions FAQ.html
View file

Large diffs are not rendered by default.

200 changes: 44 additions & 156 deletions MIGRATING_TO_2.x.html
View file

Large diffs are not rendered by default.

185 changes: 37 additions & 148 deletions MIGRATING_TO_3.x.html
View file
Original file line number Diff line number Diff line change
@@ -1,48 +1,21 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Migrating from PyTables 2.x to 3.x &mdash; PyTables 3.8.1.dev0 documentation</title>



<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />










<title>Migrating from PyTables 2.x to 3.x &mdash; PyTables 3.9.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<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 type="text/javascript" src="_static/js/theme.js"></script>


<script src="_static/documentation_options.js?v=e55a5be6"></script>
<script src="_static/doctools.js?v=888ff710"></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" />
<link rel="next" title="Downloads" href="downloads.html" />
Expand All @@ -61,55 +34,29 @@

</head>

<body class="wy-body-for-nav">


<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">

<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html">



<a href="index.html">

<img src="_static/logo-pytables-small.png" class="logo" alt="Logo"/>

<img src="_static/logo-pytables-small.png" class="logo" alt="Logo"/>
</a>




<div class="version">
3.8.1.dev0
3.9.0
</div>




<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>


<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="usersguide/index.html">User’s Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="cookbook/index.html">Cookbook</a></li>
Expand Down Expand Up @@ -150,73 +97,32 @@
<li class="toctree-l1"><a class="reference internal" href="dev_team.html">Development Team</a></li>
</ul>



</div>

</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" aria-label="top navigation">

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PyTables</a>

</nav>


<div class="wy-nav-content">

<div class="rst-content">



















<div role="navigation" aria-label="breadcrumbs navigation">

<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">

<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>

<li>Migrating from PyTables 2.x to 3.x</li>


<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Migrating from PyTables 2.x to 3.x</li>
<li class="wy-breadcrumbs-aside">


<a href="_sources/MIGRATING_TO_3.x.rst.txt" rel="nofollow"> View page source</a>


</li>

</ul>


<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="migrating-from-pytables-2-x-to-3-x">
<h1>Migrating from PyTables 2.x to 3.x<a class="headerlink" href="#migrating-from-pytables-2-x-to-3-x" title="Permalink to this heading"></a></h1>
<h1>Migrating from PyTables 2.x to 3.x<a class="headerlink" href="#migrating-from-pytables-2-x-to-3-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>Antonio Valentino</p>
Expand All @@ -232,7 +138,7 @@ <h1>Migrating from PyTables 2.x to 3.x<a class="headerlink" href="#migrating-fro
2.x to 3.x series and what you need to know when migrating downstream
code bases.</p>
<section id="python-3-at-last">
<h2>Python 3 at Last!<a class="headerlink" href="#python-3-at-last" title="Permalink to this heading"></a></h2>
<h2>Python 3 at Last!<a class="headerlink" href="#python-3-at-last" title="Link to this heading"></a></h2>
<p>The PyTables 3.x series now ships with full compatibility for Python 3.1+.
Additionally, we plan on maintaining compatibility with Python 2.7 for the
foreseeable future. Python 2.6 is no longer supported but
Expand All @@ -241,14 +147,14 @@ <h2>Python 3 at Last!<a class="headerlink" href="#python-3-at-last" title="Perma
Python 2 &amp; 3.</p>
</section>
<section id="numeric-numarray-netcdf3-hdf5-1-6-no-more">
<h2>Numeric, Numarray, NetCDF3, &amp; HDF5 1.6 No More!<a class="headerlink" href="#numeric-numarray-netcdf3-hdf5-1-6-no-more" title="Permalink to this heading"></a></h2>
<h2>Numeric, Numarray, NetCDF3, &amp; HDF5 1.6 No More!<a class="headerlink" href="#numeric-numarray-netcdf3-hdf5-1-6-no-more" title="Link to this heading"></a></h2>
<p>PyTables no longer supports numeric and numarray. Please use numpy instead.
Additionally, the <code class="docutils literal notranslate"><span class="pre">tables.netcdf3</span></code> module has been removed. Please refer
to the <a class="reference external" href="http://code.google.com/p/netcdf4-python/">netcdf4-python</a> project for further support. Lastly, the older
HDF5 1.6 API is no longer supported. Please upgrade to HDF5 1.8+.</p>
</section>
<section id="unicode-all-the-strings">
<h2>Unicode all the strings!<a class="headerlink" href="#unicode-all-the-strings" title="Permalink to this heading"></a></h2>
<h2>Unicode all the strings!<a class="headerlink" href="#unicode-all-the-strings" title="Link to this heading"></a></h2>
<p>In Python 3, all strings are natively in Unicode. This introduces some
difficulties, as the native HDF5 string format is not Unicode-compatible.
To minimize explicit conversion troubles when writing, especially <a class="reference internal" href="#create-signatures"><span class="std std-ref">when
Expand All @@ -261,13 +167,13 @@ <h2>Unicode all the strings!<a class="headerlink" href="#unicode-all-the-strings
For true Unicode support, look into the <code class="docutils literal notranslate"><span class="pre">VLUnicodeAtom</span></code> class.</p>
</section>
<section id="major-api-changes">
<h2>Major API Changes<a class="headerlink" href="#major-api-changes" title="Permalink to this heading"></a></h2>
<h2>Major API Changes<a class="headerlink" href="#major-api-changes" title="Link to this heading"></a></h2>
<p>The PyTables developers, <a class="reference external" href="http://sourceforge.net/mailarchive/message.php?msg_id=29584752">by popular demand</a>, have taken this opportunity
that a major version number upgrade affords to implement significant API
changes. We have tried to do this in such a way that will not immediately
break most existing code, though in some breakages may still occur.</p>
<section id="pep-8-compliance">
<h3>PEP 8 Compliance<a class="headerlink" href="#pep-8-compliance" title="Permalink to this heading"></a></h3>
<h3>PEP 8 Compliance<a class="headerlink" href="#pep-8-compliance" title="Link to this heading"></a></h3>
<p>The PyTables 3.x series now follows <a class="reference external" href="http://www.python.org/dev/peps/pep-0008/">PEP 8</a> coding standard. This makes
using PyTables more idiomatic with surrounding Python code that also adheres
to this standard. The primary way that the 2.x series was <em>not</em> PEP 8
Expand Down Expand Up @@ -333,7 +239,7 @@ <h3>PEP 8 Compliance<a class="headerlink" href="#pep-8-compliance" title="Permal
is subject to change.</p>
</section>
<section id="consistent-create-xxx-signatures">
<span id="create-signatures"></span><h3>Consistent <code class="docutils literal notranslate"><span class="pre">create_xxx()</span></code> Signatures<a class="headerlink" href="#consistent-create-xxx-signatures" title="Permalink to this heading"></a></h3>
<span id="create-signatures"></span><h3>Consistent <code class="docutils literal notranslate"><span class="pre">create_xxx()</span></code> Signatures<a class="headerlink" href="#consistent-create-xxx-signatures" title="Link to this heading"></a></h3>
<p>Also by popular demand, it is now possible to create all data sets (<code class="docutils literal notranslate"><span class="pre">Array</span></code>,
<code class="docutils literal notranslate"><span class="pre">CArray</span></code>, <code class="docutils literal notranslate"><span class="pre">EArray</span></code>, <code class="docutils literal notranslate"><span class="pre">VLArray</span></code>, and <code class="docutils literal notranslate"><span class="pre">Table</span></code>) from existing Python objects.
Constructors for these classes now accept either of the following keyword arguments:</p>
Expand All @@ -356,7 +262,7 @@ <h3>PEP 8 Compliance<a class="headerlink" href="#pep-8-compliance" title="Permal
keyword argument.</p>
</section>
<section id="api-name-changes">
<span id="id1"></span><h3>API Name Changes<a class="headerlink" href="#api-name-changes" title="Permalink to this heading"></a></h3>
<span id="id1"></span><h3>API Name Changes<a class="headerlink" href="#api-name-changes" title="Link to this heading"></a></h3>
<p>The following tables shows the old 2.x names that have been update to their
new values in the new 3.x series. Please use the <code class="docutils literal notranslate"><span class="pre">pt2to3</span></code> tool to convert
between these.</p>
Expand Down Expand Up @@ -1565,50 +1471,33 @@ <h3>PEP 8 Compliance<a class="headerlink" href="#pep-8-compliance" title="Permal


</div>

</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="downloads.html" class="btn btn-neutral float-right" title="Downloads" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="other_material.html" class="btn btn-neutral float-left" title="Other Material" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="downloads.html" class="btn btn-neutral float-right" title="Downloads" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>
&#169; Copyright 2011–2022, PyTables maintainers.

</p>
<p>&#169; Copyright 2011–2023, PyTables maintainers.</p>
</div>



Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a


Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>

</section>

</div>


<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>





</script>

</body>
</html>
Binary file added _images/b2nd_getslice_big.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/b2nd_getslice_small.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 940eb37

Please sign in to comment.