SimpleXMLRPCServer
index
/usr/lib/python2.2/SimpleXMLRPCServer.py

Simple XML-RPC Server.
 
This module can be used to create simple XML-RPC servers
by creating a server and either installing functions, a
class instance, or by extending the SimpleXMLRPCRequestHandler
class.
 
A list of possible usage patterns follows:
 
1. Install functions:
 
server = SimpleXMLRPCServer(("localhost", 8000))
server.register_function(pow)
server.register_function(lambda x,y: x+y, 'add')
server.serve_forever()
 
2. Install an instance:
 
class MyFuncs:
    def __init__(self):
        # make all of the string functions available through
        # string.func_name
        import string
        self.string = string
    def pow(self, x, y): return pow(x, y)
    def add(self, x, y) : return x + y
server = SimpleXMLRPCServer(("localhost", 8000))
server.register_instance(MyFuncs())
server.serve_forever()
 
3. Install an instance with custom dispatch method:
 
class Math:
    def _dispatch(self, method, params):
        if method == 'pow':
            return apply(pow, params)
        elif method == 'add':
            return params[0] + params[1]
        else:
            raise 'bad method'
server = SimpleXMLRPCServer(("localhost", 8000))
server.register_instance(Math())
server.serve_forever()
 
4. Subclass SimpleXMLRPCRequestHandler:
 
class MathHandler(SimpleXMLRPCRequestHandler):
    def _dispatch(self, method, params):
        try:
            # We are forcing the 'export_' prefix on methods that are
            # callable through XML-RPC to prevent potential security
            # problems
            func = getattr(self, 'export_' + method)
        except AttributeError:
            raise Exception('method "%s" is not supported' % method)
        else:
            return apply(func, params)
 
    def log_message(self, format, *args):
        pass # maybe do something fancy like write the messages to a file
 
    def export_add(self, x, y):
        return x + y
 
server = SimpleXMLRPCServer(("localhost", 8000), MathHandler)
server.serve_forever()

 
Modules
            
BaseHTTPServer
SocketServer
sys
xmlrpclib
 
Classes
            
BaseHTTPServer.BaseHTTPRequestHandler(SocketServer.StreamRequestHandler)
SimpleXMLRPCRequestHandler
SocketServer.TCPServer(SocketServer.BaseServer)
SimpleXMLRPCServer
 
class SimpleXMLRPCRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler)
      Simple XML-RPC request handler class.
 
Handles all HTTP POST requests and attempts to decode them as
XML-RPC requests.
 
XML-RPC requests are dispatched to the _dispatch method, which
may be overriden by subclasses. The default implementation attempts
to dispatch XML-RPC calls to the functions or instance installed
in the server.
 
  
Method resolution order:
SimpleXMLRPCRequestHandler
BaseHTTPServer.BaseHTTPRequestHandler
SocketServer.StreamRequestHandler
SocketServer.BaseRequestHandler

Methods defined here:
_dispatch(self, method, params)
Dispatches the XML-RPC method.
 
XML-RPC calls are forwarded to a registered function that
matches the called XML-RPC method name. If no such function
exists then the call is forwarded to the registered instance,
if available.
 
If the registered instance has a _dispatch method then that
method will be called with the name of the XML-RPC method and
it's parameters as a tuple
e.g. instance._dispatch('add',(2,3))
 
If the registered instance does not have a _dispatch method
then the instance will be searched to find a matching method
and, if found, will be called.
 
Methods beginning with an '_' are considered private and will
not be called by SimpleXMLRPCServer.
do_POST(self)
Handles the HTTP POST request.
 
Attempts to interpret all HTTP POST requests as XML-RPC calls,
which are forwarded to the _dispatch method for handling.
log_request(self, code='-', size='-')
Selectively log an accepted request.

Data and non-method functions defined here:
__doc__ = 'Simple XML-RPC request handler class.\n\n Ha... or instance installed\n in the server.\n '
__module__ = 'SimpleXMLRPCServer'

Methods inherited from BaseHTTPServer.BaseHTTPRequestHandler:
address_string(self)
Return the client address formatted for logging.
 
This version looks up the full hostname using gethostbyaddr(),
and tries to find a name that contains at least one dot.
date_time_string(self)
Return the current date and time formatted for a message header.
end_headers(self)
Send the blank line ending the MIME headers.
handle(self)
Handle a single HTTP request.
 
You normally don't need to override this method; see the class
__doc__ string for information on how to handle specific HTTP
commands such as GET and POST.
log_date_time_string(self)
Return the current time formatted for logging.
log_error(self, *args)
Log an error.
 
This is called when a request cannot be fulfilled.  By
default it passes the message on to log_message().
 
Arguments are the same as for log_message().
 
XXX This should go to the separate error log.
log_message(self, format, *args)
Log an arbitrary message.
 
This is used by all other logging functions.  Override
it if you have specific logging wishes.
 
The first argument, FORMAT, is a format string for the
message to be logged.  If the format string contains
any % escapes requiring parameters, they should be
specified as subsequent arguments (it's just like
printf!).
 
The client host and current date/time are prefixed to
every message.
parse_request(self)
Parse a request (internal).
 
The request should be stored in self.raw_request; the results
are in self.command, self.path, self.request_version and
self.headers.
 
Return value is 1 for success, 0 for failure; on failure, an
error is sent back.
send_error(self, code, message=None)
Send and log an error reply.
 
Arguments are the error code, and a detailed message.
The detailed message defaults to the short entry matching the
response code.
 
This sends an error response (so it must be called before any
output has been generated), logs the error, and finally sends
a piece of HTML explaining the error to the user.
send_header(self, keyword, value)
Send a MIME header.
send_response(self, code, message=None)
Send the response header and log the response code.
 
Also send two standard headers with the server software
version and the current date.
version_string(self)
Return the server software version string.

Data and non-method functions inherited from BaseHTTPServer.BaseHTTPRequestHandler:
MessageClass = <class mimetools.Message>
A derived class of rfc822.Message that knows about MIME headers and
contains some hooks for decoding encoded and multipart messages.
error_message_format = '\nError response\n\... explanation: %(code)s = %(explain)s.\n\n'
monthname = [None, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
protocol_version = 'HTTP/1.0'
responses = {200: ('OK', 'Request fulfilled, document follows'), 201: ('Created', 'Document created, URL follows'), 202: ('Accepted', 'Request accepted, processing continues off-line'), 203: ('Partial information', 'Request fulfilled from cache'), 204: ('No response', 'Request fulfilled, nothing follows'), 301: ('Moved', 'Object moved permanently -- see URI list'), 302: ('Found', 'Object moved temporarily -- see URI list'), 303: ('Method', 'Object moved -- see Method and URL list'), 304: ('Not modified', 'Document has not changed singe given time'), 400: ('Bad request', 'Bad request syntax or unsupported method'), ...}
server_version = 'BaseHTTP/0.2'
sys_version = 'Python/2.2'
weekdayname = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']

Methods inherited from SocketServer.StreamRequestHandler:
finish(self)
setup(self)

Data and non-method functions inherited from SocketServer.StreamRequestHandler:
rbufsize = -1
wbufsize = 0

Methods inherited from SocketServer.BaseRequestHandler:
__init__(self, request, client_address, server)
 
class SimpleXMLRPCServer(SocketServer.TCPServer)
      Simple XML-RPC server.
 
Simple XML-RPC server that allows functions and a single instance
to be installed to handle requests.
 
  
Method resolution order:
SimpleXMLRPCServer
SocketServer.TCPServer
SocketServer.BaseServer

Methods defined here:
__init__(self, addr, requestHandler=<class SimpleXMLRPCServer.SimpleXMLRPCRequestHandler>, logRequests=1)
register_function(self, function, name=None)
Registers a function to respond to XML-RPC requests.
 
The optional name argument can be used to set a Unicode name
for the function.
 
If an instance is also registered then it will only be called
if a matching function is not found.
register_instance(self, instance)
Registers an instance to respond to XML-RPC requests.
 
Only one instance can be installed at a time.
 
If the registered instance has a _dispatch method then that
method will be called with the name of the XML-RPC method and
it's parameters as a tuple
e.g. instance._dispatch('add',(2,3))
 
If the registered instance does not have a _dispatch method
then the instance will be searched to find a matching method
and, if found, will be called.
 
Methods beginning with an '_' are considered private and will
not be called by SimpleXMLRPCServer.
 
If a registered function matches a XML-RPC request, then it
will be called instead of the registered instance.

Data and non-method functions defined here:
__doc__ = 'Simple XML-RPC server.\n\n Simple XML-RPC se...e\n to be installed to handle requests.\n '
__module__ = 'SimpleXMLRPCServer'

Methods inherited from SocketServer.TCPServer:
close_request(self, request)
Called to clean up an individual request.
fileno(self)
Return socket file number.
 
Interface required by select().
get_request(self)
Get the request and client address from the socket.
 
May be overridden.
server_activate(self)
Called by constructor to activate the server.
 
May be overridden.
server_bind(self)
Called by constructor to bind the socket.
 
May be overridden.
server_close(self)
Called to clean-up the server.
 
May be overridden.

Data and non-method functions inherited from SocketServer.TCPServer:
address_family = 2
allow_reuse_address = 0
request_queue_size = 5
socket_type = 1

Methods inherited from SocketServer.BaseServer:
finish_request(self, request, client_address)
Finish one request by instantiating RequestHandlerClass.
handle_error(self, request, client_address)
Handle an error gracefully.  May be overridden.
 
The default is to print a traceback and continue.
handle_request(self)
Handle one request, possibly blocking.
process_request(self, request, client_address)
Call finish_request.
 
Overridden by ForkingMixIn and ThreadingMixIn.
serve_forever(self)
Handle one request at a time until doomsday.
verify_request(self, request, client_address)
Verify the request.  May be overridden.
 
Return true if we should proceed with this request.
 
Functions
            
_resolve_dotted_attribute(obj, attr)
Resolves a dotted attribute name to an object.  Raises
an AttributeError if any attribute in the chain starts with a '_'.
 
Data
             __file__ = '/usr/lib/python2.2/SimpleXMLRPCServer.pyc'
__name__ = 'SimpleXMLRPCServer'