cpython-lru_cache-weakref: Lib/DocXMLRPCServer.py annotate

annotate Lib/DocXMLRPCServer.py @ 39042:c02fa187e0f4 legacy-trunk

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	f831e8bc6bd3
children	63237fcefd99 101a1ab573db

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
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	33 # XXX Note that this regular expressions does not allow for the
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('"', '"')
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:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	55 url = 'http://www.python.org/peps/pep-%04d.html' % int(pep)
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
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	67 def docroutine(self, object, name=None, mod=None,
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
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	74 title = '<a name="%s"><strong>%s</strong></a>' % (anchor, name)
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	75
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	76 if inspect.ismethod(object):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	77 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	78 # 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	79 # confusing to the non-Python user
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	80 argspec = inspect.formatargspec (
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	81 args[1:],
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	82 varargs,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	83 varkw,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	84 defaults,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	85 formatvalue=self.formatvalue
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	86 )
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	87 elif inspect.isfunction(object):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	88 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	89 argspec = inspect.formatargspec(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	90 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	91 else:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	92 argspec = '(...)'
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	93
34551 028f92e44b48 Reduce the usage of the types module. Raymond Hettinger <python@rcn.com> parents: 33356 diff changeset	94 if isinstance(object, tuple):
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	95 argspec = object[0] or argspec
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	96 docstring = object[1] or ""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	97 else:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	98 docstring = pydoc.getdoc(object)
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	99
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	100 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	101 '<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	102
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	103 doc = self.markup(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	104 docstring, self.preformat, funcs, classes, methods)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	105 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	106 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	107
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	108 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	109 """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	110
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	111 fdict = {}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	112 for key, value in methods.items():
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	113 fdict[key] = '#-' + key
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	114 fdict[value] = fdict[key]
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	115
c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	116 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	117 result = self.heading(head, '#ffffff', '#7799ee')
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	118
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	119 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	120 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	121 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	122
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	123 contents = []
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	124 method_items = methods.items()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	125 method_items.sort()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	126 for key, value in method_items:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	127 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	128 result = result + self.bigsection(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	129 'Methods', '#ffffff', '#eeaa77', pydoc.join(contents))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	130
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	131 return result
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	132
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	133 class XMLRPCDocGenerator:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	134 """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	135
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	136 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	137 be constructed directly.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	138 """
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	139
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	140 def __init__(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	141 # setup variables used for HTML documentation
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	142 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	143 self.server_documentation = \
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	144 "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	145 "protocol."
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	146 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	147
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	148 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	149 """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	150
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	151 self.server_title = server_title
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	152
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	153 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	154 """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	155
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	156 self.server_name = server_name
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	157
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	158 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	159 """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	160
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	161 self.server_documentation = server_documentation
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	162
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	163 def generate_html_documentation(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	164 """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	165
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	166 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	167 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	168 _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	169 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	170 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	171 _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	172 in the documentation."""
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	173
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	174 methods = {}
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	175
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	176 for method_name in self.system_listMethods():
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	177 if self.funcs.has_key(method_name):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	178 method = self.funcs[method_name]
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	179 elif self.instance is not None:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	180 method_info = [None, None] # argspec, documentation
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	181 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	182 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	183 if hasattr(self.instance, '_methodHelp'):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	184 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	185
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	186 method_info = tuple(method_info)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	187 if method_info != (None, None):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	188 method = method_info
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	189 elif not hasattr(self.instance, '_dispatch'):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	190 try:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	191 method = resolve_dotted_attribute(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	192 self.instance,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	193 method_name
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	194 )
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	195 except AttributeError:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	196 method = method_info
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	197 else:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	198 method = method_info
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	199 else:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	200 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	201 "instance installed"
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	202
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	203 methods[method_name] = method
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	204
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	205 documenter = ServerHTMLDoc()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	206 documentation = documenter.docserver(
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	207 self.server_name,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	208 self.server_documentation,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	209 methods
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	210 )
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	211
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	212 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	213
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	214 class DocXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	215 """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	216
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	217 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	218 XML-RPC requests.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	219
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	220 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	221 for documentation.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	222 """
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 def do_GET(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	225 """Handles the HTTP GET request.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	226
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	227 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	228 documentation.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	229 """
38526 f831e8bc6bd3 [Bug #1473048] Andrew M. Kuchling <amk@amk.ca> parents: 34551 diff changeset	230 # Check that the path is legal
f831e8bc6bd3 [Bug #1473048] Andrew M. Kuchling <amk@amk.ca> parents: 34551 diff changeset	231 if not self.is_rpc_path_valid():
f831e8bc6bd3 [Bug #1473048] Andrew M. Kuchling <amk@amk.ca> parents: 34551 diff changeset	232 self.report_404()
f831e8bc6bd3 [Bug #1473048] Andrew M. Kuchling <amk@amk.ca> parents: 34551 diff changeset	233 return
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	234
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	235 response = self.server.generate_html_documentation()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	236 self.send_response(200)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	237 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	238 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	239 self.end_headers()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	240 self.wfile.write(response)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	241
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	242 # shut down the connection
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	243 self.wfile.flush()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	244 self.connection.shutdown(1)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	245
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	246 class DocXMLRPCServer( SimpleXMLRPCServer,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	247 XMLRPCDocGenerator):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	248 """XML-RPC and HTML documentation server.
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 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	251 of SimpleXMLRPCServer.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	252 """
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	253
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	254 def __init__(self, addr, requestHandler=DocXMLRPCRequestHandler,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	255 logRequests=1):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	256 SimpleXMLRPCServer.__init__(self, addr, requestHandler, logRequests)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	257 XMLRPCDocGenerator.__init__(self)
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	258
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	259 class DocCGIXMLRPCRequestHandler( CGIXMLRPCRequestHandler,
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	260 XMLRPCDocGenerator):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	261 """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	262 CGI"""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	263
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	264 def handle_get(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	265 """Handles the HTTP GET request.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	266
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	267 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	268 documentation.
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
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	271 response = self.generate_html_documentation()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	272
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	273 print 'Content-Type: text/html'
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	274 print 'Content-Length: %d' % len(response)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	275 print
28912 4ef108f8181f Patch #727805: Remove extra line ending from CGI responses. Martin v. Löwis <martin@v.loewis.de> parents: 28774 diff changeset	276 sys.stdout.write(response)
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	277
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	278 def __init__(self):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	279 CGIXMLRPCRequestHandler.__init__(self)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	280 XMLRPCDocGenerator.__init__(self)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	281
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	282 if __name__ == '__main__':
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	283 def deg_to_rad(deg):
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	284 """deg_to_rad(90) => 1.5707963267948966
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	285
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	286 Converts an angle in degrees to an angle in radians"""
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	287 import math
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	288 return deg * math.pi / 180
c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	289
28679 ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	290 server = DocXMLRPCServer(("localhost", 8000))
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	291
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	292 server.set_server_title("Math Server")
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	293 server.set_server_name("Math XML-RPC Server")
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	294 server.set_server_documentation("""This server supports various mathematical functions.
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	295
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	296 You can use it from Python as follows:
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	297
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	298 >>> from xmlrpclib import ServerProxy
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	299 >>> s = ServerProxy("http://localhost:8000")
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	300 >>> s.deg_to_rad(90.0)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	301 1.5707963267948966""")
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	302
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	303 server.register_function(deg_to_rad)
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	304 server.register_introspection_functions()
ab0c067fe286 Patch #536883: SimpleXMLRPCServer auto-docing subclass. Martin v. Löwis <martin@v.loewis.de> parents: diff changeset	305
28774 c9bee11eaa8b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 28679 diff changeset	306 server.serve_forever()

Mercurial > cpython-lru_cache-weakref

annotate Lib/DocXMLRPCServer.py @ 39042:c02fa187e0f4 legacy-trunk