U
vf Z d?d@ Z d2S )ISFTPFilez
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 rc C s^ t | || _|| _t | || d| _d| _d| _i | _i | _ t
| _ d | _
t | _d S )NF)r __init__sftphandleZ _set_mode pipelined _prefetching_prefetch_done_prefetch_data_prefetch_extents threadingLock_prefetch_lock_saved_exceptionr _reqs)selfr r modebufsize r' C/opt/alt/python38/lib/python3.8/site-packages/paramiko/sftp_file.pyr = s
zSFTPFile.__init__c C s | j dd d S )NTasync__closer$ r' r' r( __del__K s zSFTPFile.__del__c C s | j dd dS )z!
Close the file.
Fr) Nr+ r- r' r' r( closeN s zSFTPFile.closeFc C s | j r
d S | jtdtt| j | jr:| j | t
| z0|rb| j t
d t| j n| jt| j W n, tk
r Y n ttjfk
r Y nX d S )Nz close({}))_closedr _logr formatr r r r Z_finish_responsesr r/ _async_requesttyper _requestEOFErrorIOErrorsocketerror)r$ r* r' r' r( r, T s
zSFTPFile._closec s fddt | j D }t|dkr,dS |jdd d |d \}}|| krXdS || | krld S | || | | | S )
Nc s g | ]}|d kr|qS )r r' ).0xoffsetr' r(
q s z7SFTPFile._data_in_prefetch_requests..r Fc S s | d S Nr r' )r; r' r' r( v z5SFTPFile._data_in_prefetch_requests..)keyr T)listr valueslensort_data_in_prefetch_requests)r$ r= sizek
buf_offsetZbuf_sizer' r< r( rG p s
z#SFTPFile._data_in_prefetch_requestsc sR fdd| j D }t|dkr(dS t|} | }|t| j | krNdS |S )a
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.
c s g | ]}| kr|qS r' r' )r: ir< r' r( r> s z6SFTPFile._data_in_prefetch_buffers..r N)r keysrE max)r$ r= rI indexrJ r' r< r( _data_in_prefetch_buffers s z"SFTPFile._data_in_prefetch_buffersc C s | | j}|dk rq8| js8| jr$q8| j | q |dkrJd| _dS | j| }| j|= | j| }|dkr|d| | j|< ||d }|t |k r||d | j| j| < |d| }|S )z
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.
NFr )
rO _realposr r0 r _read_response_check_exceptionr r rE )r$ rH r= prefetchrJ r' r' r( _read_prefetch s(
zSFTPFile._read_prefetchc C sb t || j}| jr(| |}|d k r(|S | jt| jt| j t
|\}}|t krZt d|
S )N
Expected data)minMAX_REQUEST_SIZEr rT r r5 r r r rP intr
r
get_string)r$ rH datatmsgr' r' r( _read s
zSFTPFile._readc C s t t|| j}| jtd t| jt| j |d | }| j
| | j rdt| j
dkr| jj
rt| j
r| j
}| j|\}}|tkrdtdqd|S )Nd zExpected status)rV rE rW r r3 r4 r r r rP r# appendr sockZ
recv_readypopleftrQ r
r )r$ rZ chunkZsftp_async_requestreqr[ r\ r' r' r( _write s(
zSFTPFile._writec C s | j j| dS )a@
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 r`
settimeout)r$ timeoutr' r' r( re s zSFTPFile.settimeoutc C s | j j S )z
Returns the timeout in seconds (as a `float`) associated with the
socket or ssh `.Channel` used for this file.
.. seealso:: `.Channel.gettimeout`
)r r`
gettimeoutr- r' r' r( rg s zSFTPFile.gettimeoutc C s | j j| dS )z
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 r` setblocking)r$ blockingr' r' r( rh s
zSFTPFile.setblockingc C s dS )z
Check if the file supports random access.
:return:
`True` if the file supports random access. If `False`,
:meth:`seek` will raise an exception
Tr' r- r' r' r( seekable s zSFTPFile.seekabler c C sb | || jkr | | _| _n6|| jkrB| j|7 _| j| _n| | | _| _t | _dS )zX
Set the file's current position.
See `file.seek` for details.
N)flushSEEK_SETrP _posSEEK_CUR _get_sizebytesZ_rbuffer)r$ r= whencer' r' r( seek s
z
SFTPFile.seekc C s. | j t| j\}}|tkr$tdt|S )a
Retrieve information about this file from the remote system. This is
exactly like `.SFTPClient.stat`, except that it operates on an
already-open file.
:returns:
an `.SFTPAttributes` object containing attributes about this file.
zExpected attributes)r r5 r r r r r Z _from_msg)r$ r[ r\ r' r' r( stat s z
SFTPFile.statc C s> | j tdt| j| t }||_| j t | j| dS )z
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
zchmod({}, {!r})N)
r r1 r r2 r r r st_moder5 r )r$ r% attrr' r' r( chmod s zSFTPFile.chmodc C sH | j tdt| j|| t }|| |_|_| j t
| j| dS )aV
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
zchown({}, {!r}, {!r})N) r r1 r r2 r r r st_uidst_gidr5 r )r$ uidgidru r' r' r( chown/ s
zSFTPFile.chownc C s\ |dkrt t f}| jtdt| j| t }|\|_|_ | j
t | j| dS )ad
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)
Nzutime({}, {!r})) timer r1 r r2 r r r st_atimest_mtimer5 r )r$ timesru r' r' r( utimeA s
zSFTPFile.utimec C s> | j tdt| j| t }||_| j t | j| dS )z
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
ztruncate({}, {!r})N)
r r1 r r2 r r r st_sizer5 r )r$ rH ru r' r' r( truncateW s zSFTPFile.truncatec C sB | j td| j|t|t||\}}| | | }|S )a
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)
:param length:
number of bytes to hash (0 means continue to the end of the file)
: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)
: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
z
check-file)r r5 r r r Zget_textZ
get_remainder)r$ Zhash_algorithmr= length
block_sizer[ r\ rZ r' r' r( checkf s . zSFTPFile.checkTc C s
|| _ dS )a
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 r' r' r(
set_pipelined s zSFTPFile.set_pipelinedNc C sh |dkr| j}g }| j}||k rLt| j|| }|||f ||7 }q t|dkrd| || dS )aE
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
`_); as a
workaround, one may call `stat` explicitly and pass its value in
via this parameter.
:param int max_concurrent_requests:
The maximum number of concurrent read requests to prefetch. See
`.SFTPClient.get` (its ``max_concurrent_prefetch_requests`` param)
for details.
.. 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.
.. versionchanged:: 3.3
Added ``max_concurrent_requests``.
Nr )rs r rP rV rW r_ rE _start_prefetch)r$ file_sizemax_concurrent_requestschunksnrb r' r' r( rS s !
zSFTPFile.prefetchc c s | j tdt| j| g }|D ]T\}}| |s$| ||rDq$|dkr$t|| j }|
||f ||7 }||8 }qDq$| || |D ]"}| |d |
|d V qdS )a/
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
:param int max_concurrent_prefetch_requests:
The maximum number of concurrent read requests to prefetch. See
`.SFTPClient.get` (its ``max_concurrent_prefetch_requests`` param)
for details.
:return: a list of blocks read, in the same order as in ``chunks``
.. versionadded:: 1.5.4
.. versionchanged:: 3.3
Added ``max_concurrent_prefetch_requests``.
zreadv({}, {!r})r N)r r1 r r2 r r rO rG rV rW r_ r rr read)r$ r Z max_concurrent_prefetch_requests read_chunksr= rH
chunk_sizer; r' r' r( readv s*
zSFTPFile.readvc C s z | jW S Y dS X d S r? )rs r r- r' r' r( ro s zSFTPFile._get_sizec C s2 d| _ d| _tj| j||fd}d|_| d S )NTF)targetargs)r r r Thread_prefetch_threaddaemonstart)r$ r r r[ r' r' r( r s zSFTPFile._start_prefetchc
C s |D ]\}}|d k rP| j $ t| j}||k r:W 5 Q R qPW 5 Q R X tt q| j| t| j t
|t |}| j ||f| j|< W 5 Q R X qd S )N) r! rE r r| sleepr r r3 r r r rX )r$ r r r= r Zpf_lennumr' r' r( r $ s
zSFTPFile._prefetch_threadc
C s |t krFz| j| W n( tk
r@ } z
|| _W 5 d }~X Y nX d S |tkrVtd| }| jP || j kr| j | \}}|| j
|< | j |= t | j dkrd| _ W 5 Q R qW 5 Q R X q^d S )NrU r T)
r
r Z_convert_status Exceptionr" r
r rY r! r r rE r )r$ r[ r\ r erZ r= r r' r' r( _async_response7 s"
zSFTPFile._async_responsec C s | j dk r| j }d| _ |dS )z.if there's a saved exception, raise & clear itN)r" )r$ r; r' r' r( rR M s
zSFTPFile._check_exception)r r )F)r )r r r )T)NN)N)N)!__name__
__module__ __qualname____doc__rW r r. r/ r, rG rO rT r] rd re rg rh rj rr rs rv r{ r r r r rS r ro r r r rR r' r' r' r( r 1 s<
<
.
/
r ) r binasciir collectionsr r8 r r| Zparamiko.commonr r Z
paramiko.filer Z
paramiko.utilr Z
paramiko.sftpr r r
r r r
r r r r r Zparamiko.sftp_attrr r r' r' r' r( s 4