xmlrpclib (version 0.9.8)
index
/home/zope/lib/python/xmlrpclib.py

# XML-RPC CLIENT LIBRARY
# $Id$
#
# an XML-RPC client interface for Python.
#
# the marshalling and response parser code can also be used to
# implement XML-RPC servers.
#
# Notes:
# this version uses the sgmlop XML parser, if installed.  this is
# typically 10-15x faster than using Python's standard XML parser.
#
# you can get the sgmlop distribution from:
#
#    http://www.pythonware.com/madscientist
#
# also note that this version is designed to work with Python 1.5.1
# or newer.  it doesn't use any 1.5.2-specific features.
#
# History:
# 1999-01-14 fl  Created
# 1999-01-15 fl  Changed dateTime to use localtime
# 1999-01-16 fl  Added Binary/base64 element, default to RPC2 service
# 1999-01-19 fl  Fixed array data element (from Skip Montanaro)
# 1999-01-21 fl  Fixed dateTime constructor, etc.
# 1999-02-02 fl  Added fault handling, handle empty sequences, etc.
# 1999-02-10 fl  Fixed problem with empty responses (from Skip Montanaro)
# 1999-06-20 fl  Speed improvements, pluggable XML parsers and HTTP transports
#
# Copyright (c) 1999 by Secret Labs AB.
# Copyright (c) 1999 by Fredrik Lundh.
#
# fredrik@pythonware.com
http://www.pythonware.com
#
# --------------------------------------------------------------------
# The XML-RPC client interface is

# Copyright (c) 1999 by Secret Labs AB
# Copyright (c) 1999 by Fredrik Lundh

# By obtaining, using, and/or copying this software and/or its
# associated documentation, you agree that you have read, understood,
# and will comply with the following terms and conditions:
#
# Permission to use, copy, modify, and distribute this software and
# its associated documentation for any purpose and without fee is
# hereby granted, provided that the above copyright notice appears in
# all copies, and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of
# Secret Labs AB or the author not be used in advertising or publicity
# pertaining to distribution of the software without specific, written
# prior permission.
#
# SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
# TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-
# ABILITY AND FITNESS.  IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR
# BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
# DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
# WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
# ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
# OF THIS SOFTWARE.
# --------------------------------------------------------------------

 
Modules
            
base64
string
time
urllib
xmllib
xmlrpclib

 
Classes
            
Binary
Boolean
DateTime
Error
Fault
ProtocolError
ResponseError
Marshaller
Server
Transport
BasicAuthTransport
Unmarshaller
xmllib.XMLParser
SlowParser
_Method

 
class BasicAuthTransport
      Transport subclass that provides HTTP basic authentication.
 
  
__init__(self, username=None, password=None)
request(self, host, handler, request_body)

 
class Binary
       
  
__init__(self, data=None)
decode(self, data)
encode(self, out)

 
class Boolean
       
  
__init__(self, value=0)
__int__(self)
__nonzero__(self)
__repr__(self)
encode(self, out)

 
class DateTime
       
  
__init__(self, value=0)
__repr__(self)
decode(self, data)
encode(self, out)

 
class Error
       
  

 
class Fault
       
  
__init__(self, faultCode, faultString, **extra)
# indicates a XML-RPC fault package
__repr__(self)

 
class Marshaller
      Generate an XML-RPC params chunk from a Python data structure
 
  
_Marshaller__dump = __dump(self, value)
__init__(self)
container(self, value)
dump_array(self, value)
dump_double(self, value)
dump_instance(self, value)
dump_int(self, value)
dump_string(self, value)
dump_struct(self, value)
dumps(self, values)

 
class ProtocolError
       
  
__init__(self, url, errcode, errmsg, headers)
# indicates an HTTP protocol error
__repr__(self)

 
class ResponseError
       
  

 
class Server
      Represents a connection to an XML-RPC server
 
  
_Server__request = __request(self, methodname, params)
__getattr__(self, name)
__init__(self, uri, transport=None)
__repr__(self)
__str__ = __repr__(self)

 
class SlowParser
       
  
__init__(self, target)

 
class Transport
      Handles an HTTP transaction to an XML-RPC server
 
  
parse_response(self, f)
request(self, host, handler, request_body)

 
class Unmarshaller
       
  
__init__(self)
close(self)
data(self, text)
end(self, tag)
end_array(self)
end_base64(self, join=<function join>)
end_boolean(self, join=<function join>)
end_dateTime(self, join=<function join>)
end_double(self, join=<function join>)
end_fault(self)
end_int(self, join=<function join>)
end_methodName(self, join=<function join>)
end_params(self)
end_string(self, join=<function join>)
end_struct(self)
end_value(self)
getmethodname(self)
start(self, tag, attrs)

 
class _Method
       
  
__call__(self, *args)
__getattr__(self, name)
__init__(self, send, name)
# some magic to bind an XML-RPC method to an RPC server.
# supports "nested" methods (e.g. examples.getStateName)

 
Functions
            
dumps(params, methodname=None, methodresponse=None)
getparser()
loads(data)

 
Data
             BufferType = <type 'buffer'>

BuiltinFunctionType = <type 'builtin_function_or_method'>

BuiltinMethodType = <type 'builtin_function_or_method'>

ClassType = <type 'class'>

CodeType = <type 'code'>

ComplexType = <type 'complex'>

DictType = <type 'dictionary'>

DictionaryType = <type 'dictionary'>

EllipsisType = <type 'ellipsis'>

False = <Boolean False at 893aecc>

FastParser = None

FileType = <type 'file'>

FloatType = <type 'float'>

FrameType = <type 'frame'>

FunctionType = <type 'function'>

InstanceType = <type 'instance'>

IntType = <type 'int'>

LambdaType = <type 'function'>

ListType = <type 'list'>

LongType = <type 'long int'>

MethodType = <type 'instance method'>

ModuleType = <type 'module'>

NoneType = <type 'None'>

SliceType = <type 'slice'>

StringType = <type 'string'>

TracebackType = <type 'traceback'>

True = <Boolean True at 8937c74>

TupleType = <type 'tuple'>

TypeType = <type 'type'>

UnboundMethodType = <type 'instance method'>

UnicodeType = <type 'unicode'>

WRAPPERS = (<class xmlrpclib.DateTime>, <class xmlrpclib.Binary>, <class xmlrpclib.Boolean>)

XRangeType = <type 'xrange'>

__file__ = '/home/zope/lib/python/xmlrpclib.pyc'

__name__ = 'xmlrpclib'

__version__ = '0.9.8'

sgmlop = None