SSHLibrary.pythonclient.SFTPClient Class Reference

Inheritance diagram for SSHLibrary.pythonclient.SFTPClient:

Public Member Functions
def	__init__ (self, ssh_client, encoding)
Public Member Functions inherited from SSHLibrary.abstractclient.AbstractSFTPClient
def	__init__ (self, encoding)
def	is_file (self, path)
	Checks if the path points to a regular file on the remote host. More...
def	is_dir (self, path)
	Checks if the path points to a directory on the remote host. More...
def	list_dir (self, path, pattern=None, absolute=False)
	Gets the item names, or optionally the absolute paths, on the given path on the remote host. More...
def	list_files_in_dir (self, path, pattern=None, absolute=False)
	Gets the file names, or optionally the absolute paths, of the regular files on the given path on the remote host. More...
def	list_dirs_in_dir (self, path, pattern=None, absolute=False)
	Gets the directory names, or optionally the absolute paths, on the given path on the remote host. More...
def	get_directory (self, source, destination, scp_preserve_time, path_separator='/', recursive=False)
def	build_destination (self, source, destination, path_separator)
	Add parent directory from source to destination path if destination is '. More...
def	get_parent_folder (self, source, path_separator)
def	get_file (self, source, destination, scp_preserve_times, path_separator='/')
	Downloads file(s) from the remote host to the local machine. More...
def	put_directory (self, source, destination, scp_preserve_times, mode, newline, path_separator='/', recursive=False)
	Uploads directory(-ies) from the local machine to the remote host, optionally with subdirectories included. More...
def	put_file (self, sources, destination, scp_preserve_times, mode, newline, path_separator='/')
	Uploads the file(s) from the local machine to the remote host. More...
def	create_local_ssh_tunnel (self, local_port, remote_host, remote_port, client)

Public Attributes
	ssh_client

Private Member Functions
def	_list (self, path)
def	_stat (self, path)
def	_create_missing_remote_path (self, path, mode)
def	_create_remote_file (self, destination, mode)
def	_write_to_remote_file (self, remote_file, data, position)
def	_close_remote_file (self, remote_file)
def	_get_file (self, remote_path, local_path, scp_preserve_times)
def	_absolute_path (self, path)
def	_is_windows_path (self, path)
def	_readlink (self, path)

Private Attributes
	_client

Detailed Description

Definition at line 334 of file pythonclient.py.

Constructor & Destructor Documentation

__init__()

def SSHLibrary.pythonclient.SFTPClient.__init__	(		self,
			ssh_client,
			encoding
	)

Reimplemented in SSHLibrary.pythonclient.SCPTransferClient.

Definition at line 336 of file pythonclient.py.

Member Function Documentation

_absolute_path()

def SSHLibrary.pythonclient.SFTPClient._absolute_path (   self,   path  )

private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 378 of file pythonclient.py.

_close_remote_file()

def SSHLibrary.pythonclient.SFTPClient._close_remote_file (   self,   remote_file  )

private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 371 of file pythonclient.py.

_create_missing_remote_path()

def SSHLibrary.pythonclient.SFTPClient._create_missing_remote_path (   self,   path,   mode  )

private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 354 of file pythonclient.py.

_create_remote_file()

def SSHLibrary.pythonclient.SFTPClient._create_remote_file (   self,   destination,   mode  )

private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 359 of file pythonclient.py.

_get_file()

def SSHLibrary.pythonclient.SFTPClient._get_file (   self,   remote_path,   local_path,   scp_preserve_times  )

private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Reimplemented in SSHLibrary.pythonclient.SCPTransferClient.

Definition at line 374 of file pythonclient.py.

_is_windows_path()

def SSHLibrary.pythonclient.SFTPClient._is_windows_path (   self,   path  )

private

Definition at line 385 of file pythonclient.py.

_list()

def SSHLibrary.pythonclient.SFTPClient._list (   self,   path  )

private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 341 of file pythonclient.py.

_readlink()

def SSHLibrary.pythonclient.SFTPClient._readlink (   self,   path  )

private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 388 of file pythonclient.py.

_stat()

def SSHLibrary.pythonclient.SFTPClient._stat (   self,   path  )

private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 349 of file pythonclient.py.

_write_to_remote_file()

def SSHLibrary.pythonclient.SFTPClient._write_to_remote_file (   self,   remote_file,   data,   position  )

private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 368 of file pythonclient.py.

Member Data Documentation

_client

SSHLibrary.pythonclient.SFTPClient._client

private

Definition at line 338 of file pythonclient.py.

ssh_client

SSHLibrary.pythonclient.SFTPClient.ssh_client

Definition at line 337 of file pythonclient.py.

---

The documentation for this class was generated from the following file:

• src/SSHLibrary/pythonclient.py