t.p.f.FTPShell(FTPAnonymousShell) : class documentation

Part of twisted.protocols.ftp View Source View In Hierarchy

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:

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_owner Undocumented
Method _stat_group Undocumented
Method _stat_directory Undocumented
def makeDirectory(self, path): (source)
Create a directory.
ParameterspathThe path, as a list of segments, to create (type: list of unicode )
ReturnsA Deferred which fires when the directory has been created, or which fails if the directory cannot be created.
def removeDirectory(self, path): (source)
Remove a directory.
ParameterspathThe path, as a list of segments, to remove (type: list of unicode )
ReturnsA Deferred which fires when the directory has been removed, or which fails if the directory cannot be removed.
def removeFile(self, path): (source)
Remove a file.
ParameterspathThe path, as a list of segments, to remove (type: list of unicode )
ReturnsA Deferred which fires when the file has been removed, or which fails if the file cannot be removed.
def rename(self, fromPath, toPath): (source)
Rename a file or directory.
ParametersfromPathThe current name of the path. (type: list of unicode )
toPathThe desired new name of the path. (type: list of unicode )
ReturnsA Deferred which fires when the path has been renamed, or which fails if the path cannot be renamed.
def openForWriting(self, path): (source)
Open path for writing.
ParameterspathThe path, as a list of segments, to open. (type: list of unicode )
ReturnsA 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.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.