Viewing file:  XmlFormatter.py (2.87 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
import pydoc, cStringIO
from repr import Repr
class XmlRepr(pydoc.TextRepr):
"""
Class for safely making a XML representation of a Python object.
"""
_escape_table = [('&', '&'),
('<', '<'),
('>', '>'),
('"', '"'),
]
def escape(self, text):
for char, repl in self._escape_table:
text = text.replace(char, repl)
return text
def repr(self, object):
return self.escape(pydoc.TextRepr.repr(self, object))
# Make sure all types are covered
repr_unicode = repr_str = pydoc.TextRepr.repr_string
class XmlFormatter(XmlRepr):
indent = ' '
def __init__(self, dist_command):
XmlRepr.__init__(self)
self.dist_command = dist_command
# These are reset each time through document()
self.module = None
self.write = None
self.indent_level = 0
return
def warn(self, msg):
return self.dist_command.warn(msg)
# -- xml writing functions -----------------------------------------------
def start_element(self, tagname, attributes={}):
self.write(self.indent * self.indent_level)
self.write('<%s' % tagname)
for name, value in attributes.items():
self.write(' %s="%s"' % (name, self.escape(str(value))))
self.write('>\n')
self.indent_level += 1
return
def end_element(self, tagname):
self.indent_level -= 1
self.write(self.indent * self.indent_level)
self.write('</%s>\n' % tagname)
return
def write_element(self, tagname, attributes={}, content=''):
self.write(self.indent * self.indent_level)
self.write('<%s' % tagname)
for name, value in attributes.items():
self.write(' %s="%s"' % (name, self.escape(str(value))))
if content:
self.write('>%s</%s>\n' % (content, tagname))
else:
self.write('/>\n')
return
# -- documenting functions -----------------------------------------------
def section(self, title, list, format):
self.start_element(title)
for name, object in list:
format(object, name)
self.end_element(title)
return
def document(self, module, encoding=None):
"""
Generate documentation for a module.
"""
self.module = module
stream = cStringIO.StringIO()
self.write = stream.write
self.indent_level = 0
self.write('<?xml version="1.0"')
if encoding:
self.write(' encoding="%s"' % encoding)
self.write('?>\n')
# Document the module
self.doc_module(module)
return stream.getvalue()
def doc_module(self, module):
raise NotImplementedError('subclass %s must override' % self.__class__)
|