diff options
Diffstat (limited to 'docs/paramiko.BufferedFile-class.html')
| -rw-r--r-- | docs/paramiko.BufferedFile-class.html | 856 |
1 files changed, 0 insertions, 856 deletions
diff --git a/docs/paramiko.BufferedFile-class.html b/docs/paramiko.BufferedFile-class.html deleted file mode 100644 index 13a3c66..0000000 --- a/docs/paramiko.BufferedFile-class.html +++ /dev/null @@ -1,856 +0,0 @@ -<?xml version="1.0" encoding="ascii"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> -<head> - <title>paramiko.BufferedFile</title> - <link rel="stylesheet" href="epydoc.css" type="text/css" /> - <script type="text/javascript" src="epydoc.js"></script> -</head> - -<body bgcolor="white" text="black" link="blue" vlink="#204080" - alink="#204080"> -<!-- ==================== NAVIGATION BAR ==================== --> -<table class="navbar" border="0" width="100%" cellpadding="0" - bgcolor="#a0c0ff" cellspacing="0"> - <tr valign="middle"> - <!-- Home link --> - <th> <a - href="paramiko-module.html">Home</a> </th> - - <!-- Tree link --> - <th> <a - href="module-tree.html">Trees</a> </th> - - <!-- Index link --> - <th> <a - href="identifier-index.html">Indices</a> </th> - - <!-- Help link --> - <th> <a - href="help.html">Help</a> </th> - - <th class="navbar" width="100%"></th> - </tr> -</table> -<table width="100%" cellpadding="0" cellspacing="0"> - <tr valign="top"> - <td width="100%"> - <span class="breadcrumbs"> - <a href="paramiko-module.html">Package paramiko</a> :: - Class BufferedFile - </span> - </td> - <td> - <table cellpadding="0" cellspacing="0"> - <!-- hide/show private --> - <tr><td align="right"><span class="options" - >[<a href="frames.html" target="_top">frames</a - >] | <a href="paramiko.BufferedFile-class.html" - target="_top">no frames</a>]</span></td></tr> - </table> - </td> - </tr> -</table> -<!-- ==================== CLASS DESCRIPTION ==================== --> -<h1 class="epydoc">Class BufferedFile</h1><p class="nomargin-top"><span class="codelink"><a href="paramiko-pysrc.html#BufferedFile">source code</a></span></p> -<pre class="base-tree"> -object --+ - | - <strong class="uidshort">BufferedFile</strong> -</pre> - -<dl><dt>Known Subclasses:</dt> -<dd> - <ul class="subclass-list"> -<li class="private">ChannelFile</li><li>, <a href="paramiko.SFTPFile-class.html">SFTPFile</a></li> </ul> -</dd></dl> - -<hr /> -<p>Reusable base class to implement python-style file buffering around a - simpler stream.</p> - -<!-- ==================== INSTANCE METHODS ==================== --> -<a name="section-InstanceMethods"></a> -<table class="summary" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td align="left" colspan="2" class="table-header"> - <span class="table-header">Instance Methods</span></td> -</tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span></td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br /> - x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">iterator</span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__iter__" class="summary-sig-name">__iter__</a>(<span class="summary-sig-arg">self</span>)</span><br /> - Returns an iterator that can be used to iterate over the lines in - this file.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br /> - Close the file.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#flush" class="summary-sig-name">flush</a>(<span class="summary-sig-arg">self</span>)</span><br /> - Write out any data in the write buffer.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">str</span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#next" class="summary-sig-name">next</a>(<span class="summary-sig-arg">self</span>)</span><br /> - Returns the next line from the input, or raises <code - class="link">StopIteration</code> when EOF is hit.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">str</span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#read" class="summary-sig-name">read</a>(<span class="summary-sig-arg">self</span>, - <span class="summary-sig-arg">size</span>=<span class="summary-sig-default">None</span>)</span><br /> - Read at most <code>size</code> bytes from the file (less if we hit - the end of the file first).</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">str</span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readline" class="summary-sig-name">readline</a>(<span class="summary-sig-arg">self</span>, - <span class="summary-sig-arg">size</span>=<span class="summary-sig-default">None</span>)</span><br /> - Read one entire line from the file.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">list</span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readlines" class="summary-sig-name">readlines</a>(<span class="summary-sig-arg">self</span>, - <span class="summary-sig-arg">sizehint</span>=<span class="summary-sig-default">None</span>)</span><br /> - Read all remaining lines using <a - href="paramiko.BufferedFile-class.html#readline" - class="link">readline</a> and return them as a list.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#seek" class="summary-sig-name">seek</a>(<span class="summary-sig-arg">self</span>, - <span class="summary-sig-arg">offset</span>, - <span class="summary-sig-arg">whence</span>=<span class="summary-sig-default">0</span>)</span><br /> - Set the file's current position, like stdio's <code>fseek</code>.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">int</span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#tell" class="summary-sig-name">tell</a>(<span class="summary-sig-arg">self</span>)</span><br /> - Return the file's current position.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>, - <span class="summary-sig-arg">data</span>)</span><br /> - Write data to the file.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#writelines" class="summary-sig-name">writelines</a>(<span class="summary-sig-arg">self</span>, - <span class="summary-sig-arg">sequence</span>)</span><br /> - Write a sequence of strings to the file.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">iterator</span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#xreadlines" class="summary-sig-name">xreadlines</a>(<span class="summary-sig-arg">self</span>)</span><br /> - Identical to <code>iter(f)</code>.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> - <tr> - <td colspan="2" class="summary"> - <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: - <code>__delattr__</code>, - <code>__format__</code>, - <code>__getattribute__</code>, - <code>__hash__</code>, - <code>__new__</code>, - <code>__reduce__</code>, - <code>__reduce_ex__</code>, - <code>__repr__</code>, - <code>__setattr__</code>, - <code>__sizeof__</code>, - <code>__str__</code>, - <code>__subclasshook__</code> - </p> - </td> - </tr> -</table> -<!-- ==================== CLASS VARIABLES ==================== --> -<a name="section-ClassVariables"></a> -<table class="summary" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td align="left" colspan="2" class="table-header"> - <span class="table-header">Class Variables</span></td> -</tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="FLAG_APPEND"></a><span class="summary-name">FLAG_APPEND</span> = <code title="4">4</code> - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="FLAG_BINARY"></a><span class="summary-name">FLAG_BINARY</span> = <code title="16">16</code> - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="FLAG_BUFFERED"></a><span class="summary-name">FLAG_BUFFERED</span> = <code title="32">32</code> - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="FLAG_LINE_BUFFERED"></a><span class="summary-name">FLAG_LINE_BUFFERED</span> = <code title="64">64</code> - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="FLAG_READ"></a><span class="summary-name">FLAG_READ</span> = <code title="1">1</code> - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="FLAG_UNIVERSAL_NEWLINE"></a><span class="summary-name">FLAG_UNIVERSAL_NEWLINE</span> = <code title="128">128</code> - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="FLAG_WRITE"></a><span class="summary-name">FLAG_WRITE</span> = <code title="2">2</code> - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="SEEK_CUR"></a><span class="summary-name">SEEK_CUR</span> = <code title="1">1</code> - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="SEEK_END"></a><span class="summary-name">SEEK_END</span> = <code title="2">2</code> - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <a name="SEEK_SET"></a><span class="summary-name">SEEK_SET</span> = <code title="0">0</code> - </td> - </tr> -</table> -<!-- ==================== PROPERTIES ==================== --> -<a name="section-Properties"></a> -<table class="summary" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td align="left" colspan="2" class="table-header"> - <span class="table-header">Properties</span></td> -</tr> - <tr> - <td colspan="2" class="summary"> - <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: - <code>__class__</code> - </p> - </td> - </tr> -</table> -<!-- ==================== METHOD DETAILS ==================== --> -<a name="section-MethodDetails"></a> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td align="left" colspan="2" class="table-header"> - <span class="table-header">Method Details</span></td> -</tr> -</table> -<a name="__init__"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span> - <br /><em class="fname">(Constructor)</em> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>x.__init__(...) initializes x; see x.__class__.__doc__ for - signature</p> - <dl class="fields"> - <dt>Overrides: - object.__init__ - <dd><em class="note">(inherited documentation)</em></dd> - </dt> - </dl> -</td></tr></table> -</div> -<a name="__iter__"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">__iter__</span>(<span class="sig-arg">self</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Returns an iterator that can be used to iterate over the lines in this - file. This iterator happens to return the file itself, since a file is - its own iterator.</p> - <dl class="fields"> - <dt>Returns: iterator</dt> - <dd>an interator.</dd> - <dt>Raises:</dt> - <dd><ul class="nomargin-top"> - <li><code><strong class='fraise'>ValueError</strong></code> - if the file is closed.</li> - </ul></dd> - </dl> -</td></tr></table> -</div> -<a name="close"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">close</span>(<span class="sig-arg">self</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Close the file. Future read and write operations will fail.</p> - <dl class="fields"> - </dl> -</td></tr></table> -</div> -<a name="flush"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">flush</span>(<span class="sig-arg">self</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Write out any data in the write buffer. This may do nothing if write - buffering is not turned on.</p> - <dl class="fields"> - </dl> -</td></tr></table> -</div> -<a name="next"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">next</span>(<span class="sig-arg">self</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Returns the next line from the input, or raises <code - class="link">StopIteration</code> when EOF is hit. Unlike python file - objects, it's okay to mix calls to <code>next</code> and <a - href="paramiko.BufferedFile-class.html#readline" - class="link">readline</a>.</p> - <dl class="fields"> - <dt>Returns: str</dt> - <dd>a line read from the file.</dd> - <dt>Raises:</dt> - <dd><ul class="nomargin-top"> - <li><code><strong class='fraise'>StopIteration</strong></code> - when the end of the file is reached.</li> - </ul></dd> - </dl> -</td></tr></table> -</div> -<a name="read"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">read</span>(<span class="sig-arg">self</span>, - <span class="sig-arg">size</span>=<span class="sig-default">None</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Read at most <code>size</code> bytes from the file (less if we hit the - end of the file first). If the <code>size</code> argument is negative or - omitted, read all the remaining data in the file.</p> - <dl class="fields"> - <dt>Parameters:</dt> - <dd><ul class="nomargin-top"> - <li><strong class="pname"><code>size</code></strong> (int) - maximum number of bytes to read</li> - </ul></dd> - <dt>Returns: str</dt> - <dd>data read from the file, or an empty string if EOF was - encountered immediately</dd> - </dl> -</td></tr></table> -</div> -<a name="readline"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">readline</span>(<span class="sig-arg">self</span>, - <span class="sig-arg">size</span>=<span class="sig-default">None</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Read one entire line from the file. A trailing newline character is - kept in the string (but may be absent when a file ends with an incomplete - line). If the size argument is present and non-negative, it is a maximum - byte count (including the trailing newline) and an incomplete line may be - returned. An empty string is returned only when EOF is encountered - immediately.</p> - <dl class="fields"> - <dt>Parameters:</dt> - <dd><ul class="nomargin-top"> - <li><strong class="pname"><code>size</code></strong> (int) - maximum length of returned string.</li> - </ul></dd> - <dt>Returns: str</dt> - <dd>next line of the file, or an empty string if the end of the file - has been reached.</dd> - </dl> -<div class="fields"> <p><strong>Note:</strong> - Unlike stdio's <code>fgets()</code>, the returned string contains - null characters (<code>'\0'</code>) if they occurred in the input. - </p> -</div></td></tr></table> -</div> -<a name="readlines"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">readlines</span>(<span class="sig-arg">self</span>, - <span class="sig-arg">sizehint</span>=<span class="sig-default">None</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Read all remaining lines using <a - href="paramiko.BufferedFile-class.html#readline" - class="link">readline</a> and return them as a list. If the optional - <code>sizehint</code> argument is present, instead of reading up to EOF, - whole lines totalling approximately sizehint bytes (possibly after - rounding up to an internal buffer size) are read.</p> - <dl class="fields"> - <dt>Parameters:</dt> - <dd><ul class="nomargin-top"> - <li><strong class="pname"><code>sizehint</code></strong> (int) - desired maximum number of bytes to read.</li> - </ul></dd> - <dt>Returns: list</dt> - <dd>list of lines read from the file.</dd> - </dl> -</td></tr></table> -</div> -<a name="seek"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">seek</span>(<span class="sig-arg">self</span>, - <span class="sig-arg">offset</span>, - <span class="sig-arg">whence</span>=<span class="sig-default">0</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Set the file's current position, like stdio's <code>fseek</code>. Not - all file objects support seeking.</p> - <dl class="fields"> - <dt>Parameters:</dt> - <dd><ul class="nomargin-top"> - <li><strong class="pname"><code>offset</code></strong> (int) - position to move to within the file, relative to - <code>whence</code>.</li> - <li><strong class="pname"><code>whence</code></strong> (int) - type of movement: 0 = absolute; 1 = relative to the current - position; 2 = relative to the end of the file.</li> - </ul></dd> - <dt>Raises:</dt> - <dd><ul class="nomargin-top"> - <li><code><strong class='fraise'>IOError</strong></code> - if the file doesn't support random access.</li> - </ul></dd> - </dl> -<div class="fields"> <p><strong>Note:</strong> - If a file is opened in append mode (<code>'a'</code> or - <code>'a+'</code>), any seek operations will be undone at the next - write (as the file position will move back to the end of the file). - </p> -</div></td></tr></table> -</div> -<a name="tell"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">tell</span>(<span class="sig-arg">self</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Return the file's current position. This may not be accurate or - useful if the underlying file doesn't support random access, or was - opened in append mode.</p> - <dl class="fields"> - <dt>Returns: int</dt> - <dd>file position (in bytes).</dd> - </dl> -</td></tr></table> -</div> -<a name="write"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>, - <span class="sig-arg">data</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Write data to the file. If write buffering is on - (<code>bufsize</code> was specified and non-zero), some or all of the - data may not actually be written yet. (Use <a - href="paramiko.BufferedFile-class.html#flush" class="link">flush</a> or - <a href="paramiko.BufferedFile-class.html#close" class="link">close</a> - to force buffered data to be written out.)</p> - <dl class="fields"> - <dt>Parameters:</dt> - <dd><ul class="nomargin-top"> - <li><strong class="pname"><code>data</code></strong> (str) - data to write.</li> - </ul></dd> - </dl> -</td></tr></table> -</div> -<a name="writelines"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">writelines</span>(<span class="sig-arg">self</span>, - <span class="sig-arg">sequence</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Write a sequence of strings to the file. The sequence can be any - iterable object producing strings, typically a list of strings. (The - name is intended to match <a - href="paramiko.BufferedFile-class.html#readlines" - class="link">readlines</a>; <code>writelines</code> does not add line - separators.)</p> - <dl class="fields"> - <dt>Parameters:</dt> - <dd><ul class="nomargin-top"> - <li><strong class="pname"><code>sequence</code></strong> (sequence) - an iterable sequence of strings.</li> - </ul></dd> - </dl> -</td></tr></table> -</div> -<a name="xreadlines"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">xreadlines</span>(<span class="sig-arg">self</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.file-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Identical to <code>iter(f)</code>. This is a deprecated file - interface that predates python iterator support.</p> - <dl class="fields"> - <dt>Returns: iterator</dt> - <dd>an iterator.</dd> - </dl> -</td></tr></table> -</div> -<br /> -<!-- ==================== NAVIGATION BAR ==================== --> -<table class="navbar" border="0" width="100%" cellpadding="0" - bgcolor="#a0c0ff" cellspacing="0"> - <tr valign="middle"> - <!-- Home link --> - <th> <a - href="paramiko-module.html">Home</a> </th> - - <!-- Tree link --> - <th> <a - href="module-tree.html">Trees</a> </th> - - <!-- Index link --> - <th> <a - href="identifier-index.html">Indices</a> </th> - - <!-- Help link --> - <th> <a - href="help.html">Help</a> </th> - - <th class="navbar" width="100%"></th> - </tr> -</table> -<table border="0" cellpadding="0" cellspacing="0" width="100%%"> - <tr> - <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Mon May 23 13:50:03 2011 - </td> - <td align="right" class="footer"> - <a target="mainFrame" href="http://epydoc.sourceforge.net" - >http://epydoc.sourceforge.net</a> - </td> - </tr> -</table> - -<script type="text/javascript"> - <!-- - // Private objects are initially displayed (because if - // javascript is turned off then we want them to be - // visible); but by default, we want to hide them. So hide - // them unless we have a cookie that says to show them. - checkCookie(); - // --> -</script> -</body> -</html> |