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`.`guard`.`BasicCredentialFactory``

class documentation

`class BasicCredentialFactory: (source)`

Constructor: `BasicCredentialFactory(authenticationRealm)`

Implements interfaces: `twisted.web.iweb.ICredentialFactory`

View In Hierarchy

Credential Factory for HTTP Basic Authentication

Method | `__init__` | Undocumented
Method | `decode` | Parse the base64-encoded, colon-separated username and password into a `credentials.UsernamePassword` instance.
Method | `getChallenge` | Return a challenge including the HTTP authentication realm with which this factory was created.
Class Variable | `scheme` | A `str` giving the name of the authentication scheme with which this factory is associated. For example, `'basic'` or `'digest'`.
Instance Variable | `authenticationRealm` | The HTTP authentication realm which will be issued in challenges.

def __init__(self, authenticationRealm): (source)

Undocumented

def decode(self, response, request): (source)
from `twisted.web.iweb.ICredentialFactory`

Parse the base64-encoded, colon-separated username and password into a `credentials.UsernamePassword` instance.

def getChallenge(self, request): (source)
from `twisted.web.iweb.ICredentialFactory`

Return a challenge including the HTTP authentication realm with which this factory was created.

scheme: `bytes` = (source)
from `twisted.web.iweb.ICredentialFactory`

A `str` giving the name of the authentication scheme with which this factory is associated. For example, `'basic'` or `'digest'`.

authenticationRealm: `bytes` = (source)

The HTTP authentication realm which will be issued in challenges.