ó
=OXc @€ sú d Z d d l m Z d d l m Z d d l m Z d d l Z d d l Z d d l Z d d l
m Z d d l m
Z
d d l m Z d d l m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z d d
l m Z d e
f d „ ƒ YZ d S(
s
SFTP file object
iÿÿÿÿ( t with_statement( t hexlify( t dequeN( t DEBUG( t BufferedFile( t long(
t CMD_CLOSEt CMD_READt CMD_DATAt SFTPErrort CMD_WRITEt
CMD_STATUSt CMD_FSTATt CMD_ATTRSt CMD_FSETSTATt CMD_EXTENDED( t SFTPAttributest SFTPFilec B€ s+ e Z d Z d Z d d d „ Z d „ Z d „ Z e d „ Z d „ Z d „ Z
d
„ Z d „ Z d „ Z
d
„ Z d „ Z d „ Z d „ Z d d „ Z d „ Z d „ Z d „ Z d „ Z d „ Z d d d d „ Z e d „ Z d! d „ Z d „ Z d „ Z d „ Z d „ Z d „ Z! d „ Z" RS(" sÄ
Proxy object for a file on the remote server, in client mode SFTP.
Instances of this class may be used as context managers in the same way
that built-in Python file objects are.
i € t riÿÿÿÿc C€ s‡ t j | ƒ | | _ | | _ t j | | | ƒ t | _ t | _ t | _ i | _ i | _
t j ƒ | _
d | _ t ƒ | _ d S( N( R t __init__t sftpt handlet _set_modet Falset pipelinedt _prefetchingt _prefetch_donet _prefetch_datat _prefetch_extentst threadingt Lockt _prefetch_lockt Nonet _saved_exceptionR t _reqs( t selfR R t modet bufsize( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR 3 s
c C€ s | j d t ƒ d S( Nt async( t _closet True( R# ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt __del__A s c C€ s | j d t ƒ d S( s!
Close the file.
R& N( R' R ( R# ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt closeD s c C€ sÉ | j r
d S| j j t d t | j ƒ ƒ | j rI | j j | ƒ n t j | ƒ yB | r | j j
t d ƒ t
| j ƒ n | j j t
| j ƒ Wn* t k
r« n t t j f k
rÄ n Xd S( Ns close(%s)( t _closedR t _logR R R R t _finish_responsesR R* t _async_requestt typeR R t _requestt EOFErrort IOErrort sockett error( R# R& ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR' J s
"
c C€ s½ g t | j j ƒ ƒ D] } | d | k r | ^ q } t | ƒ d k rN t S| j d d „ ƒ | d \ } } | | | k r… t S| | | | k r t S| j | | | | | | ƒ S( Ni t keyc S€ s | d S( Ni ( ( t x( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt <lambda>i s iÿÿÿÿ( t listR t valuest lenR t sortR( t _data_in_prefetch_requests( R# t offsett sizeR6 t kt
buf_offsett buf_size( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR< e s 8c C€ s{ g | j j ƒ D] } | | k r | ^ q } t | ƒ d k rD d St | ƒ } | | } | t | j | ƒ k rw d S| S( s
if a block of data is present in the prefetch buffers, at the given
offset, return the offset of the relevant prefetch buffer. otherwise,
return None. this guarantees nothing about the number of bytes
collected in the prefetch buffer so far.
i N( R t keysR: R t max( R# R= t iR? t indexR@ ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt _data_in_prefetch_bufferst s .
c C€ sþ xY t r[ | j | j ƒ } | d k r+ Pn | j s= | j rA Pn | j j ƒ | j ƒ q W| d k ru t | _
d S| j | } | j | =| j | } | d k rà | | | j | <| | } n | t | ƒ k rú | | | j | j | <| | } n | S( s£
read data out of the prefetch buffer, if possible. if the data isn't
in the buffer, return None. otherwise, behaves like a normal read.
i N(
R( RF t _realposR R R+ R t _read_responset _check_exceptionR R R R: ( R# R> R= t prefetchR@ ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt _read_prefetch… s*
c C€ s• t | | j ƒ } | j r= | j | ƒ } | d k r= | Sn | j j t | j t | j
ƒ t | ƒ ƒ \ } } | t k r‹ t
d ƒ ‚ n | j ƒ S( Ns
Expected data( t mint MAX_REQUEST_SIZER RK R R R0 R R R RG t intR R t
get_string( R# R> t datat tt msg( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt _read¢ s 3 c C€ sæ t t | ƒ | j ƒ } | j j | j j t d ƒ t | j
t | j ƒ | | ƒ ƒ | j
s‡ t | j ƒ d k râ | j j j ƒ râ xX t | j ƒ rÞ | j j ƒ } | j j | ƒ \ } } | t k rŠ t d ƒ ‚ qŠ qŠ Wn | S( Nid s Expected status( RL R: RM R" t appendR R. R/ R R
R R RG R t sockt
recv_readyt popleftRH R R ( R# RP t chunkt reqRQ RR ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt _write s >1 c C€ s | j j j | ƒ d S( s@
Set a timeout on read/write operations on the underlying socket or
ssh `.Channel`.
:param float timeout:
seconds to wait for a pending read/write operation before raising
``socket.timeout``, or ``None`` for no timeout
.. seealso:: `.Channel.settimeout`
N( R RU t
settimeout( R# t timeout( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR[ º s c C€ s | j j j ƒ S( s´
Returns the timeout in seconds (as a `float`) associated with the
socket or ssh `.Channel` used for this file.
.. seealso:: `.Channel.gettimeout`
( R RU t
gettimeout( R# ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR] Ç s c C€ s | j j j | ƒ d S( sö
Set blocking or non-blocking mode on the underiying socket or ssh
`.Channel`.
:param int blocking:
0 to set non-blocking mode; non-0 to set blocking mode.
.. seealso:: `.Channel.setblocking`
N( R RU t setblocking( R# t blocking( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR^ Ð s
c C€ s t S( sÁ
Check if the file supports random access.
:return:
`True` if the file supports random access. If `False`,
:meth:`seek` will raise an exception
( R( ( R# ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt seekableÜ s i c C€ sƒ | j ƒ | | j k r, | | _ | _ nG | | j k rY | j | 7_ | j | _ n | j ƒ | | _ | _ t ƒ | _ d S( N( t flusht SEEK_SETRG t _post SEEK_CURt _get_sizet bytest _rbuffer( R# R= t whence( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt seekæ s
c C€ sF | j j t | j ƒ \ } } | t k r9 t d ƒ ‚ n t j | ƒ S( s
Retrieve information about this file from the remote system. This is
exactly like `.SFTPClient.stat`, except that it operates on an
already-open file.
:return: an `.SFTPAttributes` object containing attributes about this file.
s Expected attributes( R R0 R R R
R R t _from_msg( R# RQ RR ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt statñ s c C€ sU | j j t d t | j ƒ | f ƒ t ƒ } | | _ | j j t | j | ƒ d S( sÔ
Change the mode (permissions) of this file. The permissions are
unix-style and identical to those used by Python's `os.chmod`
function.
:param int mode: new permissions
s
chmod(%s, %r)N( R R, R R R R t st_modeR0 R ( R# R$ t attr( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt chmodþ s & c C€ sb | j j t d t | j ƒ | | f ƒ t ƒ } | | | _ | _ | j j t | j | ƒ d S( sV
Change the owner (``uid``) and group (``gid``) of this file. As with
Python's `os.chown` function, you must pass both arguments, so if you
only want to change one, use `stat` first to retrieve the current
owner and group.
:param int uid: new owner's uid
:param int gid: new group id
s chown(%s, %r, %r)N(
R R, R R R R t st_uidt st_gidR0 R ( R# t uidt gidRm ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt chown s
) c C€ s… | d k r' t j ƒ t j ƒ f } n | j j t d t | j ƒ | f ƒ t ƒ } | \ | _ | _ | j j
t | j | ƒ d S( sd
Set the access and modified times of this file. If
``times`` is ``None``, then the file's access and modified times are set
to the current time. Otherwise, ``times`` must be a 2-tuple of numbers,
of the form ``(atime, mtime)``, which is used to set the access and
modified times, respectively. This bizarre API is mimicked from Python
for the sake of consistency -- I apologize.
:param tuple times:
``None`` or a tuple of (access time, modified time) in standard
internet epoch time (seconds since 01 January 1970 GMT)
s
utime(%s, %r)N( R t timeR R, R R R R t st_atimet st_mtimeR0 R ( R# t timesRm ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt utime s
& c C€ sU | j j t d t | j ƒ | f ƒ t ƒ } | | _ | j j t | j | ƒ d S( s
Change the size of this file. This usually extends
or shrinks the size of the file, just like the ``truncate()`` method on
Python file objects.
:param size: the new size of the file
:type size: int or long
s truncate(%s, %r)N( R R, R R R R t st_sizeR0 R ( R# R> Rm ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt truncate. s & c
C€ sa | j j t d | j | t | ƒ t | ƒ | ƒ \ } } | j ƒ } | j ƒ } | j ƒ } | S( s`
Ask the server for a hash of a section of this file. This can be used
to verify a successful upload or download, or for various rsync-like
operations.
The file is hashed from ``offset``, for ``length`` bytes. If ``length``
is 0, the remainder of the file is hashed. Thus, if both ``offset``
and ``length`` are zero, the entire file is hashed.
Normally, ``block_size`` will be 0 (the default), and this method will
return a byte string representing the requested hash (for example, a
string of length 16 for MD5, or 20 for SHA-1). If a non-zero
``block_size`` is given, each chunk of the file (from ``offset`` to
``offset + length``) of ``block_size`` bytes is computed as a separate
hash. The hash results are all concatenated and returned as a single
string.
For example, ``check('sha1', 0, 1024, 512)`` will return a string of
length 40. The first 20 bytes will be the SHA-1 of the first 512 bytes
of the file, and the last 20 bytes will be the SHA-1 of the next 512
bytes.
:param str hash_algorithm:
the name of the hash algorithm to use (normally ``"sha1"`` or
``"md5"``)
:param offset:
offset into the file to begin hashing (0 means to start from the
beginning)
:type offset: int or long
:param length:
number of bytes to hash (0 means continue to the end of the file)
:type length: int or long
:param int block_size:
number of bytes to hash per result (must not be less than 256; 0
means to compute only one hash of the entire segment)
:type block_size: int
:return:
`str` of bytes representing the hash of each block, concatenated
together
:raises IOError: if the server doesn't support the "check-file"
extension, or possibly doesn't support the hash algorithm
requested
.. note:: Many (most?) servers don't support this extension yet.
.. versionadded:: 1.4
s
check-file( R R0 R R R t get_textt
get_remainder(
R# t hash_algorithmR= t lengtht
block_sizeRQ RR t extt algRP ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt check< s 1$ c C€ s
| | _ d S( sÐ
Turn on/off the pipelining of write operations to this file. When
pipelining is on, paramiko won't wait for the server response after
each write operation. Instead, they're collected as they come in. At
the first non-write operation (including `.close`), all remaining
server responses are collected. This means that if there was an error
with one of your later writes, an exception might be thrown from within
`.close` instead of `.write`.
By default, files are not pipelined.
:param bool pipelined:
``True`` if pipelining should be turned on for this file; ``False``
otherwise
.. versionadded:: 1.5
N( R ( R# R ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt
set_pipelinedt s c C€ s™ | d k r | j ƒ j } n g } | j } xC | | k rr t | j | | ƒ } | j | | f ƒ | | 7} q0 Wt | ƒ d k r• | j | ƒ n d S( s
Pre-fetch the remaining contents of this file in anticipation of future
`.read` calls. If reading the entire file, pre-fetching can
dramatically improve the download speed by avoiding roundtrip latency.
The file's contents are incrementally buffered in a background thread.
The prefetched data is stored in a buffer until read via the `.read`
method. Once data has been read, it's removed from the buffer. The
data may be read in a random order (using `.seek`); chunks of the
buffer that haven't been read will continue to be buffered.
:param int file_size:
When this is ``None`` (the default), this method calls `stat` to
determine the remote file size. In some situations, doing so can
cause exceptions or hangs (see `#562
<https://github.com/paramiko/paramiko/pull/562>`_); as a
workaround, one may call `stat` explicitly and pass its value in
via this parameter.
.. versionadded:: 1.5.1
.. versionchanged:: 1.16.0
The ``file_size`` parameter was added (with no default value).
.. versionchanged:: 1.16.1
The ``file_size`` parameter was made optional for backwards
compatibility.
i N( R Rk Ry RG RL RM RT R: t _start_prefetch( R# t file_sizet chunkst nRX ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyRJ ˆ s c c€ sû | j j t d t | j ƒ | f ƒ g } x‡ | D] \ } } | j | ƒ s3 | j | | ƒ rf q3 n xI | d k r± t | | j ƒ } | j | | f ƒ | | 7} | | 8} qi Wq3 W| j
| ƒ x1 | D]) } | j | d ƒ | j | d ƒ VqÊ Wd S( s
Read a set of blocks from the file by (offset, length). This is more
efficient than doing a series of `.seek` and `.read` calls, since the
prefetch machinery is used to retrieve all the requested blocks at
once.
:param chunks:
a list of (offset, length) tuples indicating which sections of the
file to read
:type chunks: list(tuple(long, int))
:return: a list of blocks read, in the same order as in ``chunks``
.. versionadded:: 1.5.4
s
readv(%s, %r)i i N(
R R, R R R RF R< RL RM RT R„ Ri t read( R# R† t read_chunksR= R> t
chunk_sizeR6 ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt readv° s &!
c C€ s y | j ƒ j SWn d SXd S( Ni ( Rk Ry ( R# ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyRe Ö s c C€ sK t | _ t | _ t j d | j d | f ƒ } | j t ƒ | j ƒ d S( Nt targett args( R( R R R R t Threadt _prefetch_threadt setDaemont start( R# R† RQ ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR„ Ü s
c C€ sk xd | D]\ \ } } | j j | t | j t | ƒ t | ƒ ƒ } | j | | f | j | <Wd QXq Wd S( N( R R. R R R RN R R ( R# R† R= R~ t num( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR ä s -
c C€ sé | t k rC y | j j | ƒ Wn t k
r> } | | _ n Xd S| t k r^ t d ƒ ‚ n | j ƒ } xx t rä | j c | | j
k rÛ | j
| \ } } | | j | <| j
| =t | j
ƒ d k r× t | _
n Pn Wd QXqm Wd S( Ns
Expected datai ( R R t _convert_statust ExceptionR! R R RO R( R R R R: R ( R# RQ RR R’ t eRP R= R~ ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt _async_responseì s$
c C€ s. | j d k r* | j } d | _ | ‚ n d S( s. if there's a saved exception, raise & clear itN( R! R ( R# R6 ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyRI s N(# t __name__t
__module__t __doc__RM R R) R* R R' R< RF RK RS RZ R[ R] R^ R` Ri Rk Rn Rs Rx Rz R‚ R( Rƒ R RJ R‹ Re R„ R R– RI ( ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR ' s<
8 ( & ( R™ t
__future__R t binasciiR t collectionsR R3 R Rt t paramiko.commonR t
paramiko.fileR t paramiko.py3compatR t
paramiko.sftpR R R R R
R R R
R R t paramiko.sftp_attrR R ( ( ( s6 /usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt <module> s F