Mercurial > cpython-lru_cache-weakref

annotate Lib/DocXMLRPCServer.py @ 58765:2ba7677bfa95 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
testCopysign was defined twice in test_math; combine the definitions
author Mark Dickinson <dickinsm@gmail.com>
date Sat, 06 Feb 2010 23:11:25 +0000
parents ffd7cf5c7285
children
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 """Self documenting XML-RPC Server.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
2
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
3 This module can be used to create XML-RPC servers that
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
4 serve pydoc-style documentation in response to HTTP
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
5 GET requests. This documentation is dynamically generated
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
6 based on the functions and methods registered with the
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
7 server.
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 This module is built upon the pydoc and SimpleXMLRPCServer
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
10 modules.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
11 """
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
12
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
13 import pydoc
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
14 import inspect
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
15 import re
28912
4ef108f8181f Patch #727805: Remove extra line ending from CGI responses.
Martin v. Löwis <martin@v.loewis.de>
parents: 28774
diff changeset
16 import sys
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
17
33356
e56192e9fd7e Use multi-line import
Andrew M. Kuchling <amk@amk.ca>
parents: 28912
diff changeset
18 from SimpleXMLRPCServer import (SimpleXMLRPCServer,
e56192e9fd7e Use multi-line import
Andrew M. Kuchling <amk@amk.ca>
parents: 28912
diff changeset
19 SimpleXMLRPCRequestHandler,
e56192e9fd7e Use multi-line import
Andrew M. Kuchling <amk@amk.ca>
parents: 28912
diff changeset
20 CGIXMLRPCRequestHandler,
e56192e9fd7e Use multi-line import
Andrew M. Kuchling <amk@amk.ca>
parents: 28912
diff changeset
21 resolve_dotted_attribute)
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
22
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
23 class ServerHTMLDoc(pydoc.HTMLDoc):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
24 """Class used to generate pydoc HTML document for a server"""
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
25
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
26 def markup(self, text, escape=None, funcs={}, classes={}, methods={}):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
27 """Mark up some plain text, given a context of symbols to look for.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
28 Each context dictionary maps object names to anchor names."""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
29 escape = escape or self.escape
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
30 results = []
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
31 here = 0
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
32
45169
b011366102db Update PEP URL.
Andrew M. Kuchling <amk@amk.ca>
parents: 44258
diff changeset
33 # XXX Note that this regular expression does not allow for the
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
34 # hyperlinking of arbitrary strings being used as method
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
35 # names. Only methods with names consisting of word characters
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
36 # and '.'s are hyperlinked.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
37 pattern = re.compile(r'\b((http|ftp)://\S+[\w/]|'
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
38 r'RFC[- ]?(\d+)|'
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
39 r'PEP[- ]?(\d+)|'
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
40 r'(self\.)?((?:\w|\.)+))\b')
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
41 while 1:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
42 match = pattern.search(text, here)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
43 if not match: break
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
44 start, end = match.span()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
45 results.append(escape(text[here:start]))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
46
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
47 all, scheme, rfc, pep, selfdot, name = match.groups()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
48 if scheme:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
49 url = escape(all).replace('"', '&quot;')
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
50 results.append('<a href="%s">%s</a>' % (url, url))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
51 elif rfc:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
52 url = 'http://www.rfc-editor.org/rfc/rfc%d.txt' % int(rfc)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
53 results.append('<a href="%s">%s</a>' % (url, escape(all)))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
54 elif pep:
45169
b011366102db Update PEP URL.
Andrew M. Kuchling <amk@amk.ca>
parents: 44258
diff changeset
55 url = 'http://www.python.org/dev/peps/pep-%04d/' % int(pep)
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
56 results.append('<a href="%s">%s</a>' % (url, escape(all)))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
57 elif text[end:end+1] == '(':
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
58 results.append(self.namelink(name, methods, funcs, classes))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
59 elif selfdot:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
60 results.append('self.<strong>%s</strong>' % name)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
61 else:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
62 results.append(self.namelink(name, classes))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
63 here = end
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
64 results.append(escape(text[here:]))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
65 return ''.join(results)
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
66
44245
5abfd07e97d4 Two fixes in DocXMLRPCServer:
Georg Brandl <georg@python.org>
parents: 41106
diff changeset
67 def docroutine(self, object, name, mod=None,
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
68 funcs={}, classes={}, methods={}, cl=None):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
69 """Produce HTML documentation for a function or method object."""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
70
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
71 anchor = (cl and cl.__name__ or '') + '-' + name
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
72 note = ''
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
73
44245
5abfd07e97d4 Two fixes in DocXMLRPCServer:
Georg Brandl <georg@python.org>
parents: 41106
diff changeset
74 title = '<a name="%s"><strong>%s</strong></a>' % (
5abfd07e97d4 Two fixes in DocXMLRPCServer:
Georg Brandl <georg@python.org>
parents: 41106
diff changeset
75 self.escape(anchor), self.escape(name))
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
76
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
77 if inspect.ismethod(object):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
78 args, varargs, varkw, defaults = inspect.getargspec(object.im_func)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
79 # exclude the argument bound to the instance, it will be
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
80 # confusing to the non-Python user
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
81 argspec = inspect.formatargspec (
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
82 args[1:],
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
83 varargs,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
84 varkw,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
85 defaults,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
86 formatvalue=self.formatvalue
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 elif inspect.isfunction(object):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
89 args, varargs, varkw, defaults = inspect.getargspec(object)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
90 argspec = inspect.formatargspec(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
91 args, varargs, varkw, defaults, formatvalue=self.formatvalue)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
92 else:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
93 argspec = '(...)'
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
94
34551
028f92e44b48 Reduce the usage of the types module.
Raymond Hettinger <python@rcn.com>
parents: 33356
diff changeset
95 if isinstance(object, tuple):
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
96 argspec = object[0] or argspec
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
97 docstring = object[1] or ""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
98 else:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
99 docstring = pydoc.getdoc(object)
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
100
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
101 decl = title + argspec + (note and self.grey(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
102 '<font face="helvetica, arial">%s</font>' % note))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
103
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
104 doc = self.markup(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
105 docstring, self.preformat, funcs, classes, methods)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
106 doc = doc and '<dd><tt>%s</tt></dd>' % doc
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
107 return '<dl><dt>%s</dt>%s</dl>\n' % (decl, doc)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
108
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
109 def docserver(self, server_name, package_documentation, methods):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
110 """Produce HTML documentation for an XML-RPC server."""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
111
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
112 fdict = {}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
113 for key, value in methods.items():
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
114 fdict[key] = '#-' + key
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
115 fdict[value] = fdict[key]
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
116
44245
5abfd07e97d4 Two fixes in DocXMLRPCServer:
Georg Brandl <georg@python.org>
parents: 41106
diff changeset
117 server_name = self.escape(server_name)
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
118 head = '<big><big><strong>%s</strong></big></big>' % server_name
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
119 result = self.heading(head, '#ffffff', '#7799ee')
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
120
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
121 doc = self.markup(package_documentation, self.preformat, fdict)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
122 doc = doc and '<tt>%s</tt>' % doc
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
123 result = result + '<p>%s</p>\n' % doc
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
124
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
125 contents = []
44258
47895ca6f0cb Remove a 2.2-ism.
Guido van Rossum <guido@python.org>
parents: 44245
diff changeset
126 method_items = sorted(methods.items())
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
127 for key, value in method_items:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
128 contents.append(self.docroutine(value, key, funcs=fdict))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
129 result = result + self.bigsection(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
130 'Methods', '#ffffff', '#eeaa77', pydoc.join(contents))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
131
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
132 return result
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
133
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
134 class XMLRPCDocGenerator:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
135 """Generates documentation for an XML-RPC server.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
136
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
137 This class is designed as mix-in and should not
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
138 be constructed directly.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
139 """
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
140
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
141 def __init__(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
142 # setup variables used for HTML documentation
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
143 self.server_name = 'XML-RPC Server Documentation'
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
144 self.server_documentation = \
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
145 "This server exports the following methods through the XML-RPC "\
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
146 "protocol."
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
147 self.server_title = 'XML-RPC Server Documentation'
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
148
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
149 def set_server_title(self, server_title):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
150 """Set the HTML title of the generated server documentation"""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
151
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
152 self.server_title = server_title
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
153
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
154 def set_server_name(self, server_name):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
155 """Set the name of the generated HTML server documentation"""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
156
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
157 self.server_name = server_name
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
158
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
159 def set_server_documentation(self, server_documentation):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
160 """Set the documentation string for the entire server."""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
161
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
162 self.server_documentation = server_documentation
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
163
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
164 def generate_html_documentation(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
165 """generate_html_documentation() => html documentation for the server
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
166
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
167 Generates HTML documentation for the server using introspection for
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
168 installed functions and instances that do not implement the
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
169 _dispatch method. Alternatively, instances can choose to implement
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
170 the _get_method_argstring(method_name) method to provide the
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
171 argument string used in the documentation and the
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
172 _methodHelp(method_name) method to provide the help text used
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
173 in the documentation."""
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
174
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
175 methods = {}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
176
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
177 for method_name in self.system_listMethods():
48148
251282580041 Remove a dict.has_key() use in DocXMLRPCServer that comes up under -3.
Brett Cannon <bcannon@gmail.com>
parents: 45169
diff changeset
178 if method_name in self.funcs:
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
179 method = self.funcs[method_name]
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
180 elif self.instance is not None:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
181 method_info = [None, None] # argspec, documentation
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
182 if hasattr(self.instance, '_get_method_argstring'):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
183 method_info[0] = self.instance._get_method_argstring(method_name)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
184 if hasattr(self.instance, '_methodHelp'):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
185 method_info[1] = self.instance._methodHelp(method_name)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
186
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
187 method_info = tuple(method_info)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
188 if method_info != (None, None):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
189 method = method_info
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
190 elif not hasattr(self.instance, '_dispatch'):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
191 try:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
192 method = resolve_dotted_attribute(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
193 self.instance,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
194 method_name
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
195 )
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
196 except AttributeError:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
197 method = method_info
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
198 else:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
199 method = method_info
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
200 else:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
201 assert 0, "Could not find method in self.functions and no "\
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
202 "instance installed"
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
203
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
204 methods[method_name] = method
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
205
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
206 documenter = ServerHTMLDoc()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
207 documentation = documenter.docserver(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
208 self.server_name,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
209 self.server_documentation,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
210 methods
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
211 )
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
212
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
213 return documenter.page(self.server_title, documentation)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
214
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
215 class DocXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
216 """XML-RPC and documentation request handler class.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
217
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
218 Handles all HTTP POST requests and attempts to decode them as
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
219 XML-RPC requests.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
220
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
221 Handles all HTTP GET requests and interprets them as requests
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
222 for documentation.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
223 """
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
224
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
225 def do_GET(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
226 """Handles the HTTP GET request.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
227
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
228 Interpret all HTTP GET requests as requests for server
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
229 documentation.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
230 """
38526
f831e8bc6bd3 [Bug #1473048]
Andrew M. Kuchling <amk@amk.ca>
parents: 34551
diff changeset
231 # Check that the path is legal
f831e8bc6bd3 [Bug #1473048]
Andrew M. Kuchling <amk@amk.ca>
parents: 34551
diff changeset
232 if not self.is_rpc_path_valid():
f831e8bc6bd3 [Bug #1473048]
Andrew M. Kuchling <amk@amk.ca>
parents: 34551
diff changeset
233 self.report_404()
f831e8bc6bd3 [Bug #1473048]
Andrew M. Kuchling <amk@amk.ca>
parents: 34551
diff changeset
234 return
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
235
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
236 response = self.server.generate_html_documentation()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
237 self.send_response(200)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
238 self.send_header("Content-type", "text/html")
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
239 self.send_header("Content-length", str(len(response)))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
240 self.end_headers()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
241 self.wfile.write(response)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
242
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
243 class DocXMLRPCServer( SimpleXMLRPCServer,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
244 XMLRPCDocGenerator):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
245 """XML-RPC and HTML documentation server.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
246
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
247 Adds the ability to serve server documentation to the capabilities
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
248 of SimpleXMLRPCServer.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
249 """
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
250
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
251 def __init__(self, addr, requestHandler=DocXMLRPCRequestHandler,
41106
101a1ab573db Patch #1599845: Add an option to disable the implicit calls to server_bind() and server_activate() in the constructors for TCPServer, SimpleXMLRPCServer and DocXMLRPCServer.
Collin Winter <collinw@gmail.com>
parents: 38526
diff changeset
252 logRequests=1, allow_none=False, encoding=None,
101a1ab573db Patch #1599845: Add an option to disable the implicit calls to server_bind() and server_activate() in the constructors for TCPServer, SimpleXMLRPCServer and DocXMLRPCServer.
Collin Winter <collinw@gmail.com>
parents: 38526
diff changeset
253 bind_and_activate=True):
101a1ab573db Patch #1599845: Add an option to disable the implicit calls to server_bind() and server_activate() in the constructors for TCPServer, SimpleXMLRPCServer and DocXMLRPCServer.
Collin Winter <collinw@gmail.com>
parents: 38526
diff changeset
254 SimpleXMLRPCServer.__init__(self, addr, requestHandler, logRequests,
101a1ab573db Patch #1599845: Add an option to disable the implicit calls to server_bind() and server_activate() in the constructors for TCPServer, SimpleXMLRPCServer and DocXMLRPCServer.
Collin Winter <collinw@gmail.com>
parents: 38526
diff changeset
255 allow_none, encoding, bind_and_activate)
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
256 XMLRPCDocGenerator.__init__(self)
28774
c9bee11eaa8b Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 28679
diff changeset
257
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
258 class DocCGIXMLRPCRequestHandler( CGIXMLRPCRequestHandler,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
259 XMLRPCDocGenerator):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
260 """Handler for XML-RPC data and documentation requests passed through
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
261 CGI"""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
262
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
263 def handle_get(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
264 """Handles the HTTP GET request.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
265
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
266 Interpret all HTTP GET requests as requests for server
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
267 documentation.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
268 """
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
269
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
270 response = self.generate_html_documentation()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
271
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
272 print 'Content-Type: text/html'
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
273 print 'Content-Length: %d' % len(response)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
274 print
28912
4ef108f8181f Patch #727805: Remove extra line ending from CGI responses.
Martin v. Löwis <martin@v.loewis.de>
parents: 28774
diff changeset
275 sys.stdout.write(response)
28679
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
276
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
277 def __init__(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
278 CGIXMLRPCRequestHandler.__init__(self)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass.
Martin v. Löwis <martin@v.loewis.de>
parents:
diff changeset
279 XMLRPCDocGenerator.__init__(self)