Encode and decode lists of instances of a single other argument type.
For example, if you want to pass:
[3, 7, 9, 15]
You can create an argument like this:
ListOf(Integer())
The serialized form of the entire list is subject to the limit imposed by MAX_VALUE_LENGTH
. List elements are represented as 16-bit length prefixed strings. The argument type passed to the ListOf
initializer is responsible for producing the serialized form of each element.
Parameters | |
optional | a boolean indicating whether this argument can be omitted in the protocol. |
Present Since | |
10.0 |
Method | __init__ |
Create an Argument. |
Method | from |
Convert the serialized form of a list of instances of some type back into that list. |
Method | to |
Serialize the given list of objects to a single string. |
Instance Variable | element |
The Argument instance used to encode and decode list elements (note, not an arbitrary IArgumentType implementation: arguments must be implemented using only the fromString and toString methods, not the ... |
Inherited from Argument
:
Method | from |
Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values. |
Method | from |
Convert a string to a Python value. |
Method | retrieve |
Retrieve the given key from the given dictionary, removing it if found. |
Method | to |
Populate an 'out' AmpBox with strings encoded from an 'in' dictionary mapping names to Python values. |
Method | to |
Convert a Python object to a string. |
Instance Variable | optional |
Undocumented |
twisted.protocols.amp.Argument.__init__
Create an Argument.
Parameters | |
element | Undocumented |
optional | a boolean indicating whether this argument can be omitted in the protocol. |
twisted.protocols.amp.Argument.toString
Serialize the given list of objects to a single string.
The Argument
instance used to encode and decode list elements (note, not an arbitrary IArgumentType
implementation: arguments must be implemented using only the fromString and toString methods, not the fromBox and toBox methods).