Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``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.