twisted.protocols.ftp.IFTPShell(Interface) interface documentation

Part of twisted.protocols.ftp (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
def makeDirectory(path):

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(path):

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(path):

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(fromPath, toPath):

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 access(path):

Determine whether access to the given path is allowed.

ParameterspathThe path, as a list of segments
ReturnsA Deferred which fires with None if access is allowed or which fails with a specific exception type if access is denied.
def stat(path, keys=()):

Retrieve information about the given path.

This is like list, except it will never return results about child paths.

def list(path, keys=()):

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.

ParameterspathThe path, as a list of segments, to list (type: list of unicode or bytes)
keysA tuple of keys desired in the resulting dictionaries.
ReturnsA 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:
  • 'size': size in bytes, as an integer (this is kinda required)
  • 'directory': boolean indicating the type of this entry
  • 'permissions': a bitvector (see os.stat(foo).st_mode)
  • 'hardlinks': Number of hard links to this entry
  • 'modified': number of seconds since the epoch since entry was modified
  • 'owner': string indicating the user owner of this entry
  • 'group': string indicating the group owner of this entry
def openForReading(path):
ParameterspathThe path, as a list of segments, to open (type: list of unicode)
Returns (type: Deferred which will fire with IReadFile)
def openForWriting(path):
ParameterspathThe path, as a list of segments, to open (type: list of unicode)
Returns (type: Deferred which will fire with IWriteFile)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.