home *** CD-ROM | disk | FTP | other *** search
/ PC World 2001 April / PCWorld_2001-04_cd.bin / Software / TemaCD / webclean / !!!python!!! / BeOpen-Python-2.0.exe / SAXUTILS.PY < prev    next >
Encoding:
Python Source  |  2000-10-11  |  7.5 KB  |  236 lines
  1. """\
  2. A library of useful helper classes to the SAX classes, for the
  3. convenience of application and driver writers.
  4. """
  5.  
  6. import os, urlparse, urllib, types
  7. import handler
  8. import xmlreader
  9.  
  10. _StringTypes = [types.StringType, types.UnicodeType]
  11.  
  12. def escape(data, entities={}):
  13.     """Escape &, <, and > in a string of data.
  14.  
  15.     You can escape other strings of data by passing a dictionary as 
  16.     the optional entities parameter.  The keys and values must all be
  17.     strings; each key will be replaced with its corresponding value.
  18.     """
  19.     data = data.replace("&", "&")
  20.     data = data.replace("<", "<")
  21.     data = data.replace(">", ">")
  22.     for chars, entity in entities.items():
  23.         data = data.replace(chars, entity)        
  24.     return data
  25.  
  26.  
  27. class XMLGenerator(handler.ContentHandler):
  28.  
  29.     def __init__(self, out=None, encoding="iso-8859-1"):
  30.         if out is None:
  31.             import sys
  32.             out = sys.stdout
  33.         handler.ContentHandler.__init__(self)
  34.         self._out = out
  35.         self._ns_contexts = [{}] # contains uri -> prefix dicts
  36.         self._current_context = self._ns_contexts[-1]
  37.         self._undeclared_ns_maps = []
  38.         self._encoding = encoding
  39.  
  40.     # ContentHandler methods
  41.  
  42.     def startDocument(self):
  43.         self._out.write('<?xml version="1.0" encoding="%s"?>\n' %
  44.                         self._encoding)
  45.  
  46.     def startPrefixMapping(self, prefix, uri):
  47.         self._ns_contexts.append(self._current_context.copy())
  48.         self._current_context[uri] = prefix
  49.         self._undeclared_ns_maps.append((prefix, uri))
  50.  
  51.     def endPrefixMapping(self, prefix):
  52.         self._current_context = self._ns_contexts[-1]
  53.         del self._ns_contexts[-1]
  54.  
  55.     def startElement(self, name, attrs):
  56.         self._out.write('<' + name)
  57.         for (name, value) in attrs.items():
  58.             self._out.write(' %s="%s"' % (name, escape(value)))
  59.         self._out.write('>')
  60.         
  61.     def endElement(self, name):
  62.         self._out.write('</%s>' % name)
  63.  
  64.     def startElementNS(self, name, qname, attrs):
  65.         if name[0] is None:
  66.             # if the name was not namespace-scoped, use the unqualified part
  67.             name = name[1]
  68.         else:
  69.             # else try to restore the original prefix from the namespace
  70.             name = self._current_context[name[0]] + ":" + name[1]
  71.         self._out.write('<' + name)
  72.  
  73.         for pair in self._undeclared_ns_maps:
  74.             self._out.write(' xmlns:%s="%s"' % pair)
  75.         self._undeclared_ns_maps = []
  76.         
  77.         for (name, value) in attrs.items():
  78.             name = self._current_context[name[0]] + ":" + name[1]
  79.             self._out.write(' %s="%s"' % (name, escape(value)))
  80.         self._out.write('>')
  81.  
  82.     def endElementNS(self, name, qname):
  83.         if name[0] is None:
  84.             name = name[1]
  85.         else:
  86.             name = self._current_context[name[0]] + ":" + name[1]
  87.         self._out.write('</%s>' % name)
  88.         
  89.     def characters(self, content):
  90.         self._out.write(escape(content))
  91.  
  92.     def ignorableWhitespace(self, content):
  93.         self._out.write(content)
  94.  
  95.     def processingInstruction(self, target, data):
  96.         self._out.write('<?%s %s?>' % (target, data))
  97.  
  98.  
  99. class XMLFilterBase(xmlreader.XMLReader):
  100.     """This class is designed to sit between an XMLReader and the
  101.     client application's event handlers.  By default, it does nothing
  102.     but pass requests up to the reader and events on to the handlers
  103.     unmodified, but subclasses can override specific methods to modify
  104.     the event stream or the configuration requests as they pass
  105.     through."""
  106.  
  107.     def __init__(self, parent = None):
  108.         xmlreader.XMLReader.__init__(self)
  109.         self._parent = parent
  110.     
  111.     # ErrorHandler methods
  112.  
  113.     def error(self, exception):
  114.         self._err_handler.error(exception)
  115.  
  116.     def fatalError(self, exception):
  117.         self._err_handler.fatalError(exception)
  118.  
  119.     def warning(self, exception):
  120.         self._err_handler.warning(exception)
  121.  
  122.     # ContentHandler methods
  123.  
  124.     def setDocumentLocator(self, locator):
  125.         self._cont_handler.setDocumentLocator(locator)
  126.  
  127.     def startDocument(self):
  128.         self._cont_handler.startDocument()
  129.  
  130.     def endDocument(self):
  131.         self._cont_handler.endDocument()
  132.  
  133.     def startPrefixMapping(self, prefix, uri):
  134.         self._cont_handler.startPrefixMapping(prefix, uri)
  135.  
  136.     def endPrefixMapping(self, prefix):
  137.         self._cont_handler.endPrefixMapping(prefix)
  138.  
  139.     def startElement(self, name, attrs):
  140.         self._cont_handler.startElement(name, attrs)
  141.  
  142.     def endElement(self, name):
  143.         self._cont_handler.endElement(name)
  144.  
  145.     def startElementNS(self, name, qname, attrs):
  146.         self._cont_handler.startElement(name, attrs)
  147.  
  148.     def endElementNS(self, name, qname):
  149.         self._cont_handler.endElementNS(name, qname)
  150.  
  151.     def characters(self, content):
  152.         self._cont_handler.characters(content)
  153.  
  154.     def ignorableWhitespace(self, chars):
  155.         self._cont_handler.ignorableWhitespace(chars)
  156.  
  157.     def processingInstruction(self, target, data):
  158.         self._cont_handler.processingInstruction(target, data)
  159.  
  160.     def skippedEntity(self, name):
  161.         self._cont_handler.skippedEntity(name)
  162.  
  163.     # DTDHandler methods
  164.  
  165.     def notationDecl(self, name, publicId, systemId):
  166.         self._dtd_handler.notationDecl(name, publicId, systemId)
  167.  
  168.     def unparsedEntityDecl(self, name, publicId, systemId, ndata):
  169.         self._dtd_handler.unparsedEntityDecl(name, publicId, systemId, ndata)
  170.  
  171.     # EntityResolver methods
  172.  
  173.     def resolveEntity(self, publicId, systemId):
  174.         self._ent_handler.resolveEntity(publicId, systemId)
  175.  
  176.     # XMLReader methods
  177.  
  178.     def parse(self, source):
  179.         self._parent.setContentHandler(self)
  180.         self._parent.setErrorHandler(self)
  181.         self._parent.setEntityResolver(self)
  182.         self._parent.setDTDHandler(self)
  183.         self._parent.parse(source)
  184.  
  185.     def setLocale(self, locale):
  186.         self._parent.setLocale(locale)
  187.  
  188.     def getFeature(self, name):
  189.         return self._parent.getFeature(name)
  190.  
  191.     def setFeature(self, name, state):
  192.         self._parent.setFeature(name, state)
  193.  
  194.     def getProperty(self, name):
  195.         return self._parent.getProperty(name)
  196.  
  197.     def setProperty(self, name, value):
  198.         self._parent.setProperty(name, value)
  199.  
  200.     # XMLFilter methods
  201.  
  202.     def getParent(self):
  203.         return self._parent
  204.  
  205.     def setParent(self, parent):
  206.         self._parent = parent
  207.  
  208. # --- Utility functions
  209.  
  210. def prepare_input_source(source, base = ""):
  211.     """This function takes an InputSource and an optional base URL and
  212.     returns a fully resolved InputSource object ready for reading."""
  213.     
  214.     if type(source) in _StringTypes:
  215.         source = xmlreader.InputSource(source)
  216.     elif hasattr(source, "read"):
  217.         f = source
  218.         source = xmlreader.InputSource()
  219.         source.setByteStream(f)
  220.         if hasattr(f, "name"):
  221.             f.setSystemId(f.name)
  222.  
  223.     if source.getByteStream() is None:
  224.         sysid = source.getSystemId()
  225.         if os.path.isfile(sysid):
  226.             basehead = os.path.split(os.path.normpath(base))[0]
  227.             source.setSystemId(os.path.join(basehead, sysid))
  228.             f = open(sysid, "rb")
  229.         else:
  230.             source.setSystemId(urlparse.urljoin(base, sysid))
  231.             f = urllib.urlopen(source.getSystemId())
  232.             
  233.         source.setByteStream(f)
  234.         
  235.     return source
  236.