doc/python.html

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><style type="text/css">
   4 TD {font-family: Verdana,Arial,Helvetica}
   5 BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
   6 H1 {font-family: Verdana,Arial,Helvetica}
   7 H2 {font-family: Verdana,Arial,Helvetica}
   8 H3 {font-family: Verdana,Arial,Helvetica}
   9 A:link, A:visited, A:active { text-decoration: underline }
  10 </style><title>Python and bindings</title></head><body bgcolor="#8b7765" text="#000000" link="#000000" vlink="#000000"><table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr><td width="120"><a href="http://swpat.ffii.org/"><img src="epatents.png" alt="Action against software patents" /></a></td><td width="100"><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></td><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"><h1>The XSLT C library for Gnome</h1><h2>Python and bindings</h2></td></tr></table></td></tr></table></td></tr></table><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><td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr><tr><td bgcolor="#fffacd"><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="20" value="" /><input name="submit" type="submit" value="Search ..." /></form><ul><li><a href="index.html">Home</a></li><li><a href="intro.html">Introduction</a></li><li><a href="docs.html">Documentation</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="help.html">How to help</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="news.html">News</a></li><li><a href="xsltproc2.html">The xsltproc tool</a></li><li><a href="docbook.html">DocBook</a></li><li><a href="API.html">The programming API</a></li><li><a href="python.html">Python and bindings</a></li><li><a href="internals.html">Library internals</a></li><li><a href="extensions.html">Writing extensions</a></li><li><a href="contribs.html">Contributions</a></li><li><a href="xslt.html">flat page</a>, <a href="site.xsl">stylesheet</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="tutorial/libxslttutorial.html">Tutorial</a></li><li><a href="xsltproc.html">Man page for xsltproc</a></li><li><a href="http://mail.gnome.org/archives/xslt/">Mail archive</a></li><li><a href="http://xmlsoft.org/">XML libxml</a></li><li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li><li><a href="ftp://xmlsoft.org/">FTP</a></li><li><a href="http://www.zlatkovic.com/projects/libxml/">Windows binaries</a></li><li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li><li><a href="http://www.zveno.com/open_source/libxml2xslt.html">MacOsX binaries</a></li><li><a href="http://sourceforge.net/projects/libxml2-pas/">Pascal bindings</a></li><li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxslt">Bug Tracker</a></li><li><a href="http://xsldbg.sourceforge.net/">Xsldbg Debugger</a></li><li><a href="http://www.mod-xslt.com/mod-xslt/">Apache module</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="APIchunk0.html">Alphabetic</a></li><li><a href="APIconstructors.html">Constructors</a></li><li><a href="APIfunctions.html">Functions/Types</a></li><li><a href="APIfiles.html">Modules</a></li><li><a href="APIsymbols.html">Symbols</a></li></ul></td></tr></table></td></tr></table></td><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"><p>There is a number of language bindings and wrappers available for libxml2,
  11 the list below is not exhaustive. Please contact the <a href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
  12 (<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
  13 order to get updates to this list or to discuss the specific topic of libxml2
  14 or libxslt wrappers or bindings:</p><ul><li><a href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
  15     Sergeant</a> developped <a href="http://axkit.org/download/">XML::LibXML
  16     and XML::LibXSLT</a>, Perl wrappers for libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML application server</a></li>
  17   <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides and
  18     earlier version of the libxml/libxslt <a href="http://www.rexx.com/~dkuhlman">wrappers for Python</a></li>
  19   <li>Petr Kozelka provides <a href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
  20     libxml2</a> with Kylix, Delphi and other Pascal compilers</li>
  21   <li>Wai-Sun &quot;Squidster&quot; Chia provides <a href="http://www.rubycolor.org/arc/redist/">bindings for Ruby</a>  and
  22     libxml2 bindings are also available in Ruby through the <a href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
  23     maintained by Tobias Peters.</li>
  24   <li>Steve Ball and contributors maintains <a href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
  25     Tcl</a></li>
  26   <li><a href="mailto:xmlwrapp@pmade.org">Peter Jones</a> maintains C++
  27     bindings for libxslt within <a href="http://pmade.org/pjones/software/xmlwrapp/">xmlwrapp</a></li>
  28   <li><a href="phillim2@comcast.net">Mike Phillips</a> provides a module
  29     using <a href="http://siasl.dyndns.org/projects/projects.html">libxslt
  30     for PHP</a>.</li>
  31   <li><a href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a> is
  32     an effort to create a 100% JAXP-compatible Java wrapper for libxml2 and
  33     libxslt as part of GNU ClasspathX project.</li>
  34 </ul><p>The libxslt Python module depends on the <a href="http://xmlsoft.org/python.html">libxml2 Python</a> module.</p><p>The distribution includes a set of Python bindings, which are garanteed to
  35 be maintained as part of the library in the future, though the Python
  36 interface have not yet reached the completeness of the C API.</p><p><a href="mailto:stephane.bidoul@softwareag.com">Stéphane Bidoul</a>
  37 maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port
  38 of the Python bindings</a>.</p><p>Note to people interested in building bindings, the API is formalized as
  39 <a href="libxslt-api.xml">an XML API description file</a> which allows to
  40 automate a large part of the Python bindings, this includes function
  41 descriptions, enums, structures, typedefs, etc... The Python script used to
  42 build the bindings is python/generator.py in the source distribution.</p><p>To install the Python bindings there are 2 options:</p><ul><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
  43     RPM</a> and the <a href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
  44     RPM</a>.</li>
  45   <li>Otherwise use the <a href="ftp://xmlsoft.org/python/">libxml2-python
  46     module distribution</a> corresponding to your installed version of
  47     libxml2 and libxslt. Note that to install it you will need both libxml2
  48     and libxslt installed and run &quot;python setup.py build install&quot; in the
  49     module tree.</li>
  50 </ul><p>The distribution includes a set of examples and regression tests for the
  51 python bindings in the <code>python/tests</code> directory. Here are some
  52 excepts from those tests:</p><h3>basic.py:</h3><p>This is a basic test of XSLT interfaces: loading a stylesheet and a
  53 document, transforming the document and saving the result.</p><pre>import libxml2
  54 import libxslt
  55
  56 styledoc = libxml2.parseFile(&quot;test.xsl&quot;)
  57 style = libxslt.parseStylesheetDoc(styledoc)
  58 doc = libxml2.parseFile(&quot;test.xml&quot;)
  59 result = style.applyStylesheet(doc, None)
  60 style.saveResultToFilename(&quot;foo&quot;, result, 0)
  61 style.freeStylesheet()
  62 doc.freeDoc()
  63 result.freeDoc()</pre><p>The Python module is called libxslt, you will also need the libxml2 module
  64 for the operations on XML trees. Let's have a look at the objects manipulated
  65 in that example and how is the processing done:</p><ul><li><code>styledoc</code> : is a libxml2 document tree. It is obtained by
  66     parsing the XML file &quot;test.xsl&quot; containing the stylesheet.</li>
  67   <li><code>style</code> : this is a precompiled stylesheet ready to be used
  68     by the following transformations (note the plural form, multiple
  69     transformations can resuse the same stylesheet).</li>
  70   <li><code>doc</code> : this is the document to apply the transformation to.
  71     In this case it is simply generated by parsing it from a file but any
  72     other processing is possible as long as one get a libxml2 Doc. Note that
  73     HTML tree are suitable for XSLT processing in libxslt. This is actually
  74     how this page is generated !</li>
  75   <li><code>result</code> : this is a document generated by applying the
  76     stylesheet to the document. Note that some of the stylesheet informations
  77     may be related to the serialization of that document and as in this
  78     example a specific saveResultToFilename() method of the stylesheet should
  79     be used to save it to a file (in that case to &quot;foo&quot;).</li>
  80 </ul><p>Also note the need to explicitely deallocate documents with freeDoc()
  81 except for the stylesheet document which is freed when its compiled form is
  82 garbage collected.</p><h3>extfunc.py:</h3><p>This one is a far more complex test. It shows how to modify the behaviour
  83 of an XSLT transformation by passing parameters and how to extend the XSLT
  84 engine with functions defined in python:</p><pre>import libxml2
  85 import libxslt
  86 import string
  87
  88 nodeName = None
  89 def f(ctx, str):
  90     global nodeName
  91
  92     #
  93     # Small check to verify the context is correcly accessed
  94     #
  95     try:
  96         pctxt = libxslt.xpathParserContext(_obj=ctx)
  97         ctxt = pctxt.context()
  98         tctxt = ctxt.transformContext()
  99         nodeName = tctxt.insertNode().name
 100     except:
 101         pass
 102
 103     return string.upper(str)
 104
 105 libxslt.registerExtModuleFunction(&quot;foo&quot;, &quot;http://example.com/foo&quot;, f)</pre><p>This code defines and register an extension function. Note that the
 106 function can be bound to any name (foo) and how the binding is also
 107 associated to a namespace name &quot;http://example.com/foo&quot;. From an XSLT point
 108 of view the function just returns an upper case version of the string passed
 109 as a parameter. But the first part of the function also read some contextual
 110 information from the current XSLT processing environement, in that case it
 111 looks for the current insertion node in the resulting output (either the
 112 resulting document or the Result Value Tree being generated), and saves it to
 113 a global variable for checking that the access actually worked.</p><p>For more informations on the xpathParserContext and transformContext
 114 objects check the <a href="internals.html">libray internals description</a>.
 115 The pctxt is actually an object from a class derived from the
 116 libxml2.xpathParserContext() with just a couple more properties including the
 117 possibility to look up the XSLT transformation context from the XPath
 118 context.</p><pre>styledoc = libxml2.parseDoc(&quot;&quot;&quot;
 119 &lt;xsl:stylesheet version='1.0'
 120   xmlns:xsl='http://www.w3.org/1999/XSL/Transform'
 121   xmlns:foo='http://example.com/foo'
 122   xsl:exclude-result-prefixes='foo'&gt;
 123
 124   &lt;xsl:param name='bar'&gt;failure&lt;/xsl:param&gt;
 125   &lt;xsl:template match='/'&gt;
 126     &lt;article&gt;&lt;xsl:value-of select='foo:foo($bar)'/&gt;&lt;/article&gt;
 127   &lt;/xsl:template&gt;
 128 &lt;/xsl:stylesheet&gt;
 129 &quot;&quot;&quot;)</pre><p>Here is a simple example of how to read an XML document from a python
 130 string with libxml2. Note how this stylesheet:</p><ul><li>Uses a global parameter <code>bar</code></li>
 131   <li>Reference the extension function f</li>
 132   <li>how the Namespace name &quot;http://example.com/foo&quot; has to be bound to a
 133     prefix</li>
 134   <li>how that prefix is excluded from the output</li>
 135   <li>how the function is called from the select</li>
 136 </ul><pre>style = libxslt.parseStylesheetDoc(styledoc)
 137 doc = libxml2.parseDoc(&quot;&lt;doc/&gt;&quot;)
 138 result = style.applyStylesheet(doc, { &quot;bar&quot;: &quot;'success'&quot; })
 139 style.freeStylesheet()
 140 doc.freeDoc()</pre><p>that part is identical, to the basic example except that the
 141 transformation is passed a dictionnary of parameters. Note that the string
 142 passed &quot;success&quot; had to be quoted, otherwise it is interpreted as an XPath
 143 query for the childs of root named &quot;success&quot;.</p><pre>root = result.children
 144 if root.name != &quot;article&quot;:
 145     print &quot;Unexpected root node name&quot;
 146     sys.exit(1)
 147 if root.content != &quot;SUCCESS&quot;:
 148     print &quot;Unexpected root node content, extension function failed&quot;
 149     sys.exit(1)
 150 if nodeName != 'article':
 151     print &quot;The function callback failed to access its context&quot;
 152     sys.exit(1)
 153
 154 result.freeDoc()</pre><p>That part just verifies that the transformation worked, that the parameter
 155 got properly passed to the engine, that the function f() got called and that
 156 it properly accessed the context to find the name of the insertion node.</p><h3>pyxsltproc.py:</h3><p>this module is a bit too long to be described there but it is basically a
 157 rewrite of the xsltproc command line interface of libxslt in Python. It
 158 provides nearly all the functionalities of xsltproc and can be used as a base
 159 module to write Python customized XSLT processors. One of the thing to notice
 160 are:</p><pre>libxml2.lineNumbersDefault(1)
 161 libxml2.substituteEntitiesDefault(1)</pre><p>those two calls in the main() function are needed to force the libxml2
 162 processor to generate DOM trees compliant with the XPath data model.</p><p><a href="bugs.html">Daniel Veillard</a></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></body></html>