U
vf @ sf d dl mZ d dlZd dlZd dlZd dlZd dlZd dlZd dlm Z d dl
m Z d dl m
Z
d dlmZmZmZ d dlmZmZmZmZmZmZmZmZmZm Z m Z m Z m Z m Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2 d dl3m4Z4 d d l5m6Z6 d d
l7m8Z8 d d l9m:Z:m;Z;mG dd dee:Z?G dd de?Z@dS ) )hexlifyN)util)Channel)Message)INFODEBUGo777) BaseSFTP CMD_OPENDIR
CMD_HANDLE SFTPError CMD_READDIRCMD_NAME CMD_CLOSESFTP_FLAG_READSFTP_FLAG_WRITESFTP_FLAG_CREATESFTP_FLAG_TRUNCSFTP_FLAG_APPENDSFTP_FLAG_EXCLCMD_OPEN
CMD_REMOVE
CMD_RENAME CMD_MKDIR CMD_RMDIRCMD_STAT CMD_ATTRS CMD_LSTAT CMD_SYMLINK CMD_SETSTAT CMD_READLINK CMD_REALPATH
CMD_STATUS CMD_EXTENDEDSFTP_OKSFTP_EOFSFTP_NO_SUCH_FILESFTP_PERMISSION_DENIEDint64)SFTPAttributes) SSHException)SFTPFile)ClosingContextManagerbuc C sX z | dW S ttfk
rR z| dW Y S tk
rL | Y Y S X Y nX dS )z
decode a string as ascii or utf8 if possible (as required by the sftp
protocol). if neither works, just return a byte string because the server
probably doesn't know the filename's encoding.
asciizutf-8N)encode UnicodeErrorAttributeErrordecode)s r5 E/opt/alt/python38/lib/python3.8/site-packages/paramiko/sftp_client.py _to_unicodeH s r7 /c s^ e Zd ZdZdd ZedQddZ fddZd d
Zd d Z dRddZ
dSddZ dTddZ dUddZ
e
Zdd ZeZdd Zd d Zefd d Zd!d" Zd#d$ Zd%d& Zd'd( Zd)d* Zd+d, Zd-d. Zd/d0 Z d1d2 Z d3d4 Z dVd5d6Z d7d8 Z d9d: Z!dWd=d>Z"dXd?d@Z#dYdAdBZ$dZdCdDZ%dEdF Z&dGdH Z'd[dIdJZ(dKdL Z)dMdN Z*dOdP Z+ Z,S )\
SFTPClientz
SFTP client object.
Used to open an SFTP session across an open SSH `.Transport` and perform
remote file operations.
Instances of this class may be used as context managers.
c C s t | || _d| _d| _t | _d| _t
| _ t |t
krj| j }t| d | _| | _z | }W n tk
r tdY nX | td| dS )a
Create an SFTP client from an existing `.Channel`. The channel
should already have requested the ``"sftp"`` subsystem.
An alternate way to create an SFTP client context is by using
`from_transport`.
:param .Channel sock: an open `.Channel` using the ``"sftp"`` subsystem
:raises:
`.SSHException` -- if there's an exception while negotiating sftp
F Nz.sftpzEOF during negotiationz*Opened sftp connection (server version {}))r __init__sockZ ultra_debugrequest_number threadingLock_lock_cwdweakrefWeakValueDictionary
_expectingtyper Z
get_transportr Z
get_loggerZget_log_channelloggerZ get_hexdumpZ
_send_versionEOFErrorr* _logr format)selfr< transportZserver_versionr5 r5 r6 r; d s.
zSFTPClient.__init__Nc C s, |j ||d}|dkrdS |d | |S )a\
Create an SFTP client channel from an open `.Transport`.
Setting the window and packet sizes might affect the transfer speed.
The default settings in the `.Transport` class are the same as in
OpenSSH and should work adequately for both files transfers and
interactive sessions.
:param .Transport t: an open `.Transport` which is already
authenticated
:param int window_size:
optional window size for the `.SFTPClient` session.
:param int max_packet_size:
optional max packet size for the `.SFTPClient` session..
:return:
a new `.SFTPClient` object, referring to an sftp session (channel)
across the transport
.. versionchanged:: 1.15
Added the ``window_size`` and ``max_packet_size`` arguments.
) window_sizemax_packet_sizeNsftp)Z open_sessionZinvoke_subsystem)clstrL rM Zchanr5 r5 r6 from_transport s
zSFTPClient.from_transportc s` t |tr(|D ]}| j||f| qn4|dd}t j|d| f| j gt| d S )N%z%%z
[chan %s] )
isinstancelistrH replacesuperr< get_name)rJ levelmsgargsm __class__r5 r6 rH s
zSFTPClient._logc C s | td | j dS )zc
Close the SFTP session and its underlying channel.
.. versionadded:: 1.4
zsftp session closed.N)rH r r< closerJ r5 r5 r6 r^ s zSFTPClient.closec C s | j S )z
Return the underlying `.Channel` object for this SFTP session. This
might be useful for doing things like setting a timeout on the channel.
.. versionadded:: 1.7.1
)r< r_ r5 r5 r6 get_channel s zSFTPClient.get_channel.c C s dd | |D S )a
Return a list containing the names of the entries in the given
``path``.
The list is in arbitrary order. It does not include the special
entries ``'.'`` and ``'..'`` even if they are present in the folder.
This method is meant to mirror ``os.listdir`` as closely as possible.
For a list of full `.SFTPAttributes` objects, see `listdir_attr`.
:param str path: path to list (defaults to ``'.'``)
c S s g | ]
}|j qS r5 )filename).0fr5 r5 r6
s z&SFTPClient.listdir..) listdir_attrrJ pathr5 r5 r6 listdir s zSFTPClient.listdirc C s | |}| td| | t|\}}|tkr1``) uses that specific buffer size.
:param str filename: name of the file to open
:param str mode: mode (Python-style) to open in
:param int bufsize: desired buffering (default: ``-1``)
:return: an `.SFTPFile` object representing the open file
:raises: ``IOError`` -- if the file could not be opened.
zopen({!r}, {!r})r r +waxrk zopen({!r}, {!r}) -> {})rn rH r rI r r r r r r r) ro r r r rp r. r r+ ) rJ rb modebufsizeZimodeZ attrblockrP rY rv r5 r5 r6 openF s6
zSFTPClient.openc C s, | |}| td| | t| dS )a
Remove the file at the given path. This only works on files; for
removing folders (directories), use `rmdir`.
:param str path: path (absolute or relative) of the file to remove
:raises: ``IOError`` -- if the path refers to a folder (directory)
z remove({!r})N)rn rH r rI ro r rg r5 r5 r6 remove s
zSFTPClient.removec C s: | |}| |}| td|| | t|| dS )a3
Rename a file or folder from ``oldpath`` to ``newpath``.
.. note::
This method implements 'standard' SFTP ``RENAME`` behavior; those
seeking the OpenSSH "POSIX rename" extension behavior should use
`posix_rename`.
:param str oldpath:
existing name of the file or folder
:param str newpath:
new name for the file or folder, must not exist already
:raises:
``IOError`` -- if ``newpath`` is a folder, or something else goes
wrong
zrename({!r}, {!r})N)rn rH r rI ro r rJ Zoldpathnewpathr5 r5 r6 rename s
zSFTPClient.renamec C s< | |}| |}| td|| | td|| dS )a
Rename a file or folder from ``oldpath`` to ``newpath``, following
posix conventions.
:param str oldpath: existing name of the file or folder
:param str newpath: new name for the file or folder, will be
overwritten if it already exists
:raises:
``IOError`` -- if ``newpath`` is a folder, posix-rename is not
supported by the server or something else goes wrong
:versionadded: 2.2
zposix_rename({!r}, {!r})zposix-rename@openssh.comN)rn rH r rI ro r# r r5 r5 r6 posix_rename s
zSFTPClient.posix_renamec C s< | |}| td|| t }||_| t|| dS )as
Create a folder (directory) named ``path`` with numeric mode ``mode``.
The default mode is 0777 (octal). On some systems, mode is ignored.
Where it is used, the current umask value is first masked out.
:param str path: name of the folder to create
:param int mode: permissions (posix-style) for the newly-created folder
zmkdir({!r}, {!r})N)rn rH r rI r) st_modero r rJ rh r r{ r5 r5 r6 mkdir s
zSFTPClient.mkdirc C s, | |}| td| | t| dS )zj
Remove the folder named ``path``.
:param str path: name of the folder to remove
z rmdir({!r})N)rn rH r rI ro r rg r5 r5 r6 rmdir s
zSFTPClient.rmdirc C sF | |}| td| | t|\}}|tkr` of bytes written to the opened file object
.. versionadded:: 1.10
.. versionchanged:: 2.8
Added the ``prefetch`` keyword argument.
.. versionchanged:: 3.3
Added ``max_concurrent_prefetch_requests``.
r r N)r r r prefetchr )rJ r r r r max_concurrent_prefetch_requestsr r r5 r5 r6 getfo s " zSFTPClient.getfoc C sR t |d}| |||||}W 5 Q R X t|}|j|krNtd|j|dS )a
Copy a remote file (``remotepath``) from the SFTP server to the local
host as ``localpath``. Any exception raised by operations will be
passed through. This method is primarily provided as a convenience.
:param str remotepath: the remote file to copy
:param str localpath: the destination path on the local host
:param callable callback:
optional callback function (form: ``func(int, int)``) that accepts
the bytes transferred so far and the total bytes to be transferred
:param bool prefetch:
controls whether prefetching is performed (default: True)
:param int max_concurrent_prefetch_requests:
The maximum number of concurrent read requests to prefetch.
When this is ``None`` (the default), do not limit the number of
concurrent prefetch requests. Note: OpenSSH's sftp internally
imposes a limit of 64 concurrent requests, while Paramiko imposes
no limit by default; consider setting a limit if a file can be
successfully received with sftp but hangs with Paramiko.
.. versionadded:: 1.4
.. versionchanged:: 1.7.4
Added the ``callback`` param
.. versionchanged:: 2.8
Added the ``prefetch`` keyword argument.
.. versionchanged:: 3.3
Added ``max_concurrent_prefetch_requests``.
r z size mismatch in get! {} != {}N)r r r r r r rI ) rJ r r r r r r r r4 r5 r5 r6 get# s $
zSFTPClient.getc G s | j td |f| }| |S N)r~ rE _read_response)rJ rP rZ r r5 r5 r6 ro W s zSFTPClient._requestc G s | j zt }|| j |D ]P}t|tr<|| q"t|t rR|| q"t|t
rh| | q"| | q"| j}|| j
|< | jd7 _W 5 | j X | || |S )Nr: )r@ acquirereleaser Zadd_intr= rS r( Z add_int64intr) _packZ
add_stringrD Z _send_packet)rJ fileobjrP rZ rY itemr r5 r5 r6 r~ [ s$
zSFTPClient._async_requestc
C s z| \}}W n0 tk
r@ } ztd|W 5 d }~X Y nX t|}| }| j zF|| j kr|
t d| |d krW qW q | j | }| j |= W 5 | j X ||kr|t kr|
| ||fS |td k r|||| |d kr qq dS )Nz Server connection dropped: {}zUnexpected response #{})NN)r rG r* rI r rq r@ r r rD rH r r" r rE Z_async_response)rJ ZwaitforrP r erY r r r5 r5 r6 r t s2
zSFTPClient._read_responsec C s$ || j kr | | q d S r )rD valuesr Z_check_exception)rJ r r5 r5 r6 _finish_responses s z SFTPClient._finish_responsesc C sf | }| }|tkr dS |tkr.t|n4|tkrDttj|n |t krZttj
|nt|dS )zU
Raises EOFError or IOError on error status; otherwise does nothing.
N) rq rs r$ r% rG r& r r ENOENTr' EACCES)rJ rY r textr5 r5 r6 r s
zSFTPClient._convert_statusc C sT t |}| jdkr|S t|r2|dd tkr2|S | jtkrF| j| S | jt | S )zr
Return an adjusted path if we're emulating a "current working
directory" for the server.
Nr r: )r- rA r b_slashrg r5 r5 r6 rn s
zSFTPClient._adjust_cwd)NN)ra )ra )ra r| )r r )N)r NT)NT)NTN)NTN)N)-__name__
__module__ __qualname____doc__r; classmethodrQ rH r^ r` ri rf r r r r unlinkr r r r r r r r r r r r r r r r r r r r r ro r~ r r r rn
__classcell__r5 r5 r\ r6 r9 Z s\ (
*
@
;
*
$
.
4
%r9 c @ s e Zd ZdZdS )SFTPzA
An alias for `.SFTPClient` for backwards compatibility.
N)r r r r r5 r5 r5 r6 r s r )Abinasciir r r r r> r rB Zparamikor Zparamiko.channelr Zparamiko.messager Zparamiko.commonr r r Z
paramiko.sftpr r
r r r
r r r r r r r r r r r r r r r r r r r r! r" r# r$ r% r& r' r( Zparamiko.sftp_attrr) Zparamiko.ssh_exceptionr* Zparamiko.sftp_filer+ Z
paramiko.utilr, r- r. r7 r r9 r r5 r5 r5 r6 s2 # l