pcJc @ sP d Z d d k Z d d k Td d k Td e f d YZ d d k l Z d S( s7
Abstraction of an SFTP file handle (for server mode).
iN( t *t
SFTPHandlec B sk e Z d Z d d Z d Z d Z d Z d Z d Z d Z d Z
d
Z d Z RS( s^
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.
Server implementations can (and should) subclass SFTPHandle to implement
features of a file handle, like L{stat} or L{chattr}.
i c C s( | | _ d | _ h | _ d | _ d S( s2
Create a new file handle representing a local file being served over
SFTP. If C{flags} is passed in, it's used to determine if the file
is open in append mode.
@param flags: optional flags as passed to L{SFTPServerInterface.open}
@type flags: int
N( t _SFTPHandle__flagst Nonet _SFTPHandle__namet _SFTPHandle__filest _SFTPHandle__tell( t selft flags( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyt __init__& s c C s^ t | d d } | d j o | i n t | d d } | d j o | i n d S( s$
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).
The default implementation checks for attributes on C{self} named
C{readfile} and/or C{writefile}, and if either or both are present,
their C{close()} methods are called. This means that if you are
using the default implementations of L{read} and L{write}, this
method's default implementation should be fine also.
t readfilet writefileN( t getattrR t close( R R
R ( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyR
5 s
c C s t | d d } | d j o t Sy` | i d j o | i | _ n | | i j o | i | | | _ n | i | } Wn+ t j
o } d | _ t i | i
SX| i t | 7_ | S( s
Read up to C{length} bytes from this file, starting at position
C{offset}. The offset may be a python long, since SFTP allows it
to be 64 bits.
If the end of the file has been reached, this method may return an
empty string to signify EOF, or it may also return L{SFTP_EOF}.
The default implementation checks for an attribute on C{self} named
C{readfile}, 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.)
@param offset: position in the file to start reading from.
@type offset: int or long
@param length: number of bytes to attempt to read.
@type length: int
@return: data read from the file, or an SFTP error code.
@rtype: str
R
N( R R t SFTP_OP_UNSUPPORTEDR t tellt seekt readt IOErrort
SFTPServert
convert_errnot errnot len( R t offsett lengthR
t datat e( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyR H s
c C s t | d d } | d j o t Sy | i t i @d j oQ | i d j o | i | _ n | | i j o | i | | | _ q n | i | | i
Wn+ t j
o } d | _ t i
| i SX| i d j o | i t | 7_ n t S( s
Write C{data} into this file at position C{offset}. Extending the
file past its original end is expected. Unlike python's normal
C{write()} methods, this method cannot do a partial write: it must
write all of C{data} or else return an error.
The default implementation checks for an attribute on C{self} named
C{writefile}, and if present, performs the write operation on the
python file-like object found there. The attribute is named
differently from C{readfile} 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.
@param offset: position in the file to start reading from.
@type offset: int or long
@param data: data to write into the file.
@type data: str
@return: an SFTP error code like L{SFTP_OK}.
R i N( R R R R t ost O_APPENDR R R t writet flushR R R R R t SFTP_OK( R R R R R ( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyR m s$
c C s t S( s
Return an L{SFTPAttributes} object referring to this open file, or an
error code. This is equivalent to L{SFTPServerInterface.stat}, except
it's called on an open file instead of a path.
@return: an attributes object for the given file, or an SFTP error
code (like L{SFTP_PERMISSION_DENIED}).
@rtype: L{SFTPAttributes} I{or error code}
( R ( R ( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyt stat s
c C s t S( s
Change the attributes of this file. The C{attr} 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.
@param attr: the attributes to change on this file.
@type attr: L{SFTPAttributes}
@return: an error code like L{SFTP_OK}.
@rtype: int
( R ( R t attr( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyt chattr s c C s
| | _ d S( s
Used by the SFTP server code to cache a directory listing. (In
the SFTP protocol, listing a directory is a multi-stage process
requiring a temporary handle.)
N( R ( R t files( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyt
_set_files s c C s! | i d } | i d | _ | S( s^
Used by the SFTP server code to retreive a cached directory
listing.
i ( R ( R t fnlist( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyt _get_next_files s
c C s | i S( N( R ( R ( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyt _get_name s c C s
| | _ d S( N( R ( R t name( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyt _set_name s (
t __name__t
__module__t __doc__R R
R R R R" R$ R& R' R) ( ( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyR s % ( ( R ( R, R t paramiko.commont
paramiko.sftpt objectR t paramiko.sftp_serverR ( ( ( s8 /usr/lib/python2.6/site-packages/paramiko/sftp_handle.pyt s