aboutsummaryrefslogtreecommitdiff
path: root/docs/public/paramiko.BufferedFile-class.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/public/paramiko.BufferedFile-class.html')
-rw-r--r--docs/public/paramiko.BufferedFile-class.html554
1 files changed, 0 insertions, 554 deletions
diff --git a/docs/public/paramiko.BufferedFile-class.html b/docs/public/paramiko.BufferedFile-class.html
deleted file mode 100644
index 535c74f..0000000
--- a/docs/public/paramiko.BufferedFile-class.html
+++ /dev/null
@@ -1,554 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!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"></link>
-</head>
-<body bgcolor="white" text="black" link="blue" vlink="#204080"
- alink="#204080">
-
-<!-- =========== START OF NAVBAR =========== -->
-<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="center">
- <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="paramiko-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
- <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
- <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
- <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
- <th class="navbar" width="100%"></th>
- </tr>
-</table>
-<table width="100%" cellpadding="0" cellspacing="0">
- <tr valign="top">
- <td width="100%">
- <font size="-1"><b class="breadcrumbs">
- <a href="paramiko-module.html">Package&nbsp;paramiko</a> ::
- Class&nbsp;BufferedFile
- </b></font></br>
- </td>
- <td><table cellpadding="0" cellspacing="0">
- <tr><td align="right"><font size="-2">[<a href="../private/paramiko.BufferedFile-class.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
- <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="paramiko.BufferedFile-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
- </table></td>
-</tr></table>
-
-<!-- =========== START OF CLASS DESCRIPTION =========== -->
-<h2 class="class">Type BufferedFile</h2>
-
-<pre class="base-tree">
-<a href="__builtin__.object-class.html"><code>object</code></a> --+
- |
- <b>BufferedFile</b>
-</pre><br />
-
-<dl><dt><b>Known Subclasses:</b></dt>
-<dd>
- <a href="paramiko.SFTPFile-class.html"><code>SFTPFile</code></a></dd></dl>
-
-<hr/>
-
-Reusable base class to implement python-style file buffering around a
-simpler stream.
-<hr/>
-
-
-<!-- =========== START OF METHOD SUMMARY =========== -->
-<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
-<tr bgcolor="#70b0f0" class="summary">
- <th colspan="2">Method Summary</th></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>)</span></code>
-</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code>
-</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator
-</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
-<br />
-Returns an iterator that can be used to iterate over the lines in this
-file.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
-<br />
-Close the file.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#flush" class="summary-sig-name"><code>flush</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
-<br />
-Write out any data in the write buffer.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"> str
-</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#next" class="summary-sig-name"><code>next</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
-<br />
-Returns the next line from the input, or raises
-<code>StopIteration</code> when EOF is hit.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"> str
-</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>,
- <span class=summary-sig-arg>size</span>)</span></code>
-<br />
-Read at most <code>size</code> bytes from the file (less if we hit the
-end of the file first).</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"> str
-</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readline" class="summary-sig-name"><code>readline</code></a>(<span class=summary-sig-arg>self</span>,
- <span class=summary-sig-arg>size</span>)</span></code>
-<br />
-Read one entire line from the file.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"> list
-</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readlines" class="summary-sig-name"><code>readlines</code></a>(<span class=summary-sig-arg>self</span>,
- <span class=summary-sig-arg>sizehint</span>)</span></code>
-<br />
-Read all remaining lines using <a
-href="paramiko.BufferedFile-class.html#readline"
-class="link"><code>readline</code></a> and return them as a list.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#seek" class="summary-sig-name"><code>seek</code></a>(<span class=summary-sig-arg>self</span>,
- <span class=summary-sig-arg>offset</span>,
- <span class=summary-sig-arg>whence</span>)</span></code>
-<br />
-Set the file's current position, like stdio's <code>fseek</code>.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"> int
-</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#tell" class="summary-sig-name"><code>tell</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
-<br />
-Return the file's current position.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>,
- <span class=summary-sig-arg>data</span>)</span></code>
-<br />
-Write data to the file.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#writelines" class="summary-sig-name"><code>writelines</code></a>(<span class=summary-sig-arg>self</span>,
- <span class=summary-sig-arg>sequence</span>)</span></code>
-<br />
-Write a sequence of strings to the file.</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator
-</font></td>
- <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#xreadlines" class="summary-sig-name"><code>xreadlines</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
-<br />
-Identical to <code>iter(f)</code>.</td></tr>
-<tr bgcolor="#e8f0f8" class="group">
- <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
-<br />
-x.__delattr__('name') &lt;==&gt; del x.name</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
-<br />
-x.__getattribute__('name') &lt;==&gt; x.name</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
-<br />
-x.__hash__() &lt;==&gt; hash(x)</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
- <span class=summary-sig-arg>S</span>,
- <span class="summary-sig-vararg">...</span>)</span></code>
-<br />
-T.__new__(S, ...) -&gt; a new object with type S, a subtype of T</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
-<br />
-helper for pickle</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
-<br />
-helper for pickle</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
-<br />
-x.__repr__() &lt;==&gt; repr(x)</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
-<br />
-x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
- <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
-<br />
-x.__str__() &lt;==&gt; str(x)</td></tr>
-</table><br />
-
-
-<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
-<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
-<tr bgcolor="#70b0f0" class="summary">
- <th colspan="2">Class Variable Summary</th></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
-<td><b><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></b> = <span title="1">1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
-<td><b><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></b> = <span title="2">2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
-<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
-<td><b><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></b> = <span title="0">0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
-</table><br />
-
-
-<!-- =========== START OF METHOD DETAILS =========== -->
-<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
-<tr bgcolor="#70b0f0" class="details">
- <th colspan="2">Method Details</th></tr>
-</table>
-
-<a name="__iter__"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><span class="sig"><span class="sig-name">__iter__</span>(<span class=sig-arg>self</span>)</span>
- </h3>
- 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.
- <dl><dt></dt><dd>
- <dl><dt><b>Returns:</b></dt>
- <dd>
- an interator.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=iterator)</i>
- </dd>
- </dl>
- <dl><dt><b>Raises:</b></dt>
- <dd><code><b>ValueError</b></code> -
- if the file is closed.
- </dl>
- </dd></dl>
-</td></tr></table>
-
-<a name="close"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span>
- </h3>
- Close the file. Future read and write operations will fail.
- <dl><dt></dt><dd>
- </dd></dl>
-</td></tr></table>
-
-<a name="flush"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><span class="sig"><span class="sig-name">flush</span>(<span class=sig-arg>self</span>)</span>
- </h3>
- Write out any data in the write buffer. This may do nothing if write
- buffering is not turned on.
- <dl><dt></dt><dd>
- </dd></dl>
-</td></tr></table>
-
-<a name="next"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><span class="sig"><span class="sig-name">next</span>(<span class=sig-arg>self</span>)</span>
- </h3>
- Returns the next line from the input, or raises
- <code>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"><code>readline</code></a>.
- <dl><dt></dt><dd>
- <dl><dt><b>Returns:</b></dt>
- <dd>
- a line read from the file.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=str)</i>
- </dd>
- </dl>
- <dl><dt><b>Raises:</b></dt>
- <dd><code><b>StopIteration</b></code> -
- when the end of the file is reached.
- </dl>
- </dd></dl>
-</td></tr></table>
-
-<a name="read"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><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>
- 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.
- <dl><dt></dt><dd>
- <dl><dt><b>Parameters:</b></dt>
- <dd><code><b>size</b></code> -
- maximum number of bytes to read.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=int)</i>
- </dd>
- </dl>
- <dl><dt><b>Returns:</b></dt>
- <dd>
- data read from the file, or an empty string if EOF was
- encountered immediately.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=str)</i>
- </dd>
- </dl>
- </dd></dl>
-</td></tr></table>
-
-<a name="readline"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><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>
- 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.
- <dl><dt></dt><dd>
- <dl><dt><b>Parameters:</b></dt>
- <dd><code><b>size</b></code> -
- maximum length of returned string.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=int)</i>
- </dd>
- </dl>
- <dl><dt><b>Returns:</b></dt>
- <dd>
- next line of the file, or an empty string if the end of the
- file has been reached.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=str)</i>
- </dd>
- </dl>
-<p><b>Note:</b> Unlike stdio's <code>fgets()</code>, the returned string contains null
-characters (<code>'\0'</code>) if they occurred in the input.
-</p>
-
- </dd></dl>
-</td></tr></table>
-
-<a name="readlines"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><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>
- Read all remaining lines using <a
- href="paramiko.BufferedFile-class.html#readline"
- class="link"><code>readline</code></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.
- <dl><dt></dt><dd>
- <dl><dt><b>Parameters:</b></dt>
- <dd><code><b>sizehint</b></code> -
- desired maximum number of bytes to read.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=int)</i>
- </dd>
- </dl>
- <dl><dt><b>Returns:</b></dt>
- <dd>
- list of lines read from the file.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=list)</i>
- </dd>
- </dl>
- </dd></dl>
-</td></tr></table>
-
-<a name="seek"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><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>
- Set the file's current position, like stdio's <code>fseek</code>.
- Not all file objects support seeking.
- <dl><dt></dt><dd>
- <dl><dt><b>Parameters:</b></dt>
- <dd><code><b>offset</b></code> -
- position to move to within the file, relative to
- <code>whence</code>.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=int)</i>
- <dd><code><b>whence</b></code> -
- type of movement: 0 = absolute; 1 = relative to the current
- position; 2 = relative to the end of the file.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=int)</i>
- </dd>
- </dl>
- <dl><dt><b>Raises:</b></dt>
- <dd><code><b>IOError</b></code> -
- if the file doesn't support random access.
- </dl>
-<p><b>Note:</b> 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>
-
- </dd></dl>
-</td></tr></table>
-
-<a name="tell"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><span class="sig"><span class="sig-name">tell</span>(<span class=sig-arg>self</span>)</span>
- </h3>
- 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.
- <dl><dt></dt><dd>
- <dl><dt><b>Returns:</b></dt>
- <dd>
- file position (in bytes).
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=int)</i>
- </dd>
- </dl>
- </dd></dl>
-</td></tr></table>
-
-<a name="write"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><span class="sig"><span class="sig-name">write</span>(<span class=sig-arg>self</span>,
- <span class=sig-arg>data</span>)</span>
- </h3>
- 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"><code>flush</code></a> or <a
- href="paramiko.BufferedFile-class.html#close"
- class="link"><code>close</code></a> to force buffered data to be
- written out.)
- <dl><dt></dt><dd>
- <dl><dt><b>Parameters:</b></dt>
- <dd><code><b>data</b></code> -
- data to write.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=str)</i>
- </dd>
- </dl>
- </dd></dl>
-</td></tr></table>
-
-<a name="writelines"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><span class="sig"><span class="sig-name">writelines</span>(<span class=sig-arg>self</span>,
- <span class=sig-arg>sequence</span>)</span>
- </h3>
- 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"><code>readlines</code></a>; <code>writelines</code> does
- not add line separators.)
- <dl><dt></dt><dd>
- <dl><dt><b>Parameters:</b></dt>
- <dd><code><b>sequence</b></code> -
- an iterable sequence of strings.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=sequence)</i>
- </dd>
- </dl>
- </dd></dl>
-</td></tr></table>
-
-<a name="xreadlines"></a>
-<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
- <h3><span class="sig"><span class="sig-name">xreadlines</span>(<span class=sig-arg>self</span>)</span>
- </h3>
- Identical to <code>iter(f)</code>. This is a deprecated file
- interface that predates python iterator support.
- <dl><dt></dt><dd>
- <dl><dt><b>Returns:</b></dt>
- <dd>
- an iterator.
- <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
- (type=iterator)</i>
- </dd>
- </dl>
- </dd></dl>
-</td></tr></table>
-<br />
-
-
-<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
-<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
-<tr bgcolor="#70b0f0" class="details">
- <th colspan="2">Class Variable Details</th></tr>
-</table>
-<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
-<a name="SEEK_CUR"></a>
-<h3>SEEK_CUR</h3>
-<dl>
- <dt></dt>
- <dd>
- <dl>
- <dt><b>Type:</b></dt>
- <dd>
- <code>int</code>
-
- </dd>
-<span title="1"> <dt><b>Value:</b></dt>
- <dd><table><tr><td>
-<pre class="variable">
-1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
- </td></tr></table></dd>
-</span> </dl>
- </dd>
-</dl></td></tr></table>
-<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
-<a name="SEEK_END"></a>
-<h3>SEEK_END</h3>
-<dl>
- <dt></dt>
- <dd>
- <dl>
- <dt><b>Type:</b></dt>
- <dd>
- <code>int</code>
-
- </dd>
-<span title="2"> <dt><b>Value:</b></dt>
- <dd><table><tr><td>
-<pre class="variable">
-2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
- </td></tr></table></dd>
-</span> </dl>
- </dd>
-</dl></td></tr></table>
-<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
-<a name="SEEK_SET"></a>
-<h3>SEEK_SET</h3>
-<dl>
- <dt></dt>
- <dd>
- <dl>
- <dt><b>Type:</b></dt>
- <dd>
- <code>int</code>
-
- </dd>
-<span title="0"> <dt><b>Value:</b></dt>
- <dd><table><tr><td>
-<pre class="variable">
-0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
- </td></tr></table></dd>
-</span> </dl>
- </dd>
-</dl></td></tr></table>
-<br />
-
-
-<!-- =========== START OF NAVBAR =========== -->
-<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="center">
- <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="paramiko-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
- <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
- <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
- <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
- <th class="navbar" width="100%"></th>
- </tr>
-</table>
-
-<table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr>
- <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</font></td>
- <td align="right"><a href="http://epydoc.sourceforge.net"
- ><font size="-2">http://epydoc.sf.net</font></a></td>
- </tr>
-</table>
-</body>
-</html>