libxml2/doc/python.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   5 <link rel="SHORTCUT ICON" href="/favicon.ico">
   6 <style type="text/css"><!--
   7 TD {font-family: Verdana,Arial,Helvetica}
   8 BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
   9 H1 {font-family: Verdana,Arial,Helvetica}
  10 H2 {font-family: Verdana,Arial,Helvetica}
  11 H3 {font-family: Verdana,Arial,Helvetica}
  12 A:link, A:visited, A:active { text-decoration: underline }
  13 --></style>
  14 <title>Python and bindings</title>
  15 </head>
  16 <body bgcolor="#8b7765" text="#000000" link="#000000" vlink="#000000">
  17 <table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr>
  18 <td width="180">
  19 <a href="http://www.gnome.org/"><img src="gnome2.png" alt="Gnome2 Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png" alt="W3C Logo"></a><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo"></a><div align="left"><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-180x168.gif" alt="Made with Libxml2 Logo"></a></div>
  20 </td>
  21 <td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center">
  22 <h1>The XML C library for Gnome</h1>
  23 <h2>Python and bindings</h2>
  24 </td></tr></table></td></tr></table></td>
  25 </tr></table>
  26 <table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr>
  27 <td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td>
  28 <table width="100%" border="0" cellspacing="1" cellpadding="3">
  29 <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr>
  30 <tr><td bgcolor="#fffacd">
  31 <form action="search.php" enctype="application/x-www-form-urlencoded" method="GET">
  32 <input name="query" type="TEXT" size="20" value=""><input name="submit" type="submit" value="Search ...">
  33 </form>
  34 <ul>
  35 <li><a href="index.html">Home</a></li>
  36 <li><a href="intro.html">Introduction</a></li>
  37 <li><a href="FAQ.html">FAQ</a></li>
  38 <li><a href="docs.html">Documentation</a></li>
  39 <li><a href="bugs.html">Reporting bugs and getting help</a></li>
  40 <li><a href="help.html">How to help</a></li>
  41 <li><a href="downloads.html">Downloads</a></li>
  42 <li><a href="news.html">News</a></li>
  43 <li><a href="XMLinfo.html">XML</a></li>
  44 <li><a href="XSLT.html">XSLT</a></li>
  45 <li><a href="python.html">Python and bindings</a></li>
  46 <li><a href="architecture.html">libxml architecture</a></li>
  47 <li><a href="tree.html">The tree output</a></li>
  48 <li><a href="interface.html">The SAX interface</a></li>
  49 <li><a href="xmldtd.html">Validation &amp; DTDs</a></li>
  50 <li><a href="xmlmem.html">Memory Management</a></li>
  51 <li><a href="encoding.html">Encodings support</a></li>
  52 <li><a href="xmlio.html">I/O Interfaces</a></li>
  53 <li><a href="catalog.html">Catalog support</a></li>
  54 <li><a href="library.html">The parser interfaces</a></li>
  55 <li><a href="entities.html">Entities or no entities</a></li>
  56 <li><a href="namespaces.html">Namespaces</a></li>
  57 <li><a href="upgrade.html">Upgrading 1.x code</a></li>
  58 <li><a href="threads.html">Thread safety</a></li>
  59 <li><a href="DOM.html">DOM Principles</a></li>
  60 <li><a href="example.html">A real example</a></li>
  61 <li><a href="contribs.html">Contributions</a></li>
  62 <li><a href="xmlreader.html">The Reader Interface</a></li>
  63 <li><a href="tutorial/index.html">Tutorial</a></li>
  64 <li><a href="guidelines.html">XML Guidelines</a></li>
  65 <li>
  66 <a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a>
  67 </li>
  68 </ul>
  69 </td></tr>
  70 </table>
  71 <table width="100%" border="0" cellspacing="1" cellpadding="3">
  72 <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr>
  73 <tr><td bgcolor="#fffacd"><ul>
  74 <li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li>
  75 <li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li>
  76 <li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li>
  77 <li><a href="http://www.aleksey.com/xmlsec/">XML-DSig xmlsec</a></li>
  78 <li><a href="ftp://xmlsoft.org/">FTP</a></li>
  79 <li><a href="http://www.zlatkovic.com/projects/libxml/">Windows binaries</a></li>
  80 <li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
  81 <li><a href="http://www.zveno.com/open_source/libxml2xslt.html">MacOsX binaries</a></li>
  82 <li><a href="http://sourceforge.net/projects/libxml2-pas/">Pascal bindings</a></li>
  83 <li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml&amp;product=libxml2">Bug Tracker</a></li>
  84 </ul></td></tr>
  85 </table>
  86 <table width="100%" border="0" cellspacing="1" cellpadding="3">
  87 <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr>
  88 <tr><td bgcolor="#fffacd"><ul>
  89 <li><a href="APIchunk0.html">Alphabetic</a></li>
  90 <li><a href="APIconstructors.html">Constructors</a></li>
  91 <li><a href="APIfunctions.html">Functions/Types</a></li>
  92 <li><a href="APIfiles.html">Modules</a></li>
  93 <li><a href="APIsymbols.html">Symbols</a></li>
  94 </ul></td></tr>
  95 </table>
  96 </td></tr></table></td>
  97 <td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd">
  98 <p>There are a number of language bindings and wrappers available for
  99 libxml2, the list below is not exhaustive. Please contact the <a href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
 100 (<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
 101 order to get updates to this list or to discuss the specific topic of libxml2
 102 or libxslt wrappers or bindings:</p>
 103 <ul>
 104 <li>
 105 <a href="http://libxmlplusplus.sourceforge.net/">Libxml++</a> seems the
 106     most up-to-date C++ bindings for libxml2, check the <a href="http://libxmlplusplus.sourceforge.net/reference/html/hierarchy.html">documentation</a>
 107     and the <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/libxmlplusplus/libxml%2b%2b/examples/">examples</a>.</li>
 108   <li>There is another <a href="http://libgdome-cpp.berlios.de/">C++ wrapper
 109     based on the gdome2 bindings</a> maintained by Tobias Peters.</li>
 110   <li>and a third C++ wrapper by Peter Jones &lt;pjones@pmade.org&gt;
 111     <p>Website: <a href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a>
 112 </p>
 113   </li>
 114   <li>
 115 <a href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
 116     Sergeant</a> developed <a href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for
 117     libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
 118     application server</a>.</li>
 119   <li>
 120 <a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides an
 121     earlier version of the libxml/libxslt <a href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>.</li>
 122   <li>Gopal.V and Peter Minten develop <a href="http://savannah.gnu.org/projects/libxmlsharp">libxml#</a>, a set of
 123     C# libxml2 bindings.</li>
 124   <li>Petr Kozelka provides <a href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
 125     libxml2</a> with Kylix, Delphi and other Pascal compilers.</li>
 126   <li>Uwe Fechner also provides <a href="http://sourceforge.net/projects/idom2-pas/">idom2</a>, a DOM2
 127     implementation for Kylix2/D5/D6 from Borland.</li>
 128   <li>Wai-Sun &quot;Squidster&quot; Chia provides <a href="http://www.rubycolor.org/arc/redist/">bindings for Ruby</a>  and
 129     libxml2 bindings are also available in Ruby through the <a href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
 130     maintained by Tobias Peters.</li>
 131   <li>Steve Ball and contributors maintains <a href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
 132     Tcl</a>.</li>
 133   <li>There is support for libxml2 in the DOM module of PHP.</li>
 134 </ul>
 135 <p>The distribution includes a set of Python bindings, which are guaranteed
 136 to be maintained as part of the library in the future, though the Python
 137 interface have not yet reached the maturity of the C API.</p>
 138 <p>
 139 <a href="mailto:stephane.bidoul@softwareag.com">Stéphane Bidoul</a>
 140 maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port
 141 of the Python bindings</a>.</p>
 142 <p>Note to people interested in building bindings, the API is formalized as
 143 <a href="libxml2-api.xml">an XML API description file</a> which allows to
 144 automate a large part of the Python bindings, this includes function
 145 descriptions, enums, structures, typedefs, etc... The Python script used to
 146 build the bindings is python/generator.py in the source distribution.</p>
 147 <p>To install the Python bindings there are 2 options:</p>
 148 <ul>
 149 <li>If you use an RPM based distribution, simply install the <a href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-python
 150     RPM</a> (and if needed the <a href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
 151     RPM</a>).</li>
 152   <li>Otherwise use the <a href="ftp://xmlsoft.org/python/">libxml2-python
 153     module distribution</a> corresponding to your installed version of
 154     libxml2 and libxslt. Note that to install it you will need both libxml2
 155     and libxslt installed and run &quot;python setup.py build install&quot; in the
 156     module tree.</li>
 157 </ul>
 158 <p>The distribution includes a set of examples and regression tests for the
 159 python bindings in the <code>python/tests</code> directory. Here are some
 160 excerpts from those tests:</p>
 161 <h3>tst.py:</h3>
 162 <p>This is a basic test of the file interface and DOM navigation:</p>
 163 <pre>import libxml2
 164
 165 doc = libxml2.parseFile(&quot;tst.xml&quot;)
 166 if doc.name != &quot;tst.xml&quot;:
 167     print &quot;doc.name failed&quot;
 168     sys.exit(1)
 169 root = doc.children
 170 if root.name != &quot;doc&quot;:
 171     print &quot;root.name failed&quot;
 172     sys.exit(1)
 173 child = root.children
 174 if child.name != &quot;foo&quot;:
 175     print &quot;child.name failed&quot;
 176     sys.exit(1)
 177 doc.freeDoc()</pre>
 178 <p>The Python module is called libxml2; parseFile is the equivalent of
 179 xmlParseFile (most of the bindings are automatically generated, and the xml
 180 prefix is removed and the casing convention are kept). All node seen at the
 181 binding level share the same subset of accessors:</p>
 182 <ul>
 183 <li>
 184 <code>name</code> : returns the node name</li>
 185   <li>
 186 <code>type</code> : returns a string indicating the node type</li>
 187   <li>
 188 <code>content</code> : returns the content of the node, it is based on
 189     xmlNodeGetContent() and hence is recursive.</li>
 190   <li>
 191 <code>parent</code> , <code>children</code>, <code>last</code>,
 192     <code>next</code>, <code>prev</code>, <code>doc</code>,
 193     <code>properties</code>: pointing to the associated element in the tree,
 194     those may return None in case no such link exists.</li>
 195 </ul>
 196 <p>Also note the need to explicitly deallocate documents with freeDoc() .
 197 Reference counting for libxml2 trees would need quite a lot of work to
 198 function properly, and rather than risk memory leaks if not implemented
 199 correctly it sounds safer to have an explicit function to free a tree. The
 200 wrapper python objects like doc, root or child are them automatically garbage
 201 collected.</p>
 202 <h3>validate.py:</h3>
 203 <p>This test check the validation interfaces and redirection of error
 204 messages:</p>
 205 <pre>import libxml2
 206
 207 #deactivate error messages from the validation
 208 def noerr(ctx, str):
 209     pass
 210
 211 libxml2.registerErrorHandler(noerr, None)
 212
 213 ctxt = libxml2.createFileParserCtxt(&quot;invalid.xml&quot;)
 214 ctxt.validate(1)
 215 ctxt.parseDocument()
 216 doc = ctxt.doc()
 217 valid = ctxt.isValid()
 218 doc.freeDoc()
 219 if valid != 0:
 220     print &quot;validity check failed&quot;</pre>
 221 <p>The first thing to notice is the call to registerErrorHandler(), it
 222 defines a new error handler global to the library. It is used to avoid seeing
 223 the error messages when trying to validate the invalid document.</p>
 224 <p>The main interest of that test is the creation of a parser context with
 225 createFileParserCtxt() and how the behaviour can be changed before calling
 226 parseDocument() . Similarly the informations resulting from the parsing phase
 227 are also available using context methods.</p>
 228 <p>Contexts like nodes are defined as class and the libxml2 wrappers maps the
 229 C function interfaces in terms of objects method as much as possible. The
 230 best to get a complete view of what methods are supported is to look at the
 231 libxml2.py module containing all the wrappers.</p>
 232 <h3>push.py:</h3>
 233 <p>This test show how to activate the push parser interface:</p>
 234 <pre>import libxml2
 235
 236 ctxt = libxml2.createPushParser(None, &quot;&lt;foo&quot;, 4, &quot;test.xml&quot;)
 237 ctxt.parseChunk(&quot;/&gt;&quot;, 2, 1)
 238 doc = ctxt.doc()
 239
 240 doc.freeDoc()</pre>
 241 <p>The context is created with a special call based on the
 242 xmlCreatePushParser() from the C library. The first argument is an optional
 243 SAX callback object, then the initial set of data, the length and the name of
 244 the resource in case URI-References need to be computed by the parser.</p>
 245 <p>Then the data are pushed using the parseChunk() method, the last call
 246 setting the third argument terminate to 1.</p>
 247 <h3>pushSAX.py:</h3>
 248 <p>this test show the use of the event based parsing interfaces. In this case
 249 the parser does not build a document, but provides callback information as
 250 the parser makes progresses analyzing the data being provided:</p>
 251 <pre>import libxml2
 252 log = &quot;&quot;
 253
 254 class callback:
 255     def startDocument(self):
 256         global log
 257         log = log + &quot;startDocument:&quot;
 258
 259     def endDocument(self):
 260         global log
 261         log = log + &quot;endDocument:&quot;
 262
 263     def startElement(self, tag, attrs):
 264         global log
 265         log = log + &quot;startElement %s %s:&quot; % (tag, attrs)
 266
 267     def endElement(self, tag):
 268         global log
 269         log = log + &quot;endElement %s:&quot; % (tag)
 270
 271     def characters(self, data):
 272         global log
 273         log = log + &quot;characters: %s:&quot; % (data)
 274
 275     def warning(self, msg):
 276         global log
 277         log = log + &quot;warning: %s:&quot; % (msg)
 278
 279     def error(self, msg):
 280         global log
 281         log = log + &quot;error: %s:&quot; % (msg)
 282
 283     def fatalError(self, msg):
 284         global log
 285         log = log + &quot;fatalError: %s:&quot; % (msg)
 286
 287 handler = callback()
 288
 289 ctxt = libxml2.createPushParser(handler, &quot;&lt;foo&quot;, 4, &quot;test.xml&quot;)
 290 chunk = &quot; url='tst'&gt;b&quot;
 291 ctxt.parseChunk(chunk, len(chunk), 0)
 292 chunk = &quot;ar&lt;/foo&gt;&quot;
 293 ctxt.parseChunk(chunk, len(chunk), 1)
 294
 295 reference = &quot;startDocument:startElement foo {'url': 'tst'}:&quot; + \
 296             &quot;characters: bar:endElement foo:endDocument:&quot;
 297 if log != reference:
 298     print &quot;Error got: %s&quot; % log
 299     print &quot;Expected: %s&quot; % reference</pre>
 300 <p>The key object in that test is the handler, it provides a number of entry
 301 points which can be called by the parser as it makes progresses to indicate
 302 the information set obtained. The full set of callback is larger than what
 303 the callback class in that specific example implements (see the SAX
 304 definition for a complete list). The wrapper will only call those supplied by
 305 the object when activated. The startElement receives the names of the element
 306 and a dictionary containing the attributes carried by this element.</p>
 307 <p>Also note that the reference string generated from the callback shows a
 308 single character call even though the string &quot;bar&quot; is passed to the parser
 309 from 2 different call to parseChunk()</p>
 310 <h3>xpath.py:</h3>
 311 <p>This is a basic test of XPath wrappers support</p>
 312 <pre>import libxml2
 313
 314 doc = libxml2.parseFile(&quot;tst.xml&quot;)
 315 ctxt = doc.xpathNewContext()
 316 res = ctxt.xpathEval(&quot;//*&quot;)
 317 if len(res) != 2:
 318     print &quot;xpath query: wrong node set size&quot;
 319     sys.exit(1)
 320 if res[0].name != &quot;doc&quot; or res[1].name != &quot;foo&quot;:
 321     print &quot;xpath query: wrong node set value&quot;
 322     sys.exit(1)
 323 doc.freeDoc()
 324 ctxt.xpathFreeContext()</pre>
 325 <p>This test parses a file, then create an XPath context to evaluate XPath
 326 expression on it. The xpathEval() method execute an XPath query and returns
 327 the result mapped in a Python way. String and numbers are natively converted,
 328 and node sets are returned as a tuple of libxml2 Python nodes wrappers. Like
 329 the document, the XPath context need to be freed explicitly, also not that
 330 the result of the XPath query may point back to the document tree and hence
 331 the document must be freed after the result of the query is used.</p>
 332 <h3>xpathext.py:</h3>
 333 <p>This test shows how to extend the XPath engine with functions written in
 334 python:</p>
 335 <pre>import libxml2
 336
 337 def foo(ctx, x):
 338     return x + 1
 339
 340 doc = libxml2.parseFile(&quot;tst.xml&quot;)
 341 ctxt = doc.xpathNewContext()
 342 libxml2.registerXPathFunction(ctxt._o, &quot;foo&quot;, None, foo)
 343 res = ctxt.xpathEval(&quot;foo(1)&quot;)
 344 if res != 2:
 345     print &quot;xpath extension failure&quot;
 346 doc.freeDoc()
 347 ctxt.xpathFreeContext()</pre>
 348 <p>Note how the extension function is registered with the context (but that
 349 part is not yet finalized, this may change slightly in the future).</p>
 350 <h3>tstxpath.py:</h3>
 351 <p>This test is similar to the previous one but shows how the extension
 352 function can access the XPath evaluation context:</p>
 353 <pre>def foo(ctx, x):
 354     global called
 355
 356     #
 357     # test that access to the XPath evaluation contexts
 358     #
 359     pctxt = libxml2.xpathParserContext(_obj=ctx)
 360     ctxt = pctxt.context()
 361     called = ctxt.function()
 362     return x + 1</pre>
 363 <p>All the interfaces around the XPath parser(or rather evaluation) context
 364 are not finalized, but it should be sufficient to do contextual work at the
 365 evaluation point.</p>
 366 <h3>Memory debugging:</h3>
 367 <p>last but not least, all tests starts with the following prologue:</p>
 368 <pre>#memory debug specific
 369 libxml2.debugMemory(1)</pre>
 370 <p>and ends with the following epilogue:</p>
 371 <pre>#memory debug specific
 372 libxml2.cleanupParser()
 373 if libxml2.debugMemory(1) == 0:
 374     print &quot;OK&quot;
 375 else:
 376     print &quot;Memory leak %d bytes&quot; % (libxml2.debugMemory(1))
 377     libxml2.dumpMemory()</pre>
 378 <p>Those activate the memory debugging interface of libxml2 where all
 379 allocated block in the library are tracked. The prologue then cleans up the
 380 library state and checks that all allocated memory has been freed. If not it
 381 calls dumpMemory() which saves that list in a <code>.memdump</code> file.</p>
 382 <p><a href="bugs.html">Daniel Veillard</a></p>
 383 </td></tr></table></td></tr></table></td></tr></table></td>
 384 </tr></table></td></tr></table>
 385 </body>
 386 </html>