← Back to branch summary

~ubuntu-branches/ubuntu/hardy/libapache2-mod-python/hardy

« back to all changes in this revision

Viewing changes to doc-html/pyapi-psp.html

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2006-07-07 13:18:35 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060707131835-zfp1vupanjj2e77y
Tags: 3.2.8-1ubuntu1
* Merge to Debian unstable.
* Remaining Ubuntu change: debian/{control,rules}: Drop python 2.3 package.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc-html/pyapi-psp.html
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
2
<html>
3
3
<head>
4
 
<link rel="STYLESHEET" href="modpython.css" type='text/css' />
5
 
<link rel="first" href="modpython.html" title='Mod_python Manual' />
6
 
<link rel='contents' href='contents.html' title="Contents" />
7
 
<link rel='index' href='genindex.html' title='Index' />
8
 
<link rel='last' href='about.html' title='About this document...' />
9
 
<link rel='help' href='about.html' title='About this document...' />
10
 
<link rel="prev" href="pyapi-sess.html" />
11
 
<link rel="parent" href="pythonapi.html" />
12
 
<link rel="next" href="directives.html" />
13
 
<meta http-equiv="Content-Type" content="text/html; charset=EUC-JP" />
14
 
<meta name='aesop' content='information' />
 
4
<link rel="STYLESHEET" href="modpython.css" type='text/css'>
 
5
<link rel="first" href="modpython.html" title='Mod_python Manual'>
 
6
<link rel='contents' href='contents.html' title="Contents">
 
7
<link rel='index' href='genindex.html' title='Index'>
 
8
<link rel='last' href='about.html' title='About this document...'>
 
9
<link rel='help' href='about.html' title='About this document...'>
 
10
<LINK REL="prev" href="pyapi-sess.html">
 
11
<LINK REL="parent" href="pythonapi.html">
 
12
<LINK REL="next" href="directives.html">
 
13
<meta name='aesop' content='information'>
 
14
<META NAME="description" CONTENT="psp - Python Server Pages">
 
15
<META NAME="keywords" CONTENT="modpython">
 
16
<META NAME="resource-type" CONTENT="document">
 
17
<META NAME="distribution" CONTENT="global">
15
18
<title>4.9 psp - Python Server Pages</title>
16
19
</head>
17
20
<body>
18
21
<DIV CLASS="navigation">
19
 
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
20
22
<table align="center" width="100%" cellpadding="0" cellspacing="2">
21
23
<tr>
22
 
<td class='online-navigation'><a rel="prev" title="4.8.1 Classes"
23
 
  href="pyapi-sess-classes.html"><img src='previous.png'
24
 
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
25
 
<td class='online-navigation'><a rel="parent" title="4. Python API"
26
 
  href="pythonapi.html"><img src='up.png'
27
 
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
28
 
<td class='online-navigation'><a rel="next" title="5. Apache Configuration Directives"
29
 
  href="directives.html"><img src='next.png'
30
 
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
 
24
<td><a rel="prev" title="4.8.2 Examples" 
 
25
  href="pyapi-sess-example.html"><img src='previous.gif'
 
26
  border='0' height='32'  alt='Previous Page' width='32'></A></td>
 
27
<td><a rel="parent" title="4. Python API" 
 
28
  href="pythonapi.html"><img src='up.gif'
 
29
  border='0' height='32'  alt='Up One Level' width='32'></A></td>
 
30
<td><a rel="next" title="5. Apache Configuration Directives" 
 
31
  href="directives.html"><img src='next.gif'
 
32
  border='0' height='32'  alt='Next Page' width='32'></A></td>
31
33
<td align="center" width="100%">Mod_python Manual</td>
32
 
<td class='online-navigation'><a rel="contents" title="Table of Contents"
33
 
  href="contents.html"><img src='contents.png'
34
 
  border='0' height='32'  alt='Contents' width='32' /></A></td>
35
 
<td class='online-navigation'><img src='blank.png'
36
 
  border='0' height='32'  alt='' width='32' /></td>
37
 
<td class='online-navigation'><a rel="index" title="Index"
38
 
  href="genindex.html"><img src='index.png'
39
 
  border='0' height='32'  alt='Index' width='32' /></A></td>
 
34
<td><a rel="contents" title="Table of Contents" 
 
35
  href="contents.html"><img src='contents.gif'
 
36
  border='0' height='32'  alt='Contents' width='32'></A></td>
 
37
<td><img src='blank.gif'
 
38
  border='0' height='32'  alt='' width='32'></td>
 
39
<td><a rel="index" title="Index" 
 
40
  href="genindex.html"><img src='index.gif'
 
41
  border='0' height='32'  alt='Index' width='32'></A></td>
40
42
</tr></table>
41
 
<div class='online-navigation'>
42
43
<b class="navlabel">Previous:</b>
43
 
<a class="sectref" rel="prev" href="pyapi-sess-classes.html">4.8.1 Classes</A>
 
44
<a class="sectref" rel="prev" href="pyapi-sess-example.html">4.8.2 Examples</A>
44
45
<b class="navlabel">Up:</b>
45
46
<a class="sectref" rel="parent" href="pythonapi.html">4. Python API</A>
46
47
<b class="navlabel">Next:</b>
47
48
<a class="sectref" rel="next" href="directives.html">5. Apache Configuration Directives</A>
48
 
</div>
49
 
<hr /></div>
 
49
<br><hr>
50
50
</DIV>
51
51
<!--End of Navigation Panel-->
52
52
 
53
 
<H1><A NAME="SECTION006900000000000000000"></A><A NAME="pyapi-psp"></A>
 
53
<H1><A NAME="SECTION006900000000000000000">&nbsp;</A>
54
54
<BR>
55
55
4.9 <tt class="module">psp</tt> - Python Server Pages
56
56
</H1>
57
 
<A NAME="module-psp"></A>
 
57
 
58
58
 
59
59
<P>
60
60
The <tt class="module">psp</tt> module provides a way to convert text documents
69
69
and is therefore very fast.
70
70
 
71
71
<P>
72
 
<em>See <A href="hand-psp.html#hand-psp">6.2</A> ``PSP Handler'' for additional PSP
73
 
information.</em>
 
72
<i>See <A href="hand-psp.html#hand-psp">6.2</A> ``PSP Handler'' for additional PSP
 
73
information.</i>
74
74
 
75
75
<P>
76
76
Inside the document, Python <i class="dfn">code</i> needs to be surrounded by
195
195
 
196
196
<P>
197
197
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
198
 
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-216' xml:id='l2h-216' class="class">PSP</tt></b>(</nobr></td>
199
 
  <td><var>req, </var><big>[</big><var>, filename, string, vars</var><big>]</big><var></var>)</td></tr></table></dt>
 
198
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<a name="l2h-228"><tt class="class">PSP</tt></a></b>(</nobr></td>
 
199
  <td><var>req, </var><big>[</big><var>, filename, string, vars</var><big>]</big>)</td></tr></table>
200
200
<dd>
201
201
  This class represents a PSP object.
202
202
 
246
246
 
247
247
<P>
248
248
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
249
 
  <td><nobr><b><tt id='l2h-217' xml:id='l2h-217' class="method">run</tt></b>(</nobr></td>
250
 
  <td><var></var><big>[</big><var>vars</var><big>]</big><var></var>)</td></tr></table></dt>
 
249
  <td><nobr><b><a name="l2h-229"><tt class="method">run</tt></a></b>(</nobr></td>
 
250
  <td><big>[</big><var>vars</var><big>]</big>)</td></tr></table>
251
251
<dd>
252
252
    This method will execute the code (produced at object
253
253
    initialization time by parsing and compiling the PSP
275
275
 
276
276
<P>
277
277
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
278
 
  <td><nobr><b><tt id='l2h-218' xml:id='l2h-218' class="method">display_code</tt></b>(</nobr></td>
279
 
  <td><var></var>)</td></tr></table></dt>
 
278
  <td><nobr><b><a name="l2h-230"><tt class="method">display_code</tt></a></b>(</nobr></td>
 
279
  <td>)</td></tr></table>
280
280
<dd>
281
281
    Returns an HTML-formatted string representing a side-by-side
282
282
    listing of the original PSP code and resulting Python code
310
310
 
311
311
<P>
312
312
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
313
 
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-219' xml:id='l2h-219' class="class">PSPInstance</tt></b>(</nobr></td>
314
 
  <td><var></var>)</td></tr></table></dt>
 
313
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<a name="l2h-231"><tt class="class">PSPInstance</tt></a></b>(</nobr></td>
 
314
  <td>)</td></tr></table>
315
315
<dd>
316
316
  An object of this class is passed as a global variable <code>psp</code> to
317
317
  the PSP code. Objects of this class are instantiated internally and
319
319
 
320
320
<P>
321
321
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
322
 
  <td><nobr><b><tt id='l2h-220' xml:id='l2h-220' class="method">set_error_page</tt></b>(</nobr></td>
323
 
  <td><var>filename</var>)</td></tr></table></dt>
 
322
  <td><nobr><b><a name="l2h-232"><tt class="method">set_error_page</tt></a></b>(</nobr></td>
 
323
  <td><var>filename</var>)</td></tr></table>
324
324
<dd>
325
325
    Used to set a psp page to be processed when an exception
326
326
    occurs. If the path is absolute, it will be appended to document
332
332
 
333
333
<P>
334
334
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
335
 
  <td><nobr><b><tt id='l2h-221' xml:id='l2h-221' class="method">apply_data</tt></b>(</nobr></td>
336
 
  <td><var>object</var><big>[</big><var>, **kw</var><big>]</big><var></var>)</td></tr></table></dt>
 
335
  <td><nobr><b><a name="l2h-233"><tt class="method">apply_data</tt></a></b>(</nobr></td>
 
336
  <td><var>object</var><big>[</big><var>, **kw</var><big>]</big>)</td></tr></table>
337
337
<dd>
338
338
    This method will call the callable object <var>object</var>, passing form
339
339
    data as keyword arguments, and return the result.
341
341
 
342
342
<P>
343
343
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
344
 
  <td><nobr><b><tt id='l2h-222' xml:id='l2h-222' class="method">redirect</tt></b>(</nobr></td>
345
 
  <td><var>location</var><big>[</big><var>, permanent=0</var><big>]</big><var></var>)</td></tr></table></dt>
 
344
  <td><nobr><b><a name="l2h-234"><tt class="method">redirect</tt></a></b>(</nobr></td>
 
345
  <td><var>location</var><big>[</big><var>, permanent=0</var><big>]</big>)</td></tr></table>
346
346
<dd>
347
347
    This method will redirect the browser to location
348
348
    <var>location</var>. If <var>permanent</var> is true, then
377
377
 
378
378
<P>
379
379
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
380
 
  <td><nobr><b><tt id='l2h-223' xml:id='l2h-223' class="function">parse</tt></b>(</nobr></td>
381
 
  <td><var>filename</var><big>[</big><var>, dir</var><big>]</big><var></var>)</td></tr></table></dt>
 
380
  <td><nobr><b><a name="l2h-235"><tt class="function">parse</tt></a></b>(</nobr></td>
 
381
  <td><var>filename</var><big>[</big><var>, dir</var><big>]</big>)</td></tr></table>
382
382
<dd>
383
383
 
384
384
<P>
395
395
 
396
396
<P>
397
397
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
398
 
  <td><nobr><b><tt id='l2h-224' xml:id='l2h-224' class="function">parsestring</tt></b>(</nobr></td>
399
 
  <td><var>string</var>)</td></tr></table></dt>
 
398
  <td><nobr><b><a name="l2h-236"><tt class="function">parsestring</tt></a></b>(</nobr></td>
 
399
  <td><var>string</var>)</td></tr></table>
400
400
<dd>
401
401
 
402
402
<P>
407
407
</dl>
408
408
 
409
409
<DIV CLASS="navigation">
410
 
<div class='online-navigation'>
411
 
<p></p><hr />
 
410
<p><hr>
412
411
<table align="center" width="100%" cellpadding="0" cellspacing="2">
413
412
<tr>
414
 
<td class='online-navigation'><a rel="prev" title="4.8.1 Classes"
415
 
  href="pyapi-sess-classes.html"><img src='previous.png'
416
 
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
417
 
<td class='online-navigation'><a rel="parent" title="4. Python API"
418
 
  href="pythonapi.html"><img src='up.png'
419
 
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
420
 
<td class='online-navigation'><a rel="next" title="5. Apache Configuration Directives"
421
 
  href="directives.html"><img src='next.png'
422
 
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
 
413
<td><a rel="prev" title="4.8.2 Examples" 
 
414
  rel="prev" title="4.8.2 Examples" 
 
415
  href="pyapi-sess-example.html"><img src='previous.gif'
 
416
  border='0' height='32'  alt='Previous Page' width='32'></A></td>
 
417
<td><a rel="parent" title="4. Python API" 
 
418
  rel="parent" title="4. Python API" 
 
419
  href="pythonapi.html"><img src='up.gif'
 
420
  border='0' height='32'  alt='Up One Level' width='32'></A></td>
 
421
<td><a rel="next" title="5. Apache Configuration Directives" 
 
422
  rel="next" title="5. Apache Configuration Directives" 
 
423
  href="directives.html"><img src='next.gif'
 
424
  border='0' height='32'  alt='Next Page' width='32'></A></td>
423
425
<td align="center" width="100%">Mod_python Manual</td>
424
 
<td class='online-navigation'><a rel="contents" title="Table of Contents"
425
 
  href="contents.html"><img src='contents.png'
426
 
  border='0' height='32'  alt='Contents' width='32' /></A></td>
427
 
<td class='online-navigation'><img src='blank.png'
428
 
  border='0' height='32'  alt='' width='32' /></td>
429
 
<td class='online-navigation'><a rel="index" title="Index"
430
 
  href="genindex.html"><img src='index.png'
431
 
  border='0' height='32'  alt='Index' width='32' /></A></td>
 
426
<td><a rel="contents" title="Table of Contents" 
 
427
  rel="contents" title="Table of Contents" 
 
428
  href="contents.html"><img src='contents.gif'
 
429
  border='0' height='32'  alt='Contents' width='32'></A></td>
 
430
<td><img src='blank.gif'
 
431
  border='0' height='32'  alt='' width='32'></td>
 
432
<td><a rel="index" title="Index" 
 
433
  rel="index" title="Index" 
 
434
  href="genindex.html"><img src='index.gif'
 
435
  border='0' height='32'  alt='Index' width='32'></A></td>
432
436
</tr></table>
433
 
<div class='online-navigation'>
434
437
<b class="navlabel">Previous:</b>
435
 
<a class="sectref" rel="prev" href="pyapi-sess-classes.html">4.8.1 Classes</A>
 
438
<a class="sectref" rel="prev" href="pyapi-sess-example.html">4.8.2 Examples</A>
436
439
<b class="navlabel">Up:</b>
437
440
<a class="sectref" rel="parent" href="pythonapi.html">4. Python API</A>
438
441
<b class="navlabel">Next:</b>
439
442
<a class="sectref" rel="next" href="directives.html">5. Apache Configuration Directives</A>
440
 
</div>
441
 
</div>
442
 
<hr />
443
 
<span class="release-info">Release 3.1.3, documentation updated on January 29, 2005.</span>
 
443
<hr>
 
444
<span class="release-info">Release 3.2.8, documentation updated on February 19, 2006.</span>
444
445
</DIV>
445
446
<!--End of Navigation Panel-->
446
447