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`.`cred`.`portal`.`IRealm``

interface documentation

`class IRealm(Interface): (source)`

Known implementations: `twisted.conch.unix.UnixSSHRealm`, `twisted.mail.maildir.MaildirDirdbmDomain`, `twisted.protocols.ftp.BaseFTPRealm`, `twisted.words.service.WordsRealm`, `twisted.conch.manhole_tap._StupidRealm`

View In Hierarchy

The realm connects application-specific objects to the authentication system.

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

def requestAvatar(avatarId: `Union[bytes, Tuple[]]`, mind: `object`, *interfaces: `_InterfaceItself`) -> `Union[Deferred[_requestResult], _requestResult]`: (source)

Return avatar which provides one of the given interfaces.

Parameters
avatarId:`Union[bytes, Tuple[]]` | a string that identifies an avatar, as returned by `ICredentialsChecker.requestAvatarId` (via a Deferred). Alternatively, it may be `twisted.cred.checkers.ANONYMOUS`.
mind:`object` | usually None. See the description of mind in `Portal.login`.
*interfaces:`_InterfaceItself` | the interface(s) the returned avatar should implement, e.g. `IMailAccount`. See the description of `Portal.login`.
Returns
`Union[Deferred[_requestResult], _requestResult]` | 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.