| Home | Trees | Indices | Help | 
|---|
|  | 
object --+    
         |    
  BaseSFTP --+
             |
            SFTPClient
SFTP client object.  SFTPClient is used to open an sftp 
  session across an open ssh Transport and do remote file operations.
| Instance Methods | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| SFTPFile | 
 | ||
| 
 | |||
| Channel | 
 | ||
| str | 
 | ||
| list of str | 
 | ||
| list of SFTPAttributes | 
 | ||
| SFTPAttributes | 
 | ||
| 
 | |||
| str | 
 | ||
| SFTPFile | 
 | ||
| SFTPAttributes | 
 | ||
| str | 
 | ||
| 
 | |||
| 
 | |||
| 
 | |||
| SFTPAttributes | 
 | ||
| 
 | |||
| 
 | |||
| 
 | |||
| 
 | |||
| Inherited from  | |||
| Class Methods | |||
| SFTPClient | 
 | ||
| Properties | |
| Inherited from  | 
| Method Details | 
| 
 Create an SFTP client from an existing Channel.  The channel
  should already have requested the  An alternate way to create an SFTP client context is by using from_transport. 
 | 
| 
 Change the "current directory" of this SFTP session.  Since 
  SFTP doesn't really have the concept of a current working directory, this
  is emulated by paramiko.  Once you use this method to set a working 
  directory, all operations on this SFTPClient object will be relative to 
  that path. You can pass in  
 Since: 1.4 | 
| 
 Change the mode (permissions) of a file.  The permissions are 
  unix-style and identical to those used by python's  
 | 
| 
 Change the owner ( 
 | 
| 
 Close the SFTP session and its underlying channel. Since: 1.4 | 
| 
 Open a file on the remote server.  The arguments are the same as for 
  python's built-in  The mode indicates how the file is to be opened:  Since 1.5.2, an  The file will be buffered in standard python style by default, but can
  be altered with the  
 | 
| 
 Create an SFTP client channel from an open Transport. 
 | 
| 
 Copy a remote file ( 
 Since: 1.4 | 
| 
 Return the underlying Channel object for this SFTP session. This might be useful for doing things like setting a timeout on the channel. 
 Since: 1.7.1 | 
| 
 Return the "current working directory" for this SFTP 
  session, as emulated by paramiko.  If no directory has been set with chdir, this 
  method will return  
 Since: 1.4 | 
| 
 Return a list containing the names of the entries in the given 
   
 | 
| 
 Return a list containing SFTPAttributes objects corresponding to files in the 
  given  The returned SFTPAttributes objects will each have an additional 
  field:  
 Since: 1.2 | 
| 
 Retrieve information about a file on the remote system, without following symbolic links (shortcuts). This otherwise behaves exactly the same as stat. 
 | 
| 
 Create a folder (directory) named  
 | 
| 
 Return the normalized path (on the server) of a given path.  This can 
  be used to quickly resolve symbolic links or determine what the server is
  considering to be the "current folder" (by passing 
   
 | 
| 
 Open a file on the remote server.  The arguments are the same as for 
  python's built-in  The mode indicates how the file is to be opened:  Since 1.5.2, an  The file will be buffered in standard python style by default, but can
  be altered with the  
 | 
| 
 Copy a local file ( The SFTP operations use pipelining for speed. 
 Since: 1.4 | 
| 
 Return the target of a symbolic link (shortcut). You can use symlink to create these. The result may be either an absolute or relative pathname. 
 | 
| 
 Remove the file at the given path. This only works on files; for removing folders (directories), use rmdir. 
 | 
| 
 Rename a file or folder from  
 | 
| 
 Remove the folder named  
 | 
| 
 Retrieve information about a file on the remote system.  The return 
  value is an object whose attributes correspond to the attributes of 
  python's  Unlike a python  The fields supported are:  
 | 
| 
 Create a symbolic link (shortcut) of the  
 | 
| 
 Change the size of the file specified by  
 | 
| 
 Remove the file at the given path. This only works on files; for removing folders (directories), use rmdir. 
 | 
| 
 Set the access and modified times of the file specified by 
   
 | 
| Home | Trees | Indices | Help | 
|---|
| Generated by Epydoc 3.0.1 on Sun Nov 1 22:14:16 2009 | http://epydoc.sourceforge.net |