Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libdocxmlrpc.tex @ 39042:c02fa187e0f4 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Part of SF patch #1484695. This removes dead code. The chksum was already verified in .frombuf() on the lines above. If there was a problem an exception is raised, so there was no way this condition could have been true.
author Neal Norwitz <nnorwitz@gmail.com>
date Mon, 10 Jul 2006 00:23:17 +0000
parents ca64c1be230b
children 101a1ab573db 06145fbc7ab9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
1 \section{\module{DocXMLRPCServer} ---
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
2 Self-documenting XML-RPC server}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
3
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
4 \declaremodule{standard}{DocXMLRPCServer}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
5 \modulesynopsis{Self-documenting XML-RPC server implementation.}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
6 \moduleauthor{Brian Quinlan}{brianq@activestate.com}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
7 \sectionauthor{Brian Quinlan}{brianq@activestate.com}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
8
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
9 \versionadded{2.3}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
10
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
11 The \module{DocXMLRPCServer} module extends the classes found in
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
12 \module{SimpleXMLRPCServer} to serve HTML documentation in response to
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
13 HTTP GET requests. Servers can either be free standing, using
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
14 \class{DocXMLRPCServer}, or embedded in a CGI environment, using
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
15 \class{DocCGIXMLRPCRequestHandler}.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
16
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
17 \begin{classdesc}{DocXMLRPCServer}{addr\optional{,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
18 requestHandler\optional{, logRequests}}}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
19
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
20 Create a new server instance. All parameters have the same meaning as
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
21 for \class{SimpleXMLRPCServer.SimpleXMLRPCServer};
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
22 \var{requestHandler} defaults to \class{DocXMLRPCRequestHandler}.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
23
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
24 \end{classdesc}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
25
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
26 \begin{classdesc}{DocCGIXMLRPCRequestHandler}{}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
27
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
28 Create a new instance to handle XML-RPC requests in a CGI environment.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
29
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
30 \end{classdesc}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
31
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
32 \begin{classdesc}{DocXMLRPCRequestHandler}{}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
33
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
34 Create a new request handler instance. This request handler supports
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
35 XML-RPC POST requests, documentation GET requests, and modifies
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
36 logging so that the \var{logRequests} parameter to the
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
37 \class{DocXMLRPCServer} constructor parameter is honored.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
38
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
39 \end{classdesc}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
40
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
41 \subsection{DocXMLRPCServer Objects \label{doc-xmlrpc-servers}}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
42
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
43 The \class{DocXMLRPCServer} class is derived from
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
44 \class{SimpleXMLRPCServer.SimpleXMLRPCServer} and provides a means of
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
45 creating self-documenting, stand alone XML-RPC servers. HTTP POST
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
46 requests are handled as XML-RPC method calls. HTTP GET requests are
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
47 handled by generating pydoc-style HTML documentation. This allows a
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
48 server to provide its own web-based documentation.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
49
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
50 \begin{methoddesc}{set_server_title}{server_title}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
51
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
52 Set the title used in the generated HTML documentation. This title
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
53 will be used inside the HTML "title" element.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
54
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
55 \end{methoddesc}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
56
28681
ca64c1be230b Correct methoddesc environments.
Martin v. Löwis <martin@v.loewis.de>
parents: 28679
diff changeset
57 \begin{methoddesc}{set_server_name}{server_name}
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
58
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
59 Set the name used in the generated HTML documentation. This name will
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
60 appear at the top of the generated documentation inside a "h1"
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
61 element.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
62
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
63 \end{methoddesc}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
64
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
65
28681
ca64c1be230b Correct methoddesc environments.
Martin v. Löwis <martin@v.loewis.de>
parents: 28679
diff changeset
66 \begin{methoddesc}{set_server_documentation}{server_documentation}
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
67
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
68 Set the description used in the generated HTML documentation. This
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
69 description will appear as a paragraph, below the server name, in the
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
70 documentation.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
71
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
72 \end{methoddesc}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
73
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
74 \subsection{DocCGIXMLRPCRequestHandler}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
75
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
76 The \class{DocCGIXMLRPCRequestHandler} class is derived from
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
77 \class{SimpleXMLRPCServer.CGIXMLRPCRequestHandler} and provides a means
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
78 of creating self-documenting, XML-RPC CGI scripts. HTTP POST requests
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
79 are handled as XML-RPC method calls. HTTP GET requests are handled by
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
80 generating pydoc-style HTML documentation. This allows a server to
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
81 provide its own web-based documentation.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
82
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
83 \begin{methoddesc}{set_server_title}{server_title}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
84
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
85 Set the title used in the generated HTML documentation. This title
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
86 will be used inside the HTML "title" element.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
87
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
88 \end{methoddesc}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
89
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
90 \begin{methoddesc}{set_server_name}{server_name}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
91
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
92 Set the name used in the generated HTML documentation. This name will
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
93 appear at the top of the generated documentation inside a "h1"
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
94 element.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
95
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
96 \end{methoddesc}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
97
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
98
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
99 \begin{methoddesc}{set_server_documentation}{server_documentation}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
100
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
101 Set the description used in the generated HTML documentation. This
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
102 description will appear as a paragraph, below the server name, in the
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
103 documentation.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
104
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
105 \end{methoddesc}