twisted.protocols.amp._LocalArgument(String) class documentationtwisted.protocols.amp
View 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 | toString | Convert a Python object into a string for passing over the network. |
| Method | fromString | Convert a string to a Python object. Subclasses must implement this. |
Inherited from Argument (via String):
| Method | __init__ | Create an Argument. |
| 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 | fromStringProto | Convert a string to a Python value. |
| Method | toStringProto | Convert a Python object to a string. |
Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values.
| Parameters | name | the argument name to retrieve (type: bytes) |
| strings | The AmpBox to read string(s) from, a mapping of argument names to string values. (type: AmpBox) | |
| objects | The dictionary to write object(s) to, a mapping of names to Python objects. Keys will be native strings. (type: dict) | |
| proto | an AMP instance. |