twisted.protocols.amp.String

class documentation

class String(Argument): (source)

Known subclasses: twisted.protocols.amp.Unicode, twisted.protocols.amp._LocalArgument

View In Hierarchy

Don't do any conversion at all; just pass through 'str'.
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:

Method __init__ Create an 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​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 fromString(self, inString): (source)
overrides twisted.protocols.amp.Argument.fromString
overridden in twisted.protocols.amp.Unicode
Convert a string to a Python object. Subclasses must implement this.
Parameters
in​String:bytesthe string to convert.
Returns
the decoded value from inString
def toString(self, inObject): (source)
overrides twisted.protocols.amp.Argument.toString
overridden in twisted.protocols.amp.Unicode
Convert a Python object into a string for passing over the network.
Parameters
in​Objectan object of the type that this Argument is intended to deal with.
Returns
bytesthe wire encoding of inObject