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`.`python`.`formmethod`.`Flags``

class documentation

`class Flags(Argument): (source)`

Known subclasses: `twisted.python.formmethod.CheckGroup`

Constructor: `Flags(name, flags, default, shortDesc, ...)`

View In Hierarchy

The result of a checkbox group or multi-menu. The flags should be a list of tuples of tag, value, and description. The tag will be the value returned if the user hits "Submit", and the description is the bale for the enumerated type. default is a list of all the values (second elements in flags). If no defaults are specified, initially nothing will be selected. Several items may be selected at once.

Method | `__init__` | Undocumented
Method | `coerce` | Convert the value to the correct format.
Instance Variable | `flags` | Undocumented

Inherited from `Argument`:

Method | `addHints` | Undocumented
Method | `getHint` | Undocumented
Method | `getLongDescription` | Undocumented
Method | `getShortDescription` | Undocumented
Class Variable | `defaultDefault` | Undocumented
Instance Variable | `allowNone` | Undocumented
Instance Variable | `default` | Undocumented
Instance Variable | `hints` | Undocumented
Instance Variable | `longDesc` | Undocumented
Instance Variable | `name` | Undocumented
Instance Variable | `shortDesc` | Undocumented

def __init__(self, name, flags=(), default=(), shortDesc=None, longDesc=None, hints=None, allowNone=1): (source)
overrides `twisted.python.formmethod.Argument.__init__`

Undocumented

def coerce(self, inFlagKeys): (source)
overrides `twisted.python.formmethod.Argument.coerce`

Convert the value to the correct format.

flags = (source)

Undocumented