twisted.protocols.ftp.BaseFTPRealm : API documentation

Method	__init__	Undocumented
Method	getHomeDirectory	Return a `FilePath` representing the home directory of the given avatar. Override this in a subclass.
Method	requestAvatar	Return avatar which provides one of the given interfaces.

def __init__(self, anonymousRoot): (source)

Undocumented

def getHomeDirectory(self, avatarId): (source)

Return a FilePath representing the home directory of the given avatar. Override this in a subclass.

Parameters	avatarId	A user identifier returned from a credentials checker. (type: `str`)
Returns	(type: `FilePath`)

def requestAvatar(self, avatarId, mind, *interfaces): (source)

Return avatar which provides one of the given interfaces.

Parameters	avatarId	a string that identifies an avatar, as returned by `ICredentialsChecker.requestAvatarId` (via a Deferred). Alternatively, it may be `twisted.cred.checkers.ANONYMOUS`.
	mind	usually None. See the description of mind in `Portal.login`.
	interfaces	the interface(s) the returned avatar should implement, e.g. `IMailAccount`. See the description of `Portal.login`.
Returns	a deferred which will fire a tuple of (interface, avatarAspect, logout), or the tuple itself. The interface will be one of the interfaces passed in the 'interfaces' argument. The 'avatarAspect' will implement that interface. The 'logout' object is a callable which will detach the mind from the avatar.

t.p.f.BaseFTPRealm : class documentation