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

module documentation
(source)

Support for resolving command-line strings that represent different checkers available to cred.

Examples:

- passwd:/etc/passwd
- memory:admin:asdf:user:lkj
- unix

Interface | `ICheckerFactory` | A factory for objects which provide `twisted.cred.checkers.ICredentialsChecker`.
Class | `AuthOptionMixin` | Defines helper methods that can be added on to any `usage.Options` subclass that needs authentication.
Exception | `InvalidAuthArgumentString` | Raised by an authentication plugin when the argument string provided is formatted incorrectly.
Exception | `InvalidAuthType` | Raised when a user provides an invalid identifier for the authentication plugin (known as the authType).
Exception | `StrcredException` | Base exception class for strcred.
Exception | `UnsupportedInterfaces` | Raised when an application is given a checker to use that does not provide any of the application's supported credentials interfaces.
Function | `findCheckerFactories` | Find all objects that implement `ICheckerFactory`.
Function | `findCheckerFactory` | Find the first checker factory that supports the given authType.
Function | `makeChecker` | Returns an `twisted.cred.checkers.ICredentialsChecker` based on the contents of a descriptive string. Similar to `twisted.application.strports`.
Variable | `notSupportedWarning` | Undocumented

def findCheckerFactories(): (source)

Find all objects that implement `ICheckerFactory`.

def findCheckerFactory(authType): (source)

Find the first checker factory that supports the given authType.

def makeChecker(description): (source)

Returns an `twisted.cred.checkers.ICredentialsChecker` based on the contents of a descriptive string. Similar to `twisted.application.strports`.

notSupportedWarning: `str` = (source)

Undocumented