diff options
Diffstat (limited to 'docs/paramiko.SFTPHandle-class.html')
| -rw-r--r-- | docs/paramiko.SFTPHandle-class.html | 473 |
1 files changed, 473 insertions, 0 deletions
diff --git a/docs/paramiko.SFTPHandle-class.html b/docs/paramiko.SFTPHandle-class.html new file mode 100644 index 0000000..63a4491 --- /dev/null +++ b/docs/paramiko.SFTPHandle-class.html @@ -0,0 +1,473 @@ +<?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.SFTPHandle</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 SFTPHandle + </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.SFTPHandle-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class SFTPHandle</h1><p class="nomargin-top"><span class="codelink"><a href="paramiko-pysrc.html#SFTPHandle">source code</a></span></p> +<pre class="base-tree"> +object --+ + | + <strong class="uidshort">SFTPHandle</strong> +</pre> + +<hr /> +<p>Abstract object representing a handle to an open file (or folder) in + an SFTP server implementation. Each handle has a string representation + used by the client to refer to the underlying file.</p> + <p>Server implementations can (and should) subclass SFTPHandle to + implement features of a file handle, like <a + href="paramiko.SFTPHandle-class.html#stat" class="link">stat</a> or <a + href="paramiko.SFTPHandle-class.html#chattr" class="link">chattr</a>.</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 href="paramiko.SFTPHandle-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">0</span>)</span><br /> + Create a new file handle representing a local file being served over + SFTP.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.sftp_handle-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.SFTPHandle-class.html#chattr" class="summary-sig-name">chattr</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">attr</span>)</span><br /> + Change the attributes of this file.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.sftp_handle-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.SFTPHandle-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br /> + When a client closes a file, this method is called on the handle.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.sftp_handle-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.SFTPHandle-class.html#read" class="summary-sig-name">read</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">offset</span>, + <span class="summary-sig-arg">length</span>)</span><br /> + Read up to <code>length</code> bytes from this file, starting at + position <code>offset</code>.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.sftp_handle-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"><a href="paramiko.SFTPAttributes-class.html" + class="link">SFTPAttributes</a> <i>or error code</i></span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#stat" class="summary-sig-name">stat</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Return an <a href="paramiko.SFTPAttributes-class.html" + class="link">SFTPAttributes</a> object referring to this open file, + or an error code.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.sftp_handle-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.SFTPHandle-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">offset</span>, + <span class="summary-sig-arg">data</span>)</span><br /> + Write <code>data</code> into this file at position + <code>offset</code>.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.sftp_handle-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>__getattribute__</code>, + <code>__hash__</code>, + <code>__new__</code>, + <code>__reduce__</code>, + <code>__reduce_ex__</code>, + <code>__repr__</code>, + <code>__setattr__</code>, + <code>__str__</code> + </p> + </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 class="sig-arg">flags</span>=<span class="sig-default">0</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.sftp_handle-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Create a new file handle representing a local file being served over + SFTP. If <code>flags</code> is passed in, it's used to determine if the + file is open in append mode.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>flags</code></strong> (int) - optional flags as passed to <a + href="paramiko.SFTPServerInterface-class.html#open" + class="link">SFTPServerInterface.open</a></li> + </ul></dd> + <dt>Overrides: + object.__init__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="chattr"></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">chattr</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">attr</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.sftp_handle-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Change the attributes of this file. The <code>attr</code> object will + contain only those fields provided by the client in its request, so you + should check for the presence of fields before using them.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>attr</code></strong> (<a href="paramiko.SFTPAttributes-class.html" + class="link">SFTPAttributes</a>) - the attributes to change on this file.</li> + </ul></dd> + <dt>Returns: int</dt> + <dd>an error code like SFTP_OK.</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.sftp_handle-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>When a client closes a file, this method is called on the handle. + Normally you would use this method to close the underlying OS level file + object(s).</p> + <p>The default implementation checks for attributes on <code>self</code> + named <code>readfile</code> and/or <code>writefile</code>, and if either + or both are present, their <code>close()</code> methods are called. This + means that if you are using the default implementations of <a + href="paramiko.SFTPHandle-class.html#read" class="link">read</a> and <a + href="paramiko.SFTPHandle-class.html#write" class="link">write</a>, this + method's default implementation should be fine also.</p> + <dl class="fields"> + </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">offset</span>, + <span class="sig-arg">length</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.sftp_handle-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Read up to <code>length</code> bytes from this file, starting at + position <code>offset</code>. The offset may be a python long, since + SFTP allows it to be 64 bits.</p> + <p>If the end of the file has been reached, this method may return an + empty string to signify EOF, or it may also return SFTP_EOF.</p> + <p>The default implementation checks for an attribute on + <code>self</code> named <code>readfile</code>, and if present, performs + the read operation on the python file-like object found there. (This is + meant as a time saver for the common case where you are wrapping a python + file object.)</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>offset</code></strong> (int or long) - position in the file to start reading from.</li> + <li><strong class="pname"><code>length</code></strong> (int) - number of bytes to attempt to read.</li> + </ul></dd> + <dt>Returns: str</dt> + <dd>data read from the file, or an SFTP error code.</dd> + </dl> +</td></tr></table> +</div> +<a name="stat"></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">stat</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.sftp_handle-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Return an <a href="paramiko.SFTPAttributes-class.html" + class="link">SFTPAttributes</a> object referring to this open file, or an + error code. This is equivalent to <a + href="paramiko.SFTPServerInterface-class.html#stat" + class="link">SFTPServerInterface.stat</a>, except it's called on an open + file instead of a path.</p> + <dl class="fields"> + <dt>Returns: <a href="paramiko.SFTPAttributes-class.html" + class="link">SFTPAttributes</a> <i>or error code</i></dt> + <dd>an attributes object for the given file, or an SFTP error code + (like SFTP_PERMISSION_DENIED).</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">offset</span>, + <span class="sig-arg">data</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.sftp_handle-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Write <code>data</code> into this file at position + <code>offset</code>. Extending the file past its original end is + expected. Unlike python's normal <code>write()</code> methods, this + method cannot do a partial write: it must write all of <code>data</code> + or else return an error.</p> + <p>The default implementation checks for an attribute on + <code>self</code> named <code>writefile</code>, and if present, performs + the write operation on the python file-like object found there. The + attribute is named differently from <code>readfile</code> to make it easy + to implement read-only (or write-only) files, but if both attributes are + present, they should refer to the same file.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>offset</code></strong> (int or long) - position in the file to start reading from.</li> + <li><strong class="pname"><code>data</code></strong> (str) - data to write into the file.</li> + </ul></dd> + <dt>Returns:</dt> + <dd>an SFTP error code like SFTP_OK.</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 Sun Jul 6 18:30:29 2008 + </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> |