twisted.test.test_amp.TransportPeer

class documentation

class TransportPeer(amp.Argument): (source)

Undocumented

Method	`fromStringProto`	Convert a string to a Python value.
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.

Inherited from Argument:

Method	`__init__`	Create an Argument.
Method	`fromBox`	Populate an 'out' dictionary with mapping names to Python values decoded from an 'in' AmpBox mapping strings to string values.
Method	`fromString`	Convert a string to a Python object. Subclasses must implement this.
Method	`toString`	Convert a Python object into a string for passing over the network.
Method	`toStringProto`	Convert a Python object to a string.
Instance Variable	`optional`	Undocumented

def fromStringProto(self, notAString, proto): (source) ¶

overrides twisted.protocols.amp.Argument.fromStringProto

Convert a string to a Python value.

Parameters
notAString	Undocumented
proto:AMP	the protocol we are converting for.
inString:`bytes`	the string to convert.
Returns
a Python object.

def retrieve(self, d, name, proto): (source) ¶

overrides twisted.protocols.amp.Argument.retrieve

Retrieve the given key from the given dictionary, removing it if found.

Parameters
d	a dictionary.
name	a key in d.
proto	an instance of an AMP.
Returns
d[name].
Raises
`KeyError`	if I am not optional and no value was found.

def toBox(self, name, strings, objects, proto): (source) ¶

from twisted.protocols.amp.IArgumentType

overrides twisted.protocols.amp.Argument.toBox

Populate an 'out' AmpBox with strings encoded from an 'in' dictionary mapping names to Python values.

Parameters
name:`bytes`	the argument name to retrieve
strings:AmpBox	The AmpBox to write string(s) to, a mapping of argument names to string values.
objects:dict	The dictionary to read object(s) from, a mapping of names to Python objects. Keys should be native strings.
proto:AMP	the protocol we are converting for.