Add Python documentation snapshot
Project: http://git-wip-us.apache.org/repos/asf/arrow-site/repo Commit: http://git-wip-us.apache.org/repos/asf/arrow-site/commit/679f060e Tree: http://git-wip-us.apache.org/repos/asf/arrow-site/tree/679f060e Diff: http://git-wip-us.apache.org/repos/asf/arrow-site/diff/679f060e Branch: refs/heads/asf-site Commit: 679f060e54df7ccb995eec60ca9c6ecb44c36916 Parents: 97fc185 Author: Wes McKinney <[email protected]> Authored: Sun Apr 23 18:21:20 2017 -0400 Committer: Wes McKinney <[email protected]> Committed: Sun Apr 23 18:21:20 2017 -0400 ---------------------------------------------------------------------- docs/python/.buildinfo | 4 + docs/python/_modules/index.html | 233 + docs/python/_modules/pyarrow.html | 338 + docs/python/_modules/pyarrow/ipc.html | 314 + docs/python/_modules/pyarrow/parquet.html | 891 ++ docs/python/_sources/api.rst.txt | 214 + docs/python/_sources/filesystems.rst.txt | 58 + .../_sources/generated/pyarrow.Array.rst.txt | 34 + .../generated/pyarrow.ArrayValue.rst.txt | 16 + .../generated/pyarrow.BinaryArray.rst.txt | 34 + .../generated/pyarrow.BinaryValue.rst.txt | 22 + .../generated/pyarrow.BooleanArray.rst.txt | 34 + .../generated/pyarrow.BooleanValue.rst.txt | 22 + .../_sources/generated/pyarrow.Buffer.rst.txt | 29 + .../generated/pyarrow.BufferReader.rst.txt | 30 + .../generated/pyarrow.ChunkedArray.rst.txt | 32 + .../_sources/generated/pyarrow.Column.rst.txt | 36 + .../_sources/generated/pyarrow.DataType.rst.txt | 22 + .../generated/pyarrow.Date32Array.rst.txt | 34 + .../generated/pyarrow.Date32Value.rst.txt | 22 + .../generated/pyarrow.Date64Array.rst.txt | 34 + .../generated/pyarrow.Date64Value.rst.txt | 22 + .../generated/pyarrow.DecimalArray.rst.txt | 34 + .../generated/pyarrow.DecimalType.rst.txt | 28 + .../generated/pyarrow.DecimalValue.rst.txt | 22 + .../generated/pyarrow.DictionaryArray.rst.txt | 37 + .../generated/pyarrow.DictionaryType.rst.txt | 22 + .../generated/pyarrow.DoubleValue.rst.txt | 22 + .../_sources/generated/pyarrow.Field.rst.txt | 30 + .../generated/pyarrow.FileReader.rst.txt | 31 + .../generated/pyarrow.FileWriter.rst.txt | 24 + .../pyarrow.FixedSizeBinaryArray.rst.txt | 34 + .../pyarrow.FixedSizeBinaryType.rst.txt | 28 + .../pyarrow.FixedSizeBinaryValue.rst.txt | 22 + .../generated/pyarrow.FloatValue.rst.txt | 22 + .../pyarrow.FloatingPointArray.rst.txt | 34 + .../pyarrow.InMemoryOutputStream.rst.txt | 31 + .../generated/pyarrow.Int16Array.rst.txt | 34 + .../generated/pyarrow.Int16Value.rst.txt | 22 + .../generated/pyarrow.Int32Array.rst.txt | 34 + .../generated/pyarrow.Int32Value.rst.txt | 22 + .../generated/pyarrow.Int64Array.rst.txt | 34 + .../generated/pyarrow.Int64Value.rst.txt | 22 + .../generated/pyarrow.Int8Array.rst.txt | 34 + .../generated/pyarrow.Int8Value.rst.txt | 22 + .../generated/pyarrow.IntegerArray.rst.txt | 34 + .../generated/pyarrow.ListArray.rst.txt | 34 + .../generated/pyarrow.ListValue.rst.txt | 28 + .../generated/pyarrow.MemoryMappedFile.rst.txt | 32 + .../generated/pyarrow.MemoryPool.rst.txt | 22 + .../_sources/generated/pyarrow.NA.rst.txt | 6 + .../_sources/generated/pyarrow.NAType.rst.txt | 22 + .../generated/pyarrow.NativeFile.rst.txt | 30 + .../generated/pyarrow.NullArray.rst.txt | 34 + .../generated/pyarrow.NumericArray.rst.txt | 34 + .../generated/pyarrow.PythonFile.rst.txt | 30 + .../generated/pyarrow.RecordBatch.rst.txt | 35 + .../_sources/generated/pyarrow.Scalar.rst.txt | 16 + .../_sources/generated/pyarrow.Schema.rst.txt | 30 + .../generated/pyarrow.StreamReader.rst.txt | 30 + .../generated/pyarrow.StreamWriter.rst.txt | 24 + .../generated/pyarrow.StringArray.rst.txt | 34 + .../generated/pyarrow.StringValue.rst.txt | 22 + .../_sources/generated/pyarrow.Table.rst.txt | 41 + .../_sources/generated/pyarrow.Tensor.rst.txt | 36 + .../generated/pyarrow.Time32Array.rst.txt | 34 + .../generated/pyarrow.Time32Type.rst.txt | 28 + .../generated/pyarrow.Time64Array.rst.txt | 34 + .../generated/pyarrow.Time64Type.rst.txt | 28 + .../generated/pyarrow.TimestampArray.rst.txt | 34 + .../generated/pyarrow.TimestampType.rst.txt | 29 + .../generated/pyarrow.TimestampValue.rst.txt | 22 + .../generated/pyarrow.UInt16Array.rst.txt | 34 + .../generated/pyarrow.UInt16Value.rst.txt | 22 + .../generated/pyarrow.UInt32Array.rst.txt | 34 + .../generated/pyarrow.UInt32Value.rst.txt | 22 + .../generated/pyarrow.UInt64Array.rst.txt | 34 + .../generated/pyarrow.UInt64Value.rst.txt | 22 + .../generated/pyarrow.UInt8Array.rst.txt | 34 + .../generated/pyarrow.UInt8Value.rst.txt | 22 + .../_sources/generated/pyarrow.array.rst.txt | 6 + .../_sources/generated/pyarrow.binary.rst.txt | 6 + .../_sources/generated/pyarrow.bool_.rst.txt | 6 + .../generated/pyarrow.create_memory_map.rst.txt | 6 + .../_sources/generated/pyarrow.date32.rst.txt | 6 + .../_sources/generated/pyarrow.date64.rst.txt | 6 + .../_sources/generated/pyarrow.decimal.rst.txt | 6 + .../pyarrow.default_memory_pool.rst.txt | 6 + .../generated/pyarrow.dictionary.rst.txt | 6 + .../_sources/generated/pyarrow.field.rst.txt | 6 + .../_sources/generated/pyarrow.float16.rst.txt | 6 + .../_sources/generated/pyarrow.float32.rst.txt | 6 + .../_sources/generated/pyarrow.float64.rst.txt | 6 + .../generated/pyarrow.from_numpy_dtype.rst.txt | 6 + .../pyarrow.get_record_batch_size.rst.txt | 6 + .../generated/pyarrow.get_tensor_size.rst.txt | 6 + .../_sources/generated/pyarrow.int16.rst.txt | 6 + .../_sources/generated/pyarrow.int32.rst.txt | 6 + .../_sources/generated/pyarrow.int64.rst.txt | 6 + .../_sources/generated/pyarrow.int8.rst.txt | 6 + .../pyarrow.jemalloc_memory_pool.rst.txt | 6 + .../_sources/generated/pyarrow.list_.rst.txt | 6 + .../generated/pyarrow.memory_map.rst.txt | 6 + .../_sources/generated/pyarrow.null.rst.txt | 6 + .../pyarrow.parquet.ParquetDataset.rst.txt | 24 + .../pyarrow.parquet.ParquetFile.rst.txt | 32 + .../pyarrow.parquet.read_table.rst.txt | 6 + .../pyarrow.parquet.write_metadata.rst.txt | 6 + .../pyarrow.parquet.write_table.rst.txt | 6 + .../generated/pyarrow.read_tensor.rst.txt | 6 + .../_sources/generated/pyarrow.schema.rst.txt | 6 + .../generated/pyarrow.set_memory_pool.rst.txt | 6 + .../_sources/generated/pyarrow.string.rst.txt | 6 + .../_sources/generated/pyarrow.struct.rst.txt | 6 + .../_sources/generated/pyarrow.time32.rst.txt | 6 + .../_sources/generated/pyarrow.time64.rst.txt | 6 + .../generated/pyarrow.timestamp.rst.txt | 6 + .../pyarrow.total_allocated_bytes.rst.txt | 6 + .../_sources/generated/pyarrow.uint16.rst.txt | 6 + .../_sources/generated/pyarrow.uint32.rst.txt | 6 + .../_sources/generated/pyarrow.uint64.rst.txt | 6 + .../_sources/generated/pyarrow.uint8.rst.txt | 6 + .../generated/pyarrow.write_tensor.rst.txt | 6 + docs/python/_sources/getting_involved.rst.txt | 37 + docs/python/_sources/index.rst.txt | 48 + docs/python/_sources/install.rst.txt | 151 + docs/python/_sources/jemalloc.rst.txt | 48 + docs/python/_sources/pandas.rst.txt | 119 + docs/python/_sources/parquet.rst.txt | 91 + docs/python/_static/ajax-loader.gif | Bin 0 -> 673 bytes docs/python/_static/basic.css | 632 ++ docs/python/_static/comment-bright.png | Bin 0 -> 756 bytes docs/python/_static/comment-close.png | Bin 0 -> 829 bytes docs/python/_static/comment.png | Bin 0 -> 641 bytes docs/python/_static/css/badge_only.css | 2 + docs/python/_static/css/theme.css | 5 + docs/python/_static/doctools.js | 287 + docs/python/_static/down-pressed.png | Bin 0 -> 222 bytes docs/python/_static/down.png | Bin 0 -> 202 bytes docs/python/_static/file.png | Bin 0 -> 286 bytes docs/python/_static/fonts/Inconsolata-Bold.ttf | Bin 0 -> 109948 bytes .../_static/fonts/Inconsolata-Regular.ttf | Bin 0 -> 96964 bytes docs/python/_static/fonts/Lato-Bold.ttf | Bin 0 -> 656544 bytes docs/python/_static/fonts/Lato-Regular.ttf | Bin 0 -> 656568 bytes docs/python/_static/fonts/RobotoSlab-Bold.ttf | Bin 0 -> 170616 bytes .../python/_static/fonts/RobotoSlab-Regular.ttf | Bin 0 -> 169064 bytes .../_static/fonts/fontawesome-webfont.eot | Bin 0 -> 76518 bytes .../_static/fonts/fontawesome-webfont.svg | 685 ++ .../_static/fonts/fontawesome-webfont.ttf | Bin 0 -> 152796 bytes .../_static/fonts/fontawesome-webfont.woff | Bin 0 -> 90412 bytes docs/python/_static/jquery-3.1.0.js | 10074 +++++++++++++++++ docs/python/_static/jquery.js | 4 + docs/python/_static/js/modernizr.min.js | 4 + docs/python/_static/js/theme.js | 169 + docs/python/_static/minus.png | Bin 0 -> 90 bytes docs/python/_static/plus.png | Bin 0 -> 90 bytes docs/python/_static/pygments.css | 65 + docs/python/_static/searchtools.js | 758 ++ docs/python/_static/stub | 18 + docs/python/_static/underscore-1.3.1.js | 999 ++ docs/python/_static/underscore.js | 31 + docs/python/_static/up-pressed.png | Bin 0 -> 214 bytes docs/python/_static/up.png | Bin 0 -> 203 bytes docs/python/_static/websupport.js | 808 ++ docs/python/api.html | 847 ++ docs/python/filesystems.html | 274 + docs/python/generated/pyarrow.Array.html | 337 + docs/python/generated/pyarrow.ArrayValue.html | 292 + docs/python/generated/pyarrow.BinaryArray.html | 337 + docs/python/generated/pyarrow.BinaryValue.html | 304 + docs/python/generated/pyarrow.BooleanArray.html | 337 + docs/python/generated/pyarrow.BooleanValue.html | 304 + docs/python/generated/pyarrow.Buffer.html | 304 + docs/python/generated/pyarrow.BufferReader.html | 322 + docs/python/generated/pyarrow.ChunkedArray.html | 315 + docs/python/generated/pyarrow.Column.html | 327 + docs/python/generated/pyarrow.DataType.html | 290 + docs/python/generated/pyarrow.Date32Array.html | 337 + docs/python/generated/pyarrow.Date32Value.html | 304 + docs/python/generated/pyarrow.Date64Array.html | 337 + docs/python/generated/pyarrow.Date64Value.html | 304 + docs/python/generated/pyarrow.DecimalArray.html | 337 + docs/python/generated/pyarrow.DecimalType.html | 302 + docs/python/generated/pyarrow.DecimalValue.html | 304 + .../generated/pyarrow.DictionaryArray.html | 346 + .../generated/pyarrow.DictionaryType.html | 290 + docs/python/generated/pyarrow.DoubleValue.html | 304 + docs/python/generated/pyarrow.Field.html | 308 + docs/python/generated/pyarrow.FileReader.html | 319 + docs/python/generated/pyarrow.FileWriter.html | 303 + .../generated/pyarrow.FixedSizeBinaryArray.html | 337 + .../generated/pyarrow.FixedSizeBinaryType.html | 302 + .../generated/pyarrow.FixedSizeBinaryValue.html | 304 + docs/python/generated/pyarrow.FloatValue.html | 304 + .../generated/pyarrow.FloatingPointArray.html | 337 + .../generated/pyarrow.InMemoryOutputStream.html | 316 + docs/python/generated/pyarrow.Int16Array.html | 337 + docs/python/generated/pyarrow.Int16Value.html | 304 + docs/python/generated/pyarrow.Int32Array.html | 337 + docs/python/generated/pyarrow.Int32Value.html | 304 + docs/python/generated/pyarrow.Int64Array.html | 337 + docs/python/generated/pyarrow.Int64Value.html | 304 + docs/python/generated/pyarrow.Int8Array.html | 337 + docs/python/generated/pyarrow.Int8Value.html | 304 + docs/python/generated/pyarrow.IntegerArray.html | 337 + docs/python/generated/pyarrow.ListArray.html | 337 + docs/python/generated/pyarrow.ListValue.html | 316 + .../generated/pyarrow.MemoryMappedFile.html | 320 + docs/python/generated/pyarrow.MemoryPool.html | 286 + docs/python/generated/pyarrow.NA.html | 286 + docs/python/generated/pyarrow.NAType.html | 304 + docs/python/generated/pyarrow.NativeFile.html | 313 + docs/python/generated/pyarrow.NullArray.html | 337 + docs/python/generated/pyarrow.NumericArray.html | 337 + docs/python/generated/pyarrow.PythonFile.html | 313 + docs/python/generated/pyarrow.RecordBatch.html | 325 + docs/python/generated/pyarrow.Scalar.html | 292 + docs/python/generated/pyarrow.Schema.html | 308 + docs/python/generated/pyarrow.StreamReader.html | 311 + docs/python/generated/pyarrow.StreamWriter.html | 303 + docs/python/generated/pyarrow.StringArray.html | 337 + docs/python/generated/pyarrow.StringValue.html | 304 + docs/python/generated/pyarrow.Table.html | 343 + docs/python/generated/pyarrow.Tensor.html | 321 + docs/python/generated/pyarrow.Time32Array.html | 337 + docs/python/generated/pyarrow.Time32Type.html | 302 + docs/python/generated/pyarrow.Time64Array.html | 337 + docs/python/generated/pyarrow.Time64Type.html | 302 + .../generated/pyarrow.TimestampArray.html | 337 + .../python/generated/pyarrow.TimestampType.html | 305 + .../generated/pyarrow.TimestampValue.html | 304 + docs/python/generated/pyarrow.UInt16Array.html | 337 + docs/python/generated/pyarrow.UInt16Value.html | 304 + docs/python/generated/pyarrow.UInt32Array.html | 337 + docs/python/generated/pyarrow.UInt32Value.html | 304 + docs/python/generated/pyarrow.UInt64Array.html | 337 + docs/python/generated/pyarrow.UInt64Value.html | 304 + docs/python/generated/pyarrow.UInt8Array.html | 337 + docs/python/generated/pyarrow.UInt8Value.html | 304 + docs/python/generated/pyarrow.array.html | 307 + docs/python/generated/pyarrow.binary.html | 301 + docs/python/generated/pyarrow.bool_.html | 290 + .../generated/pyarrow.create_memory_map.html | 288 + docs/python/generated/pyarrow.date32.html | 290 + docs/python/generated/pyarrow.date64.html | 290 + docs/python/generated/pyarrow.decimal.html | 290 + .../generated/pyarrow.default_memory_pool.html | 268 + docs/python/generated/pyarrow.dictionary.html | 291 + docs/python/generated/pyarrow.field.html | 290 + docs/python/generated/pyarrow.float16.html | 290 + docs/python/generated/pyarrow.float32.html | 290 + docs/python/generated/pyarrow.float64.html | 290 + .../generated/pyarrow.from_numpy_dtype.html | 291 + .../pyarrow.get_record_batch_size.html | 269 + .../generated/pyarrow.get_tensor_size.html | 268 + docs/python/generated/pyarrow.int16.html | 290 + docs/python/generated/pyarrow.int32.html | 290 + docs/python/generated/pyarrow.int64.html | 290 + docs/python/generated/pyarrow.int8.html | 290 + .../generated/pyarrow.jemalloc_memory_pool.html | 270 + docs/python/generated/pyarrow.list_.html | 290 + docs/python/generated/pyarrow.memory_map.html | 287 + docs/python/generated/pyarrow.null.html | 290 + .../pyarrow.parquet.ParquetDataset.html | 311 + .../generated/pyarrow.parquet.ParquetFile.html | 323 + .../generated/pyarrow.parquet.read_table.html | 289 + .../pyarrow.parquet.write_metadata.html | 282 + .../generated/pyarrow.parquet.write_table.html | 287 + docs/python/generated/pyarrow.read_tensor.html | 280 + docs/python/generated/pyarrow.schema.html | 290 + .../generated/pyarrow.set_memory_pool.html | 268 + docs/python/generated/pyarrow.string.html | 291 + docs/python/generated/pyarrow.struct.html | 290 + docs/python/generated/pyarrow.time32.html | 290 + docs/python/generated/pyarrow.time64.html | 290 + docs/python/generated/pyarrow.timestamp.html | 290 + .../pyarrow.total_allocated_bytes.html | 268 + docs/python/generated/pyarrow.uint16.html | 290 + docs/python/generated/pyarrow.uint32.html | 290 + docs/python/generated/pyarrow.uint64.html | 290 + docs/python/generated/pyarrow.uint8.html | 290 + docs/python/generated/pyarrow.write_tensor.html | 283 + docs/python/genindex.html | 772 ++ docs/python/getting_involved.html | 258 + docs/python/index.html | 294 + docs/python/install.html | 370 + docs/python/jemalloc.html | 264 + docs/python/objects.inv | Bin 0 -> 2960 bytes docs/python/pandas.html | 379 + docs/python/parquet.html | 305 + docs/python/search.html | 243 + docs/python/searchindex.js | 1 + 292 files changed, 59009 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/.buildinfo ---------------------------------------------------------------------- diff --git a/docs/python/.buildinfo b/docs/python/.buildinfo new file mode 100644 index 0000000..cfff128 --- /dev/null +++ b/docs/python/.buildinfo @@ -0,0 +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: 8a14f2870997e906f4c89eca99e5d190 +tags: 645f666f9bcd5a90fca523b33c5a78b7 http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/_modules/index.html ---------------------------------------------------------------------- diff --git a/docs/python/_modules/index.html b/docs/python/_modules/index.html new file mode 100644 index 0000000..e1d0045 --- /dev/null +++ b/docs/python/_modules/index.html @@ -0,0 +1,233 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Overview: module code — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="pyarrow documentation" href="../index.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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" class="icon icon-home"> pyarrow + + + + </a> + + + + + + + +<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="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"> + + + + + + + <p class="caption"><span class="caption-text">Getting Started</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">pyarrow</a> + + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../index.html">Docs</a> »</li> + + <li>Overview: module code</li> + + + <li class="wy-breadcrumbs-aside"> + + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <h1>All modules for which code is available</h1> +<ul><li><a href="pyarrow.html">pyarrow</a></li> +<ul><li><a href="pyarrow/_array.html">pyarrow._array</a></li> +<li><a href="pyarrow/_io.html">pyarrow._io</a></li> +<li><a href="pyarrow/_memory.html">pyarrow._memory</a></li> +<li><a href="pyarrow/_table.html">pyarrow._table</a></li> +<li><a href="pyarrow/ipc.html">pyarrow.ipc</a></li> +<li><a href="pyarrow/parquet.html">pyarrow.parquet</a></li> +</ul></ul> + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/_modules/pyarrow.html ---------------------------------------------------------------------- diff --git a/docs/python/_modules/pyarrow.html b/docs/python/_modules/pyarrow.html new file mode 100644 index 0000000..b5ef93c --- /dev/null +++ b/docs/python/_modules/pyarrow.html @@ -0,0 +1,338 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>pyarrow — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="pyarrow documentation" href="../index.html"/> + <link rel="up" title="Module code" href="index.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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" class="icon icon-home"> pyarrow + + + + </a> + + + + + + + +<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="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"> + + + + + + + <p class="caption"><span class="caption-text">Getting Started</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">pyarrow</a> + + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../index.html">Docs</a> »</li> + + <li><a href="index.html">Module code</a> »</li> + + <li>pyarrow</li> + + + <li class="wy-breadcrumbs-aside"> + + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <h1>Source code for pyarrow</h1><div class="highlight"><pre> +<span></span><span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> +<span class="c1"># or more contributor license agreements. See the NOTICE file</span> +<span class="c1"># distributed with this work for additional information</span> +<span class="c1"># regarding copyright ownership. The ASF licenses this file</span> +<span class="c1"># to you under the Apache License, Version 2.0 (the</span> +<span class="c1"># "License"); you may not use this file except in compliance</span> +<span class="c1"># with the License. You may obtain a copy of the License at</span> +<span class="c1">#</span> +<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> +<span class="c1">#</span> +<span class="c1"># Unless required by applicable law or agreed to in writing,</span> +<span class="c1"># software distributed under the License is distributed on an</span> +<span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> +<span class="c1"># KIND, either express or implied. See the License for the</span> +<span class="c1"># specific language governing permissions and limitations</span> +<span class="c1"># under the License.</span> + +<span class="c1"># flake8: noqa</span> + +<span class="kn">from</span> <span class="nn">pkg_resources</span> <span class="k">import</span> <span class="n">get_distribution</span><span class="p">,</span> <span class="n">DistributionNotFound</span> +<span class="k">try</span><span class="p">:</span> + <span class="n">__version__</span> <span class="o">=</span> <span class="n">get_distribution</span><span class="p">(</span><span class="n">__name__</span><span class="p">)</span><span class="o">.</span><span class="n">version</span> +<span class="k">except</span> <span class="n">DistributionNotFound</span><span class="p">:</span> + <span class="c1"># package is not installed</span> + <span class="k">pass</span> + + +<span class="kn">import</span> <span class="nn">pyarrow._config</span> +<span class="kn">from</span> <span class="nn">pyarrow._config</span> <span class="k">import</span> <span class="n">cpu_count</span><span class="p">,</span> <span class="n">set_cpu_count</span> + +<span class="kn">from</span> <span class="nn">pyarrow._array</span> <span class="k">import</span> <span class="p">(</span><span class="n">null</span><span class="p">,</span> <span class="n">bool_</span><span class="p">,</span> + <span class="n">int8</span><span class="p">,</span> <span class="n">int16</span><span class="p">,</span> <span class="n">int32</span><span class="p">,</span> <span class="n">int64</span><span class="p">,</span> + <span class="n">uint8</span><span class="p">,</span> <span class="n">uint16</span><span class="p">,</span> <span class="n">uint32</span><span class="p">,</span> <span class="n">uint64</span><span class="p">,</span> + <span class="n">time32</span><span class="p">,</span> <span class="n">time64</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">date32</span><span class="p">,</span> <span class="n">date64</span><span class="p">,</span> + <span class="n">float16</span><span class="p">,</span> <span class="n">float32</span><span class="p">,</span> <span class="n">float64</span><span class="p">,</span> + <span class="n">binary</span><span class="p">,</span> <span class="n">string</span><span class="p">,</span> <span class="n">decimal</span><span class="p">,</span> + <span class="n">list_</span><span class="p">,</span> <span class="n">struct</span><span class="p">,</span> <span class="n">dictionary</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> + <span class="n">DataType</span><span class="p">,</span> + <span class="n">DecimalType</span><span class="p">,</span> + <span class="n">DictionaryType</span><span class="p">,</span> + <span class="n">FixedSizeBinaryType</span><span class="p">,</span> + <span class="n">TimestampType</span><span class="p">,</span> + <span class="n">Time32Type</span><span class="p">,</span> + <span class="n">Time64Type</span><span class="p">,</span> + <span class="n">Field</span><span class="p">,</span> + <span class="n">Schema</span><span class="p">,</span> + <span class="n">schema</span><span class="p">,</span> + <span class="n">Array</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">,</span> + <span class="n">array</span><span class="p">,</span> + <span class="n">from_numpy_dtype</span><span class="p">,</span> + <span class="n">NullArray</span><span class="p">,</span> + <span class="n">NumericArray</span><span class="p">,</span> <span class="n">IntegerArray</span><span class="p">,</span> <span class="n">FloatingPointArray</span><span class="p">,</span> + <span class="n">BooleanArray</span><span class="p">,</span> + <span class="n">Int8Array</span><span class="p">,</span> <span class="n">UInt8Array</span><span class="p">,</span> + <span class="n">Int16Array</span><span class="p">,</span> <span class="n">UInt16Array</span><span class="p">,</span> + <span class="n">Int32Array</span><span class="p">,</span> <span class="n">UInt32Array</span><span class="p">,</span> + <span class="n">Int64Array</span><span class="p">,</span> <span class="n">UInt64Array</span><span class="p">,</span> + <span class="n">ListArray</span><span class="p">,</span> + <span class="n">BinaryArray</span><span class="p">,</span> <span class="n">StringArray</span><span class="p">,</span> + <span class="n">FixedSizeBinaryArray</span><span class="p">,</span> + <span class="n">DictionaryArray</span><span class="p">,</span> + <span class="n">Date32Array</span><span class="p">,</span> <span class="n">Date64Array</span><span class="p">,</span> + <span class="n">TimestampArray</span><span class="p">,</span> <span class="n">Time32Array</span><span class="p">,</span> <span class="n">Time64Array</span><span class="p">,</span> + <span class="n">DecimalArray</span><span class="p">,</span> + <span class="n">ArrayValue</span><span class="p">,</span> <span class="n">Scalar</span><span class="p">,</span> <span class="n">NA</span><span class="p">,</span> <span class="n">NAType</span><span class="p">,</span> + <span class="n">BooleanValue</span><span class="p">,</span> + <span class="n">Int8Value</span><span class="p">,</span> <span class="n">Int16Value</span><span class="p">,</span> <span class="n">Int32Value</span><span class="p">,</span> <span class="n">Int64Value</span><span class="p">,</span> + <span class="n">UInt8Value</span><span class="p">,</span> <span class="n">UInt16Value</span><span class="p">,</span> <span class="n">UInt32Value</span><span class="p">,</span> <span class="n">UInt64Value</span><span class="p">,</span> + <span class="n">FloatValue</span><span class="p">,</span> <span class="n">DoubleValue</span><span class="p">,</span> <span class="n">ListValue</span><span class="p">,</span> + <span class="n">BinaryValue</span><span class="p">,</span> <span class="n">StringValue</span><span class="p">,</span> <span class="n">FixedSizeBinaryValue</span><span class="p">,</span> + <span class="n">DecimalValue</span><span class="p">,</span> + <span class="n">Date32Value</span><span class="p">,</span> <span class="n">Date64Value</span><span class="p">,</span> <span class="n">TimestampValue</span><span class="p">)</span> + +<span class="kn">from</span> <span class="nn">pyarrow._io</span> <span class="k">import</span> <span class="p">(</span><span class="n">HdfsFile</span><span class="p">,</span> <span class="n">NativeFile</span><span class="p">,</span> <span class="n">PythonFile</span><span class="p">,</span> + <span class="n">Buffer</span><span class="p">,</span> <span class="n">BufferReader</span><span class="p">,</span> <span class="n">InMemoryOutputStream</span><span class="p">,</span> + <span class="n">OSFile</span><span class="p">,</span> <span class="n">MemoryMappedFile</span><span class="p">,</span> <span class="n">memory_map</span><span class="p">,</span> + <span class="n">frombuffer</span><span class="p">,</span> <span class="n">read_tensor</span><span class="p">,</span> <span class="n">write_tensor</span><span class="p">,</span> + <span class="n">memory_map</span><span class="p">,</span> <span class="n">create_memory_map</span><span class="p">,</span> + <span class="n">get_record_batch_size</span><span class="p">,</span> <span class="n">get_tensor_size</span><span class="p">,</span> + <span class="n">have_libhdfs</span><span class="p">,</span> <span class="n">have_libhdfs3</span><span class="p">)</span> + +<span class="kn">from</span> <span class="nn">pyarrow._memory</span> <span class="k">import</span> <span class="p">(</span><span class="n">MemoryPool</span><span class="p">,</span> <span class="n">total_allocated_bytes</span><span class="p">,</span> + <span class="n">set_memory_pool</span><span class="p">,</span> <span class="n">default_memory_pool</span><span class="p">)</span> +<span class="kn">from</span> <span class="nn">pyarrow._table</span> <span class="k">import</span> <span class="p">(</span><span class="n">ChunkedArray</span><span class="p">,</span> <span class="n">Column</span><span class="p">,</span> <span class="n">RecordBatch</span><span class="p">,</span> <span class="n">Table</span><span class="p">,</span> + <span class="n">concat_tables</span><span class="p">)</span> +<span class="kn">from</span> <span class="nn">pyarrow._error</span> <span class="k">import</span> <span class="p">(</span><span class="n">ArrowException</span><span class="p">,</span> + <span class="n">ArrowKeyError</span><span class="p">,</span> + <span class="n">ArrowInvalid</span><span class="p">,</span> + <span class="n">ArrowIOError</span><span class="p">,</span> + <span class="n">ArrowMemoryError</span><span class="p">,</span> + <span class="n">ArrowNotImplementedError</span><span class="p">,</span> + <span class="n">ArrowTypeError</span><span class="p">)</span> + + +<div class="viewcode-block" id="jemalloc_memory_pool"><a class="viewcode-back" href="../generated/pyarrow.jemalloc_memory_pool.html#pyarrow.jemalloc_memory_pool">[docs]</a><span class="k">def</span> <span class="nf">jemalloc_memory_pool</span><span class="p">():</span> + <span class="sd">"""</span> +<span class="sd"> Returns a jemalloc-based memory allocator, which can be passed to</span> +<span class="sd"> pyarrow.set_memory_pool</span> +<span class="sd"> """</span> + <span class="kn">from</span> <span class="nn">pyarrow._jemalloc</span> <span class="k">import</span> <span class="n">default_pool</span> + <span class="k">return</span> <span class="n">default_pool</span><span class="p">()</span></div> + + +<span class="kn">from</span> <span class="nn">pyarrow.filesystem</span> <span class="k">import</span> <span class="n">Filesystem</span><span class="p">,</span> <span class="n">HdfsClient</span><span class="p">,</span> <span class="n">LocalFilesystem</span> + +<span class="kn">from</span> <span class="nn">pyarrow.ipc</span> <span class="k">import</span> <span class="n">FileReader</span><span class="p">,</span> <span class="n">FileWriter</span><span class="p">,</span> <span class="n">StreamReader</span><span class="p">,</span> <span class="n">StreamWriter</span> + + +<span class="n">localfs</span> <span class="o">=</span> <span class="n">LocalFilesystem</span><span class="o">.</span><span class="n">get_instance</span><span class="p">()</span> +</pre></div> + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/_modules/pyarrow/ipc.html ---------------------------------------------------------------------- diff --git a/docs/python/_modules/pyarrow/ipc.html b/docs/python/_modules/pyarrow/ipc.html new file mode 100644 index 0000000..aaaa165 --- /dev/null +++ b/docs/python/_modules/pyarrow/ipc.html @@ -0,0 +1,314 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>pyarrow.ipc — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../../genindex.html"/> + <link rel="search" title="Search" href="../../search.html"/> + <link rel="top" title="pyarrow documentation" href="../../index.html"/> + <link rel="up" title="pyarrow" href="../pyarrow.html"/> + + + <script src="../../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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" class="icon icon-home"> pyarrow + + + + </a> + + + + + + + +<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="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"> + + + + + + + <p class="caption"><span class="caption-text">Getting Started</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">pyarrow</a> + + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html">Docs</a> »</li> + + <li><a href="../index.html">Module code</a> »</li> + + <li><a href="../pyarrow.html">pyarrow</a> »</li> + + <li>pyarrow.ipc</li> + + + <li class="wy-breadcrumbs-aside"> + + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <h1>Source code for pyarrow.ipc</h1><div class="highlight"><pre> +<span></span><span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> +<span class="c1"># or more contributor license agreements. See the NOTICE file</span> +<span class="c1"># distributed with this work for additional information</span> +<span class="c1"># regarding copyright ownership. The ASF licenses this file</span> +<span class="c1"># to you under the Apache License, Version 2.0 (the</span> +<span class="c1"># "License"); you may not use this file except in compliance</span> +<span class="c1"># with the License. You may obtain a copy of the License at</span> +<span class="c1">#</span> +<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> +<span class="c1">#</span> +<span class="c1"># Unless required by applicable law or agreed to in writing,</span> +<span class="c1"># software distributed under the License is distributed on an</span> +<span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> +<span class="c1"># KIND, either express or implied. See the License for the</span> +<span class="c1"># specific language governing permissions and limitations</span> +<span class="c1"># under the License.</span> + +<span class="c1"># Arrow file and stream reader/writer classes, and other messaging tools</span> + +<span class="kn">import</span> <span class="nn">pyarrow._io</span> <span class="k">as</span> <span class="nn">_io</span> + + +<div class="viewcode-block" id="StreamReader"><a class="viewcode-back" href="../../generated/pyarrow.StreamReader.html#pyarrow.StreamReader">[docs]</a><span class="k">class</span> <span class="nc">StreamReader</span><span class="p">(</span><span class="n">_io</span><span class="o">.</span><span class="n">_StreamReader</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Reader for the Arrow streaming binary format</span> + +<span class="sd"> Parameters</span> +<span class="sd"> ----------</span> +<span class="sd"> source : str, pyarrow.NativeFile, or file-like Python object</span> +<span class="sd"> Either a file path, or a readable file object</span> +<span class="sd"> """</span> +<div class="viewcode-block" id="StreamReader.__init__"><a class="viewcode-back" href="../../generated/pyarrow.StreamReader.html#pyarrow.StreamReader.__init__">[docs]</a> <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">source</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">source</span><span class="p">)</span></div> + + <span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> + <span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_next_batch</span><span class="p">()</span></div> + + +<div class="viewcode-block" id="StreamWriter"><a class="viewcode-back" href="../../generated/pyarrow.StreamWriter.html#pyarrow.StreamWriter">[docs]</a><span class="k">class</span> <span class="nc">StreamWriter</span><span class="p">(</span><span class="n">_io</span><span class="o">.</span><span class="n">_StreamWriter</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Writer for the Arrow streaming binary format</span> + +<span class="sd"> Parameters</span> +<span class="sd"> ----------</span> +<span class="sd"> sink : str, pyarrow.NativeFile, or file-like Python object</span> +<span class="sd"> Either a file path, or a writeable file object</span> +<span class="sd"> schema : pyarrow.Schema</span> +<span class="sd"> The Arrow schema for data to be written to the file</span> +<span class="sd"> """</span> +<div class="viewcode-block" id="StreamWriter.__init__"><a class="viewcode-back" href="../../generated/pyarrow.StreamWriter.html#pyarrow.StreamWriter.__init__">[docs]</a> <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">sink</span><span class="p">,</span> <span class="n">schema</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">sink</span><span class="p">,</span> <span class="n">schema</span><span class="p">)</span></div></div> + + +<div class="viewcode-block" id="FileReader"><a class="viewcode-back" href="../../generated/pyarrow.FileReader.html#pyarrow.FileReader">[docs]</a><span class="k">class</span> <span class="nc">FileReader</span><span class="p">(</span><span class="n">_io</span><span class="o">.</span><span class="n">_FileReader</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Class for reading Arrow record batch data from the Arrow binary file format</span> + +<span class="sd"> Parameters</span> +<span class="sd"> ----------</span> +<span class="sd"> source : str, pyarrow.NativeFile, or file-like Python object</span> +<span class="sd"> Either a file path, or a readable file object</span> +<span class="sd"> footer_offset : int, default None</span> +<span class="sd"> If the file is embedded in some larger file, this is the byte offset to</span> +<span class="sd"> the very end of the file data</span> +<span class="sd"> """</span> +<div class="viewcode-block" id="FileReader.__init__"><a class="viewcode-back" href="../../generated/pyarrow.FileReader.html#pyarrow.FileReader.__init__">[docs]</a> <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">source</span><span class="p">,</span> <span class="n">footer_offset</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">footer_offset</span><span class="o">=</span><span class="n">footer_offset</span><span class="p">)</span></div></div> + + +<div class="viewcode-block" id="FileWriter"><a class="viewcode-back" href="../../generated/pyarrow.FileWriter.html#pyarrow.FileWriter">[docs]</a><span class="k">class</span> <span class="nc">FileWriter</span><span class="p">(</span><span class="n">_io</span><span class="o">.</span><span class="n">_FileWriter</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Writer to create the Arrow binary file format</span> + +<span class="sd"> Parameters</span> +<span class="sd"> ----------</span> +<span class="sd"> sink : str, pyarrow.NativeFile, or file-like Python object</span> +<span class="sd"> Either a file path, or a writeable file object</span> +<span class="sd"> schema : pyarrow.Schema</span> +<span class="sd"> The Arrow schema for data to be written to the file</span> +<span class="sd"> """</span> +<div class="viewcode-block" id="FileWriter.__init__"><a class="viewcode-back" href="../../generated/pyarrow.FileWriter.html#pyarrow.FileWriter.__init__">[docs]</a> <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">sink</span><span class="p">,</span> <span class="n">schema</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">sink</span><span class="p">,</span> <span class="n">schema</span><span class="p">)</span></div></div> +</pre></div> + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
