1  """Simple API for XML (SAX) implementation for Python.
       2  
       3  This module provides an implementation of the SAX 2 interface;
       4  information about the Java version of the interface can be found at
       5  http://www.megginson.com/SAX/.  The Python version of the interface is
       6  documented at <...>.
       7  
       8  This package contains the following modules:
       9  
      10  handler -- Base classes and constants which define the SAX 2 API for
      11             the 'client-side' of SAX for Python.
      12  
      13  saxutils -- Implementation of the convenience classes commonly used to
      14              work with SAX.
      15  
      16  xmlreader -- Base classes and constants which define the SAX 2 API for
      17               the parsers used with SAX for Python.
      18  
      19  expatreader -- Driver that allows use of the Expat parser with SAX.
      20  """
      21  
      22  from .xmlreader import InputSource
      23  from .handler import ContentHandler, ErrorHandler
      24  from ._exceptions import SAXException, SAXNotRecognizedException, \
      25                          SAXParseException, SAXNotSupportedException, \
      26                          SAXReaderNotAvailable
      27  
      28  
      29  def parse(source, handler, errorHandler=ErrorHandler()):
      30      parser = make_parser()
      31      parser.setContentHandler(handler)
      32      parser.setErrorHandler(errorHandler)
      33      parser.parse(source)
      34  
      35  def parseString(string, handler, errorHandler=ErrorHandler()):
      36      import io
      37      if errorHandler is None:
      38          errorHandler = ErrorHandler()
      39      parser = make_parser()
      40      parser.setContentHandler(handler)
      41      parser.setErrorHandler(errorHandler)
      42  
      43      inpsrc = InputSource()
      44      if isinstance(string, str):
      45          inpsrc.setCharacterStream(io.StringIO(string))
      46      else:
      47          inpsrc.setByteStream(io.BytesIO(string))
      48      parser.parse(inpsrc)
      49  
      50  # this is the parser list used by the make_parser function if no
      51  # alternatives are given as parameters to the function
      52  
      53  default_parser_list = ["xml.sax.expatreader"]
      54  
      55  # tell modulefinder that importing sax potentially imports expatreader
      56  _false = 0
      57  if _false:
      58      import xml.sax.expatreader
      59  
      60  import os, sys
      61  if not sys.flags.ignore_environment and "PY_SAX_PARSER" in os.environ:
      62      default_parser_list = os.environ["PY_SAX_PARSER"].split(",")
      63  del os
      64  
      65  _key = "python.xml.sax.parser"
      66  if sys.platform[:4] == "java" and sys.registry.containsKey(_key):
      67      default_parser_list = sys.registry.getProperty(_key).split(",")
      68  
      69  
      70  def make_parser(parser_list=()):
      71      """Creates and returns a SAX parser.
      72  
      73      Creates the first parser it is able to instantiate of the ones
      74      given in the iterable created by chaining parser_list and
      75      default_parser_list.  The iterables must contain the names of Python
      76      modules containing both a SAX parser and a create_parser function."""
      77  
      78      for parser_name in list(parser_list) + default_parser_list:
      79          try:
      80              return _create_parser(parser_name)
      81          except ImportError:
      82              import sys
      83              if parser_name in sys.modules:
      84                  # The parser module was found, but importing it
      85                  # failed unexpectedly, pass this exception through
      86                  raise
      87          except SAXReaderNotAvailable:
      88              # The parser module detected that it won't work properly,
      89              # so try the next one
      90              pass
      91  
      92      raise SAXReaderNotAvailable("No parsers found", None)
      93  
      94  # --- Internal utility methods used by make_parser
      95  
      96  if sys.platform[ : 4] == "java":
      97      def _create_parser(parser_name):
      98          from org.python.core import imp
      99          drv_module = imp.importName(parser_name, 0, globals())
     100          return drv_module.create_parser()
     101  
     102  else:
     103      def _create_parser(parser_name):
     104          drv_module = __import__(parser_name,{},{},['create_parser'])
     105          return drv_module.create_parser()
     106  
     107  del sys