Go to the latest version of this document.

# ``twisted`.`protocols`.`ftp`.`FTPRealm``

class documentation

`class FTPRealm(BaseFTPRealm): (source)`

Constructor: `FTPRealm(anonymousRoot, userHome)`

View In Hierarchy

Method | `__init__` | Undocumented
Method | `getHomeDirectory` | Use `avatarId` as a single path segment to construct a child of `self.userHome` and return that child.
Instance Variable | `anonymousRoot` | Root of the filesystem to which anonymous users will be granted access.
Instance Variable | `userHome` | Root of the filesystem containing user home directories.

Inherited from `BaseFTPRealm`:

Method | `requestAvatar` | Return avatar which provides one of the given interfaces.

def __init__(self, anonymousRoot, userHome='/home'): (source)
overrides `twisted.protocols.ftp.BaseFTPRealm.__init__`

Undocumented

def getHomeDirectory(self, avatarId): (source)
overrides `twisted.protocols.ftp.BaseFTPRealm.getHomeDirectory`

Use `avatarId` as a single path segment to construct a child of `self.userHome` and return that child.

anonymousRoot: `twisted.python.filepath.FilePath` = (source)
overrides `twisted.protocols.ftp.BaseFTPRealm.anonymousRoot`

Root of the filesystem to which anonymous users will be granted access.

userHome: `filepath.FilePath` = (source)

Root of the filesystem containing user home directories.