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 <style type="text/css"><!--
   6 TD {font-family: Verdana,Arial,Helvetica}
   7 BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
   8 H1 {font-family: Verdana,Arial,Helvetica}
   9 H2 {font-family: Verdana,Arial,Helvetica}
  10 H3 {font-family: Verdana,Arial,Helvetica}
  11 A: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="100">
  18 <a href="http://www.gnome.org/"><img src="gnome2.png" alt="Gnome2 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/XSLT/"><img src="Libxslt-Logo-180x168.gif" alt="Made with Libxslt Logo"></a></div>
  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 XSLT 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="docs.html">Documentation</a></li>
  33 <li><a href="bugs.html">Reporting bugs and getting help</a></li>
  34 <li><a href="help.html">How to help</a></li>
  35 <li><a href="downloads.html">Downloads</a></li>
  36 <li><a href="FAQ.html">FAQ</a></li>
  37 <li><a href="news.html">News</a></li>
  38 <li><a href="xsltproc2.html">The xsltproc tool</a></li>
  39 <li><a href="docbook.html">DocBook</a></li>
  40 <li><a href="API.html">The programming API</a></li>
  41 <li><a href="python.html">Python and bindings</a></li>
  42 <li><a href="internals.html">Library internals</a></li>
  43 <li><a href="extensions.html">Writing extensions</a></li>
  44 <li><a href="contribs.html">Contributions</a></li>
  45 <li>
  46 <a href="xslt.html">flat page</a>, <a href="site.xsl">stylesheet</a>
  47 </li>
  48 </ul></td></tr>
  49 </table>
  50 <table width="100%" border="0" cellspacing="1" cellpadding="3">
  51 <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr>
  52 <tr><td bgcolor="#fffacd">
  53 <form action="http://xmlsoft.org/XSLT/search.php" enctype="application/x-www-form-urlencoded" method="GET">
  54 <input name="query" type="TEXT" size="20" value=""><input name="submit" type="submit" value="Search ...">
  55 </form>
  56 <ul>
  57 <li><a href="APIchunk0.html">Alphabetic</a></li>
  58 <li><a href="APIconstructors.html">Constructors</a></li>
  59 <li><a href="APIfunctions.html">Functions/Types</a></li>
  60 <li><a href="APIfiles.html">Modules</a></li>
  61 <li><a href="APIsymbols.html">Symbols</a></li>
  62 </ul>
  63 </td></tr>
  64 </table>
  65 <table width="100%" border="0" cellspacing="1" cellpadding="3">
  66 <tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr>
  67 <tr><td bgcolor="#fffacd"><ul>
  68 <li><a href="tutorial/libxslttutorial.html">Tutorial</a></li>
  69 <li><a href="xsltproc.html">Man page for xsltproc</a></li>
  70 <li><a href="http://mail.gnome.org/archives/xslt/">Mail archive</a></li>
  71 <li><a href="http://xmlsoft.org/">XML libxml</a></li>
  72 <li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li>
  73 <li><a href="ftp://xmlsoft.org/">FTP</a></li>
  74 <li><a href="http://www.fh-frankfurt.de/~igor/projects/libxml/">Windows binaries</a></li>
  75 <li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
  76 <li><a href="http://www.zveno.com/open_source/libxml2xslt.html">MacOsX binaries</a></li>
  77 <li><a href="http://sourceforge.net/projects/libxml2-pas/">Pascal bindings</a></li>
  78 <li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxslt">Bug Tracker</a></li>
  79 <li><a href="http://xsldbg.sourceforge.net/">Xsldbg Debugger</a></li>
  80 </ul></td></tr>
  81 </table>
  82 </td></tr></table></td>
  83 <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">
  84 <p>There is a number of language bindings and wrappers available for libxml2,
  85 the list below is not exhaustive. Please contact the <a href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
  86 (<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
  87 order to get updates to this list or to discuss the specific topic of libxml2
  88 or libxslt wrappers or bindings:</p>
  89 <ul>
  90 <li>
  91 <a href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
  92     Sergeant</a> developped <a href="http://axkit.org/download/">XML::LibXML
  93     and XML::LibXSLT</a>, a perl wrapper for libxml2/libxslt as part of the
  94     <a href="http://axkit.com/">AxKit XML application server</a>
  95 </li>
  96   <li>
  97 <a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides and
  98     earlier version of the libxml/libxslt <a href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>
  99 </li>
 100   <li>Petr Kozelka provides <a href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
 101     libxml2</a> with Kylix, Delphi and other Pascal compilers</li>
 102   <li>Wai-Sun &quot;Squidster&quot; Chia provides <a href="http://www.rubycolor.org/arc/redist/">bindings for Ruby</a>  and
 103     libxml2 bindings are also available in Ruby through the <a href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
 104     maintained by Tobias Peters.</li>
 105   <li>Steve Ball and contributors maintains <a href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
 106     Tcl</a>
 107 </li>
 108 </ul>
 109 <p>The libxslt Python module depends on the <a href="http://xmlsoft.org/python.html">libxml2 Python</a> module.</p>
 110 <p>The distribution includes a set of Python bindings, which are garanteed to
 111 be maintained as part of the library in the future, though the Python
 112 interface have not yet reached the maturity of the C API.</p>
 113 <p>To install the Python bindings there are 2 options:</p>
 114 <ul>
 115 <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
 116     RPM</a> and the <a href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
 117     RPM</a>.</li>
 118   <li>Otherwise use the <a href="ftp://xmlsoft.org/python/">libxml2-python
 119     module distribution</a> corresponding to your installed version of
 120     libxml2 and libxslt. Note that to install it you will need both libxml2
 121     and libxslt installed and run &quot;python setup.py build install&quot; in the
 122     module tree.</li>
 123 </ul>
 124 <p>The distribution includes a set of examples and regression tests for the
 125 python bindings in the <code>python/tests</code> directory. Here are some
 126 excepts from those tests:</p>
 127 <h3>basic.py:</h3>
 128 <p>This is a basic test of XSLT interfaces: loading a stylesheet and a
 129 document, transforming the document and saving the result.</p>
 130 <pre>import libxml2
 131 import libxslt
 132
 133 styledoc = libxml2.parseFile(&quot;test.xsl&quot;)
 134 style = libxslt.parseStylesheetDoc(styledoc)
 135 doc = libxml2.parseFile(&quot;test.xml&quot;)
 136 result = style.applyStylesheet(doc, None)
 137 style.saveResultToFilename(&quot;foo&quot;, result, 0)
 138 style.freeStylesheet()
 139 doc.freeDoc()
 140 result.freeDoc()</pre>
 141 <p>The Python module is called libxslt, you will also need the libxml2 module
 142 for the operations on XML trees. Let's have a look at the objects manipulated
 143 in that example and how is the processing done:</p>
 144 <ul>
 145 <li>
 146 <code>styledoc</code> : is a libxml2 document tree. It is obtained by
 147     parsing the XML file &quot;test.xsl&quot; containing the stylesheet.</li>
 148   <li>
 149 <code>style</code> : this is a precompiled stylesheet ready to be used
 150     by the following transformations (note the plural form, multiple
 151     transformations can resuse the same stylesheet).</li>
 152   <li>
 153 <code>doc</code> : this is the document to apply the transformation to.
 154     In this case it is simply generated by parsing it from a file but any
 155     other processing is possible as long as one get a libxml2 Doc. Note that
 156     HTML tree are suitable for XSLT processing in libxslt. This is actually
 157     how this page is generated !</li>
 158   <li>
 159 <code>result</code> : this is a document generated by applying the
 160     stylesheet to the document. Note that some of the stylesheet informations
 161     may be related to the serialization of that document and as in this
 162     example a specific saveResultToFilename() method of the stylesheet should
 163     be used to save it to a file (in that case to &quot;foo&quot;).</li>
 164 </ul>
 165 <p>Also note the need to explicitely deallocate documents with freeDoc()
 166 except for the stylesheet document which is freed when its compiled form is
 167 garbage collected.</p>
 168 <h3>extfunc.py:</h3>
 169 <p>This one is a far more complex test. It shows how to modify the behaviour
 170 of an XSLT transformation by passing parameters and how to extend the XSLT
 171 engine with functions defined in python:</p>
 172 <pre>import libxml2
 173 import libxslt
 174 import string
 175
 176 nodeName = None
 177 def f(ctx, str):
 178     global nodeName
 179
 180     #
 181     # Small check to verify the context is correcly accessed
 182     #
 183     try:
 184         pctxt = libxslt.xpathParserContext(_obj=ctx)
 185         ctxt = pctxt.context()
 186         tctxt = ctxt.transformContext()
 187         nodeName = tctxt.insertNode().name
 188     except:
 189         pass
 190
 191     return string.upper(str)
 192
 193 libxslt.registerExtModuleFunction(&quot;foo&quot;, &quot;http://example.com/foo&quot;, f)</pre>
 194 <p>This code defines and register an extension function. Note that the
 195 function can be bound to any name (foo) and how the binding is also
 196 associated to a namespace name &quot;http://example.com/foo&quot;. From an XSLT point
 197 of view the function just returns an upper case version of the string passed
 198 as a parameter. But the first part of the function also read some contextual
 199 information from the current XSLT processing environement, in that case it
 200 looks for the current insertion node in the resulting output (either the
 201 resulting document or the Result Value Tree being generated), and saves it to
 202 a global variable for checking that the access actually worked.</p>
 203 <p>For more informations on the xpathParserContext and transformContext
 204 objects check the <a href="internals.html">libray internals description</a>.
 205 The pctxt is actually an object from a class derived from the
 206 libxml2.xpathParserContext() with just a couple more properties including the
 207 possibility to look up the XSLT transformation context from the XPath
 208 context.</p>
 209 <pre>styledoc = libxml2.parseDoc(&quot;&quot;&quot;
 210 &lt;xsl:stylesheet version='1.0'
 211   xmlns:xsl='http://www.w3.org/1999/XSL/Transform'
 212   xmlns:foo='http://example.com/foo'
 213   xsl:exclude-result-prefixes='foo'&gt;
 214
 215   &lt;xsl:param name='bar'&gt;failure&lt;/xsl:param&gt;
 216   &lt;xsl:template match='/'&gt;
 217     &lt;article&gt;&lt;xsl:value-of select='foo:foo($bar)'/&gt;&lt;/article&gt;
 218   &lt;/xsl:template&gt;
 219 &lt;/xsl:stylesheet&gt;
 220 &quot;&quot;&quot;)</pre>
 221 <p>Here is a simple example of how to read an XML document from a python
 222 string with libxml2. Note how this stylesheet:</p>
 223 <ul>
 224 <li>Uses a global parameter <code>bar</code>
 225 </li>
 226   <li>Reference the extension function f</li>
 227   <li>how the Namespace name &quot;http://example.com/foo&quot; has to be bound to a
 228     prefix</li>
 229   <li>how that prefix is excluded from the output</li>
 230   <li>how the function is called from the select</li>
 231 </ul>
 232 <pre>style = libxslt.parseStylesheetDoc(styledoc)
 233 doc = libxml2.parseDoc(&quot;&lt;doc/&gt;&quot;)
 234 result = style.applyStylesheet(doc, { &quot;bar&quot;: &quot;'success'&quot; })
 235 style.freeStylesheet()
 236 doc.freeDoc()</pre>
 237 <p>that part is identical, to the basic example except that the
 238 transformation is passed a dictionnary of parameters. Note that the string
 239 passed &quot;success&quot; had to be quoted, otherwise it is interpreted as an XPath
 240 query for the childs of root named &quot;success&quot;.</p>
 241 <pre>root = result.children
 242 if root.name != &quot;article&quot;:
 243     print &quot;Unexpected root node name&quot;
 244     sys.exit(1)
 245 if root.content != &quot;SUCCESS&quot;:
 246     print &quot;Unexpected root node content, extension function failed&quot;
 247     sys.exit(1)
 248 if nodeName != 'article':
 249     print &quot;The function callback failed to access its context&quot;
 250     sys.exit(1)
 251
 252 result.freeDoc()</pre>
 253 <p>That part just verifies that the transformation worked, that the parameter
 254 got properly passed to the engine, that the function f() got called and that
 255 it properly accessed the context to find the name of the insertion node.</p>
 256 <h3>pyxsltproc.py:</h3>
 257 <p>this module is a bit too long to be described there but it is basically a
 258 rewrite of the xsltproc command line interface of libxslt in Python. It
 259 provides nearly all the functionalities of xsltproc and can be used as a base
 260 module to write Python customized XSLT processors. One of the thing to notice
 261 are:</p>
 262 <pre>libxml2.lineNumbersDefault(1)
 263 libxml2.substituteEntitiesDefault(1)</pre>
 264 <p>those two calls in the main() function are needed to force the libxml2
 265 processor to generate DOM trees compliant with the XPath data model.</p>
 266 <p><a href="bugs.html">Daniel Veillard</a></p>
 267 </td></tr></table></td></tr></table></td></tr></table></td>
 268 </tr></table></td></tr></table>
 269 </body>
 270 </html>