<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>io — 0.1 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for io</h1><div class="highlight"><pre>
<span></span><span class="sd">"""The io module provides the Python interfaces to stream handling. The</span>
<span class="sd">builtin open function is defined in this module.</span>
<span class="sd">At the top of the I/O hierarchy is the abstract base class IOBase. It</span>
<span class="sd">defines the basic interface to a stream. Note, however, that there is no</span>
<span class="sd">separation between reading and writing to streams; implementations are</span>
<span class="sd">allowed to raise an OSError if they do not support a given operation.</span>
<span class="sd">Extending IOBase is RawIOBase which deals simply with the reading and</span>
<span class="sd">writing of raw bytes to a stream. FileIO subclasses RawIOBase to provide</span>
<span class="sd">an interface to OS files.</span>
<span class="sd">BufferedIOBase deals with buffering on a raw byte stream (RawIOBase). Its</span>
<span class="sd">subclasses, BufferedWriter, BufferedReader, and BufferedRWPair buffer</span>
<span class="sd">streams that are readable, writable, and both respectively.</span>
<span class="sd">BufferedRandom provides a buffered interface to random access</span>
<span class="sd">streams. BytesIO is a simple stream of in-memory bytes.</span>
<span class="sd">Another IOBase subclass, TextIOBase, deals with the encoding and decoding</span>
<span class="sd">of streams into text. TextIOWrapper, which extends it, is a buffered text</span>
<span class="sd">interface to a buffered raw stream (`BufferedIOBase`). Finally, StringIO</span>
<span class="sd">is an in-memory stream for text.</span>
<span class="sd">Argument names are not part of the specification, and only the arguments</span>
<span class="sd">of open() are intended to be used as keyword arguments.</span>
<span class="sd">data:</span>
<span class="sd">DEFAULT_BUFFER_SIZE</span>
<span class="sd"> An int containing the default buffer size used by the module's buffered</span>
<span class="sd"> I/O classes. open() uses the file's blksize (as obtained by os.stat) if</span>
<span class="sd"> possible.</span>
<span class="sd">"""</span>
<span class="c1"># New I/O library conforming to PEP 3116.</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"Guido van Rossum <guido@python.org>, "</span>
<span class="s2">"Mike Verdone <mike.verdone@gmail.com>, "</span>
<span class="s2">"Mark Russell <mark.russell@zen.co.uk>, "</span>
<span class="s2">"Antoine Pitrou <solipsis@pitrou.net>, "</span>
<span class="s2">"Amaury Forgeot d'Arc <amauryfa@gmail.com>, "</span>
<span class="s2">"Benjamin Peterson <benjamin@python.org>"</span><span class="p">)</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"BlockingIOError"</span><span class="p">,</span> <span class="s2">"open"</span><span class="p">,</span> <span class="s2">"IOBase"</span><span class="p">,</span> <span class="s2">"RawIOBase"</span><span class="p">,</span> <span class="s2">"FileIO"</span><span class="p">,</span>
<span class="s2">"BytesIO"</span><span class="p">,</span> <span class="s2">"StringIO"</span><span class="p">,</span> <span class="s2">"BufferedIOBase"</span><span class="p">,</span>
<span class="s2">"BufferedReader"</span><span class="p">,</span> <span class="s2">"BufferedWriter"</span><span class="p">,</span> <span class="s2">"BufferedRWPair"</span><span class="p">,</span>
<span class="s2">"BufferedRandom"</span><span class="p">,</span> <span class="s2">"TextIOBase"</span><span class="p">,</span> <span class="s2">"TextIOWrapper"</span><span class="p">,</span>
<span class="s2">"UnsupportedOperation"</span><span class="p">,</span> <span class="s2">"SEEK_SET"</span><span class="p">,</span> <span class="s2">"SEEK_CUR"</span><span class="p">,</span> <span class="s2">"SEEK_END"</span><span class="p">]</span>
<span class="kn">import</span> <span class="nn">_io</span>
<span class="kn">import</span> <span class="nn">abc</span>
<span class="kn">from</span> <span class="nn">_io</span> <span class="k">import</span> <span class="p">(</span><span class="n">DEFAULT_BUFFER_SIZE</span><span class="p">,</span> <span class="ne">BlockingIOError</span><span class="p">,</span> <span class="n">UnsupportedOperation</span><span class="p">,</span>
<span class="nb">open</span><span class="p">,</span> <span class="n">FileIO</span><span class="p">,</span> <span class="n">BytesIO</span><span class="p">,</span> <span class="n">StringIO</span><span class="p">,</span> <span class="n">BufferedReader</span><span class="p">,</span>
<span class="n">BufferedWriter</span><span class="p">,</span> <span class="n">BufferedRWPair</span><span class="p">,</span> <span class="n">BufferedRandom</span><span class="p">,</span>
<span class="n">IncrementalNewlineDecoder</span><span class="p">,</span> <span class="n">TextIOWrapper</span><span class="p">)</span>
<span class="n">OpenWrapper</span> <span class="o">=</span> <span class="n">_io</span><span class="o">.</span><span class="n">open</span> <span class="c1"># for compatibility with _pyio</span>
<span class="c1"># Pretend this exception was created here.</span>
<span class="n">UnsupportedOperation</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">=</span> <span class="s2">"io"</span>
<span class="c1"># for seek()</span>
<span class="n">SEEK_SET</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">SEEK_CUR</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">SEEK_END</span> <span class="o">=</span> <span class="mi">2</span>
<span class="c1"># Declaring ABCs in C is tricky so we do it here.</span>
<span class="c1"># Method descriptions and default implementations are inherited from the C</span>
<span class="c1"># version however.</span>
<div class="viewcode-block" id="IOBase"><a class="viewcode-back" href="../maui.html#io.IOBase">[docs]</a><span class="k">class</span> <span class="nc">IOBase</span><span class="p">(</span><span class="n">_io</span><span class="o">.</span><span class="n">_IOBase</span><span class="p">,</span> <span class="n">metaclass</span><span class="o">=</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">):</span>
<span class="vm">__doc__</span> <span class="o">=</span> <span class="n">_io</span><span class="o">.</span><span class="n">_IOBase</span><span class="o">.</span><span class="vm">__doc__</span></div>
<div class="viewcode-block" id="RawIOBase"><a class="viewcode-back" href="../maui.html#io.RawIOBase">[docs]</a><span class="k">class</span> <span class="nc">RawIOBase</span><span class="p">(</span><span class="n">_io</span><span class="o">.</span><span class="n">_RawIOBase</span><span class="p">,</span> <span class="n">IOBase</span><span class="p">):</span>
<span class="vm">__doc__</span> <span class="o">=</span> <span class="n">_io</span><span class="o">.</span><span class="n">_RawIOBase</span><span class="o">.</span><span class="vm">__doc__</span></div>
<div class="viewcode-block" id="BufferedIOBase"><a class="viewcode-back" href="../maui.html#io.BufferedIOBase">[docs]</a><span class="k">class</span> <span class="nc">BufferedIOBase</span><span class="p">(</span><span class="n">_io</span><span class="o">.</span><span class="n">_BufferedIOBase</span><span class="p">,</span> <span class="n">IOBase</span><span class="p">):</span>
<span class="vm">__doc__</span> <span class="o">=</span> <span class="n">_io</span><span class="o">.</span><span class="n">_BufferedIOBase</span><span class="o">.</span><span class="vm">__doc__</span></div>
<div class="viewcode-block" id="TextIOBase"><a class="viewcode-back" href="../maui.html#io.TextIOBase">[docs]</a><span class="k">class</span> <span class="nc">TextIOBase</span><span class="p">(</span><span class="n">_io</span><span class="o">.</span><span class="n">_TextIOBase</span><span class="p">,</span> <span class="n">IOBase</span><span class="p">):</span>
<span class="vm">__doc__</span> <span class="o">=</span> <span class="n">_io</span><span class="o">.</span><span class="n">_TextIOBase</span><span class="o">.</span><span class="vm">__doc__</span></div>
<span class="n">RawIOBase</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">FileIO</span><span class="p">)</span>
<span class="k">for</span> <span class="n">klass</span> <span class="ow">in</span> <span class="p">(</span><span class="n">BytesIO</span><span class="p">,</span> <span class="n">BufferedReader</span><span class="p">,</span> <span class="n">BufferedWriter</span><span class="p">,</span> <span class="n">BufferedRandom</span><span class="p">,</span>
<span class="n">BufferedRWPair</span><span class="p">):</span>
<span class="n">BufferedIOBase</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">klass</span><span class="p">)</span>
<span class="k">for</span> <span class="n">klass</span> <span class="ow">in</span> <span class="p">(</span><span class="n">StringIO</span><span class="p">,</span> <span class="n">TextIOWrapper</span><span class="p">):</span>
<span class="n">TextIOBase</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">klass</span><span class="p">)</span>
<span class="k">del</span> <span class="n">klass</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">_io</span> <span class="k">import</span> <span class="n">_WindowsConsoleIO</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">RawIOBase</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">_WindowsConsoleIO</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/hex-maui.png" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="../index.html"></a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../maui.html">The Maui Class</a></li>
<li class="toctree-l1"><a class="reference internal" href="../utils.html">Maui Utilities</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2018, Jonathan Ronen, Altuna Akalin.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.2</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>
</body>
</html>
Datasets
Models
