rest25/library/docxmlrpcserver.rst => rest262/library/docxmlrpcserver.rst
n1- 
2:mod:`DocXMLRPCServer` --- Self-documenting XML-RPC server
3==========================================================
4
5.. module:: DocXMLRPCServer
6   :synopsis: Self-documenting XML-RPC server implementation.
7.. moduleauthor:: Brian Quinlan <brianq@activestate.com>
8.. sectionauthor:: Brian Quinlan <brianq@activestate.com>
n8+ 
9+.. note::
10+   The :mod:`DocXMLRPCServer` module has been merged into :mod:`xmlrpc.server`
11+   in Python 3.0.  The :term:`2to3` tool will automatically adapt imports when
12+   converting your sources to 3.0.
9
10
11.. versionadded:: 2.3
12
13The :mod:`DocXMLRPCServer` module extends the classes found in
14:mod:`SimpleXMLRPCServer` to serve HTML documentation in response to HTTP GET
15requests. Servers can either be free standing, using :class:`DocXMLRPCServer`,
16or embedded in a CGI environment, using :class:`DocCGIXMLRPCRequestHandler`.
17
18
n19-.. class:: DocXMLRPCServer(addr[,  requestHandler[, logRequests]])
n23+.. class:: DocXMLRPCServer(addr[, requestHandler[, logRequests[, allow_none[,  encoding[, bind_and_activate]]]]])
20
21   Create a new server instance. All parameters have the same meaning as for
22   :class:`SimpleXMLRPCServer.SimpleXMLRPCServer`; *requestHandler* defaults to
23   :class:`DocXMLRPCRequestHandler`.
24
25
26.. class:: DocCGIXMLRPCRequestHandler()
27
44The :class:`DocXMLRPCServer` class is derived from
45:class:`SimpleXMLRPCServer.SimpleXMLRPCServer` and provides a means of creating
46self-documenting, stand alone XML-RPC servers. HTTP POST requests are handled as
47XML-RPC method calls. HTTP GET requests are handled by generating pydoc-style
48HTML documentation. This allows a server to provide its own web-based
49documentation.
50
51
n52-.. method:: XXX Class.set_server_title(server_title)
n56+.. method:: DocXMLRPCServer.set_server_title(server_title)
53
54   Set the title used in the generated HTML documentation. This title will be used
55   inside the HTML "title" element.
56
57
n58-.. method:: XXX Class.set_server_name(server_name)
n62+.. method:: DocXMLRPCServer.set_server_name(server_name)
59
60   Set the name used in the generated HTML documentation. This name will appear at
61   the top of the generated documentation inside a "h1" element.
62
63
n64-.. method:: XXX Class.set_server_documentation(server_documentation)
n68+.. method:: DocXMLRPCServer.set_server_documentation(server_documentation)
65
66   Set the description used in the generated HTML documentation. This description
67   will appear as a paragraph, below the server name, in the documentation.
68
69
70DocCGIXMLRPCRequestHandler
71--------------------------
72
73The :class:`DocCGIXMLRPCRequestHandler` class is derived from
74:class:`SimpleXMLRPCServer.CGIXMLRPCRequestHandler` and provides a means of
75creating self-documenting, XML-RPC CGI scripts. HTTP POST requests are handled
76as XML-RPC method calls. HTTP GET requests are handled by generating pydoc-style
77HTML documentation. This allows a server to provide its own web-based
78documentation.
79
80
n81-.. method:: XXX Class.set_server_title(server_title)
n85+.. method:: DocCGIXMLRPCRequestHandler.set_server_title(server_title)
82
83   Set the title used in the generated HTML documentation. This title will be used
84   inside the HTML "title" element.
85
86
n87-.. method:: XXX Class.set_server_name(server_name)
n91+.. method:: DocCGIXMLRPCRequestHandler.set_server_name(server_name)
88
89   Set the name used in the generated HTML documentation. This name will appear at
90   the top of the generated documentation inside a "h1" element.
91
92
t93-.. method:: XXX Class.set_server_documentation(server_documentation)
t97+.. method:: DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)
94
95   Set the description used in the generated HTML documentation. This description
96   will appear as a paragraph, below the server name, in the documentation.
97
Legends
Colors
 Added 
Changed
Deleted
Links
(f)irst change
(n)ext change
(t)op