<!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>astropy.io.ascii.fixedwidth — Astropy v0.2.4</title>
<link rel="stylesheet" href="../../../../_static/bootstrap-astropy.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../../',
VERSION: '0.2.4',
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/sidebar.js"></script>
<link rel="shortcut icon" href="../../../../_static/astropy_logo.ico"/>
<link rel="top" title="Astropy v0.2.4" href="../../../../index.html" />
<link rel="up" title="Module code" href="../../../index.html" />
</head>
<body>
<div class="topbar">
<a class="brand" title="Documentation Home" href="../../../../index.html"></a>
<ul>
<li><a class="homelink" title="AstroPy Homepage" href="http://www.astropy.org"></a></li>
<li><a title="General Index" href="../../../../genindex.html">Index</a></li>
<li><a title="Python Module Index" href="../../../../py-modindex.html">Modules</a></li>
<li>
<form action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</li>
</ul>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li>
<a href="../../../../index.html">Astropy v0.2.4</a>
»
</li>
<li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for astropy.io.ascii.fixedwidth</h1><div class="highlight"><pre>
<span class="c"># Licensed under a 3-clause BSD style license - see LICENSE.rst</span>
<span class="sd">"""An extensible ASCII table reader and writer.</span>
<span class="sd">fixedwidth.py:</span>
<span class="sd"> Read or write a table with fixed width columns.</span>
<span class="sd">:Copyright: Smithsonian Astrophysical Observatory (2011)</span>
<span class="sd">:Author: Tom Aldcroft (aldcroft@head.cfa.harvard.edu)</span>
<span class="sd">"""</span>
<span class="c">## </span>
<span class="c">## Redistribution and use in source and binary forms, with or without</span>
<span class="c">## modification, are permitted provided that the following conditions are met:</span>
<span class="c">## * Redistributions of source code must retain the above copyright</span>
<span class="c">## notice, this list of conditions and the following disclaimer.</span>
<span class="c">## * Redistributions in binary form must reproduce the above copyright</span>
<span class="c">## notice, this list of conditions and the following disclaimer in the</span>
<span class="c">## documentation and/or other materials provided with the distribution.</span>
<span class="c">## * Neither the name of the Smithsonian Astrophysical Observatory nor the</span>
<span class="c">## names of its contributors may be used to endorse or promote products</span>
<span class="c">## derived from this software without specific prior written permission.</span>
<span class="c">## </span>
<span class="c">## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND</span>
<span class="c">## ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span>
<span class="c">## WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span>
<span class="c">## DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY</span>
<span class="c">## DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span>
<span class="c">## (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;</span>
<span class="c">## LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND</span>
<span class="c">## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<span class="c">## (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS </span>
<span class="c">## SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">itertools</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">core</span>
<span class="kn">from</span> <span class="nn">.core</span> <span class="kn">import</span> <span class="n">io</span><span class="p">,</span> <span class="nb">next</span><span class="p">,</span> <span class="n">izip</span><span class="p">,</span> <span class="nb">any</span>
<div class="viewcode-block" id="FixedWidthSplitter"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthSplitter.html#astropy.io.ascii.fixedwidth.FixedWidthSplitter">[docs]</a><span class="k">class</span> <span class="nc">FixedWidthSplitter</span><span class="p">(</span><span class="n">core</span><span class="o">.</span><span class="n">BaseSplitter</span><span class="p">):</span>
<span class="sd">"""Split line based on fixed start and end positions for each ``col`` in</span>
<span class="sd"> ``self.cols``.</span>
<span class="sd"> This class requires that the Header class will have defined ``col.start``</span>
<span class="sd"> and ``col.end`` for each column. The reference to the ``header.cols`` gets</span>
<span class="sd"> put in the splitter object by the base Reader.read() function just in time</span>
<span class="sd"> for splitting data lines by a ``data`` object. </span>
<span class="sd"> Note that the ``start`` and ``end`` positions are defined in the pythonic</span>
<span class="sd"> style so line[start:end] is the desired substring for a column. This splitter</span>
<span class="sd"> class does not have a hook for ``process_lines`` since that is generally not</span>
<span class="sd"> useful for fixed-width input.</span>
<span class="sd"> """</span>
<span class="n">delimiter_pad</span> <span class="o">=</span> <span class="s">''</span>
<span class="n">bookend</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lines</span><span class="p">):</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">lines</span><span class="p">:</span>
<span class="n">vals</span> <span class="o">=</span> <span class="p">[</span><span class="n">line</span><span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">start</span><span class="p">:</span><span class="n">x</span><span class="o">.</span><span class="n">end</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cols</span><span class="p">]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">process_val</span><span class="p">:</span>
<span class="k">yield</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">process_val</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">vals</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">vals</span>
<div class="viewcode-block" id="FixedWidthSplitter.join"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthSplitter.html#astropy.io.ascii.fixedwidth.FixedWidthSplitter.join">[docs]</a> <span class="k">def</span> <span class="nf">join</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vals</span><span class="p">,</span> <span class="n">widths</span><span class="p">):</span>
<span class="n">pad</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">delimiter_pad</span> <span class="ow">or</span> <span class="s">''</span>
<span class="n">delimiter</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">delimiter</span> <span class="ow">or</span> <span class="s">''</span>
<span class="n">padded_delim</span> <span class="o">=</span> <span class="n">pad</span> <span class="o">+</span> <span class="n">delimiter</span> <span class="o">+</span> <span class="n">pad</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">bookend</span><span class="p">:</span>
<span class="n">bookend_left</span> <span class="o">=</span> <span class="n">delimiter</span> <span class="o">+</span> <span class="n">pad</span>
<span class="n">bookend_right</span> <span class="o">=</span> <span class="n">pad</span> <span class="o">+</span> <span class="n">delimiter</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">bookend_left</span> <span class="o">=</span> <span class="s">''</span>
<span class="n">bookend_right</span> <span class="o">=</span> <span class="s">''</span>
<span class="n">vals</span> <span class="o">=</span> <span class="p">[</span><span class="s">' '</span> <span class="o">*</span> <span class="p">(</span><span class="n">width</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">val</span><span class="p">))</span> <span class="o">+</span> <span class="n">val</span> <span class="k">for</span> <span class="n">val</span><span class="p">,</span> <span class="n">width</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">vals</span><span class="p">,</span> <span class="n">widths</span><span class="p">)]</span>
<span class="k">return</span> <span class="n">bookend_left</span> <span class="o">+</span> <span class="n">padded_delim</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">vals</span><span class="p">)</span> <span class="o">+</span> <span class="n">bookend_right</span>
</div></div>
<div class="viewcode-block" id="FixedWidthHeader"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthHeader.html#astropy.io.ascii.fixedwidth.FixedWidthHeader">[docs]</a><span class="k">class</span> <span class="nc">FixedWidthHeader</span><span class="p">(</span><span class="n">core</span><span class="o">.</span><span class="n">BaseHeader</span><span class="p">):</span>
<span class="sd">"""Fixed width table header reader.</span>
<span class="sd"> The key settable class attributes are:</span>
<span class="sd"> :param auto_format: format string for auto-generating column names</span>
<span class="sd"> :param start_line: None, int, or a function of ``lines`` that returns None or int</span>
<span class="sd"> :param comment: regular expression for comment lines</span>
<span class="sd"> :param splitter_class: Splitter class for splitting data lines into columns</span>
<span class="sd"> :param names: list of names corresponding to each data column</span>
<span class="sd"> :param include_names: list of names to include in output (default=None selects all names)</span>
<span class="sd"> :param exclude_names: list of names to exlude from output (applied after ``include_names``)</span>
<span class="sd"> :param position_line: row index of line that specifies position (default = 1)</span>
<span class="sd"> :param position_char: character used to write the position line (default = "-")</span>
<span class="sd"> :param col_starts: list of start positions for each column (0-based counting)</span>
<span class="sd"> :param col_ends: list of end positions (inclusive) for each column</span>
<span class="sd"> :param delimiter_pad: padding around delimiter when writing (default = None)</span>
<span class="sd"> :param bookend: put the delimiter at start and end of line when writing (default = False)</span>
<span class="sd"> """</span>
<span class="n">position_line</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># secondary header line position</span>
<div class="viewcode-block" id="FixedWidthHeader.get_line"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthHeader.html#astropy.io.ascii.fixedwidth.FixedWidthHeader.get_line">[docs]</a> <span class="k">def</span> <span class="nf">get_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lines</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">line</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">process_lines</span><span class="p">(</span><span class="n">lines</span><span class="p">)):</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="n">index</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">else</span><span class="p">:</span> <span class="c"># No header line matching</span>
<span class="k">raise</span> <span class="n">InconsistentTableError</span><span class="p">(</span><span class="s">'No header line found in table'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">line</span>
</div>
<div class="viewcode-block" id="FixedWidthHeader.get_cols"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthHeader.html#astropy.io.ascii.fixedwidth.FixedWidthHeader.get_cols">[docs]</a> <span class="k">def</span> <span class="nf">get_cols</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lines</span><span class="p">):</span>
<span class="sd">"""Initialize the header Column objects from the table ``lines``.</span>
<span class="sd"> Based on the previously set Header attributes find or create the column names.</span>
<span class="sd"> Sets ``self.cols`` with the list of Columns. This list only includes the actual</span>
<span class="sd"> requested columns after filtering by the include_names and exclude_names</span>
<span class="sd"> attributes. See ``self.names`` for the full list.</span>
<span class="sd"> :param lines: list of table lines</span>
<span class="sd"> :returns: None</span>
<span class="sd"> """</span>
<span class="c"># See "else" clause below for explanation of start_line and position_line</span>
<span class="n">start_line</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">_get_line_index</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">start_line</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">process_lines</span><span class="p">(</span><span class="n">lines</span><span class="p">))</span>
<span class="n">position_line</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">_get_line_index</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">position_line</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">process_lines</span><span class="p">(</span><span class="n">lines</span><span class="p">))</span>
<span class="c"># If start_line is none then there is no header line. Column positions are</span>
<span class="c"># determined from first data line and column names are either supplied by user</span>
<span class="c"># or auto-generated.</span>
<span class="k">if</span> <span class="n">start_line</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">position_line</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Cannot set position_line without also setting header_start"</span><span class="p">)</span>
<span class="n">data_lines</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">process_lines</span><span class="p">(</span><span class="n">lines</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">data_lines</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">InconsistentTableError</span><span class="p">(</span><span class="s">'No data lines found so cannot autogenerate column names'</span><span class="p">)</span>
<span class="n">vals</span><span class="p">,</span> <span class="n">starts</span><span class="p">,</span> <span class="n">ends</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_fixedwidth_params</span><span class="p">(</span><span class="n">data_lines</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">names</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">names</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">auto_format</span> <span class="o">%</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">vals</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)]</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># This bit of code handles two cases:</span>
<span class="c"># start_line = <index> and position_line = None</span>
<span class="c"># Single header line where that line is used to determine both the</span>
<span class="c"># column positions and names.</span>
<span class="c"># start_line = <index> and position_line = <index2></span>
<span class="c"># Two header lines where the first line defines the column names and</span>
<span class="c"># the second line defines the column positions</span>
<span class="k">if</span> <span class="n">position_line</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="c"># Define self.col_starts and self.col_ends so that the call to</span>
<span class="c"># get_fixedwidth_params below will use those to find the header</span>
<span class="c"># column names. Note that get_fixedwidth_params returns Python</span>
<span class="c"># slice col_ends but expects inclusive col_ends on input (for</span>
<span class="c"># more intuitive user interface).</span>
<span class="n">line</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_line</span><span class="p">(</span><span class="n">lines</span><span class="p">,</span> <span class="n">position_line</span><span class="p">)</span>
<span class="n">vals</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">col_starts</span><span class="p">,</span> <span class="n">col_ends</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_fixedwidth_params</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">col_ends</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span> <span class="o">-</span> <span class="mi">1</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">col_ends</span><span class="p">]</span>
<span class="c"># Get the header column names and column positions</span>
<span class="n">line</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_line</span><span class="p">(</span><span class="n">lines</span><span class="p">,</span> <span class="n">start_line</span><span class="p">)</span>
<span class="n">vals</span><span class="p">,</span> <span class="n">starts</span><span class="p">,</span> <span class="n">ends</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_fixedwidth_params</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="c"># Possibly override the column names with user-supplied values</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">names</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">names</span> <span class="o">=</span> <span class="n">vals</span>
<span class="c"># Filter self.names using include_names and exclude_names, then create</span>
<span class="c"># the actual Column objects.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_cols_from_names</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">n_data_cols</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cols</span><span class="p">)</span>
<span class="c"># Set column start and end positions. Also re-index the cols because</span>
<span class="c"># the FixedWidthSplitter does NOT return the ignored cols (as is the</span>
<span class="c"># case for typical delimiter-based splitters)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">col</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cols</span><span class="p">):</span>
<span class="n">col</span><span class="o">.</span><span class="n">start</span> <span class="o">=</span> <span class="n">starts</span><span class="p">[</span><span class="n">col</span><span class="o">.</span><span class="n">index</span><span class="p">]</span>
<span class="n">col</span><span class="o">.</span><span class="n">end</span> <span class="o">=</span> <span class="n">ends</span><span class="p">[</span><span class="n">col</span><span class="o">.</span><span class="n">index</span><span class="p">]</span>
<span class="n">col</span><span class="o">.</span><span class="n">index</span> <span class="o">=</span> <span class="n">i</span>
</div>
<div class="viewcode-block" id="FixedWidthHeader.get_fixedwidth_params"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthHeader.html#astropy.io.ascii.fixedwidth.FixedWidthHeader.get_fixedwidth_params">[docs]</a> <span class="k">def</span> <span class="nf">get_fixedwidth_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="sd">"""Split ``line`` on the delimiter and determine column values and</span>
<span class="sd"> column start and end positions. This might include null columns with</span>
<span class="sd"> zero length (e.g. for ``header row = "| col1 || col2 | col3 |"`` or</span>
<span class="sd"> ``header2_row = "----- ------- -----"``). The null columns are</span>
<span class="sd"> stripped out. Returns the values between delimiters and the</span>
<span class="sd"> corresponding start and end positions.</span>
<span class="sd"> :param line: input line</span>
<span class="sd"> :returns: (vals, starts, ends)</span>
<span class="sd"> """</span>
<span class="c"># If column positions are already specified then just use those, otherwise</span>
<span class="c"># figure out positions between delimiters.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">col_starts</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">col_ends</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">starts</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">col_starts</span><span class="p">)</span> <span class="c"># could be any iterable, e.g. np.array</span>
<span class="n">ends</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span> <span class="o">+</span> <span class="mi">1</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">col_ends</span><span class="p">]</span> <span class="c"># user supplies inclusive endpoint</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">starts</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">ends</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'Fixed width col_starts and col_ends must have the same length'</span><span class="p">)</span>
<span class="n">vals</span> <span class="o">=</span> <span class="p">[</span><span class="n">line</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">end</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">starts</span><span class="p">,</span> <span class="n">ends</span><span class="p">)]</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># There might be a cleaner way to do this but it works...</span>
<span class="n">vals</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">delimiter</span><span class="p">)</span>
<span class="n">starts</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">ends</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">vals</span><span class="p">:</span>
<span class="k">if</span> <span class="n">val</span><span class="p">:</span>
<span class="n">ends</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">starts</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">val</span><span class="p">))</span>
<span class="n">starts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ends</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">starts</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">starts</span> <span class="o">=</span> <span class="n">starts</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">vals</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">vals</span> <span class="k">if</span> <span class="n">x</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">vals</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">starts</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">vals</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">ends</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">InconsistentTableError</span><span class="p">(</span><span class="s">'Error parsing fixed width header'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">vals</span><span class="p">,</span> <span class="n">starts</span><span class="p">,</span> <span class="n">ends</span>
</div>
<div class="viewcode-block" id="FixedWidthHeader.write"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthHeader.html#astropy.io.ascii.fixedwidth.FixedWidthHeader.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lines</span><span class="p">):</span>
<span class="c"># Header line not written until data are formatted. Until then it is</span>
<span class="c"># not known how wide each column will be for fixed width.</span>
<span class="k">pass</span>
</div></div>
<div class="viewcode-block" id="FixedWidthData"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthData.html#astropy.io.ascii.fixedwidth.FixedWidthData">[docs]</a><span class="k">class</span> <span class="nc">FixedWidthData</span><span class="p">(</span><span class="n">core</span><span class="o">.</span><span class="n">BaseData</span><span class="p">):</span>
<span class="sd">"""Base table data reader.</span>
<span class="sd"> :param start_line: None, int, or a function of ``lines`` that returns None or int</span>
<span class="sd"> :param end_line: None, int, or a function of ``lines`` that returns None or int</span>
<span class="sd"> :param comment: Regular expression for comment lines</span>
<span class="sd"> :param splitter_class: Splitter class for splitting data lines into columns</span>
<span class="sd"> """</span>
<span class="n">splitter_class</span> <span class="o">=</span> <span class="n">FixedWidthSplitter</span>
<div class="viewcode-block" id="FixedWidthData.write"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthData.html#astropy.io.ascii.fixedwidth.FixedWidthData.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lines</span><span class="p">):</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_set_col_formats</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cols</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">formats</span><span class="p">):</span>
<span class="n">vals_list</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c"># Col iterator does the formatting defined above so each val is a string</span>
<span class="c"># and vals is a tuple of strings for all columns of each row</span>
<span class="n">col_str_iters</span> <span class="o">=</span> <span class="p">[</span><span class="n">col</span><span class="o">.</span><span class="n">iter_str_vals</span><span class="p">()</span> <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cols</span><span class="p">]</span>
<span class="k">for</span> <span class="n">vals</span> <span class="ow">in</span> <span class="n">izip</span><span class="p">(</span><span class="o">*</span><span class="n">col_str_iters</span><span class="p">):</span>
<span class="n">vals_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">vals</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">col</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cols</span><span class="p">):</span>
<span class="n">col</span><span class="o">.</span><span class="n">width</span> <span class="o">=</span> <span class="nb">max</span><span class="p">([</span><span class="nb">len</span><span class="p">(</span><span class="n">vals</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="k">for</span> <span class="n">vals</span> <span class="ow">in</span> <span class="n">vals_list</span><span class="p">])</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">start_line</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">col</span><span class="o">.</span><span class="n">width</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">col</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">col</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
<span class="n">widths</span> <span class="o">=</span> <span class="p">[</span><span class="n">col</span><span class="o">.</span><span class="n">width</span> <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cols</span><span class="p">]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">start_line</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">col</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cols</span><span class="p">],</span> <span class="n">widths</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">position_line</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">char</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">position_char</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">char</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'Position_char="</span><span class="si">%s</span><span class="s">" must be a single character'</span> <span class="o">%</span> <span class="n">char</span><span class="p">)</span>
<span class="n">vals</span> <span class="o">=</span> <span class="p">[</span><span class="n">char</span> <span class="o">*</span> <span class="n">col</span><span class="o">.</span><span class="n">width</span> <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cols</span><span class="p">]</span>
<span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">vals</span><span class="p">,</span> <span class="n">widths</span><span class="p">))</span>
<span class="k">for</span> <span class="n">vals</span> <span class="ow">in</span> <span class="n">vals_list</span><span class="p">:</span>
<span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">vals</span><span class="p">,</span> <span class="n">widths</span><span class="p">))</span>
<span class="k">return</span> <span class="n">lines</span>
</div></div>
<div class="viewcode-block" id="FixedWidth"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidth.html#astropy.io.ascii.fixedwidth.FixedWidth">[docs]</a><span class="k">class</span> <span class="nc">FixedWidth</span><span class="p">(</span><span class="n">core</span><span class="o">.</span><span class="n">BaseReader</span><span class="p">):</span>
<span class="sd">"""Read or write a fixed width table with a single header line that defines column</span>
<span class="sd"> names and positions. Examples::</span>
<span class="sd"> # Bar delimiter in header and data</span>
<span class="sd"> </span>
<span class="sd"> | Col1 | Col2 | Col3 |</span>
<span class="sd"> | 1.2 | hello there | 3 |</span>
<span class="sd"> | 2.4 | many words | 7 |</span>
<span class="sd"> </span>
<span class="sd"> # Bar delimiter in header only</span>
<span class="sd"> </span>
<span class="sd"> Col1 | Col2 | Col3 </span>
<span class="sd"> 1.2 hello there 3 </span>
<span class="sd"> 2.4 many words 7 </span>
<span class="sd"> </span>
<span class="sd"> # No delimiter with column positions specified as input</span>
<span class="sd"> </span>
<span class="sd"> Col1 Col2Col3 </span>
<span class="sd"> 1.2hello there 3 </span>
<span class="sd"> 2.4many words 7 </span>
<span class="sd"> See the :ref:`fixed_width_gallery` for specific usage examples.</span>
<span class="sd"> :param col_starts: list of start positions for each column (0-based counting)</span>
<span class="sd"> :param col_ends: list of end positions (inclusive) for each column</span>
<span class="sd"> :param delimiter_pad: padding around delimiter when writing (default = None)</span>
<span class="sd"> :param bookend: put the delimiter at start and end of line when writing (default = False)</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">col_starts</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">col_ends</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">delimiter_pad</span><span class="o">=</span><span class="s">' '</span><span class="p">,</span> <span class="n">bookend</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="n">core</span><span class="o">.</span><span class="n">BaseReader</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="n">FixedWidthHeader</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">FixedWidthData</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">delimiter</span> <span class="o">=</span> <span class="s">'|'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">delimiter</span> <span class="o">=</span> <span class="s">'|'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">delimiter_pad</span> <span class="o">=</span> <span class="n">delimiter_pad</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">bookend</span> <span class="o">=</span> <span class="n">bookend</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">start_line</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">start_line</span> <span class="o">=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">comment</span> <span class="o">=</span> <span class="s">r'\s*#'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">write_comment</span> <span class="o">=</span> <span class="s">'# '</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">comment</span> <span class="o">=</span> <span class="s">r'\s*#'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">write_comment</span> <span class="o">=</span> <span class="s">'# '</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">col_starts</span> <span class="o">=</span> <span class="n">col_starts</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">col_ends</span> <span class="o">=</span> <span class="n">col_ends</span>
</div>
<div class="viewcode-block" id="FixedWidthNoHeader"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthNoHeader.html#astropy.io.ascii.fixedwidth.FixedWidthNoHeader">[docs]</a><span class="k">class</span> <span class="nc">FixedWidthNoHeader</span><span class="p">(</span><span class="n">FixedWidth</span><span class="p">):</span>
<span class="sd">"""Read or write a fixed width table which has no header line. Column</span>
<span class="sd"> names are either input (``names`` keyword) or auto-generated. Column</span>
<span class="sd"> positions are determined either by input (``col_starts`` and ``col_stops``</span>
<span class="sd"> keywords) or by splitting the first data line. In the latter case a</span>
<span class="sd"> ``delimiter`` is required to split the data line.</span>
<span class="sd"> Examples::</span>
<span class="sd"> # Bar delimiter in header and data</span>
<span class="sd"> </span>
<span class="sd"> | 1.2 | hello there | 3 |</span>
<span class="sd"> | 2.4 | many words | 7 |</span>
<span class="sd"> </span>
<span class="sd"> # Compact table having no delimiter and column positions specified as input</span>
<span class="sd"> 1.2hello there3 </span>
<span class="sd"> 2.4many words 7 </span>
<span class="sd"> This class is just a convenience wrapper around the ``FixedWidth`` reader</span>
<span class="sd"> but with ``header.start_line = None`` and ``data.start_line = 0``.</span>
<span class="sd"> See the :ref:`fixed_width_gallery` for specific usage examples.</span>
<span class="sd"> :param col_starts: list of start positions for each column (0-based counting)</span>
<span class="sd"> :param col_ends: list of end positions (inclusive) for each column</span>
<span class="sd"> :param delimiter_pad: padding around delimiter when writing (default = None)</span>
<span class="sd"> :param bookend: put the delimiter at start and end of line when writing (default = False)</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">col_starts</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">col_ends</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">delimiter_pad</span><span class="o">=</span><span class="s">' '</span><span class="p">,</span> <span class="n">bookend</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="n">FixedWidth</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">col_starts</span><span class="p">,</span> <span class="n">col_ends</span><span class="p">,</span>
<span class="n">delimiter_pad</span><span class="o">=</span><span class="n">delimiter_pad</span><span class="p">,</span> <span class="n">bookend</span><span class="o">=</span><span class="n">bookend</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">start_line</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">start_line</span> <span class="o">=</span> <span class="mi">0</span>
</div>
<div class="viewcode-block" id="FixedWidthTwoLine"><a class="viewcode-back" href="../../../../_generated/astropy.io.ascii.fixedwidth.FixedWidthTwoLine.html#astropy.io.ascii.fixedwidth.FixedWidthTwoLine">[docs]</a><span class="k">class</span> <span class="nc">FixedWidthTwoLine</span><span class="p">(</span><span class="n">FixedWidth</span><span class="p">):</span>
<span class="sd">"""Read or write a fixed width table which has two header lines. The first</span>
<span class="sd"> header line defines the column names and the second implicitly defines the</span>
<span class="sd"> column positions. Examples::</span>
<span class="sd"> # Typical case with column extent defined by ---- under column names.</span>
<span class="sd"> col1 col2 <== header_start = 0</span>
<span class="sd"> ----- ------------ <== position_line = 1, position_char = "-"</span>
<span class="sd"> 1 bee flies <== data_start = 2</span>
<span class="sd"> 2 fish swims</span>
<span class="sd"> # Pretty-printed table </span>
<span class="sd"> +------+------------+</span>
<span class="sd"> | Col1 | Col2 |</span>
<span class="sd"> +------+------------+</span>
<span class="sd"> | 1.2 | "hello" |</span>
<span class="sd"> | 2.4 | there world|</span>
<span class="sd"> +------+------------+</span>
<span class="sd"> See the :ref:`fixed_width_gallery` for specific usage examples.</span>
<span class="sd"> :param position_line: row index of line that specifies position (default = 1)</span>
<span class="sd"> :param position_char: character used to write the position line (default = "-")</span>
<span class="sd"> :param delimiter_pad: padding around delimiter when writing (default = None)</span>
<span class="sd"> :param bookend: put the delimiter at start and end of line when writing (default = False)</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">position_line</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">position_char</span><span class="o">=</span><span class="s">'-'</span><span class="p">,</span> <span class="n">delimiter_pad</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">bookend</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="n">FixedWidth</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">delimiter_pad</span><span class="o">=</span><span class="n">delimiter_pad</span><span class="p">,</span> <span class="n">bookend</span><span class="o">=</span><span class="n">bookend</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">position_line</span> <span class="o">=</span> <span class="n">position_line</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">position_char</span> <span class="o">=</span> <span class="n">position_char</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">start_line</span> <span class="o">=</span> <span class="n">position_line</span> <span class="o">+</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">delimiter</span> <span class="o">=</span> <span class="s">' '</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">splitter</span><span class="o">.</span><span class="n">delimiter</span> <span class="o">=</span> <span class="s">' '</span>
</div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Page Contents</h3>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="#">Back to Top</a></p>
<p>
© Copyright 2011-2013, The Astropy Developers.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
Last built 22 Oct 2013. <br/>
</p>
</footer>
</body>
</html>
