class documentation

class AmpList(Argument): (source)

View In Hierarchy

Convert a list of dictionaries into a list of AMP boxes on the wire.

For example, if you want to pass:

    [{'a': 7, 'b': u'hello'}, {'a': 9, 'b': u'goodbye'}]

You might use an AmpList like this in your arguments or response list:

    AmpList([('a', Integer()),
             ('b', Unicode())])
Method __init__ Create an AmpList.
Method from​String​Proto Convert a string to a Python value.
Method to​String​Proto Convert a Python object to a string.
Instance Variable subargs Undocumented

Inherited from Argument:

Method from​Box Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values.
Method from​String Convert a string to a Python object. Subclasses must implement this.
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 Convert a Python object into a string for passing over the network.
Instance Variable optional Undocumented
def __init__(self, subargs, optional=False): (source)
Create an AmpList.
Parameters
subargs:A list of (bytes, Argument) tuples.a list of 2-tuples of ('name', argument) describing the schema of the dictionaries in the sequence of amp boxes.
optionala boolean indicating whether this argument can be omitted in the protocol.
def fromStringProto(self, inString, proto): (source)
Convert a string to a Python value.
Parameters
in​String:bytesthe string to convert.
proto:AMPthe protocol we are converting for.
Returns
a Python object.
def toStringProto(self, inObject, proto): (source)
Convert a Python object to a string.
Parameters
in​Objectthe object to convert.
proto:AMPthe protocol we are converting for.
subargs = (source)

Undocumented