Package lxml :: Module etree :: Class xmlfile
[hide private]
[frames] | no frames]

Class xmlfile

object --+
         |
        xmlfile

xmlfile(self, output_file, encoding=None, compression=None)

A simple mechanism for incremental XML serialisation.

Usage example:

with xmlfile("somefile.xml", encoding='utf-8') as xf:
    xf.write_declaration(standalone=True)
    xf.write_doctype('<!DOCTYPE root SYSTEM "some.dtd">')

    # generate an element (the root element)
    with xf.element('root'):
         # write a complete Element into the open root element
         xf.write(etree.Element('test'))

         # generate and write more Elements, e.g. through iterparse
         for element in generate_some_elements():
             # serialise generated elements into the XML file
             xf.write(element)
Instance Methods [hide private]
 
__enter__(...)
 
__exit__(...)
 
__init__(self, output_file, encoding=None, compression=None)
x.__init__(...) initializes x; see help(type(x)) for signature
a new object with type S, a subtype of T
__new__(T, S, ...)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, output_file, encoding=None, compression=None)
(Constructor)

 
x.__init__(...) initializes x; see help(type(x)) for signature
Overrides: object.__init__

__new__(T, S, ...)

 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__