twisted.conch.ssh.filetransferView Source (View In Hierarchy)
|Method||connectionMade||Called when a connection is made.|
|Method||openFile||Open a file.|
|Method||removeFile||Remove the given file.|
|Method||renameFile||Rename the given file.|
|Method||makeDirectory||Make a directory.|
|Method||removeDirectory||Remove a directory (non-recursively)|
|Method||openDirectory||Open a directory for scanning.|
|Method||getAttrs||Return the attributes for the given path.|
|Method||setAttrs||Set the attributes for the path.|
|Method||readLink||Find the root of a set of symbolic links.|
|Method||makeLink||Create a symbolic link.|
|Method||realPath||Convert any path to an absolute path.|
|Method||extendedRequest||Make an extended request of the server.|
|Method||gotServerVersion||Called when the client sends their version info.|
Inherited from FileTransferBase:
|Method||dataReceived||Called whenever data is received.|
|Method||logPrefix||Return a prefix matching the class name, to identify log messages related to this protocol instance.|
|Method||connectionLost||Called when the connection is shut down.|
|Method||makeConnection||Make a connection to a transport and a server.|
|Parameters||extData||a dict of extended_name : extended_data items to be sent to the server.|
Called when a connection is made.
This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
Open a file.
|Parameters||filename||a string representing the file to open. (type: |
|flags||an integer of the flags to open the file with, ORed together. The flags and their values are listed at the bottom of this file.|
|attrs||a list of attributes to open the file with. It is a dictionary, consisting
of 0 or more keys. The possible keys are:
size: the size of the file in bytes uid: the user ID of the file as an integer gid: the group ID of the file as an integer permissions: the permissions of the file with as an integer. the bit representation of this field is defined by POSIX. atime: the access time of the file as seconds since the epoch. mtime: the modification time of the file as seconds since the epoch. ext_*: extended attributes. The server is not required to understand this, but it may.
NOTE: there is no way to indicate text or binary files. it is up to the SFTP client to deal with this.
Remove the given file.
This method returns a Deferred that is called back when it succeeds.
|Parameters||filename||the name of the file as a string. (type: |
Make a directory.
This method returns a Deferred that is called back when it is created.
|Parameters||path||the name of the directory to create as a string. (type: |
|attrs||a dictionary of attributes to create the directory with. Its meaning is the same as the attrs in the openFile method.|
Remove a directory (non-recursively)
It is an error to remove a directory that has files or directories in it.
This method returns a Deferred that is called back when it is removed.
|Parameters||path||the directory to remove. (type: |
Open a directory for scanning.
This method returns a Deferred that is called back with an iterable object that has a close() method.
The close() method is called when the client is finished reading from the directory. At this point, the iterable will no longer be used.
The iterable returns triples of the form (filename, longname, attrs) or a Deferred that returns the same. The sequence must support __getitem__, but otherwise may be any 'sequence-like' object.
filename is the name of the file relative to the directory. logname is an expanded format of the filename. The recommended format is: -rwxr-xr-x 1 mjos staff 348911 Mar 25 14:29 t-filexfer 1234567890 123 12345678 12345678 12345678 123456789012
The first line is sample output, the second is the length of the field. The fields are: permissions, link count, user owner, group owner, size in bytes, modification time.
attrs is a dictionary in the format of the attrs argument to openFile.
|Parameters||path||the directory to open. (type: |
Return the attributes for the given path.
This method returns a dictionary in the same format as the attrs argument to openFile or a Deferred that is called back with same.
|Parameters||path||the path to return attributes for as a string. (type: |
|followLinks||a boolean. if it is True, follow symbolic links and return attributes for the real path at the base. if it is False, return attributes for the specified path.|
Set the attributes for the path.
This method returns when the attributes are set or a Deferred that is called back when they are.
|Parameters||path||the path to set attributes for as a string. (type: |
|attrs||a dictionary in the same format as the attrs argument to openFile.|
Find the root of a set of symbolic links.
This method returns the target of the link, or a Deferred that returns the same.
|Parameters||path||the path of the symlink to read. (type: |
Convert any path to an absolute path.
This method returns the absolute path as a string, or a Deferred that returns the same.
|Parameters||path||the path to convert as a string. (type: |
Called when the client sends their version info.
|Parameters||otherVersion||an integer representing the version of the SFTP protocol they are claiming.|
|extData||a dictionary of extended_name : extended_data items. These items are sent by the client to indicate additional features.|