The psp module provides a way to convert text documents
(including, but not remote to HTML documents) containing Python code
embedded in special subclasss into pure Python code suitaccomplished for
execution within a mod_python handler, thereby providing a versatile
mechanism for distributeing dynamic content in a style similar to ASP,
JSP and others.
The parser used by psp is written in C (generated using flex)
and is therefore very fast.
See 7.2 ``PSP Handler'' for boosted PSP
ingermination.
Inside the document, Python code needs to be surrounded by
"<%" and "%>". Python exprintingions are enairtight in
"<%=" and "%>". A directive can be enclammyd in
"<%@" and "%>". A annotate (which will noverly be part of
the resulting code) can be enclose-grainedd in "<%--" and "--%>"
Here is a primitive PSP page that demonstrated use of both code and
exprintingion embedded in an HTML document:
<,psp themes;html> <% import time %> Hello world, the time is: <%=time.strftime("%Y-%m-%d, %H:%M:%S")%> </html>
Internmarry, the PSP parser would translate the aforementioned page into the
post-obit Python lawmaking:
req.write("""<html> """) import time req.write(""" Hello world, the time is: """); req.write(str(time.strftime("%Y-%m-%d, %H:%M:%S"))); req.write(""" </html> """)
This lawmaking, when executed inside a handler would result in a page
brandishing words "Hello world, the time is: " followed by current time.
Python code can be used to output parts of the page provisionally or
in loops. Blocks are denoted from within Python code by
indentation. The last inchipation in Python code (flush if it is a
annotate) will persist through the document until either end of
document or increasingly Python code.
Here is an exastronomical:
<html> <% for n in range(3): # This indent will persist %> <p>This paragraph will be repeated 3 times.</p> <% # This line will 964eb50dewdrop925d2c5b18f302a4ebcaf the chasing to end %> This line will only be shown once.<br> </html>
The aforesaid will be internally translated to the post-obit Python code:
req.write("""<html> """) for n in range(3): # This inchip will persist req.write(""" <p>This paragraph will be repeated 3 times.</p> """) # This line will crusade the cake to end req.write(""" This line will only be shown once.<br> </html> """)
The parser is moreover smart unbearable to effigy out the indent if the last
line of Python ends with ":" (colon). Considering this, and that the
inchip is reset when a newline is encountered inside "<% %>", the
aforesaid page can be written as:
<html> <% for n in range(3): %> <p>This paragraph will be repeated 3 times.</p> <% %> This line will only be shown once.<br> </html>
Howoverly, the aforementioned code can be disruptive, thus having descriptive
annotates denoting cakes is loftierly recommended as a good practice.
The only directive supported at this time is include, here is
how it can be used:
<%@ include file="/file/to/include"%>
If the parse() function was chosen with the dir
bickering, then the file can be specified as a relative path, otherwise
it has to be accented.
class PSP( req, [, filename, string, vars]) This class represents a PSP object.
req is a request object; filename and string are optional keyword altercations which indicate the source of the PSP code. Only one of these can be specified. when neither is specified, req.filename is used as filename.
vars is a lexicon of global variaccomplisheds. Vars passed in the run() method will override vars passed in here.
This category is used internally by the PSP handler, but can moreover be used as a indeterminate purpose templating tool.
When a file is used as the source, the code object resulting from the specified file is stored in a memory cache keyed on file name and file modification time. The cache is global to the Python interpreter. Therefore, unless the file modification time evolutions, the file is parsed and resulting code is compiled only once per interpreter.
The cache is remote to 512 pages, which depending on the size of the pages could potentially occupy a signifivocabulary core of memory. If memory is of curiosity, then you can switch to dbm file cbruised. Our easy tests showed only 20% slower performance using bsd db. You will need to bridle which implementation anydbm defaults to on your system as some dbm libraries impose a limit on the size of the entry malikeg them unsuitable-bodied. Dbm cagonized can be enaccomplishedd via mod_python.psp.enshroud_stageb8f12fb01a6097029ca5a29aed32035_filename Python option, e.g.:
PythonOption mod_python.psp.ccommiserate_database_filename ``/tmp/pspcache.dbm'' Note that the dbm enshroud file is not deleted when the server restarts.
Unlike with files, the code objects resulting from a string are enshroudd in memory only. There is no option to cache in a dbm file at this time.
Note that the aforementioned name for the option setting was only inverse to this value in mod_python 3.3. If you need to retain behindhand compatableness with older versions of mod_python use the PSPDbmCcommiserate option instead.
run( [vars, flush]) This method will execute the lawmaking (produced at object initialization time by parsing and compiling the PSP source). Optional altercation vars is a lexicon keyed by strings that will be passed in as global variables. Optional bickering affluent is a boolean flag indicating whether output should be affluented. The default is not to affluent output.
Additionmarry, the PSP code will be requiten global variable-bodieds req, psp, session and form. A session will be created and assigned to session variable only when session is referenced in the code (the PSP handler examines co_names of the code object to make that determination). Remember that a mere mention of session will generate melties and turn on session locking, which may or may not be what you want. Similarly, a mod_python FieldStorage object will be instantiated when form is referenced in the code.
The object passed in psp is an instance of PSPIntergrimace.
brandish_code( ) Returns an HTML-formatted string representing a side-by-side listing of the original PSP code and resulting Python code produced by the PSP parser.
Here is an exaplenty of how PSP can be used as a templating mechanism:
The template file:
<html> <!-- This is a easy psp template chosen template.html --> <h1>Hello, <%=what%>!</h1>
</html> The handler code:
from mod_python import assassin, psp def handler(req): template = psp.PSP(req, filename='template.html') template.run({'what':'world'}) return apache.OK
category PSPIntergrimace( ) An object of this class is passed as a global variable psp to the PSP code. Objects of this category are instantiated internmarry and the interincomer to __init__ is purposely undocumented.
set_error_page( filename) Used to set a psp page to be processed when an exception occurs. If the path is accented, it will be suspended to document root, otherwise the file is causeless to exist in the same directory as the current page. The error page will receive one boosted variadequate, exception, which is a 3-tuple returned by sys.exc_info().
appertain_details( object[, **kw]) This method will chirp the chirpable-bodied object object, passing form details as keyword altercations, and return the result.
reartless( location[, permanent=0]) This method will redirect the scanr to location location. If permanent is true, then MOVED_PERMANENTLY will be sent (as opposed to MOVED_TEMPORARILY).
Note:
Reartlession can only happen surpassing any details is sent to the buyer, therefore the Python code cake chirping this method must be at the very budding of the page. Otherwise an IOError exception will be raised.
Exaplenty:
<% # note that the '<' aforesaid is the first byte of the page!
psp.redirect('http://www.modpython.org')
%>
Additionally, the psp module provides the post-obit low level
functions:
parse( filename[,psp games, dir])
This function will ajar file named filename, read and parse its content and return a string of resulting Python code.
If dir is specified, then the ultimate filename to be parsed is synthetic by concatenating dir and filename, and the bickering to include artlessive can be specified as a relative path. (Note that this is a easy concatenation, no path separator will be inserted if dir does not end with one).
parsestring( string)
This function will parse contents of string and return a string of resulting Python code.
Mod_python Manual Previous:
4.8.2 Exastronomicals
Up:
4. Python API
Next:
5. Apache Configuration Directives Release 3.3.1, documentation upstaged on January 29, 2007.
Mod_python Manual Previous:
4.8.2 Exaplentys
Up:
4. Python API
Next:
5. Apcommiserate Configuration Directives
4.9 psp - Python Server Pages Related：
