20. Structured Markup Processing Tools

Python supports a variety of modules to work with various forms of structured data markup. This includes modules to work with the Standard Generalized Markup Language (SGML) and the Hypertext Markup Language (HTML), and several interfaces for working with the Extensible Markup Language (XML).

• 20.1. html — HyperText Markup Language support
  • escape()
  • unescape()
• 20.2. html.parser — Simple HTML and XHTML parser
  • HTMLParser
  • 20.2.1. Example HTML Parser Application
  • 20.2.2. HTMLParser Methods
    • HTMLParser.feed()
    • HTMLParser.close()
    • HTMLParser.reset()
    • HTMLParser.getpos()
    • HTMLParser.get_starttag_text()
    • HTMLParser.handle_starttag()
    • HTMLParser.handle_endtag()
    • HTMLParser.handle_startendtag()
    • HTMLParser.handle_data()
    • HTMLParser.handle_entityref()
    • HTMLParser.handle_charref()
    • HTMLParser.handle_comment()
    • HTMLParser.handle_decl()
    • HTMLParser.handle_pi()
    • HTMLParser.unknown_decl()
  • 20.2.3. Examples
• 20.3. html.entities — Definitions of HTML general entities
  • html5
  • entitydefs
  • name2codepoint
  • codepoint2name
• 20.4. XML Processing Modules
  • 20.4.1. XML vulnerabilities
  • 20.4.2. The defusedxml and defusedexpat Packages
• 20.5. xml.etree.ElementTree — The ElementTree XML API
  • 20.5.1. Tutorial
    • 20.5.1.1. XML tree and elements
    • 20.5.1.2. Parsing XML
    • 20.5.1.3. Pull API for non-blocking parsing
    • 20.5.1.4. Finding interesting elements
    • 20.5.1.5. Modifying an XML File
    • 20.5.1.6. Building XML documents
    • 20.5.1.7. Parsing XML with Namespaces
    • 20.5.1.8. Additional resources
  • 20.5.2. XPath support
    • 20.5.2.1. Example
    • 20.5.2.2. Supported XPath syntax
  • 20.5.3. Reference
    • 20.5.3.1. Functions
      • Comment()
      • dump()
      • fromstring()
      • fromstringlist()
      • iselement()
      • iterparse()
      • parse()
      • ProcessingInstruction()
      • register_namespace()
      • SubElement()
      • tostring()
      • tostringlist()
      • XML()
      • XMLID()
    • 20.5.3.2. Element Objects
      • Element
        • Element.tag
        • Element.text
        • Element.tail
        • Element.attrib
        • Element.clear()
        • Element.get()
        • Element.items()
        • Element.keys()
        • Element.set()
        • Element.append()
        • Element.extend()
        • Element.find()
        • Element.findall()
        • Element.findtext()
        • Element.getchildren()
        • Element.getiterator()
        • Element.insert()
        • Element.iter()
        • Element.iterfind()
        • Element.itertext()
        • Element.makeelement()
        • Element.remove()
    • 20.5.3.3. ElementTree Objects
      • ElementTree
        • ElementTree._setroot()
        • ElementTree.find()
        • ElementTree.findall()
        • ElementTree.findtext()
        • ElementTree.getiterator()
        • ElementTree.getroot()
        • ElementTree.iter()
        • ElementTree.iterfind()
        • ElementTree.parse()
        • ElementTree.write()
    • 20.5.3.4. QName Objects
      • QName
    • 20.5.3.5. TreeBuilder Objects
      • TreeBuilder
        • TreeBuilder.close()
        • TreeBuilder.data()
        • TreeBuilder.end()
        • TreeBuilder.start()
        • TreeBuilder.doctype()
    • 20.5.3.6. XMLParser Objects
      • XMLParser
        • XMLParser.close()
        • XMLParser.doctype()
        • XMLParser.feed()
    • 20.5.3.7. XMLPullParser Objects
      • XMLPullParser
        • XMLPullParser.feed()
        • XMLPullParser.close()
        • XMLPullParser.read_events()
    • 20.5.3.8. Exceptions
      • ParseError
        • ParseError.code
        • ParseError.position
• 20.6. xml.dom — The Document Object Model API
  • 20.6.1. Module Contents
    • registerDOMImplementation()
    • getDOMImplementation()
    • EMPTY_NAMESPACE
    • XML_NAMESPACE
    • XMLNS_NAMESPACE
    • XHTML_NAMESPACE
  • 20.6.2. Objects in the DOM
    • 20.6.2.1. DOMImplementation Objects
      • DOMImplementation.hasFeature()
      • DOMImplementation.createDocument()
      • DOMImplementation.createDocumentType()
    • 20.6.2.2. Node Objects
      • Node.nodeType
      • Node.parentNode
      • Node.attributes
      • Node.previousSibling
      • Node.nextSibling
      • Node.childNodes
      • Node.firstChild
      • Node.lastChild
      • Node.localName
      • Node.prefix
      • Node.namespaceURI
      • Node.nodeName
      • Node.nodeValue
      • Node.hasAttributes()
      • Node.hasChildNodes()
      • Node.isSameNode()
      • Node.appendChild()
      • Node.insertBefore()
      • Node.removeChild()
      • Node.replaceChild()
      • Node.normalize()
      • Node.cloneNode()
    • 20.6.2.3. NodeList Objects
      • NodeList.item()
      • NodeList.length
    • 20.6.2.4. DocumentType Objects
      • DocumentType.publicId
      • DocumentType.systemId
      • DocumentType.internalSubset
      • DocumentType.name
      • DocumentType.entities
      • DocumentType.notations
    • 20.6.2.5. Document Objects
      • Document.documentElement
      • Document.createElement()
      • Document.createElementNS()
      • Document.createTextNode()
      • Document.createComment()
      • Document.createProcessingInstruction()
      • Document.createAttribute()
      • Document.createAttributeNS()
      • Document.getElementsByTagName()
      • Document.getElementsByTagNameNS()
    • 20.6.2.6. Element Objects
      • Element.tagName
      • Element.getElementsByTagName()
      • Element.getElementsByTagNameNS()
      • Element.hasAttribute()
      • Element.hasAttributeNS()
      • Element.getAttribute()
      • Element.getAttributeNode()
      • Element.getAttributeNS()
      • Element.getAttributeNodeNS()
      • Element.removeAttribute()
      • Element.removeAttributeNode()
      • Element.removeAttributeNS()
      • Element.setAttribute()
      • Element.setAttributeNode()
      • Element.setAttributeNodeNS()
      • Element.setAttributeNS()
    • 20.6.2.7. Attr Objects
      • Attr.name
      • Attr.localName
      • Attr.prefix
      • Attr.value
    • 20.6.2.8. NamedNodeMap Objects
      • NamedNodeMap.length
      • NamedNodeMap.item()
    • 20.6.2.9. Comment Objects
      • Comment.data
    • 20.6.2.10. Text and CDATASection Objects
      • Text.data
    • 20.6.2.11. ProcessingInstruction Objects
      • ProcessingInstruction.target
      • ProcessingInstruction.data
    • 20.6.2.12. Exceptions
      • DOMException
      • DomstringSizeErr
      • HierarchyRequestErr
      • IndexSizeErr
      • InuseAttributeErr
      • InvalidAccessErr
      • InvalidCharacterErr
      • InvalidModificationErr
      • InvalidStateErr
      • NamespaceErr
      • NotFoundErr
      • NotSupportedErr
      • NoDataAllowedErr
      • NoModificationAllowedErr
      • SyntaxErr
      • WrongDocumentErr
  • 20.6.3. Conformance
    • 20.6.3.1. Type Mapping
    • 20.6.3.2. Accessor Methods
• 20.7. xml.dom.minidom — Minimal DOM implementation
  • parse()
  • parseString()
  • 20.7.1. DOM Objects
    • Node.unlink()
    • Node.writexml()
    • Node.toxml()
    • Node.toprettyxml()
  • 20.7.2. DOM Example
  • 20.7.3. minidom and the DOM standard
• 20.8. xml.dom.pulldom — Support for building partial DOM trees
  • PullDom
  • SAX2DOM
  • parse()
  • parseString()
  • default_bufsize
  • 20.8.1. DOMEventStream Objects
    • DOMEventStream
      • DOMEventStream.getEvent()
      • DOMEventStream.expandNode()
      • DOMEventStream.reset()
• 20.9. xml.sax — Support for SAX2 parsers
  • make_parser()
  • parse()
  • parseString()
  • SAXException
  • SAXParseException
  • SAXNotRecognizedException
  • SAXNotSupportedException
  • 20.9.1. SAXException Objects
    • SAXException.getMessage()
    • SAXException.getException()
• 20.10. xml.sax.handler — Base classes for SAX handlers
  • ContentHandler
  • DTDHandler
  • EntityResolver
  • ErrorHandler
  • feature_namespaces
  • feature_namespace_prefixes
  • feature_string_interning
  • feature_validation
  • feature_external_ges
  • feature_external_pes
  • all_features
  • property_lexical_handler
  • property_declaration_handler
  • property_dom_node
  • property_xml_string
  • all_properties
  • 20.10.1. ContentHandler Objects
    • ContentHandler.setDocumentLocator()
    • ContentHandler.startDocument()
    • ContentHandler.endDocument()
    • ContentHandler.startPrefixMapping()
    • ContentHandler.endPrefixMapping()
    • ContentHandler.startElement()
    • ContentHandler.endElement()
    • ContentHandler.startElementNS()
    • ContentHandler.endElementNS()
    • ContentHandler.characters()
    • ContentHandler.ignorableWhitespace()
    • ContentHandler.processingInstruction()
    • ContentHandler.skippedEntity()
  • 20.10.2. DTDHandler Objects
    • DTDHandler.notationDecl()
    • DTDHandler.unparsedEntityDecl()
  • 20.10.3. EntityResolver Objects
    • EntityResolver.resolveEntity()
  • 20.10.4. ErrorHandler Objects
    • ErrorHandler.error()
    • ErrorHandler.fatalError()
    • ErrorHandler.warning()
• 20.11. xml.sax.saxutils — SAX Utilities
  • escape()
  • unescape()
  • quoteattr()
  • XMLGenerator
  • XMLFilterBase
  • prepare_input_source()
• 20.12. xml.sax.xmlreader — Interface for XML parsers
  • XMLReader
  • IncrementalParser
  • Locator
  • InputSource
  • AttributesImpl
  • AttributesNSImpl
  • 20.12.1. XMLReader Objects
    • XMLReader.parse()
    • XMLReader.getContentHandler()
    • XMLReader.setContentHandler()
    • XMLReader.getDTDHandler()
    • XMLReader.setDTDHandler()
    • XMLReader.getEntityResolver()
    • XMLReader.setEntityResolver()
    • XMLReader.getErrorHandler()
    • XMLReader.setErrorHandler()
    • XMLReader.setLocale()
    • XMLReader.getFeature()
    • XMLReader.setFeature()
    • XMLReader.getProperty()
    • XMLReader.setProperty()
  • 20.12.2. IncrementalParser Objects
    • IncrementalParser.feed()
    • IncrementalParser.close()
    • IncrementalParser.reset()
  • 20.12.3. Locator Objects
    • Locator.getColumnNumber()
    • Locator.getLineNumber()
    • Locator.getPublicId()
    • Locator.getSystemId()
  • 20.12.4. InputSource Objects
    • InputSource.setPublicId()
    • InputSource.getPublicId()
    • InputSource.setSystemId()
    • InputSource.getSystemId()
    • InputSource.setEncoding()
    • InputSource.getEncoding()
    • InputSource.setByteStream()
    • InputSource.getByteStream()
    • InputSource.setCharacterStream()
    • InputSource.getCharacterStream()
  • 20.12.5. The Attributes Interface
    • Attributes.getLength()
    • Attributes.getNames()
    • Attributes.getType()
    • Attributes.getValue()
  • 20.12.6. The AttributesNS Interface
    • AttributesNS.getValueByQName()
    • AttributesNS.getNameByQName()
    • AttributesNS.getQNameByName()
    • AttributesNS.getQNames()
• 20.13. xml.parsers.expat — Fast XML parsing using Expat
  • ExpatError
  • error
  • XMLParserType
  • ErrorString()
  • ParserCreate()
  • 20.13.1. XMLParser Objects
    • xmlparser.Parse()
    • xmlparser.ParseFile()
    • xmlparser.SetBase()
    • xmlparser.GetBase()
    • xmlparser.GetInputContext()
    • xmlparser.ExternalEntityParserCreate()
    • xmlparser.SetParamEntityParsing()
    • xmlparser.UseForeignDTD()
    • xmlparser.buffer_size
    • xmlparser.buffer_text
    • xmlparser.buffer_used
    • xmlparser.ordered_attributes
    • xmlparser.specified_attributes
    • xmlparser.ErrorByteIndex
    • xmlparser.ErrorCode
    • xmlparser.ErrorColumnNumber
    • xmlparser.ErrorLineNumber
    • xmlparser.CurrentByteIndex
    • xmlparser.CurrentColumnNumber
    • xmlparser.CurrentLineNumber
    • xmlparser.XmlDeclHandler()
    • xmlparser.StartDoctypeDeclHandler()
    • xmlparser.EndDoctypeDeclHandler()
    • xmlparser.ElementDeclHandler()
    • xmlparser.AttlistDeclHandler()
    • xmlparser.StartElementHandler()
    • xmlparser.EndElementHandler()
    • xmlparser.ProcessingInstructionHandler()
    • xmlparser.CharacterDataHandler()
    • xmlparser.UnparsedEntityDeclHandler()
    • xmlparser.EntityDeclHandler()
    • xmlparser.NotationDeclHandler()
    • xmlparser.StartNamespaceDeclHandler()
    • xmlparser.EndNamespaceDeclHandler()
    • xmlparser.CommentHandler()
    • xmlparser.StartCdataSectionHandler()
    • xmlparser.EndCdataSectionHandler()
    • xmlparser.DefaultHandler()
    • xmlparser.DefaultHandlerExpand()
    • xmlparser.NotStandaloneHandler()
    • xmlparser.ExternalEntityRefHandler()
  • 20.13.2. ExpatError Exceptions
    • ExpatError.code
    • ExpatError.lineno
    • ExpatError.offset
  • 20.13.3. Example
  • 20.13.4. Content Model Descriptions
  • 20.13.5. Expat error constants
    • codes
    • messages
    • XML_ERROR_ASYNC_ENTITY
    • XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF
    • XML_ERROR_BAD_CHAR_REF
    • XML_ERROR_BINARY_ENTITY_REF
    • XML_ERROR_DUPLICATE_ATTRIBUTE
    • XML_ERROR_INCORRECT_ENCODING
    • XML_ERROR_INVALID_TOKEN
    • XML_ERROR_JUNK_AFTER_DOC_ELEMENT
    • XML_ERROR_MISPLACED_XML_PI
    • XML_ERROR_NO_ELEMENTS
    • XML_ERROR_NO_MEMORY
    • XML_ERROR_PARAM_ENTITY_REF
    • XML_ERROR_PARTIAL_CHAR
    • XML_ERROR_RECURSIVE_ENTITY_REF
    • XML_ERROR_SYNTAX
    • XML_ERROR_TAG_MISMATCH
    • XML_ERROR_UNCLOSED_TOKEN
    • XML_ERROR_UNDEFINED_ENTITY
    • XML_ERROR_UNKNOWN_ENCODING
    • XML_ERROR_UNCLOSED_CDATA_SECTION
    • XML_ERROR_EXTERNAL_ENTITY_HANDLING
    • XML_ERROR_NOT_STANDALONE
    • XML_ERROR_UNEXPECTED_STATE
    • XML_ERROR_ENTITY_DECLARED_IN_PE
    • XML_ERROR_FEATURE_REQUIRES_XML_DTD
    • XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING
    • XML_ERROR_UNBOUND_PREFIX
    • XML_ERROR_UNDECLARING_PREFIX
    • XML_ERROR_INCOMPLETE_PE
    • XML_ERROR_XML_DECL
    • XML_ERROR_TEXT_DECL
    • XML_ERROR_PUBLICID
    • XML_ERROR_SUSPENDED
    • XML_ERROR_NOT_SUSPENDED
    • XML_ERROR_ABORTED
    • XML_ERROR_FINISHED
    • XML_ERROR_SUSPEND_PE