lxml.etree.iterparse

Package lxml :: Module etree :: Class iterparse

[show private | hide private]

Type iterparse

 object --+    
          |    
_BaseParser --+
              |
             iterparse

Incremental parser. Parses XML into a tree and generates tuples (event, element) in a SAX-like fashion. ``event`` is any of 'start', 'end', 'start-ns', 'end-ns'.

For 'start' and 'end', ``element`` is the Element that the parser just found opening or closing. For 'start-ns', it is a tuple (prefix, URI) of a new namespace declaration. For 'end-ns', it is simply None. Note that all start and end events are guaranteed to be properly nested.

The keyword argument ``events`` specifies a sequence of event type names that should be generated. By default, only 'end' events will be generated.

The additional ``tag`` argument restricts the 'start' and 'end' events to those elements that match the given tag. By default, events are generated for all elements. Note that the 'start-ns' and 'end-ns' events are not impacted by this restriction.

The other keyword arguments in the constructor are mainly based on the libxml2 parser configuration. A DTD will also be loaded if validation or attribute default values are requested.

Available boolean keyword arguments: * attribute_defaults - read default attributes from DTD * dtd_validation - validate (if DTD is available) * load_dtd - use DTD for parsing * no_network - prevent network access * remove_blank_text - discard blank text nodes * remove_comments - discard comments * remove_pis - discard processing instructions

Method Summary
	`__init__(...)` x.__init__(...) initializes x; see x.__class__.__doc__ for signature
	`__iter__(x)` x.__iter__() <==> iter(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`next(x)` x.next() -> the next value, or raise StopIteration
Inherited from _BaseParser
	`copy(...)` Create a new parser with the same configuration.
	`makeelement(...)` Creates a new element associated with this parser.
	`set_element_class_lookup(...)` Set a lookup scheme for element classes generated from this parser.
	`setElementClassLookup(...)` Deprecated, use ``parser.set_element_class_lookup(lookup)`` instead.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__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)

Class Variable Summary
`PyCObject`	`__pyx_vtable__` = `<PyCObject object at 0x401cb9f8>`
`member_descriptor`	`root` = `<member 'root' of 'lxml.etree.iterparse' objects>`
Inherited from _BaseParser
`getset_descriptor`	`error_log` = `<attribute 'error_log' of 'lxml.etree._BaseP...`
`member_descriptor`	`resolvers` = `<member 'resolvers' of 'lxml.etree._BasePars...`

Method Details

init(...)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides:: lxml.etree._BaseParser.__init__

iter(x)

x.__iter__() <==> iter(x)

Returns:

iter(x)

new(T, S, ...)

T.__new__(S, ...) -> a new object with type S, a subtype of T

Returns:

a new object with type S, a subtype of T

Overrides:: lxml.etree._BaseParser.__new__

next(x)

x.next() -> the next value, or raise StopIteration

Returns:

the next value, or raise StopIteration

Class Variable Details

__pyx_vtable__

Type:: PyCObject
Value:: <PyCObject object at 0x401cb9f8>

root

Type:: member_descriptor
Value:: <member 'root' of 'lxml.etree.iterparse' objects>

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

http://epydoc.sf.net

Type iterparse

__init__(...) (Constructor)

__iter__(x)

__new__(T, S, ...)

next(x)

__pyx_vtable__

root

init(...)
(Constructor)

iter(x)

new(T, S, ...)