interface documentation
class ISFTPFile(Interface): (source)
Known implementations: twisted.conch.ssh.filetransfer.ClientFile
, twisted.conch.unix.UnixSFTPFile
This represents an open file on the server. An object adhering to this interface should be returned from openFile
().
Method | close |
Close the file. |
Method | get |
Return the attributes for the file. |
Method | read |
Read from the file. |
Method | set |
Set the attributes for the file. |
Method | write |
Write to the file. |
Close the file.
This method returns nothing if the close succeeds immediately, or a Deferred that is called back when the close succeeds.
Read from the file.
If EOF is reached before any data is read, raise EOFError.
This method returns the data as a string, or a Deferred that is called back with same.
Parameters | |
offset | an integer that is the index to start from in the file. |
length | the maximum length of data to return. The actual amount returned may less than this. For normal disk files, however, this should read the requested number (up to the end of the file). |
Set the attributes for the file.
This method returns when the attributes are set or a Deferred that is called back when they are.
Parameters | |
attrs | a dictionary in the same format as the attrs argument to openFile . |