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

class documentation

`class SystemFTPRealm(BaseFTPRealm): (source)`

Constructor: `SystemFTPRealm(anonymousRoot)`

View In Hierarchy

`SystemFTPRealm` uses system user account information to decide what the home directory for a particular avatarId is.

This works on POSIX but probably is not reliable on Windows.

Method | `getHomeDirectory` | Return the system-defined home directory of the system user account with the name `avatarId`.

Inherited from `BaseFTPRealm`:

Method | `__init__` | Undocumented
Method | `requestAvatar` | Return avatar which provides one of the given interfaces.
Instance Variable | `anonymousRoot` | Undocumented

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

Return the system-defined home directory of the system user account with the name `avatarId`.