<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"module-asyncore.html" />
<link rel=
"prev" href=
"module-SimpleXMLRPCServer.html" />
<link rel=
"parent" href=
"internet.html" />
<link rel=
"next" href=
"doc-xmlrpc-servers.html" />
<meta name='aesop' content='information'
/>
<title>11.24 DocXMLRPCServer -- Self-documenting XML-RPC server
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.23.2 CGIXMLRPCRequestHandler"
href=
"node564.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11. Internet Protocols and"
href=
"internet.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.24.1 DocXMLRPCServer Objects"
href=
"doc-xmlrpc-servers.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node564.html">11.23.2 CGIXMLRPCRequestHandler
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"internet.html">11. Internet Protocols and
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"doc-xmlrpc-servers.html">11.24.1 DocXMLRPCServer Objects
</A>
<!--End of Navigation Panel-->
<H1><A NAME=
"SECTION00132400000000000000000">
11.24 <tt class=
"module">DocXMLRPCServer
</tt> --
Self-documenting XML-RPC server
</A>
<A NAME=
"module-DocXMLRPCServer"></A>
<span class=
"versionnote">New in version
2.3.
</span>
The
<tt class=
"module">DocXMLRPCServer
</tt> module extends the classes found in
<tt class=
"module">SimpleXMLRPCServer
</tt> to serve HTML documentation in response to
HTTP GET requests. Servers can either be free standing, using
<tt class=
"class">DocXMLRPCServer
</tt>, or embedded in a CGI environment, using
<tt class=
"class">DocCGIXMLRPCRequestHandler
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
3733' xml:id='l2h-
3733'
class=
"class">DocXMLRPCServer
</tt></b>(
</nobr></td>
<td><var>addr
</var><big>[
</big><var>,
requestHandler
</var><big>[
</big><var>, logRequests
</var><big>]
</big><var></var><big>]
</big><var></var>)
</td></tr></table></dt>
Create a new server instance. All parameters have the same meaning as
for
<tt class=
"class">SimpleXMLRPCServer.SimpleXMLRPCServer
</tt>;
<var>requestHandler
</var> defaults to
<tt class=
"class">DocXMLRPCRequestHandler
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
3734' xml:id='l2h-
3734'
class=
"class">DocCGIXMLRPCRequestHandler
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Create a new instance to handle XML-RPC requests in a CGI environment.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
3735' xml:id='l2h-
3735'
class=
"class">DocXMLRPCRequestHandler
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Create a new request handler instance. This request handler supports
XML-RPC POST requests, documentation GET requests, and modifies
logging so that the
<var>logRequests
</var> parameter to the
<tt class=
"class">DocXMLRPCServer
</tt> constructor parameter is honored.
<p><br /></p><hr class='online-navigation'
/>
<div class='online-navigation'
>
<!--Table of Child-Links-->
<A NAME=
"CHILD_LINKS"><STRONG>Subsections
</STRONG></a>
<LI><A href=
"doc-xmlrpc-servers.html">11.24.1 DocXMLRPCServer Objects
</a>
<LI><A href=
"node567.html">11.24.2 DocCGIXMLRPCRequestHandler
</a>
<!--End of Table of Child-Links-->
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.23.2 CGIXMLRPCRequestHandler"
href=
"node564.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11. Internet Protocols and"
href=
"internet.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.24.1 DocXMLRPCServer Objects"
href=
"doc-xmlrpc-servers.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node564.html">11.23.2 CGIXMLRPCRequestHandler
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"internet.html">11. Internet Protocols and
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"doc-xmlrpc-servers.html">11.24.1 DocXMLRPCServer Objects
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.