Vega strike Python Modules doc: xmlrpclib Namespace Reference

All Data Structures Namespaces Files Functions Variables

Data Structures
class	Error

class	ProtocolError

class	ResponseError

class	Fault

class	Boolean

class	DateTime

class	Binary

class	SgmlopParser

class	ExpatParser

class	SlowParser

class	Marshaller

class	Unmarshaller

class	_Method

class	Transport

class	SafeTransport

class	ServerProxy

Functions
def	escape

def	boolean

def	datetime

def	binary

def	getparser

def	dumps

def	loads

Variables
	unicode = None

int	MAXINT = 2L

int	MININT = -2L

string	__version__ = "1.0.0"

	WRAPPERS = DateTime,Binary,Boolean

	FastParser = _xmlrpclib.Parser

	FastUnmarshaller = _xmlrpclib.Unmarshaller

	SgmlopParser = None

	ExpatParser = None

	Server = ServerProxy

tuple	server = ServerProxy("http://betty.userland.com")

Function Documentation

def xmlrpclib.binary ( data)

Definition at line 298 of file xmlrpclib.py.

 
 def binary(data):
     value = Binary()
     value.decode(data)
     return value

def xmlrpclib.boolean	(	value,
		truefalse = `(False, True`
	)

Convert any Python value to XML-RPC 'boolean'.

Definition at line 237 of file xmlrpclib.py.

 
 def boolean(value, truefalse=(False, True)):
     """Convert any Python value to XML-RPC 'boolean'."""
     return truefalse[operator.truth(value)]

def xmlrpclib.datetime ( data)

Definition at line 272 of file xmlrpclib.py.

 
 def datetime(data):
     value = DateTime()
     value.decode(data)
     return value

def xmlrpclib.dumps	(	params,
		methodname = `None`,
		methodresponse = `None`,
		encoding = `None`
	)

data [,options] -> marshalled data

Convert an argument tuple or a Fault instance to an XML-RPC
request (or response, if the methodresponse option is used).

In addition to the data object, the following options can be given
as keyword arguments:

    methodname: the method name for a methodCall packet

    methodresponse: true to create a methodResponse packet.
    If this option is used with a tuple, the tuple must be
    a singleton (i.e. it can contain only one element).

    encoding: the packet encoding (default is UTF-8)

All 8-bit strings in the data structure are assumed to use the
packet encoding.  Unicode strings are automatically converted,
where necessary.

Definition at line 729 of file xmlrpclib.py.

References string.join().

 
 def dumps(params, methodname=None, methodresponse=None, encoding=None):
     """data [,options] -> marshalled data
 
     Convert an argument tuple or a Fault instance to an XML-RPC
     request (or response, if the methodresponse option is used).
 
     In addition to the data object, the following options can be given
     as keyword arguments:
 
         methodname: the method name for a methodCall packet
 
         methodresponse: true to create a methodResponse packet.
         If this option is used with a tuple, the tuple must be
         a singleton (i.e. it can contain only one element).
 
         encoding: the packet encoding (default is UTF-8)
 
     All 8-bit strings in the data structure are assumed to use the
     packet encoding.  Unicode strings are automatically converted,
     where necessary.
     """
 
     assert isinstance(params, TupleType) or isinstance(params, Fault),\
            "argument must be tuple or Fault instance"
 
     if isinstance(params, Fault):
         methodresponse = 1
     elif methodresponse and isinstance(params, TupleType):
         assert len(params) == 1, "response tuple must be a singleton"
 
     if not encoding:
         encoding = "utf-8"
 
     m = Marshaller(encoding)
     data = m.dumps(params)
 
     if encoding != "utf-8":
         xmlheader = "<?xml version='1.0' encoding=%s?>\n" % repr(encoding)
     else:
         xmlheader = "<?xml version='1.0'?>\n" # utf-8 is default
 
     # standard XML-RPC wrappings
     if methodname:
         # a method call
         if not isinstance(methodname, StringType):
             methodname = methodname.encode(encoding)
         data = (
             xmlheader,
             "<methodCall>\n"
             "<methodName>", methodname, "</methodName>\n",
             data,
             "</methodCall>\n"
             )
     elif methodresponse:
         # a method response, or a fault structure
         data = (
             xmlheader,
             "<methodResponse>\n",
             data,
             "</methodResponse>\n"
             )
     else:
         return data # return as is
     return string.join(data, "")

def xmlrpclib.escape	(	s,
		replace = `string.replace`
	)

Definition at line 144 of file xmlrpclib.py.

References pydoc.replace().

 
 def escape(s, replace=string.replace):
     s = replace(s, "&", "&amp;")
     s = replace(s, "<", "&lt;")
     return replace(s, ">", "&gt;",)

def xmlrpclib.getparser ( )

getparser() -> parser, unmarshaller

Create an instance of the fastest available parser, and attach it
to an unmarshalling object.  Return both objects.

Definition at line 708 of file xmlrpclib.py.

References FastParser, and FastUnmarshaller.

 
 def getparser():
     """getparser() -> parser, unmarshaller
 
     Create an instance of the fastest available parser, and attach it
     to an unmarshalling object.  Return both objects.
     """
     if FastParser and FastUnmarshaller:
         target = FastUnmarshaller(True, False, binary, datetime)
         parser = FastParser(target)
     else:
         target = Unmarshaller()
         if FastParser:
             parser = FastParser(target)
         elif SgmlopParser:
             parser = SgmlopParser(target)
         elif ExpatParser:
             parser = ExpatParser(target)
         else:
             parser = SlowParser(target)
     return parser, target

def xmlrpclib.loads ( data)

data -> unmarshalled data, method name

Convert an XML-RPC packet to unmarshalled data plus a method
name (None if not present).

If the XML-RPC packet represents a fault condition, this function
raises a Fault exception.

Definition at line 794 of file xmlrpclib.py.

References getparser().

 
 def loads(data):
     """data -> unmarshalled data, method name
 
     Convert an XML-RPC packet to unmarshalled data plus a method
     name (None if not present).
 
     If the XML-RPC packet represents a fault condition, this function
     raises a Fault exception.
     """
     p, u = getparser()
     p.feed(data)
     p.close()
     return u.close(), u.getmethodname()
 
 
 # --------------------------------------------------------------------
 # request dispatcher

Data Structures

Functions

Variables

Function Documentation

Variable Documentation