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`.`protocols`.`amp`.`_LocalArgument``

class documentation

`class _LocalArgument(String): (source)`

View In Hierarchy

Local arguments are never actually relayed across the wire. This is just a shim so that StartTLS can pretend to have some arguments: if arguments acquire documentation properties, replace this with something nicer later.

Method | `fromBox` | Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values.

Inherited from `String`:

Method | `fromString` | Convert a string to a Python object. Subclasses must implement this.
Method | `toString` | Convert a Python object into a string for passing over the network.

Inherited from `Argument` (via `String`):

Method | `__init__` | Create an Argument.
Method | `fromStringProto` | Convert a string to a Python value.
Method | `retrieve` | Retrieve the given key from the given dictionary, removing it if found.
Method | `toBox` | Populate an 'out' AmpBox with strings encoded from an 'in' dictionary mapping names to Python values.
Method | `toStringProto` | Convert a Python object to a string.
Instance Variable | `optional` | Undocumented

def fromBox(self, name, strings, objects, proto): (source)
from `twisted.protocols.amp.IArgumentType`
overrides `twisted.protocols.amp.Argument.fromBox`

Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values.

Parameters
name:`bytes` | the argument name to retrieve
strings:AmpBox | The AmpBox to read string(s) from, a mapping of argument names to string values.
objects:dict | The dictionary to write object(s) to, a mapping of names to Python objects. Keys will be native strings.
proto | an AMP instance.