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

class documentation

`class Argument: (source)`

Known subclasses: `twisted.python.formmethod.Boolean`, `twisted.python.formmethod.Choice`, `twisted.python.formmethod.Date`, `twisted.python.formmethod.File`, `twisted.python.formmethod.Flags`, `twisted.python.formmethod.Float`, `twisted.python.formmethod.Integer`, `twisted.python.formmethod.String`

View In Hierarchy

Base class for form arguments.

Method | `__init__` | Undocumented
Method | `addHints` | Undocumented
Method | `coerce` | Convert the value to the correct format.
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, default=None, shortDesc=None, longDesc=None, hints=None, allowNone=1): (source)
overridden in `twisted.python.formmethod.Choice`, `twisted.python.formmethod.Date`, `twisted.python.formmethod.File`, `twisted.python.formmethod.Flags`, `twisted.python.formmethod.Float`, `twisted.python.formmethod.Integer`, `twisted.python.formmethod.String`

Undocumented

def addHints(self, **kwargs): (source)

Undocumented

def coerce(self, val): (source)
overridden in `twisted.python.formmethod.Boolean`, `twisted.python.formmethod.Choice`, `twisted.python.formmethod.Date`, `twisted.python.formmethod.File`, `twisted.python.formmethod.Flags`, `twisted.python.formmethod.Float`, `twisted.python.formmethod.Integer`, `twisted.python.formmethod.String`

Convert the value to the correct format.

def getHint(self, name, default=None): (source)

Undocumented

def getLongDescription(self): (source)

Undocumented

def getShortDescription(self): (source)

Undocumented

defaultDefault: `Any` = (source)
overridden in `twisted.python.formmethod.Date`, `twisted.python.formmethod.Float`, `twisted.python.formmethod.Integer`, `twisted.python.formmethod.String`

Undocumented

allowNone = (source)
overridden in `twisted.python.formmethod.Date`, `twisted.python.formmethod.Submit`

Undocumented

default = (source)

Undocumented

hints = (source)

Undocumented

longDesc = (source)

Undocumented

name = (source)

Undocumented

shortDesc = (source)

Undocumented