twisted.protocols.ftp.FTPAnonymousShell(object) class documentationtwisted.protocols.ftp
(View In Hierarchy)
Known subclasses: twisted.protocols.ftp.FTPShell
Implements interfaces: twisted.protocols.ftp.IFTPShell
An anonymous implementation of IFTPShell
| Instance Variable | filesystemRoot | The path which is considered the root of this shell. (type: twisted.python.filepath.FilePath) |
| Method | __init__ | Undocumented |
| Method | makeDirectory | Create a directory. |
| Method | removeDirectory | Remove a directory. |
| Method | removeFile | Remove a file. |
| Method | rename | Rename a file or directory. |
| Method | receive | Undocumented |
| Method | openForReading | Open path for reading. |
| Method | openForWriting | Reject write attempts by anonymous users with PermissionDeniedError. |
| 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 |
twisted.python.filepath.FilePath)
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 reading.
| 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 IReadFile 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. | |
Reject write attempts by anonymous users with PermissionDeniedError.
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.
Return the list of files at given path, adding
keys stat informations if specified.
| Parameters | path | the directory or file to check. (type: str) |
| keys | the list of desired metadata (type: list of str) |
Shortcut method to get stat info on a node.
| Parameters | filePath | the node to stat. (type: filepath.FilePath) |
| keys | the stat keys to get. (type: iterable) |
Get the filepath's size as an int
| Parameters | fp | twisted.python.filepath.FilePath |
| Returns | int representing the size | |
Get the filepath's permissions object
| Parameters | fp | twisted.python.filepath.FilePath |
| Returns | twisted.python.filepath.Permissions
of fp | |
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.
(Reference: http://stackoverflow.com/questions/5275731/os-stat-on-windows)
| Parameters | fp | twisted.python.filepath.FilePath |
| Returns | int representing the number of hardlinks | |
Get the filepath's last modified date
| Parameters | fp | twisted.python.filepath.FilePath |
| Returns | int as seconds since the epoch | |
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.
(Reference: http://stackoverflow.com/questions/5275731/os-stat-on-windows)
| Parameters | fp | twisted.python.filepath.FilePath |
| Returns | str representing the owner's username | |
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.
(Reference: http://stackoverflow.com/questions/5275731/os-stat-on-windows)
| Parameters | fp | twisted.python.filepath.FilePath |
| Returns | str representing the owner's group | |
Get whether the filepath is a directory
| Parameters | fp | twisted.python.filepath.FilePath |
| Returns | bool | |