http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.HdfsFile.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.HdfsFile.html b/docs/python/generated/pyarrow.HdfsFile.html new file mode 100644 index 0000000..3b972e5 --- /dev/null +++ b/docs/python/generated/pyarrow.HdfsFile.html @@ -0,0 +1,336 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.HdfsFile — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <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/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="The Plasma In-Memory Object Store" href="../plasma.html" /> + <link rel="prev" title="pyarrow.HadoopFileSystem.upload" href="pyarrow.HadoopFileSystem.upload.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><p class="caption"><span class="caption-text">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</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> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.HdfsFile</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.HadoopFileSystem.upload.html" title="Previous Chapter: pyarrow.HadoopFileSystem.upload"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Hadoo...</span> + </a> + </li> + <li> + <a href="../plasma.html" title="Next Chapter: The Plasma In-Memory Object Store"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">The Plasma In... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.HdfsFile.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-hdfsfile"> +<h1>pyarrow.HdfsFile<a class="headerlink" href="#pyarrow-hdfsfile" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.HdfsFile"> +<em class="property">class </em><code class="descclassname">pyarrow.</code><code class="descname">HdfsFile</code><a class="headerlink" href="#pyarrow.HdfsFile" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">pyarrow.lib.NativeFile</span></code></p> +<dl class="method"> +<dt id="pyarrow.HdfsFile.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>Initialize self. See help(type(self)) for accurate signature.</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.HdfsFile.close" title="pyarrow.HdfsFile.close"><code class="xref py py-obj docutils literal"><span class="pre">close</span></code></a>(self)</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.HdfsFile.download" title="pyarrow.HdfsFile.download"><code class="xref py py-obj docutils literal"><span class="pre">download</span></code></a>(self, stream_or_path[, buffer_size])</td> +<td>Read file completely to local path (rather than reading completely into memory).</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.HdfsFile.read" title="pyarrow.HdfsFile.read"><code class="xref py py-obj docutils literal"><span class="pre">read</span></code></a>(self[, nbytes])</td> +<td>Read indicated number of bytes from file, or read all remaining bytes</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.HdfsFile.read_buffer" title="pyarrow.HdfsFile.read_buffer"><code class="xref py py-obj docutils literal"><span class="pre">read_buffer</span></code></a>(self[, nbytes])</td> +<td></td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.HdfsFile.seek" title="pyarrow.HdfsFile.seek"><code class="xref py py-obj docutils literal"><span class="pre">seek</span></code></a>(self, int64_t position, int whence=0)</td> +<td>Change current file stream position</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.HdfsFile.size" title="pyarrow.HdfsFile.size"><code class="xref py py-obj docutils literal"><span class="pre">size</span></code></a>(self)</td> +<td>Return file size</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.HdfsFile.tell" title="pyarrow.HdfsFile.tell"><code class="xref py py-obj docutils literal"><span class="pre">tell</span></code></a>(self)</td> +<td>Return current stream position</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.HdfsFile.upload" title="pyarrow.HdfsFile.upload"><code class="xref py py-obj docutils literal"><span class="pre">upload</span></code></a>(self, stream[, buffer_size])</td> +<td>Pipe file-like object to file</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.HdfsFile.write" title="pyarrow.HdfsFile.write"><code class="xref py py-obj docutils literal"><span class="pre">write</span></code></a>(self, data)</td> +<td>Write byte from any object implementing buffer protocol (bytes,</td> +</tr> +</tbody> +</table> +<p class="rubric">Attributes</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.HdfsFile.buffer_size" title="pyarrow.HdfsFile.buffer_size"><code class="xref py py-obj docutils literal"><span class="pre">buffer_size</span></code></a></td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.HdfsFile.mode" title="pyarrow.HdfsFile.mode"><code class="xref py py-obj docutils literal"><span class="pre">mode</span></code></a></td> +<td></td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.HdfsFile.parent" title="pyarrow.HdfsFile.parent"><code class="xref py py-obj docutils literal"><span class="pre">parent</span></code></a></td> +<td></td> +</tr> +</tbody> +</table> +<dl class="attribute"> +<dt id="pyarrow.HdfsFile.buffer_size"> +<code class="descname">buffer_size</code><a class="headerlink" href="#pyarrow.HdfsFile.buffer_size" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.HdfsFile.close"> +<code class="descname">close</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.close" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.HdfsFile.download"> +<code class="descname">download</code><span class="sig-paren">(</span><em>self</em>, <em>stream_or_path</em>, <em>buffer_size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.download" title="Permalink to this definition">¶</a></dt> +<dd><p>Read file completely to local path (rather than reading completely into +memory). First seeks to the beginning of the file.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.HdfsFile.mode"> +<code class="descname">mode</code><a class="headerlink" href="#pyarrow.HdfsFile.mode" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.HdfsFile.parent"> +<code class="descname">parent</code><a class="headerlink" href="#pyarrow.HdfsFile.parent" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.HdfsFile.read"> +<code class="descname">read</code><span class="sig-paren">(</span><em>self</em>, <em>nbytes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.read" title="Permalink to this definition">¶</a></dt> +<dd><p>Read indicated number of bytes from file, or read all remaining bytes +if no argument passed</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nbytes</strong> (<em>int</em><em>, </em><em>default None</em>) – </td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>data</strong> (<em>bytes</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.HdfsFile.read_buffer"> +<code class="descname">read_buffer</code><span class="sig-paren">(</span><em>self</em>, <em>nbytes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.read_buffer" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.HdfsFile.seek"> +<code class="descname">seek</code><span class="sig-paren">(</span><em>self</em>, <em>int64_t position</em>, <em>int whence=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.seek" title="Permalink to this definition">¶</a></dt> +<dd><p>Change current file stream position</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>position</strong> (<em>int</em>) – Byte offset, interpreted relative to value of whence argument</li> +<li><strong>whence</strong> (<em>int</em><em>, </em><em>default 0</em>) – Point of reference for seek offset</li> +</ul> +</td> +</tr> +</tbody> +</table> +<p class="rubric">Notes</p> +<p>Values of whence: +* 0 – start of stream (the default); offset should be zero or positive +* 1 – current stream position; offset may be negative +* 2 – end of stream; offset is usually negative</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>new_position</strong> (<em>the new absolute stream position</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.HdfsFile.size"> +<code class="descname">size</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.size" title="Permalink to this definition">¶</a></dt> +<dd><p>Return file size</p> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.HdfsFile.tell"> +<code class="descname">tell</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.tell" title="Permalink to this definition">¶</a></dt> +<dd><p>Return current stream position</p> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.HdfsFile.upload"> +<code class="descname">upload</code><span class="sig-paren">(</span><em>self</em>, <em>stream</em>, <em>buffer_size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.upload" title="Permalink to this definition">¶</a></dt> +<dd><p>Pipe file-like object to file</p> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.HdfsFile.write"> +<code class="descname">write</code><span class="sig-paren">(</span><em>self</em>, <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.HdfsFile.write" title="Permalink to this definition">¶</a></dt> +<dd><p>Write byte from any object implementing buffer protocol (bytes, +bytearray, ndarray, pyarrow.Buffer)</p> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.Int16Value.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.Int16Value.html b/docs/python/generated/pyarrow.Int16Value.html index 2b62e1e..da2d360 100644 --- a/docs/python/generated/pyarrow.Int16Value.html +++ b/docs/python/generated/pyarrow.Int16Value.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,11 +102,11 @@ <li> - <a href="pyarrow.Int8Value.html" title="Previous Chapter: pyarrow.Int8Value"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Int8Value</span> + <a href="pyarrow.Int8Value.html" title="Previous Chapter: pyarrow.Int8Value"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Int8V...</span> </a> </li> <li> - <a href="pyarrow.Int32Value.html" title="Next Chapter: pyarrow.Int32Value"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Int32Value »</span> + <a href="pyarrow.Int32Value.html" title="Next Chapter: pyarrow.Int32Value"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Int32... »</span> </a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.Int32Value.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.Int32Value.html b/docs/python/generated/pyarrow.Int32Value.html index a79fde0..734f65d 100644 --- a/docs/python/generated/pyarrow.Int32Value.html +++ b/docs/python/generated/pyarrow.Int32Value.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,11 +102,11 @@ <li> - <a href="pyarrow.Int16Value.html" title="Previous Chapter: pyarrow.Int16Value"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Int16Value</span> + <a href="pyarrow.Int16Value.html" title="Previous Chapter: pyarrow.Int16Value"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Int16...</span> </a> </li> <li> - <a href="pyarrow.Int64Value.html" title="Next Chapter: pyarrow.Int64Value"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Int64Value »</span> + <a href="pyarrow.Int64Value.html" title="Next Chapter: pyarrow.Int64Value"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Int64... »</span> </a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.Int64Value.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.Int64Value.html b/docs/python/generated/pyarrow.Int64Value.html index 07b5f5f..1b3b625 100644 --- a/docs/python/generated/pyarrow.Int64Value.html +++ b/docs/python/generated/pyarrow.Int64Value.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,11 +102,11 @@ <li> - <a href="pyarrow.Int32Value.html" title="Previous Chapter: pyarrow.Int32Value"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Int32Value</span> + <a href="pyarrow.Int32Value.html" title="Previous Chapter: pyarrow.Int32Value"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Int32...</span> </a> </li> <li> - <a href="pyarrow.UInt8Value.html" title="Next Chapter: pyarrow.UInt8Value"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.UInt8Value »</span> + <a href="pyarrow.UInt8Value.html" title="Next Chapter: pyarrow.UInt8Value"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.UInt8... »</span> </a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.Int8Value.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.Int8Value.html b/docs/python/generated/pyarrow.Int8Value.html index f979b1e..4fb0d49 100644 --- a/docs/python/generated/pyarrow.Int8Value.html +++ b/docs/python/generated/pyarrow.Int8Value.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,11 +102,11 @@ <li> - <a href="pyarrow.BooleanValue.html" title="Previous Chapter: pyarrow.BooleanValue"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.BooleanValue</span> + <a href="pyarrow.BooleanValue.html" title="Previous Chapter: pyarrow.BooleanValue"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Boole...</span> </a> </li> <li> - <a href="pyarrow.Int16Value.html" title="Next Chapter: pyarrow.Int16Value"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Int16Value »</span> + <a href="pyarrow.Int16Value.html" title="Next Chapter: pyarrow.Int16Value"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Int16... »</span> </a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.ListValue.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.ListValue.html b/docs/python/generated/pyarrow.ListValue.html index 8cb0129..533e7ba 100644 --- a/docs/python/generated/pyarrow.ListValue.html +++ b/docs/python/generated/pyarrow.ListValue.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,11 +102,11 @@ <li> - <a href="pyarrow.DoubleValue.html" title="Previous Chapter: pyarrow.DoubleValue"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.DoubleValue</span> + <a href="pyarrow.DoubleValue.html" title="Previous Chapter: pyarrow.DoubleValue"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Doubl...</span> </a> </li> <li> - <a href="pyarrow.BinaryValue.html" title="Next Chapter: pyarrow.BinaryValue"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.BinaryValue »</span> + <a href="pyarrow.BinaryValue.html" title="Next Chapter: pyarrow.BinaryValue"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Binar... »</span> </a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.LocalFileSystem.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.LocalFileSystem.html b/docs/python/generated/pyarrow.LocalFileSystem.html new file mode 100644 index 0000000..5373490 --- /dev/null +++ b/docs/python/generated/pyarrow.LocalFileSystem.html @@ -0,0 +1,424 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.LocalFileSystem — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <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/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.Message" href="pyarrow.Message.html" /> + <link rel="prev" title="pyarrow.PythonFile" href="pyarrow.PythonFile.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><p class="caption"><span class="caption-text">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><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> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.LocalFileSystem</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.PythonFile.html" title="Previous Chapter: pyarrow.PythonFile"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Pytho...</span> + </a> + </li> + <li> + <a href="pyarrow.Message.html" title="Next Chapter: pyarrow.Message"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Message »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.LocalFileSystem.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-localfilesystem"> +<h1>pyarrow.LocalFileSystem<a class="headerlink" href="#pyarrow-localfilesystem" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.LocalFileSystem"> +<em class="property">class </em><code class="descclassname">pyarrow.</code><code class="descname">LocalFileSystem</code><a class="reference internal" href="../_modules/pyarrow/filesystem.html#LocalFileSystem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">pyarrow.filesystem.FileSystem</span></code></p> +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>Initialize self. See help(type(self)) for accurate signature.</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.cat" title="pyarrow.LocalFileSystem.cat"><code class="xref py py-obj docutils literal"><span class="pre">cat</span></code></a>(path)</td> +<td>Return contents of file as a bytes object</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.delete" title="pyarrow.LocalFileSystem.delete"><code class="xref py py-obj docutils literal"><span class="pre">delete</span></code></a>(path[, recursive])</td> +<td>Delete the indicated file or directory</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.disk_usage" title="pyarrow.LocalFileSystem.disk_usage"><code class="xref py py-obj docutils literal"><span class="pre">disk_usage</span></code></a>(path)</td> +<td>Compute bytes used by all contents under indicated path in file tree</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.exists" title="pyarrow.LocalFileSystem.exists"><code class="xref py py-obj docutils literal"><span class="pre">exists</span></code></a>(path)</td> +<td></td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.get_instance" title="pyarrow.LocalFileSystem.get_instance"><code class="xref py py-obj docutils literal"><span class="pre">get_instance</span></code></a>()</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.isdir" title="pyarrow.LocalFileSystem.isdir"><code class="xref py py-obj docutils literal"><span class="pre">isdir</span></code></a>(path)</td> +<td>Return True if path is a directory</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.isfile" title="pyarrow.LocalFileSystem.isfile"><code class="xref py py-obj docutils literal"><span class="pre">isfile</span></code></a>(path)</td> +<td>Return True if path is a file</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.ls" title="pyarrow.LocalFileSystem.ls"><code class="xref py py-obj docutils literal"><span class="pre">ls</span></code></a>(path)</td> +<td>Return list of file paths</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.mkdir" title="pyarrow.LocalFileSystem.mkdir"><code class="xref py py-obj docutils literal"><span class="pre">mkdir</span></code></a>(path[, create_parents])</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.mv" title="pyarrow.LocalFileSystem.mv"><code class="xref py py-obj docutils literal"><span class="pre">mv</span></code></a>(path, new_path)</td> +<td>Alias for FileSystem.rename</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.open" title="pyarrow.LocalFileSystem.open"><code class="xref py py-obj docutils literal"><span class="pre">open</span></code></a>(path[, mode])</td> +<td>Open file for reading or writing</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.read_parquet" title="pyarrow.LocalFileSystem.read_parquet"><code class="xref py py-obj docutils literal"><span class="pre">read_parquet</span></code></a>(path[, columns, metadata, ...])</td> +<td>Read Parquet data from path in file system.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.rename" title="pyarrow.LocalFileSystem.rename"><code class="xref py py-obj docutils literal"><span class="pre">rename</span></code></a>(path, new_path)</td> +<td>Rename file, like UNIX mv command</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.rm" title="pyarrow.LocalFileSystem.rm"><code class="xref py py-obj docutils literal"><span class="pre">rm</span></code></a>(path[, recursive])</td> +<td>Alias for FileSystem.delete</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.stat" title="pyarrow.LocalFileSystem.stat"><code class="xref py py-obj docutils literal"><span class="pre">stat</span></code></a>(path)</td> +<td><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">returns:</th><td class="field-body"><strong>stat</strong> (<em>dict</em>)</td> +</tr> +</tbody> +</table> +</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.walk" title="pyarrow.LocalFileSystem.walk"><code class="xref py py-obj docutils literal"><span class="pre">walk</span></code></a>(top_dir)</td> +<td>Directory tree generator, see os.walk</td> +</tr> +</tbody> +</table> +<p class="rubric">Attributes</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.LocalFileSystem.pathsep" title="pyarrow.LocalFileSystem.pathsep"><code class="xref py py-obj docutils literal"><span class="pre">pathsep</span></code></a></td> +<td></td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.cat"> +<code class="descname">cat</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.cat" title="Permalink to this definition">¶</a></dt> +<dd><p>Return contents of file as a bytes object</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>contents</strong> (<em>bytes</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.delete"> +<code class="descname">delete</code><span class="sig-paren">(</span><em>path</em>, <em>recursive=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.delete" title="Permalink to this definition">¶</a></dt> +<dd><p>Delete the indicated file or directory</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>path</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a>) – </li> +<li><strong>recursive</strong> (<em>boolean</em><em>, </em><em>default False</em>) – If True, also delete child paths for directories</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.disk_usage"> +<code class="descname">disk_usage</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.disk_usage" title="Permalink to this definition">¶</a></dt> +<dd><p>Compute bytes used by all contents under indicated path in file tree</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a>) – Can be a file path or directory</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>usage</strong> (<em>int</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.exists"> +<code class="descname">exists</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/filesystem.html#LocalFileSystem.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.exists" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="classmethod"> +<dt id="pyarrow.LocalFileSystem.get_instance"> +<em class="property">classmethod </em><code class="descname">get_instance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/filesystem.html#LocalFileSystem.get_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.get_instance" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.isdir"> +<code class="descname">isdir</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/filesystem.html#LocalFileSystem.isdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.isdir" title="Permalink to this definition">¶</a></dt> +<dd><p>Return True if path is a directory</p> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.isfile"> +<code class="descname">isfile</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/filesystem.html#LocalFileSystem.isfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.isfile" title="Permalink to this definition">¶</a></dt> +<dd><p>Return True if path is a file</p> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.ls"> +<code class="descname">ls</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/filesystem.html#LocalFileSystem.ls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.ls" title="Permalink to this definition">¶</a></dt> +<dd><p>Return list of file paths</p> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.mkdir"> +<code class="descname">mkdir</code><span class="sig-paren">(</span><em>path</em>, <em>create_parents=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/filesystem.html#LocalFileSystem.mkdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.mkdir" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.mv"> +<code class="descname">mv</code><span class="sig-paren">(</span><em>path</em>, <em>new_path</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.mv" title="Permalink to this definition">¶</a></dt> +<dd><p>Alias for FileSystem.rename</p> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.open"> +<code class="descname">open</code><span class="sig-paren">(</span><em>path</em>, <em>mode='rb'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/filesystem.html#LocalFileSystem.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.open" title="Permalink to this definition">¶</a></dt> +<dd><p>Open file for reading or writing</p> +</dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.LocalFileSystem.pathsep"> +<code class="descname">pathsep</code><a class="headerlink" href="#pyarrow.LocalFileSystem.pathsep" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.read_parquet"> +<code class="descname">read_parquet</code><span class="sig-paren">(</span><em>path</em>, <em>columns=None</em>, <em>metadata=None</em>, <em>schema=None</em>, <em>nthreads=1</em>, <em>use_pandas_metadata=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.read_parquet" title="Permalink to this definition">¶</a></dt> +<dd><p>Read Parquet data from path in file system. Can read from a single file +or a directory of files</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>path</strong> (<em>str</em>) – Single file path or directory</li> +<li><strong>columns</strong> (<em>List</em><em>[</em><em>str</em><em>]</em><em></em><em>, </em><em>optional</em>) – Subset of columns to read</li> +<li><strong>metadata</strong> (<em>pyarrow.parquet.FileMetaData</em>) – Known metadata to validate files against</li> +<li><strong>schema</strong> (<em>pyarrow.parquet.Schema</em>) – Known schema to validate files against. Alternative to metadata +argument</li> +<li><strong>nthreads</strong> (<em>int</em><em>, </em><em>default 1</em>) – Number of columns to read in parallel. If > 1, requires that the +underlying file source is threadsafe</li> +<li><strong>use_pandas_metadata</strong> (<em>boolean</em><em>, </em><em>default False</em>) – If True and file has custom pandas schema metadata, ensure that +index columns are also loaded</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><strong>table</strong> (<em>pyarrow.Table</em>)</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.rename"> +<code class="descname">rename</code><span class="sig-paren">(</span><em>path</em>, <em>new_path</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.rename" title="Permalink to this definition">¶</a></dt> +<dd><p>Rename file, like UNIX mv command</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>path</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a>) – Path to alter</li> +<li><strong>new_path</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a>) – Path to move to</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.rm"> +<code class="descname">rm</code><span class="sig-paren">(</span><em>path</em>, <em>recursive=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.rm" title="Permalink to this definition">¶</a></dt> +<dd><p>Alias for FileSystem.delete</p> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.stat"> +<code class="descname">stat</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.stat" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>stat</strong> (<em>dict</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.LocalFileSystem.walk"> +<code class="descname">walk</code><span class="sig-paren">(</span><em>top_dir</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/filesystem.html#LocalFileSystem.walk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.walk" title="Permalink to this definition">¶</a></dt> +<dd><p>Directory tree generator, see os.walk</p> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.MemoryMappedFile.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.MemoryMappedFile.html b/docs/python/generated/pyarrow.MemoryMappedFile.html index d524d32..b347f8d 100644 --- a/docs/python/generated/pyarrow.MemoryMappedFile.html +++ b/docs/python/generated/pyarrow.MemoryMappedFile.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,11 +102,11 @@ <li> - <a href="pyarrow.NativeFile.html" title="Previous Chapter: pyarrow.NativeFile"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.NativeFile</span> + <a href="pyarrow.NativeFile.html" title="Previous Chapter: pyarrow.NativeFile"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Nativ...</span> </a> </li> <li> - <a href="pyarrow.memory_map.html" title="Next Chapter: pyarrow.memory_map"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.memory_map »</span> + <a href="pyarrow.memory_map.html" title="Next Chapter: pyarrow.memory_map"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.memor... »</span> </a> </li> @@ -169,19 +170,19 @@ <td>Read file completely to local path (rather than reading completely into memory).</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#pyarrow.MemoryMappedFile.read" title="pyarrow.MemoryMappedFile.read"><code class="xref py py-obj docutils literal"><span class="pre">read</span></code></a>(self[, nbytes])</td> -<td></td> +<td>Read indicated number of bytes from file, or read all remaining bytes</td> </tr> <tr class="row-odd"><td><a class="reference internal" href="#pyarrow.MemoryMappedFile.read_buffer" title="pyarrow.MemoryMappedFile.read_buffer"><code class="xref py py-obj docutils literal"><span class="pre">read_buffer</span></code></a>(self[, nbytes])</td> <td></td> </tr> -<tr class="row-even"><td><a class="reference internal" href="#pyarrow.MemoryMappedFile.seek" title="pyarrow.MemoryMappedFile.seek"><code class="xref py py-obj docutils literal"><span class="pre">seek</span></code></a>(self, int64_t position)</td> -<td></td> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.MemoryMappedFile.seek" title="pyarrow.MemoryMappedFile.seek"><code class="xref py py-obj docutils literal"><span class="pre">seek</span></code></a>(self, int64_t position, int whence=0)</td> +<td>Change current file stream position</td> </tr> <tr class="row-odd"><td><a class="reference internal" href="#pyarrow.MemoryMappedFile.size" title="pyarrow.MemoryMappedFile.size"><code class="xref py py-obj docutils literal"><span class="pre">size</span></code></a>(self)</td> -<td></td> +<td>Return file size</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#pyarrow.MemoryMappedFile.tell" title="pyarrow.MemoryMappedFile.tell"><code class="xref py py-obj docutils literal"><span class="pre">tell</span></code></a>(self)</td> -<td></td> +<td>Return current stream position</td> </tr> <tr class="row-odd"><td><a class="reference internal" href="#pyarrow.MemoryMappedFile.upload" title="pyarrow.MemoryMappedFile.upload"><code class="xref py py-obj docutils literal"><span class="pre">upload</span></code></a>(self, stream[, buffer_size])</td> <td>Pipe file-like object to file</td> @@ -234,7 +235,19 @@ memory). First seeks to the beginning of the file.</p> <dl class="method"> <dt id="pyarrow.MemoryMappedFile.read"> <code class="descname">read</code><span class="sig-paren">(</span><em>self</em>, <em>nbytes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.MemoryMappedFile.read" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<dd><p>Read indicated number of bytes from file, or read all remaining bytes +if no argument passed</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nbytes</strong> (<em>int</em><em>, </em><em>default None</em>) – </td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>data</strong> (<em>bytes</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> <dl class="method"> <dt id="pyarrow.MemoryMappedFile.read_buffer"> @@ -243,18 +256,46 @@ memory). First seeks to the beginning of the file.</p> <dl class="method"> <dt id="pyarrow.MemoryMappedFile.seek"> -<code class="descname">seek</code><span class="sig-paren">(</span><em>self</em>, <em>int64_t position</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.MemoryMappedFile.seek" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<code class="descname">seek</code><span class="sig-paren">(</span><em>self</em>, <em>int64_t position</em>, <em>int whence=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.MemoryMappedFile.seek" title="Permalink to this definition">¶</a></dt> +<dd><p>Change current file stream position</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>position</strong> (<em>int</em>) – Byte offset, interpreted relative to value of whence argument</li> +<li><strong>whence</strong> (<em>int</em><em>, </em><em>default 0</em>) – Point of reference for seek offset</li> +</ul> +</td> +</tr> +</tbody> +</table> +<p class="rubric">Notes</p> +<p>Values of whence: +* 0 – start of stream (the default); offset should be zero or positive +* 1 – current stream position; offset may be negative +* 2 – end of stream; offset is usually negative</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>new_position</strong> (<em>the new absolute stream position</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> <dl class="method"> <dt id="pyarrow.MemoryMappedFile.size"> <code class="descname">size</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.MemoryMappedFile.size" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<dd><p>Return file size</p> +</dd></dl> <dl class="method"> <dt id="pyarrow.MemoryMappedFile.tell"> <code class="descname">tell</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.MemoryMappedFile.tell" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<dd><p>Return current stream position</p> +</dd></dl> <dl class="method"> <dt id="pyarrow.MemoryMappedFile.upload"> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.MemoryPool.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.MemoryPool.html b/docs/python/generated/pyarrow.MemoryPool.html index 7573931..676af2f 100644 --- a/docs/python/generated/pyarrow.MemoryPool.html +++ b/docs/python/generated/pyarrow.MemoryPool.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.Message.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.Message.html b/docs/python/generated/pyarrow.Message.html index 209687a..504281f 100644 --- a/docs/python/generated/pyarrow.Message.html +++ b/docs/python/generated/pyarrow.Message.html @@ -31,7 +31,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="pyarrow.MessageReader" href="pyarrow.MessageReader.html" /> - <link rel="prev" title="pyarrow.PythonFile" href="pyarrow.PythonFile.html" /> + <link rel="prev" title="pyarrow.LocalFileSystem" href="pyarrow.LocalFileSystem.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,11 +102,11 @@ <li> - <a href="pyarrow.PythonFile.html" title="Previous Chapter: pyarrow.PythonFile"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.PythonFile</span> + <a href="pyarrow.LocalFileSystem.html" title="Previous Chapter: pyarrow.LocalFileSystem"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Local...</span> </a> </li> <li> - <a href="pyarrow.MessageReader.html" title="Next Chapter: pyarrow.MessageReader"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.MessageReader »</span> + <a href="pyarrow.MessageReader.html" title="Next Chapter: pyarrow.MessageReader"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Messa... »</span> </a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.MessageReader.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.MessageReader.html b/docs/python/generated/pyarrow.MessageReader.html index 71e6321..d0f5249 100644 --- a/docs/python/generated/pyarrow.MessageReader.html +++ b/docs/python/generated/pyarrow.MessageReader.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.NA.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.NA.html b/docs/python/generated/pyarrow.NA.html index bc0d2b6..4649a88 100644 --- a/docs/python/generated/pyarrow.NA.html +++ b/docs/python/generated/pyarrow.NA.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.NativeFile.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.NativeFile.html b/docs/python/generated/pyarrow.NativeFile.html index e2fd0d0..002a28b 100644 --- a/docs/python/generated/pyarrow.NativeFile.html +++ b/docs/python/generated/pyarrow.NativeFile.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -165,19 +166,19 @@ <td>Read file completely to local path (rather than reading completely into memory).</td> </tr> <tr class="row-odd"><td><a class="reference internal" href="#pyarrow.NativeFile.read" title="pyarrow.NativeFile.read"><code class="xref py py-obj docutils literal"><span class="pre">read</span></code></a>(self[, nbytes])</td> -<td></td> +<td>Read indicated number of bytes from file, or read all remaining bytes</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#pyarrow.NativeFile.read_buffer" title="pyarrow.NativeFile.read_buffer"><code class="xref py py-obj docutils literal"><span class="pre">read_buffer</span></code></a>(self[, nbytes])</td> <td></td> </tr> -<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.NativeFile.seek" title="pyarrow.NativeFile.seek"><code class="xref py py-obj docutils literal"><span class="pre">seek</span></code></a>(self, int64_t position)</td> -<td></td> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.NativeFile.seek" title="pyarrow.NativeFile.seek"><code class="xref py py-obj docutils literal"><span class="pre">seek</span></code></a>(self, int64_t position, int whence=0)</td> +<td>Change current file stream position</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#pyarrow.NativeFile.size" title="pyarrow.NativeFile.size"><code class="xref py py-obj docutils literal"><span class="pre">size</span></code></a>(self)</td> -<td></td> +<td>Return file size</td> </tr> <tr class="row-odd"><td><a class="reference internal" href="#pyarrow.NativeFile.tell" title="pyarrow.NativeFile.tell"><code class="xref py py-obj docutils literal"><span class="pre">tell</span></code></a>(self)</td> -<td></td> +<td>Return current stream position</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#pyarrow.NativeFile.upload" title="pyarrow.NativeFile.upload"><code class="xref py py-obj docutils literal"><span class="pre">upload</span></code></a>(self, stream[, buffer_size])</td> <td>Pipe file-like object to file</td> @@ -225,7 +226,19 @@ memory). First seeks to the beginning of the file.</p> <dl class="method"> <dt id="pyarrow.NativeFile.read"> <code class="descname">read</code><span class="sig-paren">(</span><em>self</em>, <em>nbytes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.NativeFile.read" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<dd><p>Read indicated number of bytes from file, or read all remaining bytes +if no argument passed</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nbytes</strong> (<em>int</em><em>, </em><em>default None</em>) – </td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>data</strong> (<em>bytes</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> <dl class="method"> <dt id="pyarrow.NativeFile.read_buffer"> @@ -234,18 +247,46 @@ memory). First seeks to the beginning of the file.</p> <dl class="method"> <dt id="pyarrow.NativeFile.seek"> -<code class="descname">seek</code><span class="sig-paren">(</span><em>self</em>, <em>int64_t position</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.NativeFile.seek" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<code class="descname">seek</code><span class="sig-paren">(</span><em>self</em>, <em>int64_t position</em>, <em>int whence=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.NativeFile.seek" title="Permalink to this definition">¶</a></dt> +<dd><p>Change current file stream position</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>position</strong> (<em>int</em>) – Byte offset, interpreted relative to value of whence argument</li> +<li><strong>whence</strong> (<em>int</em><em>, </em><em>default 0</em>) – Point of reference for seek offset</li> +</ul> +</td> +</tr> +</tbody> +</table> +<p class="rubric">Notes</p> +<p>Values of whence: +* 0 – start of stream (the default); offset should be zero or positive +* 1 – current stream position; offset may be negative +* 2 – end of stream; offset is usually negative</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>new_position</strong> (<em>the new absolute stream position</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> <dl class="method"> <dt id="pyarrow.NativeFile.size"> <code class="descname">size</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.NativeFile.size" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<dd><p>Return file size</p> +</dd></dl> <dl class="method"> <dt id="pyarrow.NativeFile.tell"> <code class="descname">tell</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.NativeFile.tell" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<dd><p>Return current stream position</p> +</dd></dl> <dl class="method"> <dt id="pyarrow.NativeFile.upload"> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.PythonFile.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.PythonFile.html b/docs/python/generated/pyarrow.PythonFile.html index 466605b..27ffc2a 100644 --- a/docs/python/generated/pyarrow.PythonFile.html +++ b/docs/python/generated/pyarrow.PythonFile.html @@ -30,7 +30,7 @@ <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="pyarrow.Message" href="pyarrow.Message.html" /> + <link rel="next" title="pyarrow.LocalFileSystem" href="pyarrow.LocalFileSystem.html" /> <link rel="prev" title="pyarrow.create_memory_map" href="pyarrow.create_memory_map.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -105,7 +106,7 @@ </a> </li> <li> - <a href="pyarrow.Message.html" title="Next Chapter: pyarrow.Message"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Message »</span> + <a href="pyarrow.LocalFileSystem.html" title="Next Chapter: pyarrow.LocalFileSystem"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.Local... »</span> </a> </li> @@ -165,19 +166,19 @@ <td>Read file completely to local path (rather than reading completely into memory).</td> </tr> <tr class="row-odd"><td><a class="reference internal" href="#pyarrow.PythonFile.read" title="pyarrow.PythonFile.read"><code class="xref py py-obj docutils literal"><span class="pre">read</span></code></a>(self[, nbytes])</td> -<td></td> +<td>Read indicated number of bytes from file, or read all remaining bytes</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#pyarrow.PythonFile.read_buffer" title="pyarrow.PythonFile.read_buffer"><code class="xref py py-obj docutils literal"><span class="pre">read_buffer</span></code></a>(self[, nbytes])</td> <td></td> </tr> -<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.PythonFile.seek" title="pyarrow.PythonFile.seek"><code class="xref py py-obj docutils literal"><span class="pre">seek</span></code></a>(self, int64_t position)</td> -<td></td> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.PythonFile.seek" title="pyarrow.PythonFile.seek"><code class="xref py py-obj docutils literal"><span class="pre">seek</span></code></a>(self, int64_t position, int whence=0)</td> +<td>Change current file stream position</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#pyarrow.PythonFile.size" title="pyarrow.PythonFile.size"><code class="xref py py-obj docutils literal"><span class="pre">size</span></code></a>(self)</td> -<td></td> +<td>Return file size</td> </tr> <tr class="row-odd"><td><a class="reference internal" href="#pyarrow.PythonFile.tell" title="pyarrow.PythonFile.tell"><code class="xref py py-obj docutils literal"><span class="pre">tell</span></code></a>(self)</td> -<td></td> +<td>Return current stream position</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#pyarrow.PythonFile.upload" title="pyarrow.PythonFile.upload"><code class="xref py py-obj docutils literal"><span class="pre">upload</span></code></a>(self, stream[, buffer_size])</td> <td>Pipe file-like object to file</td> @@ -225,7 +226,19 @@ memory). First seeks to the beginning of the file.</p> <dl class="method"> <dt id="pyarrow.PythonFile.read"> <code class="descname">read</code><span class="sig-paren">(</span><em>self</em>, <em>nbytes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.PythonFile.read" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<dd><p>Read indicated number of bytes from file, or read all remaining bytes +if no argument passed</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nbytes</strong> (<em>int</em><em>, </em><em>default None</em>) – </td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>data</strong> (<em>bytes</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> <dl class="method"> <dt id="pyarrow.PythonFile.read_buffer"> @@ -234,18 +247,46 @@ memory). First seeks to the beginning of the file.</p> <dl class="method"> <dt id="pyarrow.PythonFile.seek"> -<code class="descname">seek</code><span class="sig-paren">(</span><em>self</em>, <em>int64_t position</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.PythonFile.seek" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<code class="descname">seek</code><span class="sig-paren">(</span><em>self</em>, <em>int64_t position</em>, <em>int whence=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.PythonFile.seek" title="Permalink to this definition">¶</a></dt> +<dd><p>Change current file stream position</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>position</strong> (<em>int</em>) – Byte offset, interpreted relative to value of whence argument</li> +<li><strong>whence</strong> (<em>int</em><em>, </em><em>default 0</em>) – Point of reference for seek offset</li> +</ul> +</td> +</tr> +</tbody> +</table> +<p class="rubric">Notes</p> +<p>Values of whence: +* 0 – start of stream (the default); offset should be zero or positive +* 1 – current stream position; offset may be negative +* 2 – end of stream; offset is usually negative</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>new_position</strong> (<em>the new absolute stream position</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> <dl class="method"> <dt id="pyarrow.PythonFile.size"> <code class="descname">size</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.PythonFile.size" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<dd><p>Return file size</p> +</dd></dl> <dl class="method"> <dt id="pyarrow.PythonFile.tell"> <code class="descname">tell</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.PythonFile.tell" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> +<dd><p>Return current stream position</p> +</dd></dl> <dl class="method"> <dt id="pyarrow.PythonFile.upload">
