blob: 37f9de8ef1cf539312ddd96d7ef787a40495d450 [file] [log] [blame]
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00001<!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 content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
Daniel Veillardc332dab2002-03-29 14:08:27 +00005<link rel="SHORTCUT ICON" href="/favicon.ico">
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00006<style type="text/css"><!--
Daniel Veillard373a4752002-02-21 14:46:29 +00007TD {font-family: Verdana,Arial,Helvetica}
8BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
9H1 {font-family: Verdana,Arial,Helvetica}
10H2 {font-family: Verdana,Arial,Helvetica}
11H3 {font-family: Verdana,Arial,Helvetica}
Daniel Veillard6dbcaf82002-02-20 14:37:47 +000012A: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="smallfootonly.gif" alt="Gnome 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>
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"><ul>
31<li><a href="index.html">Home</a></li>
32<li><a href="intro.html">Introduction</a></li>
33<li><a href="FAQ.html">FAQ</a></li>
34<li><a href="docs.html">Documentation</a></li>
35<li><a href="bugs.html">Reporting bugs and getting help</a></li>
36<li><a href="help.html">How to help</a></li>
37<li><a href="downloads.html">Downloads</a></li>
38<li><a href="news.html">News</a></li>
39<li><a href="XMLinfo.html">XML</a></li>
40<li><a href="XSLT.html">XSLT</a></li>
41<li><a href="python.html">Python and bindings</a></li>
42<li><a href="architecture.html">libxml architecture</a></li>
43<li><a href="tree.html">The tree output</a></li>
44<li><a href="interface.html">The SAX interface</a></li>
45<li><a href="xmldtd.html">Validation &amp; DTDs</a></li>
46<li><a href="xmlmem.html">Memory Management</a></li>
47<li><a href="encoding.html">Encodings support</a></li>
48<li><a href="xmlio.html">I/O Interfaces</a></li>
49<li><a href="catalog.html">Catalog support</a></li>
50<li><a href="library.html">The parser interfaces</a></li>
51<li><a href="entities.html">Entities or no entities</a></li>
52<li><a href="namespaces.html">Namespaces</a></li>
53<li><a href="upgrade.html">Upgrading 1.x code</a></li>
54<li><a href="threads.html">Thread safety</a></li>
55<li><a href="DOM.html">DOM Principles</a></li>
56<li><a href="example.html">A real example</a></li>
57<li><a href="contribs.html">Contributions</a></li>
58<li>
59<a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a>
60</li>
61</ul></td></tr>
62</table>
63<table width="100%" border="0" cellspacing="1" cellpadding="3">
64<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr>
65<tr><td bgcolor="#fffacd"><ul>
66<li><a href="APIchunk0.html">Alphabetic</a></li>
67<li><a href="APIconstructors.html">Constructors</a></li>
68<li><a href="APIfunctions.html">Functions/Types</a></li>
69<li><a href="APIfiles.html">Modules</a></li>
70<li><a href="APIsymbols.html">Symbols</a></li>
71</ul></td></tr>
72</table>
73<table width="100%" border="0" cellspacing="1" cellpadding="3">
74<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr>
75<tr><td bgcolor="#fffacd"><ul>
76<li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li>
77<li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li>
78<li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li>
Daniel Veillard2d347fa2002-03-17 10:34:11 +000079<li><a href="http://www.aleksey.com/xmlsec/">XML-DSig xmlsec</a></li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +000080<li><a href="ftp://xmlsoft.org/">FTP</a></li>
81<li><a href="http://www.fh-frankfurt.de/~igor/projects/libxml/">Windows binaries</a></li>
82<li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
Daniel Veillard2d347fa2002-03-17 10:34:11 +000083<li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml&amp;product=libxml2">Bug Tracker</a></li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +000084</ul></td></tr>
85</table>
86</td></tr></table></td>
87<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">
88<p>There is a number of language bindings and wrappers available for libxml2,
89the list below is not exhaustive. Please contact the <a href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
90(<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
91order to get updates to this list or to discuss the specific topic of libxml2
92or libxslt wrappers or bindings:</p>
93<ul>
94<li>
Daniel Veillardaf43f632002-03-08 15:05:20 +000095<a href="mailto:ari@lusis.org">Ari Johnson</a> provides a C++ wrapper
96 for libxml:<br>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +000097 Website: <a href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a><br>
98 Download: <a href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a>
99</li>
100<li>There is another <a href="http://libgdome-cpp.berlios.de/">C++ wrapper
101 based on the gdome2 </a>bindings maintained by Tobias Peters.</li>
102<li>
103<a href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
Daniel Veillardaf43f632002-03-08 15:05:20 +0000104 Sergeant</a> developped <a href="http://axkit.org/download/">XML::LibXSLT</a>, a perl wrapper for
105 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
106 application server</a>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000107</li>
108<li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000109<a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides and
110 earlier version of the libxml/libxslt <a href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000111</li>
112<li>Petr Kozelka provides <a href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
113 libxml2</a> with Kylix, Delphi and other Pascal compilers</li>
114<li>Wai-Sun &quot;Squidster&quot; Chia provides <a href="http://www.rubycolor.org/arc/redist/">bindings for Ruby</a> and
115 libxml2 bindings are also available in Ruby through the <a href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
116 maintained by Tobias Peters.</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000117<li>Steve Ball and contributors maintains <a href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
Daniel Veillardb9e469a2002-02-21 12:08:42 +0000118 Tcl</a>
119</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000120<li>There is support for libxml2 in the DOM module of PHP.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000121</ul>
122<p>The distribution includes a set of Python bindings, which are garanteed to
123be maintained as part of the library in the future, though the Python
Daniel Veillard0b79dfe2002-02-23 13:02:31 +0000124interface have not yet reached the maturity of the C API.</p>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000125<p>To install the Python bindings there are 2 options:</p>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +0000126<ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000127<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
128 RPM</a> (and if needed the <a href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
129 RPM</a>).</li>
130<li>Otherwise use the <a href="ftp://xmlsoft.org/python/">libxml2-python
131 module distribution</a> corresponding to your installed version of
132 libxml2 and libxslt. Note that to install it you will need both libxml2
133 and libxslt installed and run &quot;python setup.py build install&quot; in the
134 module tree.</li>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +0000135</ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000136<p>The distribution includes a set of examples and regression tests for the
137python bindings in the <code>python/tests</code> directory. Here are some
138excepts from those tests:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000139<h3>tst.py:</h3>
140<p>This is a basic test of the file interface and DOM navigation:</p>
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000141<pre>import libxml2
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000142
143doc = libxml2.parseFile(&quot;tst.xml&quot;)
144if doc.name != &quot;tst.xml&quot;:
145 print &quot;doc.name failed&quot;
146 sys.exit(1)
147root = doc.children
148if root.name != &quot;doc&quot;:
149 print &quot;root.name failed&quot;
150 sys.exit(1)
151child = root.children
152if child.name != &quot;foo&quot;:
153 print &quot;child.name failed&quot;
154 sys.exit(1)
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000155doc.freeDoc()</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000156<p>The Python module is called libxml2, parseFile is the equivalent of
157xmlParseFile (most of the bindings are automatically generated, and the xml
158prefix is removed and the casing convention are kept). All node seen at the
159binding level share the same subset of accesors:</p>
160<ul>
161<li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000162<code>name</code> : returns the node name</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000163<li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000164<code>type</code> : returns a string indicating the node
165 typ<code>e</code>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000166</li>
167<li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000168<code>content</code> : returns the content of the node, it is based on
169 xmlNodeGetContent() and hence is recursive.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000170<li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000171<code>parent</code> , <code>children</code>, <code>last</code>,
172 <code>next</code>, <code>prev</code>, <code>doc</code>,
173 <code>properties</code>: pointing to the associated element in the tree,
174 those may return None in case no such link exists.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000175</ul>
176<p>Also note the need to explicitely deallocate documents with freeDoc() .
177Reference counting for libxml2 trees would need quite a lot of work to
178function properly, and rather than risk memory leaks if not implemented
179correctly it sounds safer to have an explicit function to free a tree. The
180wrapper python objects like doc, root or child are them automatically garbage
181collected.</p>
182<h3>validate.py:</h3>
183<p>This test check the validation interfaces and redirection of error
184messages:</p>
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000185<pre>import libxml2
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000186
187#desactivate error messages from the validation
188def noerr(ctx, str):
189 pass
190
191libxml2.registerErrorHandler(noerr, None)
192
193ctxt = libxml2.createFileParserCtxt(&quot;invalid.xml&quot;)
194ctxt.validate(1)
195ctxt.parseDocument()
196doc = ctxt.doc()
197valid = ctxt.isValid()
198doc.freeDoc()
199if valid != 0:
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000200 print &quot;validity chec failed&quot;</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000201<p>The first thing to notice is the call to registerErrorHandler(), it
202defines a new error handler global to the library. It is used to avoid seeing
203the error messages when trying to validate the invalid document.</p>
204<p>The main interest of that test is the creation of a parser context with
205createFileParserCtxt() and how the behaviour can be changed before calling
206parseDocument() . Similary the informations resulting from the parsing phase
207are also available using context methods.</p>
208<p>Contexts like nodes are defined as class and the libxml2 wrappers maps the
209C function interfaces in terms of objects method as much as possible. The
210best to get a complete view of what methods are supported is to look at the
211libxml2.py module containing all the wrappers.</p>
212<h3>push.py:</h3>
213<p>This test show how to activate the push parser interface:</p>
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000214<pre>import libxml2
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000215
216ctxt = libxml2.createPushParser(None, &quot;&lt;foo&quot;, 4, &quot;test.xml&quot;)
217ctxt.parseChunk(&quot;/&gt;&quot;, 2, 1)
218doc = ctxt.doc()
219
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000220doc.freeDoc()</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000221<p>The context is created with a speciall call based on the
222xmlCreatePushParser() from the C library. The first argument is an optional
223SAX callback object, then the initial set of data, the lenght and the name of
224the resource in case URI-References need to be computed by the parser.</p>
225<p>Then the data are pushed using the parseChunk() method, the last call
226setting the thrird argument terminate to 1.</p>
227<h3>pushSAX.py:</h3>
228<p>this test show the use of the event based parsing interfaces. In this case
229the parser does not build a document, but provides callback information as
230the parser makes progresses analyzing the data being provided:</p>
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000231<pre>import libxml2
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000232log = &quot;&quot;
233
234class callback:
235 def startDocument(self):
236 global log
237 log = log + &quot;startDocument:&quot;
238
239 def endDocument(self):
240 global log
241 log = log + &quot;endDocument:&quot;
242
243 def startElement(self, tag, attrs):
244 global log
245 log = log + &quot;startElement %s %s:&quot; % (tag, attrs)
246
247 def endElement(self, tag):
248 global log
249 log = log + &quot;endElement %s:&quot; % (tag)
250
251 def characters(self, data):
252 global log
253 log = log + &quot;characters: %s:&quot; % (data)
254
255 def warning(self, msg):
256 global log
257 log = log + &quot;warning: %s:&quot; % (msg)
258
259 def error(self, msg):
260 global log
261 log = log + &quot;error: %s:&quot; % (msg)
262
263 def fatalError(self, msg):
264 global log
265 log = log + &quot;fatalError: %s:&quot; % (msg)
266
267handler = callback()
268
269ctxt = libxml2.createPushParser(handler, &quot;&lt;foo&quot;, 4, &quot;test.xml&quot;)
270chunk = &quot; url='tst'&gt;b&quot;
271ctxt.parseChunk(chunk, len(chunk), 0)
272chunk = &quot;ar&lt;/foo&gt;&quot;
273ctxt.parseChunk(chunk, len(chunk), 1)
274
Daniel Veillardfcbfa2d2002-02-21 17:54:27 +0000275reference = &quot;startDocument:startElement foo {'url': 'tst'}:&quot; + \
276 &quot;characters: bar:endElement foo:endDocument:&quot;
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000277if log != reference:
278 print &quot;Error got: %s&quot; % log
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000279 print &quot;Exprected: %s&quot; % reference</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000280<p>The key object in that test is the handler, it provides a number of entry
281points which can be called by the parser as it makes progresses to indicate
282the information set obtained. The full set of callback is larger than what
283the callback class in that specific example implements (see the SAX
284definition for a complete list). The wrapper will only call those supplied by
285the object when activated. The startElement receives the names of the element
286and a dictionnary containing the attributes carried by this element.</p>
287<p>Also note that the reference string generated from the callback shows a
288single character call even though the string &quot;bar&quot; is passed to the parser
289from 2 different call to parseChunk()</p>
290<h3>xpath.py:</h3>
291<p>This is a basic test of XPath warppers support</p>
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000292<pre>import libxml2
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000293
294doc = libxml2.parseFile(&quot;tst.xml&quot;)
295ctxt = doc.xpathNewContext()
296res = ctxt.xpathEval(&quot;//*&quot;)
297if len(res) != 2:
298 print &quot;xpath query: wrong node set size&quot;
299 sys.exit(1)
300if res[0].name != &quot;doc&quot; or res[1].name != &quot;foo&quot;:
301 print &quot;xpath query: wrong node set value&quot;
302 sys.exit(1)
303doc.freeDoc()
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000304ctxt.xpathFreeContext()</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000305<p>This test parses a file, then create an XPath context to evaluate XPath
306expression on it. The xpathEval() method execute an XPath query and returns
307the result mapped in a Python way. String and numbers are natively converted,
308and node sets are returned as a tuple of libxml2 Python nodes wrappers. Like
309the document, the XPath context need to be freed explicitely, also not that
310the result of the XPath query may point back to the document tree and hence
311the document must be freed after the result of the query is used.</p>
312<h3>xpathext.py:</h3>
313<p>This test shows how to extend the XPath engine with functions written in
314python:</p>
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000315<pre>import libxml2
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000316
317def foo(ctx, x):
318 return x + 1
319
320doc = libxml2.parseFile(&quot;tst.xml&quot;)
321ctxt = doc.xpathNewContext()
322libxml2.registerXPathFunction(ctxt._o, &quot;foo&quot;, None, foo)
323res = ctxt.xpathEval(&quot;foo(1)&quot;)
324if res != 2:
325 print &quot;xpath extension failure&quot;
326doc.freeDoc()
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000327ctxt.xpathFreeContext()</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000328<p>Note how the extension function is registered with the context (but that
329part is not yet finalized, ths may change slightly in the future).</p>
330<h3>tstxpath.py:</h3>
331<p>This test is similar to the previousone but shows how the extension
332function can access the XPath evaluation context:</p>
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000333<pre>def foo(ctx, x):
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000334 global called
335
336 #
337 # test that access to the XPath evaluation contexts
338 #
339 pctxt = libxml2.xpathParserContext(_obj=ctx)
340 ctxt = pctxt.context()
341 called = ctxt.function()
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000342 return x + 1</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000343<p>All the interfaces around the XPath parser(or rather evaluation) context
344are not finalized, but it should be sufficient to do contextual work at the
345evaluation point.</p>
346<h3>Memory debugging:</h3>
347<p>last but not least, all tests starts with the following prologue:</p>
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000348<pre>#memory debug specific
Daniel Veillardaf43f632002-03-08 15:05:20 +0000349libxml2.debugMemory(1)</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000350<p>and ends with the following epilogue:</p>
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000351<pre>#memory debug specific
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000352libxml2.cleanupParser()
353if libxml2.debugMemory(1) == 0:
354 print &quot;OK&quot;
355else:
356 print &quot;Memory leak %d bytes&quot; % (libxml2.debugMemory(1))
Daniel Veillard9eb146b2002-02-21 16:04:51 +0000357 libxml2.dumpMemory()</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000358<p>Those activate the memory debugging interface of libxml2 where all
359alloacted block in the library are tracked. The prologue then cleans up the
360library state and checks that all allocated memory has been freed. If not it
361calls dumpMemory() which saves that list in a <code>.memdump</code> file.</p>
362<p><a href="bugs.html">Daniel Veillard</a></p>
363</td></tr></table></td></tr></table></td></tr></table></td>
364</tr></table></td></tr></table>
365</body>
366</html>