t.p.a._LocalArgument(String) : class documentation

Part of twisted.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.
def fromBox(self, name, strings, objects, proto): (source)
Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values.
Parametersnamethe argument name to retrieve (type: str)
stringsThe AmpBox to read string(s) from, a mapping of argument names to string values. (type: AmpBox)
objectsThe dictionary to write object(s) to, a mapping of names to Python objects. (type: dict)
protoan AMP instance.
API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.