lxml.sax.ElementTreeContentHandler

Package lxml :: Module sax :: Class ElementTreeContentHandler

[show private | hide private]

Type ElementTreeContentHandler

        object --+
                 |
ContentHandler --+
                 |
                ElementTreeContentHandler

Build an lxml ElementTree from SAX events.

Method Summary
	`__init__(self, makeelement)`
	`characters(self, data)`
	`endDocument(self)` Receive notification of the end of a document.
	`endElement(self, name)` Signals the end of an element in non-namespace mode.
	`endElementNS(self, ns_name, qname)`
	`endPrefixMapping(self, prefix)` End the scope of a prefix-URI mapping.
	`ignorableWhitespace(self, data)`
	`processingInstruction(self, target, data)` Receive notification of a processing instruction.
	`setDocumentLocator(self, locator)` Called by the parser to give the application a locator for locating the origin of document events.
	`startDocument(self)` Receive notification of the beginning of a document.
	`startElement(self, name, attributes)`
	`startElementNS(self, ns_name, qname, attributes)`
	`startPrefixMapping(self, prefix, uri)` Begin the scope of a prefix-URI Namespace mapping.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Property Summary
	`etree`: Contains the generated ElementTree after parsing is finished.

Method Details

endDocument(self)

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:: _xmlplus.sax.handler.ContentHandler.endDocument (inherited documentation)

endElement(self, name)

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:: _xmlplus.sax.handler.ContentHandler.endElement (inherited documentation)

endPrefixMapping(self, prefix)

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:: _xmlplus.sax.handler.ContentHandler.endPrefixMapping (inherited documentation)

processingInstruction(self, target, data)

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:: _xmlplus.sax.handler.ContentHandler.processingInstruction (inherited documentation)

setDocumentLocator(self, locator)

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:: _xmlplus.sax.handler.ContentHandler.setDocumentLocator (inherited documentation)

startDocument(self)

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:: _xmlplus.sax.handler.ContentHandler.startDocument (inherited documentation)

startPrefixMapping(self, prefix, uri)

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:: _xmlplus.sax.handler.ContentHandler.startPrefixMapping (inherited documentation)

Property Details

etree

Contains the generated ElementTree after parsing is finished.

Generated by Epydoc 2.1 on Sat Aug 18 12:44:27 2007

http://epydoc.sf.net