twisted.protocols.ftp.IFTPShell(Interface)
interface documentationtwisted.protocols.ftp
View Source
(View In Hierarchy)
Known implementations: twisted.protocols.ftp.FTPAnonymousShell
An abstraction of the shell commands used by the FTP protocol for a given user account.
All path names must be absolute.
Method | makeDirectory | Create a directory. |
Method | removeDirectory | Remove a directory. |
Method | removeFile | Remove a file. |
Method | rename | Rename a file or directory. |
Method | access | Determine whether access to the given path is allowed. |
Method | stat | Retrieve information about the given path. |
Method | list | Retrieve information about the given path. |
Method | openForReading | |
Method | openForWriting |
Create a directory.
Parameters | path | The path, as a list of segments, to create (type: list of unicode ) |
Returns | A Deferred which fires when the directory has been created, or which fails if the directory cannot be created. |
Remove a directory.
Parameters | path | The path, as a list of segments, to remove (type: list of unicode ) |
Returns | A Deferred which fires when the directory has been removed, or which fails if the directory cannot be removed. |
Remove a file.
Parameters | path | The path, as a list of segments, to remove (type: list of unicode ) |
Returns | A Deferred which fires when the file has been removed, or which fails if the file cannot be removed. |
Rename a file or directory.
Parameters | fromPath | The current name of the path. (type: list of unicode ) |
toPath | The desired new name of the path. (type: list of unicode ) | |
Returns | A Deferred which fires when the path has been renamed, or which fails if the path cannot be renamed. |
Determine whether access to the given path is allowed.
Parameters | path | The path, as a list of segments |
Returns | A Deferred which fires with None if access is allowed or which fails with a specific exception type if access is denied. |
Retrieve information about the given path.
This is like list, except it will never return results about child paths.
Retrieve information about the given path.
If the path represents a non-directory, the result list should have only one entry with information about that non-directory. Otherwise, the result list should have an element for each child of the directory.
Parameters | path | The path, as a list of segments, to list (type: list of unicode or bytes ) |
keys | A tuple of keys desired in the resulting dictionaries. | |
Returns | A Deferred which fires with a list of (name, list), where the name is the
name of the entry as a unicode string or bytes and each list contains
values corresponding to the requested keys. The following are possible
elements of keys, and the values which should be returned for them:
|
Parameters | path | The path, as a list of segments, to open (type: list of unicode ) |
Returns | (type: Deferred which will fire with IReadFile ) |
Parameters | path | The path, as a list of segments, to open (type: list of unicode ) |
Returns | (type: Deferred which will fire with IWriteFile ) |