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 from​Box Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values.

Inherited from String:

Method from​String Convert a string to a Python object. Subclasses must implement this.
Method to​String Convert a Python object into a string for passing over the network.

Inherited from Argument (via String):

Method __init__ Create an Argument.
Method from​String​Proto Convert a string to a Python value.
Method retrieve Retrieve the given key from the given dictionary, removing it if found.
Method to​Box Populate an 'out' AmpBox with strings encoded from an 'in' dictionary mapping names to Python values.
Method to​String​Proto 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:bytesthe argument name to retrieve
strings:AmpBoxThe AmpBox to read string(s) from, a mapping of argument names to string values.
objects:dictThe dictionary to write object(s) to, a mapping of names to Python objects. Keys will be native strings.
protoan AMP instance.