twisted.protocols.amp.Path

class documentation

class Path(Unicode): (source)

View In Hierarchy

Encode and decode filepath.FilePath instances as paths on the wire.

This is really intended for use with subprocess communication tools: exchanging pathnames on different machines over a network is not generally meaningful, but neither is it disallowed; you can use this to communicate about NFS paths, for example.

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 Unicode, String):

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.Unicode.fromString
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.Unicode.toString
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