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`.`web`.`iweb`.`IUsernameDigestHash``

interface documentation

`class IUsernameDigestHash(ICredentials): (source)`

Known implementations: `twisted.cred.credentials.DigestedCredentials`

View In Hierarchy

This credential is used when a CredentialChecker has access to the hash of the username:realm:password as in an Apache .htdigest file.

Method | `checkHash` | No summary

def checkHash(digestHash): (source)

Parameters
digestHash | The hashed username:realm:password to check against.
Returns
`True` if the credentials represented by this object match the given hash, `False` if they do not, or a `Deferred` which will be called back with one of these values.