class twisted.protocols.ftp.FTPShell(FTPAnonymousShell): (source)
An authenticated implementation of IFTPShell.
| Method | makeDirectory | Create a directory. |
| Method | removeDirectory | Remove a directory. |
| Method | removeFile | Remove a file. |
| Method | rename | Rename a file or directory. |
| Method | openForWriting | Open path for writing. |
Inherited from FTPAnonymousShell:
| Instance Variable | filesystemRoot | The path which is considered the root of this shell. |
| Method | __init__ | Undocumented |
| Method | receive | Undocumented |
| Method | openForReading | Open path for reading. |
| Method | access | Determine whether access to the given path is allowed. |
| Method | stat | Retrieve information about the given path. |
| Method | list | Return the list of files at given path, adding keys stat informations if specified. |
| Method | _path | Undocumented |
| Method | _statNode | Shortcut method to get stat info on a node. |
| Method | _stat_size | Get the filepath's size as an int |
| Method | _stat_permissions | Get the filepath's permissions object |
| Method | _stat_hardlinks | Get the number of hardlinks for the filepath - if the number of hardlinks is not yet implemented (say in Windows), just return 0 since stat-ing a file in Windows seems to return st_nlink=0. |
| Method | _stat_modified | Get the filepath's last modified date |
| Method | _stat_owner | Get the filepath's owner's username. If this is not implemented (say in Windows) return the string "0" since stat-ing a file in Windows seems to return st_uid=0. |
| Method | _stat_group | Get the filepath's owner's group. If this is not implemented (say in Windows) return the string "0" since stat-ing a file in Windows seems to return st_gid=0. |
| Method | _stat_directory | Get whether the filepath is a directory |
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. | |
Open path for writing.
| Parameters | path | The path, as a list of segments, to open. (type: list of unicode) |
| Returns | A Deferred is returned that will fire with an object implementing IWriteFile if the file is successfully opened. If path is a directory, or if an exception is raised while trying to open the file, the Deferred will fire with an error. | |