expatreader.py 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446
  1. """
  2. SAX driver for the pyexpat C module. This driver works with
  3. pyexpat.__version__ == '2.22'.
  4. """
  5. version = "0.20"
  6. from xml.sax._exceptions import *
  7. from xml.sax.handler import feature_validation, feature_namespaces
  8. from xml.sax.handler import feature_namespace_prefixes
  9. from xml.sax.handler import feature_external_ges, feature_external_pes
  10. from xml.sax.handler import feature_string_interning
  11. from xml.sax.handler import property_xml_string, property_interning_dict
  12. # xml.parsers.expat does not raise ImportError in Jython
  13. import sys
  14. if sys.platform[:4] == "java":
  15. raise SAXReaderNotAvailable("expat not available in Java", None)
  16. del sys
  17. try:
  18. from xml.parsers import expat
  19. except ImportError:
  20. raise SAXReaderNotAvailable("expat not supported", None)
  21. else:
  22. if not hasattr(expat, "ParserCreate"):
  23. raise SAXReaderNotAvailable("expat not supported", None)
  24. from xml.sax import xmlreader, saxutils, handler
  25. AttributesImpl = xmlreader.AttributesImpl
  26. AttributesNSImpl = xmlreader.AttributesNSImpl
  27. # If we're using a sufficiently recent version of Python, we can use
  28. # weak references to avoid cycles between the parser and content
  29. # handler, otherwise we'll just have to pretend.
  30. try:
  31. import _weakref
  32. except ImportError:
  33. def _mkproxy(o):
  34. return o
  35. else:
  36. import weakref
  37. _mkproxy = weakref.proxy
  38. del weakref, _weakref
  39. class _ClosedParser:
  40. pass
  41. # --- ExpatLocator
  42. class ExpatLocator(xmlreader.Locator):
  43. """Locator for use with the ExpatParser class.
  44. This uses a weak reference to the parser object to avoid creating
  45. a circular reference between the parser and the content handler.
  46. """
  47. def __init__(self, parser):
  48. self._ref = _mkproxy(parser)
  49. def getColumnNumber(self):
  50. parser = self._ref
  51. if parser._parser is None:
  52. return None
  53. return parser._parser.ErrorColumnNumber
  54. def getLineNumber(self):
  55. parser = self._ref
  56. if parser._parser is None:
  57. return 1
  58. return parser._parser.ErrorLineNumber
  59. def getPublicId(self):
  60. parser = self._ref
  61. if parser is None:
  62. return None
  63. return parser._source.getPublicId()
  64. def getSystemId(self):
  65. parser = self._ref
  66. if parser is None:
  67. return None
  68. return parser._source.getSystemId()
  69. # --- ExpatParser
  70. class ExpatParser(xmlreader.IncrementalParser, xmlreader.Locator):
  71. """SAX driver for the pyexpat C module."""
  72. def __init__(self, namespaceHandling=0, bufsize=2**16-20):
  73. xmlreader.IncrementalParser.__init__(self, bufsize)
  74. self._source = xmlreader.InputSource()
  75. self._parser = None
  76. self._namespaces = namespaceHandling
  77. self._lex_handler_prop = None
  78. self._parsing = False
  79. self._entity_stack = []
  80. self._external_ges = 0
  81. self._interning = None
  82. # XMLReader methods
  83. def parse(self, source):
  84. "Parse an XML document from a URL or an InputSource."
  85. source = saxutils.prepare_input_source(source)
  86. self._source = source
  87. try:
  88. self.reset()
  89. self._cont_handler.setDocumentLocator(ExpatLocator(self))
  90. xmlreader.IncrementalParser.parse(self, source)
  91. except:
  92. # bpo-30264: Close the source on error to not leak resources:
  93. # xml.sax.parse() doesn't give access to the underlying parser
  94. # to the caller
  95. self._close_source()
  96. raise
  97. def prepareParser(self, source):
  98. if source.getSystemId() is not None:
  99. self._parser.SetBase(source.getSystemId())
  100. # Redefined setContentHandler to allow changing handlers during parsing
  101. def setContentHandler(self, handler):
  102. xmlreader.IncrementalParser.setContentHandler(self, handler)
  103. if self._parsing:
  104. self._reset_cont_handler()
  105. def getFeature(self, name):
  106. if name == feature_namespaces:
  107. return self._namespaces
  108. elif name == feature_string_interning:
  109. return self._interning is not None
  110. elif name in (feature_validation, feature_external_pes,
  111. feature_namespace_prefixes):
  112. return 0
  113. elif name == feature_external_ges:
  114. return self._external_ges
  115. raise SAXNotRecognizedException("Feature '%s' not recognized" % name)
  116. def setFeature(self, name, state):
  117. if self._parsing:
  118. raise SAXNotSupportedException("Cannot set features while parsing")
  119. if name == feature_namespaces:
  120. self._namespaces = state
  121. elif name == feature_external_ges:
  122. self._external_ges = state
  123. elif name == feature_string_interning:
  124. if state:
  125. if self._interning is None:
  126. self._interning = {}
  127. else:
  128. self._interning = None
  129. elif name == feature_validation:
  130. if state:
  131. raise SAXNotSupportedException(
  132. "expat does not support validation")
  133. elif name == feature_external_pes:
  134. if state:
  135. raise SAXNotSupportedException(
  136. "expat does not read external parameter entities")
  137. elif name == feature_namespace_prefixes:
  138. if state:
  139. raise SAXNotSupportedException(
  140. "expat does not report namespace prefixes")
  141. else:
  142. raise SAXNotRecognizedException(
  143. "Feature '%s' not recognized" % name)
  144. def getProperty(self, name):
  145. if name == handler.property_lexical_handler:
  146. return self._lex_handler_prop
  147. elif name == property_interning_dict:
  148. return self._interning
  149. elif name == property_xml_string:
  150. if self._parser:
  151. if hasattr(self._parser, "GetInputContext"):
  152. return self._parser.GetInputContext()
  153. else:
  154. raise SAXNotRecognizedException(
  155. "This version of expat does not support getting"
  156. " the XML string")
  157. else:
  158. raise SAXNotSupportedException(
  159. "XML string cannot be returned when not parsing")
  160. raise SAXNotRecognizedException("Property '%s' not recognized" % name)
  161. def setProperty(self, name, value):
  162. if name == handler.property_lexical_handler:
  163. self._lex_handler_prop = value
  164. if self._parsing:
  165. self._reset_lex_handler_prop()
  166. elif name == property_interning_dict:
  167. self._interning = value
  168. elif name == property_xml_string:
  169. raise SAXNotSupportedException("Property '%s' cannot be set" %
  170. name)
  171. else:
  172. raise SAXNotRecognizedException("Property '%s' not recognized" %
  173. name)
  174. # IncrementalParser methods
  175. def feed(self, data, isFinal=False):
  176. if not self._parsing:
  177. self.reset()
  178. self._parsing = True
  179. self._cont_handler.startDocument()
  180. try:
  181. # The isFinal parameter is internal to the expat reader.
  182. # If it is set to true, expat will check validity of the entire
  183. # document. When feeding chunks, they are not normally final -
  184. # except when invoked from close.
  185. self._parser.Parse(data, isFinal)
  186. except expat.error as e:
  187. exc = SAXParseException(expat.ErrorString(e.code), e, self)
  188. # FIXME: when to invoke error()?
  189. self._err_handler.fatalError(exc)
  190. def _close_source(self):
  191. source = self._source
  192. try:
  193. file = source.getCharacterStream()
  194. if file is not None:
  195. file.close()
  196. finally:
  197. file = source.getByteStream()
  198. if file is not None:
  199. file.close()
  200. def close(self):
  201. if (self._entity_stack or self._parser is None or
  202. isinstance(self._parser, _ClosedParser)):
  203. # If we are completing an external entity, do nothing here
  204. return
  205. try:
  206. self.feed(b"", isFinal=True)
  207. self._cont_handler.endDocument()
  208. self._parsing = False
  209. # break cycle created by expat handlers pointing to our methods
  210. self._parser = None
  211. finally:
  212. self._parsing = False
  213. if self._parser is not None:
  214. # Keep ErrorColumnNumber and ErrorLineNumber after closing.
  215. parser = _ClosedParser()
  216. parser.ErrorColumnNumber = self._parser.ErrorColumnNumber
  217. parser.ErrorLineNumber = self._parser.ErrorLineNumber
  218. self._parser = parser
  219. self._close_source()
  220. def _reset_cont_handler(self):
  221. self._parser.ProcessingInstructionHandler = \
  222. self._cont_handler.processingInstruction
  223. self._parser.CharacterDataHandler = self._cont_handler.characters
  224. def _reset_lex_handler_prop(self):
  225. lex = self._lex_handler_prop
  226. parser = self._parser
  227. if lex is None:
  228. parser.CommentHandler = None
  229. parser.StartCdataSectionHandler = None
  230. parser.EndCdataSectionHandler = None
  231. parser.StartDoctypeDeclHandler = None
  232. parser.EndDoctypeDeclHandler = None
  233. else:
  234. parser.CommentHandler = lex.comment
  235. parser.StartCdataSectionHandler = lex.startCDATA
  236. parser.EndCdataSectionHandler = lex.endCDATA
  237. parser.StartDoctypeDeclHandler = self.start_doctype_decl
  238. parser.EndDoctypeDeclHandler = lex.endDTD
  239. def reset(self):
  240. if self._namespaces:
  241. self._parser = expat.ParserCreate(self._source.getEncoding(), " ",
  242. intern=self._interning)
  243. self._parser.namespace_prefixes = 1
  244. self._parser.StartElementHandler = self.start_element_ns
  245. self._parser.EndElementHandler = self.end_element_ns
  246. else:
  247. self._parser = expat.ParserCreate(self._source.getEncoding(),
  248. intern = self._interning)
  249. self._parser.StartElementHandler = self.start_element
  250. self._parser.EndElementHandler = self.end_element
  251. self._reset_cont_handler()
  252. self._parser.UnparsedEntityDeclHandler = self.unparsed_entity_decl
  253. self._parser.NotationDeclHandler = self.notation_decl
  254. self._parser.StartNamespaceDeclHandler = self.start_namespace_decl
  255. self._parser.EndNamespaceDeclHandler = self.end_namespace_decl
  256. self._decl_handler_prop = None
  257. if self._lex_handler_prop:
  258. self._reset_lex_handler_prop()
  259. # self._parser.DefaultHandler =
  260. # self._parser.DefaultHandlerExpand =
  261. # self._parser.NotStandaloneHandler =
  262. self._parser.ExternalEntityRefHandler = self.external_entity_ref
  263. try:
  264. self._parser.SkippedEntityHandler = self.skipped_entity_handler
  265. except AttributeError:
  266. # This pyexpat does not support SkippedEntity
  267. pass
  268. self._parser.SetParamEntityParsing(
  269. expat.XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE)
  270. self._parsing = False
  271. self._entity_stack = []
  272. # Locator methods
  273. def getColumnNumber(self):
  274. if self._parser is None:
  275. return None
  276. return self._parser.ErrorColumnNumber
  277. def getLineNumber(self):
  278. if self._parser is None:
  279. return 1
  280. return self._parser.ErrorLineNumber
  281. def getPublicId(self):
  282. return self._source.getPublicId()
  283. def getSystemId(self):
  284. return self._source.getSystemId()
  285. # event handlers
  286. def start_element(self, name, attrs):
  287. self._cont_handler.startElement(name, AttributesImpl(attrs))
  288. def end_element(self, name):
  289. self._cont_handler.endElement(name)
  290. def start_element_ns(self, name, attrs):
  291. pair = name.split()
  292. if len(pair) == 1:
  293. # no namespace
  294. pair = (None, name)
  295. elif len(pair) == 3:
  296. pair = pair[0], pair[1]
  297. else:
  298. # default namespace
  299. pair = tuple(pair)
  300. newattrs = {}
  301. qnames = {}
  302. for (aname, value) in attrs.items():
  303. parts = aname.split()
  304. length = len(parts)
  305. if length == 1:
  306. # no namespace
  307. qname = aname
  308. apair = (None, aname)
  309. elif length == 3:
  310. qname = "%s:%s" % (parts[2], parts[1])
  311. apair = parts[0], parts[1]
  312. else:
  313. # default namespace
  314. qname = parts[1]
  315. apair = tuple(parts)
  316. newattrs[apair] = value
  317. qnames[apair] = qname
  318. self._cont_handler.startElementNS(pair, None,
  319. AttributesNSImpl(newattrs, qnames))
  320. def end_element_ns(self, name):
  321. pair = name.split()
  322. if len(pair) == 1:
  323. pair = (None, name)
  324. elif len(pair) == 3:
  325. pair = pair[0], pair[1]
  326. else:
  327. pair = tuple(pair)
  328. self._cont_handler.endElementNS(pair, None)
  329. # this is not used (call directly to ContentHandler)
  330. def processing_instruction(self, target, data):
  331. self._cont_handler.processingInstruction(target, data)
  332. # this is not used (call directly to ContentHandler)
  333. def character_data(self, data):
  334. self._cont_handler.characters(data)
  335. def start_namespace_decl(self, prefix, uri):
  336. self._cont_handler.startPrefixMapping(prefix, uri)
  337. def end_namespace_decl(self, prefix):
  338. self._cont_handler.endPrefixMapping(prefix)
  339. def start_doctype_decl(self, name, sysid, pubid, has_internal_subset):
  340. self._lex_handler_prop.startDTD(name, pubid, sysid)
  341. def unparsed_entity_decl(self, name, base, sysid, pubid, notation_name):
  342. self._dtd_handler.unparsedEntityDecl(name, pubid, sysid, notation_name)
  343. def notation_decl(self, name, base, sysid, pubid):
  344. self._dtd_handler.notationDecl(name, pubid, sysid)
  345. def external_entity_ref(self, context, base, sysid, pubid):
  346. if not self._external_ges:
  347. return 1
  348. source = self._ent_handler.resolveEntity(pubid, sysid)
  349. source = saxutils.prepare_input_source(source,
  350. self._source.getSystemId() or
  351. "")
  352. self._entity_stack.append((self._parser, self._source))
  353. self._parser = self._parser.ExternalEntityParserCreate(context)
  354. self._source = source
  355. try:
  356. xmlreader.IncrementalParser.parse(self, source)
  357. except:
  358. return 0 # FIXME: save error info here?
  359. (self._parser, self._source) = self._entity_stack[-1]
  360. del self._entity_stack[-1]
  361. return 1
  362. def skipped_entity_handler(self, name, is_pe):
  363. if is_pe:
  364. # The SAX spec requires to report skipped PEs with a '%'
  365. name = '%'+name
  366. self._cont_handler.skippedEntity(name)
  367. # ---
  368. def create_parser(*args, **kwargs):
  369. return ExpatParser(*args, **kwargs)
  370. # ---
  371. if __name__ == "__main__":
  372. import xml.sax.saxutils
  373. p = create_parser()
  374. p.setContentHandler(xml.sax.saxutils.XMLGenerator())
  375. p.setErrorHandler(xml.sax.ErrorHandler())
  376. p.parse("http://www.ibiblio.org/xml/examples/shakespeare/hamlet.xml")