twisted.protocols.ftp.IFTPShell : API documentation

def makeDirectory(path): (source)

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.

def removeDirectory(path): (source)

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.

def removeFile(path): (source)

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.

def rename(fromPath, toPath): (source)

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.

def access(path): (source)

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.

def stat(path, keys=()): (source)

Retrieve information about the given path.

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

def list(path, keys=()): (source)

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` )
	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 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): (source)

Parameters	path	The path, as a list of segments, to open (type: `list` of `unicode` )
Returns	(type: `Deferred` which will fire with `IReadFile` )

def openForWriting(path): (source)

Parameters	path	The path, as a list of segments, to open (type: `list` of `unicode` )
Returns	(type: `Deferred` which will fire with `IWriteFile` )

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

t.p.f.IFTPShell(Interface) : interface documentation