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”:
Search in specific fields. The following search matches all objects
in "twisted.mail" that matches “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”:
Results provided by Lunr.js
class AuthOptionMixin: (source)
Defines helper methods that can be added on to any
usage.Options subclass that needs authentication.
This mixin implements three new options methods:
The opt_auth method (--auth) will write two new values to the 'self' dictionary: credInterfaces (a dict of lists) and credCheckers (a list).
The opt_help_auth method (--help-auth) will search for all available checker plugins and list them for the user; it will exit when finished.
The opt_help_auth_type method (--help-auth-type) will display detailed help for a particular checker plugin.
||Supply a supplied credentials checker to the Options class.|
||Specify an authentication method for the server.|
||Show all authentication methods available.|
||Show help for a particular authentication type.|
||Returns whether a checker factory will provide at least one of the credentials interfaces that we care about.|
||Returns whether a particular credentials interface is supported.|
||A writeable object to which this options class will send all help-related output. Default:
||An iterable object that returns credential interfaces which this application is able to support.|
||Return a list of which authTypes will be displayed by --help-auth. This makes it a lot easier to test this module.|
Supply a supplied credentials checker to the Options class.
Returns whether a checker factory will provide at least one of the credentials interfaces that we care about.
Returns whether a particular credentials interface is supported.
A writeable object to which this options class will send all help-related output. Default:
An iterable object that returns credential interfaces which this application is able to support.