<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>PIL.ContainerIO — Pillow (PIL fork) 2.2.0 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.2.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="Pillow (PIL fork) 2.2.0 documentation" href="../../index.html" />
<link rel="up" title="Module code" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">Pillow (PIL fork) 2.2.0 documentation</a> »</li>
<li><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for PIL.ContainerIO</h1><div class="highlight"><pre>
<span class="c">#</span>
<span class="c"># The Python Imaging Library.</span>
<span class="c"># $Id$</span>
<span class="c">#</span>
<span class="c"># a class to read from a container file</span>
<span class="c">#</span>
<span class="c"># History:</span>
<span class="c"># 1995-06-18 fl Created</span>
<span class="c"># 1995-09-07 fl Added readline(), readlines()</span>
<span class="c">#</span>
<span class="c"># Copyright (c) 1997-2001 by Secret Labs AB</span>
<span class="c"># Copyright (c) 1995 by Fredrik Lundh</span>
<span class="c">#</span>
<span class="c"># See the README file for information on usage and redistribution.</span>
<span class="c">#</span>
<span class="c">##</span>
<span class="c"># A file object that provides read access to a part of an existing</span>
<span class="c"># file (for example a TAR file).</span>
<div class="viewcode-block" id="ContainerIO"><a class="viewcode-back" href="../../PIL.html#PIL.ContainerIO.ContainerIO">[docs]</a><span class="k">class</span> <span class="nc">ContainerIO</span><span class="p">:</span>
<span class="c">##</span>
<span class="c"># Create file object.</span>
<span class="c">#</span>
<span class="c"># @param file Existing file.</span>
<span class="c"># @param offset Start of region, in bytes.</span>
<span class="c"># @param length Size of region, in bytes.</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">file</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">length</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fh</span> <span class="o">=</span> <span class="nb">file</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pos</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">offset</span> <span class="o">=</span> <span class="n">offset</span>
<span class="bp">self</span><span class="o">.</span><span class="n">length</span> <span class="o">=</span> <span class="n">length</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fh</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">offset</span><span class="p">)</span>
<span class="c">##</span>
<span class="c"># Always false.</span>
<div class="viewcode-block" id="ContainerIO.isatty"><a class="viewcode-back" href="../../PIL.html#PIL.ContainerIO.ContainerIO.isatty">[docs]</a> <span class="k">def</span> <span class="nf">isatty</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="mi">0</span>
<span class="c">##</span>
<span class="c"># Move file pointer.</span>
<span class="c">#</span>
<span class="c"># @param offset Offset in bytes.</span>
<span class="c"># @param mode Starting position. Use 0 for beginning of region, 1</span>
<span class="c"># for current offset, and 2 for end of region. You cannot move</span>
<span class="c"># the pointer outside the defined region.</span>
</div>
<div class="viewcode-block" id="ContainerIO.seek"><a class="viewcode-back" href="../../PIL.html#PIL.ContainerIO.ContainerIO.seek">[docs]</a> <span class="k">def</span> <span class="nf">seek</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">mode</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
<span class="k">if</span> <span class="n">mode</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pos</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pos</span> <span class="o">+</span> <span class="n">offset</span>
<span class="k">elif</span> <span class="n">mode</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pos</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">length</span> <span class="o">+</span> <span class="n">offset</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pos</span> <span class="o">=</span> <span class="n">offset</span>
<span class="c"># clamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pos</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pos</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">length</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fh</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">offset</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">pos</span><span class="p">)</span>
<span class="c">##</span>
<span class="c"># Get current file pointer.</span>
<span class="c">#</span>
<span class="c"># @return Offset from start of region, in bytes.</span>
</div>
<div class="viewcode-block" id="ContainerIO.tell"><a class="viewcode-back" href="../../PIL.html#PIL.ContainerIO.ContainerIO.tell">[docs]</a> <span class="k">def</span> <span class="nf">tell</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">pos</span>
<span class="c">##</span>
<span class="c"># Read data.</span>
<span class="c">#</span>
<span class="c"># @def read(bytes=0)</span>
<span class="c"># @param bytes Number of bytes to read. If omitted or zero,</span>
<span class="c"># read until end of region.</span>
<span class="c"># @return An 8-bit string.</span>
</div>
<div class="viewcode-block" id="ContainerIO.read"><a class="viewcode-back" href="../../PIL.html#PIL.ContainerIO.ContainerIO.read">[docs]</a> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
<span class="k">if</span> <span class="n">n</span><span class="p">:</span>
<span class="n">n</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">length</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">pos</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">n</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">length</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">pos</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">n</span><span class="p">:</span> <span class="c"># EOF</span>
<span class="k">return</span> <span class="s">""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pos</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pos</span> <span class="o">+</span> <span class="n">n</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">fh</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">n</span><span class="p">)</span>
<span class="c">##</span>
<span class="c"># Read a line of text.</span>
<span class="c">#</span>
<span class="c"># @return An 8-bit string.</span>
</div>
<div class="viewcode-block" id="ContainerIO.readline"><a class="viewcode-back" href="../../PIL.html#PIL.ContainerIO.ContainerIO.readline">[docs]</a> <span class="k">def</span> <span class="nf">readline</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="s">""</span>
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="p">:</span>
<span class="k">break</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span> <span class="o">+</span> <span class="n">c</span>
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">return</span> <span class="n">s</span>
<span class="c">##</span>
<span class="c"># Read multiple lines of text.</span>
<span class="c">#</span>
<span class="c"># @return A list of 8-bit strings.</span>
</div>
<div class="viewcode-block" id="ContainerIO.readlines"><a class="viewcode-back" href="../../PIL.html#PIL.ContainerIO.ContainerIO.readlines">[docs]</a> <span class="k">def</span> <span class="nf">readlines</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">l</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">s</span><span class="p">:</span>
<span class="k">break</span>
<span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">return</span> <span class="n">l</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<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>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">Pillow (PIL fork) 2.2.0 documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 1997-2011 by Secret Labs AB, 1995-2011 by Fredrik Lundh, 2010-2013 Alex Clark.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
distrib
>
Mageia
>
4
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
1b8cdcd72f762d0ed6f2f33d2c69f0d6
>
files
>
38
