xmlrpclib

An XML-RPC client interface for Python.

The marshalling and response parser code can also be used to implement XML-RPC servers.

Exported exceptions:

Error Base class for client errors ProtocolError Indicates an HTTP protocol error ResponseError Indicates a broken response package Fault Indicates an XML-RPC fault package

Exported classes:

ServerProxy Represents a logical connection to an XML-RPC server

MultiCall Executor of boxcared xmlrpc requests Boolean boolean wrapper to generate a “boolean” XML-RPC value DateTime dateTime wrapper for an ISO 8601 string or time tuple or

localtime integer value to generate a “dateTime.iso8601” XML-RPC value

Binary binary data wrapper

SlowParser Slow but safe standard parser (based on xmllib) Marshaller Generate an XML-RPC params chunk from a Python data structure Unmarshaller Unmarshal an XML-RPC response from incoming XML event message Transport Handles an HTTP transaction to an XML-RPC server SafeTransport Handles an HTTPS transaction to an XML-RPC server

Exported constants:

True False

Exported functions:

boolean Convert any Python value to an XML-RPC boolean getparser Create instance of the fastest available parser & attach

to an unmarshalling object
dumps Convert an argument tuple or a Fault instance to an XML-RPC
request (or response, if the methodresponse option is used).
loads Convert an XML-RPC packet to unmarshalled data plus a method
name (None if not present).

Functions

dumps(params[, methodname, methodresponse, ...]) data [,options] -> marshalled data
escape(s[, replace])
getparser(() -> parser, unmarshaller) Create an instance of the fastest available parser, and attach it to an unmarshalling object.
gzip_decode(data[, max_decode]) gzip encoded data -> unencoded data
gzip_encode(data) data -> gzip encoded data
loads(data[, use_datetime]) data -> unmarshalled data, method name

Classes

Binary([data]) Wrapper for binary data.
Boolean alias of bool
BooleanType alias of bool
BufferType alias of buffer
BuiltinFunctionType alias of builtin_function_or_method
BuiltinMethodType alias of builtin_function_or_method
ClassType alias of classobj
CodeType alias of code
ComplexType alias of complex
DateTime([value]) DateTime wrapper for an ISO 8601 string or time tuple or localtime integer value to generate ‘dateTime.iso8601’ XML-RPC value.
DictProxyType alias of dictproxy
DictType alias of dict
DictionaryType alias of dict
EllipsisType alias of ellipsis
ExpatParser(target)
FileType alias of file
FloatType alias of float
FrameType alias of frame
FunctionType alias of function
GeneratorType alias of generator
GetSetDescriptorType alias of getset_descriptor
GzipDecodedResponse(response) a file-like object to decode a response encoded with the gzip
InstanceType alias of instance
IntType alias of int
LambdaType alias of function
ListType alias of list
LongType alias of long
Marshaller([encoding, allow_none]) Generate an XML-RPC params chunk from a Python data structure.
MemberDescriptorType alias of member_descriptor
MethodType alias of instancemethod
ModuleType alias of module
MultiCall(server) server -> a object used to boxcar method calls
MultiCallIterator(results) Iterates over the results of a multicall.
NoneType
NotImplementedType
ObjectType alias of object
SafeTransport([use_datetime, context]) Handles an HTTPS transaction to an XML-RPC server.
Server alias of ServerProxy
ServerProxy(uri[, transport, encoding, ...]) uri [,options] -> a logical connection to an XML-RPC server
SliceType alias of slice
SlowParser(target) Default XML parser (based on xmllib.XMLParser).
StringType alias of str
TracebackType alias of traceback
Transport([use_datetime]) Handles an HTTP transaction to an XML-RPC server.
TupleType alias of tuple
TypeType alias of type
UnboundMethodType alias of instancemethod
UnicodeType alias of unicode
Unmarshaller([use_datetime]) Unmarshal an XML-RPC response, based on incoming XML event messages (start, data, end).
XRangeType alias of xrange
boolean alias of bool

Exceptions

Error Base class for client errors.
Fault(faultCode, faultString, **extra) Indicates an XML-RPC fault package.
ProtocolError(url, errcode, errmsg, headers) Indicates an HTTP protocol error.
ResponseError Indicates a broken response package.