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