b1e8cb6700955fd0aedfd59a9736e8e5889bed2b
[platform/upstream/python-lxml.git] / doc / html / api / lxml.etree.XSLT-class.html
1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3           "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6   <title>lxml.etree.XSLT</title>
7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
8   <script type="text/javascript" src="epydoc.js"></script>
9 </head>
10
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12       alink="#204080">
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15        bgcolor="#a0c0ff" cellspacing="0">
16   <tr valign="middle">
17   <!-- Home link -->
18       <th>&nbsp;&nbsp;&nbsp;<a
19         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21   <!-- Tree link -->
22       <th>&nbsp;&nbsp;&nbsp;<a
23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25   <!-- Index link -->
26       <th>&nbsp;&nbsp;&nbsp;<a
27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29   <!-- Help link -->
30       <th>&nbsp;&nbsp;&nbsp;<a
31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33   <!-- Project homepage -->
34       <th class="navbar" align="right" width="100%">
35         <table border="0" cellpadding="0" cellspacing="0">
36           <tr><th class="navbar" align="center"
37             ><a class="navbar" target="_top" href="/">lxml API</a></th>
38           </tr></table></th>
39   </tr>
40 </table>
41 <table width="100%" cellpadding="0" cellspacing="0">
42   <tr valign="top">
43     <td width="100%">
44       <span class="breadcrumbs">
45         <a href="lxml-module.html">Package&nbsp;lxml</a> ::
46         <a href="lxml.etree-module.html">Module&nbsp;etree</a> ::
47         Class&nbsp;XSLT
48       </span>
49     </td>
50     <td>
51       <table cellpadding="0" cellspacing="0">
52         <!-- hide/show private -->
53         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
54     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
55         <tr><td align="right"><span class="options"
56             >[<a href="frames.html" target="_top">frames</a
57             >]&nbsp;|&nbsp;<a href="lxml.etree.XSLT-class.html"
58             target="_top">no&nbsp;frames</a>]</span></td></tr>
59       </table>
60     </td>
61   </tr>
62 </table>
63 <!-- ==================== CLASS DESCRIPTION ==================== -->
64 <h1 class="epydoc">Class XSLT</h1><p class="nomargin-top"></p>
65 <pre class="base-tree">
66 object --+
67          |
68         <strong class="uidshort">XSLT</strong>
69 </pre>
70
71 <hr />
72 <p>XSLT(self, xslt_input, extensions=None, regexp=True, access_control=None)</p>
73 <p>Turn an XSL document into an XSLT object.</p>
74 <p>Calling this object on a tree or Element will execute the XSLT:</p>
75 <pre class="rst-literal-block">
76 transform = etree.XSLT(xsl_tree)
77 result = transform(xml_tree)
78 </pre>
79 <p>Keyword arguments of the constructor:</p>
80 <ul class="rst-simple">
81 <li>extensions: a dict mapping <tt class="rst-docutils literal">(namespace, name)</tt> pairs to
82 extension functions or extension elements</li>
83 <li>regexp: enable exslt regular expression support in XPath
84 (default: True)</li>
85 <li>access_control: access restrictions for network or file
86 system (see <a href="lxml.etree.XSLTAccessControl-class.html" class="link">XSLTAccessControl</a>)</li>
87 </ul>
88 <p>Keyword arguments of the XSLT call:</p>
89 <ul class="rst-simple">
90 <li>profile_run: enable XSLT profiling (default: False)</li>
91 </ul>
92 <p>Other keyword arguments of the call are passed to the stylesheet
93 as parameters.</p>
94
95 <!-- ==================== INSTANCE METHODS ==================== -->
96 <a name="section-InstanceMethods"></a>
97 <table class="summary" border="1" cellpadding="3"
98        cellspacing="0" width="100%" bgcolor="white">
99 <tr bgcolor="#70b0f0" class="table-header">
100   <td colspan="2" class="table-header">
101     <table border="0" cellpadding="0" cellspacing="0" width="100%">
102       <tr valign="top">
103         <td align="left"><span class="table-header">Instance Methods</span></td>
104         <td align="right" valign="top"
105          ><span class="options">[<a href="#section-InstanceMethods"
106          class="privatelink" onclick="toggle_private();"
107          >hide private</a>]</span></td>
108       </tr>
109     </table>
110   </td>
111 </tr>
112 <tr>
113     <td width="15%" align="right" valign="top" class="summary">
114       <span class="summary-type">&nbsp;</span>
115     </td><td class="summary">
116       <table width="100%" cellpadding="0" cellspacing="0" border="0">
117         <tr>
118           <td><span class="summary-sig"><a href="lxml.etree.XSLT-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
119         <span class="summary-sig-arg">_input</span>,
120         <span class="summary-sig-arg">profile_run</span>=<span class="summary-sig-default">False</span>,
121         <span class="summary-sig-arg">**kw</span>)</span><br />
122       Execute the XSL transformation on a tree or Element.</td>
123           <td align="right" valign="top">
124             
125             
126           </td>
127         </tr>
128       </table>
129       
130     </td>
131   </tr>
132 <tr>
133     <td width="15%" align="right" valign="top" class="summary">
134       <span class="summary-type">&nbsp;</span>
135     </td><td class="summary">
136       <table width="100%" cellpadding="0" cellspacing="0" border="0">
137         <tr>
138           <td><span class="summary-sig"><a name="__copy__"></a><span class="summary-sig-name">__copy__</span>(<span class="summary-sig-arg">...</span>)</span></td>
139           <td align="right" valign="top">
140             
141             
142           </td>
143         </tr>
144       </table>
145       
146     </td>
147   </tr>
148 <tr>
149     <td width="15%" align="right" valign="top" class="summary">
150       <span class="summary-type">&nbsp;</span>
151     </td><td class="summary">
152       <table width="100%" cellpadding="0" cellspacing="0" border="0">
153         <tr>
154           <td><span class="summary-sig"><a name="__deepcopy__"></a><span class="summary-sig-name">__deepcopy__</span>(<span class="summary-sig-arg">...</span>)</span></td>
155           <td align="right" valign="top">
156             
157             
158           </td>
159         </tr>
160       </table>
161       
162     </td>
163   </tr>
164 <tr>
165     <td width="15%" align="right" valign="top" class="summary">
166       <span class="summary-type">&nbsp;</span>
167     </td><td class="summary">
168       <table width="100%" cellpadding="0" cellspacing="0" border="0">
169         <tr>
170           <td><span class="summary-sig"><a href="lxml.etree.XSLT-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
171         <span class="summary-sig-arg">xslt_input</span>,
172         <span class="summary-sig-arg">extensions</span>=<span class="summary-sig-default">None</span>,
173         <span class="summary-sig-arg">regexp</span>=<span class="summary-sig-default">True</span>,
174         <span class="summary-sig-arg">access_control</span>=<span class="summary-sig-default">None</span>)</span><br />
175       x.__init__(...) initializes x; see help(type(x)) for signature</td>
176           <td align="right" valign="top">
177             
178             
179           </td>
180         </tr>
181       </table>
182       
183     </td>
184   </tr>
185 <tr>
186     <td width="15%" align="right" valign="top" class="summary">
187       <span class="summary-type">a new object with type S, a subtype of T</span>
188     </td><td class="summary">
189       <table width="100%" cellpadding="0" cellspacing="0" border="0">
190         <tr>
191           <td><span class="summary-sig"><a href="lxml.etree.XSLT-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
192         <span class="summary-sig-arg">S</span>,
193         <span class="summary-sig-arg">...</span>)</span></td>
194           <td align="right" valign="top">
195             
196             
197           </td>
198         </tr>
199       </table>
200       
201     </td>
202   </tr>
203 <tr>
204     <td width="15%" align="right" valign="top" class="summary">
205       <span class="summary-type">&nbsp;</span>
206     </td><td class="summary">
207       <table width="100%" cellpadding="0" cellspacing="0" border="0">
208         <tr>
209           <td><span class="summary-sig"><a href="lxml.etree.XSLT-class.html#apply" class="summary-sig-name">apply</a>(<span class="summary-sig-arg">self</span>,
210         <span class="summary-sig-arg">_input</span>,
211         <span class="summary-sig-arg">profile_run</span>=<span class="summary-sig-default">False</span>,
212         <span class="summary-sig-arg">**kw</span>)</span></td>
213           <td align="right" valign="top">
214             
215             
216           </td>
217         </tr>
218       </table>
219       
220     </td>
221   </tr>
222 <tr>
223     <td width="15%" align="right" valign="top" class="summary">
224       <span class="summary-type">&nbsp;</span>
225     </td><td class="summary">
226       <table width="100%" cellpadding="0" cellspacing="0" border="0">
227         <tr>
228           <td><span class="summary-sig"><a href="lxml.etree.XSLT-class.html#tostring" class="summary-sig-name">tostring</a>(<span class="summary-sig-arg">self</span>,
229         <span class="summary-sig-arg">result_tree</span>)</span><br />
230       Save result doc to string based on stylesheet output method.</td>
231           <td align="right" valign="top">
232             
233             
234           </td>
235         </tr>
236       </table>
237       
238     </td>
239   </tr>
240   <tr>
241     <td colspan="2" class="summary">
242     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
243       <code>__delattr__</code>,
244       <code>__format__</code>,
245       <code>__getattribute__</code>,
246       <code>__hash__</code>,
247       <code>__reduce__</code>,
248       <code>__reduce_ex__</code>,
249       <code>__repr__</code>,
250       <code>__setattr__</code>,
251       <code>__sizeof__</code>,
252       <code>__str__</code>,
253       <code>__subclasshook__</code>
254       </p>
255     </td>
256   </tr>
257 </table>
258 <!-- ==================== STATIC METHODS ==================== -->
259 <a name="section-StaticMethods"></a>
260 <table class="summary" border="1" cellpadding="3"
261        cellspacing="0" width="100%" bgcolor="white">
262 <tr bgcolor="#70b0f0" class="table-header">
263   <td colspan="2" class="table-header">
264     <table border="0" cellpadding="0" cellspacing="0" width="100%">
265       <tr valign="top">
266         <td align="left"><span class="table-header">Static Methods</span></td>
267         <td align="right" valign="top"
268          ><span class="options">[<a href="#section-StaticMethods"
269          class="privatelink" onclick="toggle_private();"
270          >hide private</a>]</span></td>
271       </tr>
272     </table>
273   </td>
274 </tr>
275 <tr>
276     <td width="15%" align="right" valign="top" class="summary">
277       <span class="summary-type">&nbsp;</span>
278     </td><td class="summary">
279       <table width="100%" cellpadding="0" cellspacing="0" border="0">
280         <tr>
281           <td><span class="summary-sig"><a href="lxml.etree.XSLT-class.html#set_global_max_depth" class="summary-sig-name">set_global_max_depth</a>(<span class="summary-sig-arg">max_depth</span>)</span><br />
282       The maximum traversal depth that the stylesheet engine will allow.
283 This does not only count the template recursion depth but also takes
284 the number of variables/parameters into account.  The required setting
285 for a run depends on both the stylesheet and the input data.</td>
286           <td align="right" valign="top">
287             
288             
289           </td>
290         </tr>
291       </table>
292       
293     </td>
294   </tr>
295 <tr>
296     <td width="15%" align="right" valign="top" class="summary">
297       <span class="summary-type">&nbsp;</span>
298     </td><td class="summary">
299       <table width="100%" cellpadding="0" cellspacing="0" border="0">
300         <tr>
301           <td><span class="summary-sig"><a href="lxml.etree.XSLT-class.html#strparam" class="summary-sig-name">strparam</a>(<span class="summary-sig-arg">strval</span>)</span><br />
302       Mark an XSLT string parameter that requires quote escaping
303 before passing it into the transformation.  Use it like this:</td>
304           <td align="right" valign="top">
305             
306             
307           </td>
308         </tr>
309       </table>
310       
311     </td>
312   </tr>
313 </table>
314 <!-- ==================== PROPERTIES ==================== -->
315 <a name="section-Properties"></a>
316 <table class="summary" border="1" cellpadding="3"
317        cellspacing="0" width="100%" bgcolor="white">
318 <tr bgcolor="#70b0f0" class="table-header">
319   <td colspan="2" class="table-header">
320     <table border="0" cellpadding="0" cellspacing="0" width="100%">
321       <tr valign="top">
322         <td align="left"><span class="table-header">Properties</span></td>
323         <td align="right" valign="top"
324          ><span class="options">[<a href="#section-Properties"
325          class="privatelink" onclick="toggle_private();"
326          >hide private</a>]</span></td>
327       </tr>
328     </table>
329   </td>
330 </tr>
331 <tr>
332     <td width="15%" align="right" valign="top" class="summary">
333       <span class="summary-type">&nbsp;</span>
334     </td><td class="summary">
335         <a name="error_log"></a><span class="summary-name">error_log</span><br />
336       The log of errors and warnings of an XSLT execution.
337     </td>
338   </tr>
339   <tr>
340     <td colspan="2" class="summary">
341     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
342       <code>__class__</code>
343       </p>
344     </td>
345   </tr>
346 </table>
347 <!-- ==================== METHOD DETAILS ==================== -->
348 <a name="section-MethodDetails"></a>
349 <table class="details" border="1" cellpadding="3"
350        cellspacing="0" width="100%" bgcolor="white">
351 <tr bgcolor="#70b0f0" class="table-header">
352   <td colspan="2" class="table-header">
353     <table border="0" cellpadding="0" cellspacing="0" width="100%">
354       <tr valign="top">
355         <td align="left"><span class="table-header">Method Details</span></td>
356         <td align="right" valign="top"
357          ><span class="options">[<a href="#section-MethodDetails"
358          class="privatelink" onclick="toggle_private();"
359          >hide private</a>]</span></td>
360       </tr>
361     </table>
362   </td>
363 </tr>
364 </table>
365 <a name="__call__"></a>
366 <div>
367 <table class="details" border="1" cellpadding="3"
368        cellspacing="0" width="100%" bgcolor="white">
369 <tr><td>
370   <table width="100%" cellpadding="0" cellspacing="0" border="0">
371   <tr valign="top"><td>
372   <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
373         <span class="sig-arg">_input</span>,
374         <span class="sig-arg">profile_run</span>=<span class="sig-default">False</span>,
375         <span class="sig-arg">**kw</span>)</span>
376     <br /><em class="fname">(Call operator)</em>
377   </h3>
378   </td><td align="right" valign="top"
379     >&nbsp;
380     </td>
381   </tr></table>
382   
383   <p>Execute the XSL transformation on a tree or Element.</p>
384 <p>Pass the <tt class="rst-docutils literal">profile_run</tt> option to get profile information
385 about the XSLT.  The result of the XSLT will have a property
386 xslt_profile that holds an XML tree with profiling data.</p>
387   <dl class="fields">
388   </dl>
389 </td></tr></table>
390 </div>
391 <a name="__init__"></a>
392 <div>
393 <table class="details" border="1" cellpadding="3"
394        cellspacing="0" width="100%" bgcolor="white">
395 <tr><td>
396   <table width="100%" cellpadding="0" cellspacing="0" border="0">
397   <tr valign="top"><td>
398   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
399         <span class="sig-arg">xslt_input</span>,
400         <span class="sig-arg">extensions</span>=<span class="sig-default">None</span>,
401         <span class="sig-arg">regexp</span>=<span class="sig-default">True</span>,
402         <span class="sig-arg">access_control</span>=<span class="sig-default">None</span>)</span>
403     <br /><em class="fname">(Constructor)</em>
404   </h3>
405   </td><td align="right" valign="top"
406     >&nbsp;
407     </td>
408   </tr></table>
409   
410   x.__init__(...) initializes x; see help(type(x)) for signature
411   <dl class="fields">
412     <dt>Overrides:
413         object.__init__
414     </dt>
415   </dl>
416 </td></tr></table>
417 </div>
418 <a name="__new__"></a>
419 <div>
420 <table class="details" border="1" cellpadding="3"
421        cellspacing="0" width="100%" bgcolor="white">
422 <tr><td>
423   <table width="100%" cellpadding="0" cellspacing="0" border="0">
424   <tr valign="top"><td>
425   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
426         <span class="sig-arg">S</span>,
427         <span class="sig-arg">...</span>)</span>
428   </h3>
429   </td><td align="right" valign="top"
430     >&nbsp;
431     </td>
432   </tr></table>
433   
434   
435   <dl class="fields">
436     <dt>Returns: a new object with type S, a subtype of T</dt>
437     <dt>Overrides:
438         object.__new__
439     </dt>
440   </dl>
441 </td></tr></table>
442 </div>
443 <a name="apply"></a>
444 <div>
445 <table class="details" border="1" cellpadding="3"
446        cellspacing="0" width="100%" bgcolor="white">
447 <tr><td>
448   <table width="100%" cellpadding="0" cellspacing="0" border="0">
449   <tr valign="top"><td>
450   <h3 class="epydoc"><span class="sig"><span class="sig-name">apply</span>(<span class="sig-arg">self</span>,
451         <span class="sig-arg">_input</span>,
452         <span class="sig-arg">profile_run</span>=<span class="sig-default">False</span>,
453         <span class="sig-arg">**kw</span>)</span>
454   </h3>
455   </td><td align="right" valign="top"
456     >&nbsp;
457     </td>
458   </tr></table>
459   
460   
461   <dl class="fields">
462   </dl>
463 <div class="fields">      <p><strong>Deprecated:</strong>
464         call the object, not this method.
465       </p>
466 </div></td></tr></table>
467 </div>
468 <a name="set_global_max_depth"></a>
469 <div>
470 <table class="details" border="1" cellpadding="3"
471        cellspacing="0" width="100%" bgcolor="white">
472 <tr><td>
473   <table width="100%" cellpadding="0" cellspacing="0" border="0">
474   <tr valign="top"><td>
475   <h3 class="epydoc"><span class="sig"><span class="sig-name">set_global_max_depth</span>(<span class="sig-arg">max_depth</span>)</span>
476     <br /><em class="fname">Static Method</em>
477   </h3>
478   </td><td align="right" valign="top"
479     >&nbsp;
480     </td>
481   </tr></table>
482   
483   <p>The maximum traversal depth that the stylesheet engine will allow.
484 This does not only count the template recursion depth but also takes
485 the number of variables/parameters into account.  The required setting
486 for a run depends on both the stylesheet and the input data.</p>
487 <p>Example:</p>
488 <pre class="rst-literal-block">
489 XSLT.set_global_max_depth(5000)
490 </pre>
491 <p>Note that this is currently a global, module-wide setting because
492 libxslt does not support it at a per-stylesheet level.</p>
493   <dl class="fields">
494   </dl>
495 </td></tr></table>
496 </div>
497 <a name="strparam"></a>
498 <div>
499 <table class="details" border="1" cellpadding="3"
500        cellspacing="0" width="100%" bgcolor="white">
501 <tr><td>
502   <table width="100%" cellpadding="0" cellspacing="0" border="0">
503   <tr valign="top"><td>
504   <h3 class="epydoc"><span class="sig"><span class="sig-name">strparam</span>(<span class="sig-arg">strval</span>)</span>
505     <br /><em class="fname">Static Method</em>
506   </h3>
507   </td><td align="right" valign="top"
508     >&nbsp;
509     </td>
510   </tr></table>
511   
512   <p>Mark an XSLT string parameter that requires quote escaping
513 before passing it into the transformation.  Use it like this:</p>
514 <pre class="rst-literal-block">
515 result = transform(doc, some_strval = XSLT.strparam(
516     '''it's &quot;Monty Python's&quot; ...'''))
517 </pre>
518 <p>Escaped string parameters can be reused without restriction.</p>
519   <dl class="fields">
520   </dl>
521 </td></tr></table>
522 </div>
523 <a name="tostring"></a>
524 <div>
525 <table class="details" border="1" cellpadding="3"
526        cellspacing="0" width="100%" bgcolor="white">
527 <tr><td>
528   <table width="100%" cellpadding="0" cellspacing="0" border="0">
529   <tr valign="top"><td>
530   <h3 class="epydoc"><span class="sig"><span class="sig-name">tostring</span>(<span class="sig-arg">self</span>,
531         <span class="sig-arg">result_tree</span>)</span>
532   </h3>
533   </td><td align="right" valign="top"
534     >&nbsp;
535     </td>
536   </tr></table>
537   
538   Save result doc to string based on stylesheet output method.
539   <dl class="fields">
540   </dl>
541 <div class="fields">      <p><strong>Deprecated:</strong>
542         use str(result_tree) instead.
543       </p>
544 </div></td></tr></table>
545 </div>
546 <br />
547 <!-- ==================== NAVIGATION BAR ==================== -->
548 <table class="navbar" border="0" width="100%" cellpadding="0"
549        bgcolor="#a0c0ff" cellspacing="0">
550   <tr valign="middle">
551   <!-- Home link -->
552       <th>&nbsp;&nbsp;&nbsp;<a
553         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
554
555   <!-- Tree link -->
556       <th>&nbsp;&nbsp;&nbsp;<a
557         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
558
559   <!-- Index link -->
560       <th>&nbsp;&nbsp;&nbsp;<a
561         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
562
563   <!-- Help link -->
564       <th>&nbsp;&nbsp;&nbsp;<a
565         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
566
567   <!-- Project homepage -->
568       <th class="navbar" align="right" width="100%">
569         <table border="0" cellpadding="0" cellspacing="0">
570           <tr><th class="navbar" align="center"
571             ><a class="navbar" target="_top" href="/">lxml API</a></th>
572           </tr></table></th>
573   </tr>
574 </table>
575 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
576   <tr>
577     <td align="left" class="footer">
578     Generated by Epydoc 3.0.1
579     on Wed Jan 29 12:26:21 2020
580     </td>
581     <td align="right" class="footer">
582       <a target="mainFrame" href="http://epydoc.sourceforge.net"
583         >http://epydoc.sourceforge.net</a>
584     </td>
585   </tr>
586 </table>
587
588 <script type="text/javascript">
589   <!--
590   // Private objects are initially displayed (because if
591   // javascript is turned off then we want them to be
592   // visible); but by default, we want to hide them.  So hide
593   // them unless we have a cookie that says to show them.
594   checkCookie();
595   // -->
596 </script>
597 </body>
598 </html>