<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>21.25. DocXMLRPCServer — Self-documenting XML-RPC server — Python v2.6.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.6.5',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python v2.6.5 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="top" title="Python v2.6.5 documentation" href="../index.html" />
<link rel="up" title="21. Internet Protocols and Support" href="internet.html" />
<link rel="next" title="22. Multimedia Services" href="mm.html" />
<link rel="prev" title="21.24. SimpleXMLRPCServer — Basic XML-RPC server" href="simplexmlrpcserver.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="mm.html" title="22. Multimedia Services"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="simplexmlrpcserver.html" title="21.24. SimpleXMLRPCServer — Basic XML-RPC server"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="internet.html" accesskey="U">21. Internet Protocols and Support</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-DocXMLRPCServer">
<h1>21.25. <tt class="xref docutils literal"><span class="pre">DocXMLRPCServer</span></tt> — Self-documenting XML-RPC server<a class="headerlink" href="#module-DocXMLRPCServer" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The <tt class="xref docutils literal"><span class="pre">DocXMLRPCServer</span></tt> module has been merged into <tt class="xref docutils literal"><span class="pre">xmlrpc.server</span></tt>
in Python 3.0. The <a class="reference external" href="../glossary.html#term-to3"><em class="xref">2to3</em></a> tool will automatically adapt imports when
converting your sources to 3.0.</p>
</div>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
<p>The <tt class="xref docutils literal"><span class="pre">DocXMLRPCServer</span></tt> module extends the classes found in
<a title="Basic XML-RPC server implementation." class="reference external" href="simplexmlrpcserver.html#module-SimpleXMLRPCServer"><tt class="xref docutils literal"><span class="pre">SimpleXMLRPCServer</span></tt></a> to serve HTML documentation in response to HTTP GET
requests. Servers can either be free standing, using <a title="DocXMLRPCServer.DocXMLRPCServer" class="reference internal" href="#DocXMLRPCServer.DocXMLRPCServer"><tt class="xref docutils literal"><span class="pre">DocXMLRPCServer</span></tt></a>,
or embedded in a CGI environment, using <a title="DocXMLRPCServer.DocCGIXMLRPCRequestHandler" class="reference internal" href="#DocXMLRPCServer.DocCGIXMLRPCRequestHandler"><tt class="xref docutils literal"><span class="pre">DocCGIXMLRPCRequestHandler</span></tt></a>.</p>
<dl class="class">
<dt id="DocXMLRPCServer.DocXMLRPCServer">
<em class="property">class </em><tt class="descclassname">DocXMLRPCServer.</tt><tt class="descname">DocXMLRPCServer</tt><big>(</big><em>addr</em><span class="optional">[</span>, <em>requestHandler</em><span class="optional">[</span>, <em>logRequests</em><span class="optional">[</span>, <em>allow_none</em><span class="optional">[</span>, <em>encoding</em><span class="optional">[</span>, <em>bind_and_activate</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#DocXMLRPCServer.DocXMLRPCServer" title="Permalink to this definition">¶</a></dt>
<dd>Create a new server instance. All parameters have the same meaning as for
<a title="SimpleXMLRPCServer.SimpleXMLRPCServer" class="reference external" href="simplexmlrpcserver.html#SimpleXMLRPCServer.SimpleXMLRPCServer"><tt class="xref docutils literal"><span class="pre">SimpleXMLRPCServer.SimpleXMLRPCServer</span></tt></a>; <em>requestHandler</em> defaults to
<a title="DocXMLRPCServer.DocXMLRPCRequestHandler" class="reference internal" href="#DocXMLRPCServer.DocXMLRPCRequestHandler"><tt class="xref docutils literal"><span class="pre">DocXMLRPCRequestHandler</span></tt></a>.</dd></dl>
<dl class="class">
<dt id="DocXMLRPCServer.DocCGIXMLRPCRequestHandler">
<em class="property">class </em><tt class="descclassname">DocXMLRPCServer.</tt><tt class="descname">DocCGIXMLRPCRequestHandler</tt><a class="headerlink" href="#DocXMLRPCServer.DocCGIXMLRPCRequestHandler" title="Permalink to this definition">¶</a></dt>
<dd>Create a new instance to handle XML-RPC requests in a CGI environment.</dd></dl>
<dl class="class">
<dt id="DocXMLRPCServer.DocXMLRPCRequestHandler">
<em class="property">class </em><tt class="descclassname">DocXMLRPCServer.</tt><tt class="descname">DocXMLRPCRequestHandler</tt><a class="headerlink" href="#DocXMLRPCServer.DocXMLRPCRequestHandler" title="Permalink to this definition">¶</a></dt>
<dd>Create a new request handler instance. This request handler supports XML-RPC
POST requests, documentation GET requests, and modifies logging so that the
<em>logRequests</em> parameter to the <a title="DocXMLRPCServer.DocXMLRPCServer" class="reference internal" href="#DocXMLRPCServer.DocXMLRPCServer"><tt class="xref docutils literal"><span class="pre">DocXMLRPCServer</span></tt></a> constructor parameter is
honored.</dd></dl>
<div class="section" id="docxmlrpcserver-objects">
<span id="doc-xmlrpc-servers"></span><h2>21.25.1. DocXMLRPCServer Objects<a class="headerlink" href="#docxmlrpcserver-objects" title="Permalink to this headline">¶</a></h2>
<p>The <a title="DocXMLRPCServer.DocXMLRPCServer" class="reference internal" href="#DocXMLRPCServer.DocXMLRPCServer"><tt class="xref docutils literal"><span class="pre">DocXMLRPCServer</span></tt></a> class is derived from
<a title="SimpleXMLRPCServer.SimpleXMLRPCServer" class="reference external" href="simplexmlrpcserver.html#SimpleXMLRPCServer.SimpleXMLRPCServer"><tt class="xref docutils literal"><span class="pre">SimpleXMLRPCServer.SimpleXMLRPCServer</span></tt></a> and provides a means of creating
self-documenting, stand alone XML-RPC servers. HTTP POST requests are handled as
XML-RPC method calls. HTTP GET requests are handled by generating pydoc-style
HTML documentation. This allows a server to provide its own web-based
documentation.</p>
<dl class="method">
<dt id="DocXMLRPCServer.DocXMLRPCServer.set_server_title">
<tt class="descclassname">DocXMLRPCServer.</tt><tt class="descname">set_server_title</tt><big>(</big><em>server_title</em><big>)</big><a class="headerlink" href="#DocXMLRPCServer.DocXMLRPCServer.set_server_title" title="Permalink to this definition">¶</a></dt>
<dd>Set the title used in the generated HTML documentation. This title will be used
inside the HTML “title” element.</dd></dl>
<dl class="method">
<dt id="DocXMLRPCServer.DocXMLRPCServer.set_server_name">
<tt class="descclassname">DocXMLRPCServer.</tt><tt class="descname">set_server_name</tt><big>(</big><em>server_name</em><big>)</big><a class="headerlink" href="#DocXMLRPCServer.DocXMLRPCServer.set_server_name" title="Permalink to this definition">¶</a></dt>
<dd>Set the name used in the generated HTML documentation. This name will appear at
the top of the generated documentation inside a “h1” element.</dd></dl>
<dl class="method">
<dt id="DocXMLRPCServer.DocXMLRPCServer.set_server_documentation">
<tt class="descclassname">DocXMLRPCServer.</tt><tt class="descname">set_server_documentation</tt><big>(</big><em>server_documentation</em><big>)</big><a class="headerlink" href="#DocXMLRPCServer.DocXMLRPCServer.set_server_documentation" title="Permalink to this definition">¶</a></dt>
<dd>Set the description used in the generated HTML documentation. This description
will appear as a paragraph, below the server name, in the documentation.</dd></dl>
</div>
<div class="section" id="doccgixmlrpcrequesthandler">
<h2>21.25.2. DocCGIXMLRPCRequestHandler<a class="headerlink" href="#doccgixmlrpcrequesthandler" title="Permalink to this headline">¶</a></h2>
<p>The <a title="DocXMLRPCServer.DocCGIXMLRPCRequestHandler" class="reference internal" href="#DocXMLRPCServer.DocCGIXMLRPCRequestHandler"><tt class="xref docutils literal"><span class="pre">DocCGIXMLRPCRequestHandler</span></tt></a> class is derived from
<a title="SimpleXMLRPCServer.CGIXMLRPCRequestHandler" class="reference external" href="simplexmlrpcserver.html#SimpleXMLRPCServer.CGIXMLRPCRequestHandler"><tt class="xref docutils literal"><span class="pre">SimpleXMLRPCServer.CGIXMLRPCRequestHandler</span></tt></a> and provides a means of
creating self-documenting, XML-RPC CGI scripts. HTTP POST requests are handled
as XML-RPC method calls. HTTP GET requests are handled by generating pydoc-style
HTML documentation. This allows a server to provide its own web-based
documentation.</p>
<dl class="method">
<dt id="DocXMLRPCServer.DocCGIXMLRPCRequestHandler.set_server_title">
<tt class="descclassname">DocCGIXMLRPCRequestHandler.</tt><tt class="descname">set_server_title</tt><big>(</big><em>server_title</em><big>)</big><a class="headerlink" href="#DocXMLRPCServer.DocCGIXMLRPCRequestHandler.set_server_title" title="Permalink to this definition">¶</a></dt>
<dd>Set the title used in the generated HTML documentation. This title will be used
inside the HTML “title” element.</dd></dl>
<dl class="method">
<dt id="DocXMLRPCServer.DocCGIXMLRPCRequestHandler.set_server_name">
<tt class="descclassname">DocCGIXMLRPCRequestHandler.</tt><tt class="descname">set_server_name</tt><big>(</big><em>server_name</em><big>)</big><a class="headerlink" href="#DocXMLRPCServer.DocCGIXMLRPCRequestHandler.set_server_name" title="Permalink to this definition">¶</a></dt>
<dd>Set the name used in the generated HTML documentation. This name will appear at
the top of the generated documentation inside a “h1” element.</dd></dl>
<dl class="method">
<dt id="DocXMLRPCServer.DocCGIXMLRPCRequestHandler.set_server_documentation">
<tt class="descclassname">DocCGIXMLRPCRequestHandler.</tt><tt class="descname">set_server_documentation</tt><big>(</big><em>server_documentation</em><big>)</big><a class="headerlink" href="#DocXMLRPCServer.DocCGIXMLRPCRequestHandler.set_server_documentation" title="Permalink to this definition">¶</a></dt>
<dd>Set the description used in the generated HTML documentation. This description
will appear as a paragraph, below the server name, in the documentation.</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">21.25. <tt class="docutils literal"><span class="pre">DocXMLRPCServer</span></tt> — Self-documenting XML-RPC server</a><ul>
<li><a class="reference external" href="#docxmlrpcserver-objects">21.25.1. DocXMLRPCServer Objects</a></li>
<li><a class="reference external" href="#doccgixmlrpcrequesthandler">21.25.2. DocCGIXMLRPCRequestHandler</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="simplexmlrpcserver.html"
title="previous chapter">21.24. <tt class="docutils literal"><span class="pre">SimpleXMLRPCServer</span></tt> — Basic XML-RPC server</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="mm.html"
title="next chapter">22. Multimedia Services</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/library/docxmlrpcserver.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="mm.html" title="22. Multimedia Services"
>next</a> |</li>
<li class="right" >
<a href="simplexmlrpcserver.html" title="21.24. SimpleXMLRPCServer — Basic XML-RPC server"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="internet.html" >21. Internet Protocols and Support</a> »</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 1990-2010, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="http://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Mar 19, 2010.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.5.
</div>
</body>
</html>
