Package lxml :: Module sax :: Class ElementTreeContentHandler

[hide private]
[frames] | no frames]

# Class ElementTreeContentHandler

source code

    xml.sax.handler.ContentHandler --+
                                     |
                                    ElementTreeContentHandler

Build an lxml ElementTree from SAX events.

Instance Methods | [hide private]

__init__(self, makeelement=None) | source code

_get_etree(self) Contains the generated ElementTree after parsing is finished. | source code

setDocumentLocator(self, locator) Called by the parser to give the application a locator for locating the origin of document events. | source code

startDocument(self) Receive notification of the beginning of a document. | source code

endDocument(self) Receive notification of the end of a document. | source code

startPrefixMapping(self, prefix, uri) Begin the scope of a prefix-URI Namespace mapping. | source code

endPrefixMapping(self, prefix) End the scope of a prefix-URI mapping. | source code

_buildTag(self, ns_name_tuple) | source code

startElementNS(self, ns_name, qname, attributes=None) Signals the start of an element in namespace mode. | source code

processingInstruction(self, target, data) Receive notification of a processing instruction. | source code

endElementNS(self, ns_name, qname) Signals the end of an element in namespace mode. | source code

startElement(self, name, attributes=None) Signals the start of an element in non-namespace mode. | source code

endElement(self, name) Signals the end of an element in non-namespace mode. | source code

characters(self, data) Receive notification of character data. | source code

ignorableWhitespace(self, data) Receive notification of character data. | source code

Inherited from `xml.sax.handler.ContentHandler`: `skippedEntity`

Class Variables | [hide private]

| __qualname__ = ``'``ElementTreeContentHandler``'``

Properties | [hide private]

| etree Contains the generated ElementTree after parsing is finished.

Method Details | [hide private]

### __init__(self, makeelement=None)
(Constructor)

source code

Overrides: xml.sax.handler.ContentHandler.__init__

### setDocumentLocator(self, locator)

source code

Called by the parser to give the application a locator for locating the origin of document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.

Overrides: xml.sax.handler.ContentHandler.setDocumentLocator
  (inherited documentation)

### startDocument(self)

source code

Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).

Overrides: xml.sax.handler.ContentHandler.startDocument
  (inherited documentation)

### endDocument(self)

source code

Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Overrides: xml.sax.handler.ContentHandler.endDocument
  (inherited documentation)

### startPrefixMapping(self, prefix, uri)

source code

Begin the scope of a prefix-URI Namespace mapping.

The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the http://xml.org/sax/features/namespaces feature is true (the default).

There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.

Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each-other: all startPrefixMapping events will occur before the corresponding startElement event, and all endPrefixMapping events will occur after the corresponding endElement event, but their order is not guaranteed.

Overrides: xml.sax.handler.ContentHandler.startPrefixMapping
  (inherited documentation)

### endPrefixMapping(self, prefix)

source code

End the scope of a prefix-URI mapping.

See startPrefixMapping for details. This event will always occur after the corresponding endElement event, but the order of endPrefixMapping events is not otherwise guaranteed.

Overrides: xml.sax.handler.ContentHandler.endPrefixMapping
  (inherited documentation)

### startElementNS(self, ns_name, qname, attributes=None)

source code

Signals the start of an element in namespace mode.

The name parameter contains the name of the element type as a (uri, localname) tuple, the qname parameter the raw XML 1.0 name used in the source document, and the attrs parameter holds an instance of the Attributes class containing the attributes of the element.

The uri part of the name tuple is None for elements which have no namespace.

Overrides: xml.sax.handler.ContentHandler.startElementNS
  (inherited documentation)

### processingInstruction(self, target, data)

source code

Receive notification of a processing instruction.

The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Overrides: xml.sax.handler.ContentHandler.processingInstruction
  (inherited documentation)

### endElementNS(self, ns_name, qname)

source code

Signals the end of an element in namespace mode.

The name parameter contains the name of the element type, just as with the startElementNS event.

Overrides: xml.sax.handler.ContentHandler.endElementNS
  (inherited documentation)

### startElement(self, name, attributes=None)

source code

Signals the start of an element in non-namespace mode.

The name parameter contains the raw XML 1.0 name of the element type as a string and the attrs parameter holds an instance of the Attributes class containing the attributes of the element.

Overrides: xml.sax.handler.ContentHandler.startElement
  (inherited documentation)

### endElement(self, name)

source code

Signals the end of an element in non-namespace mode.

The name parameter contains the name of the element type, just as with the startElement event.

Overrides: xml.sax.handler.ContentHandler.endElement
  (inherited documentation)

### characters(self, data)

source code

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

Overrides: xml.sax.handler.ContentHandler.characters
  (inherited documentation)

### ignorableWhitespace(self, data)

source code

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

Overrides: xml.sax.handler.ContentHandler.ignorableWhitespace
  (inherited documentation)

Property Details | [hide private]

### etree

Contains the generated ElementTree after parsing is finished.

Get Method:
  _get_etree(self) - Contains the generated ElementTree after parsing is finished.