sunlabs.brazil.python
Class PythonServerTemplate

java.lang.Object
  sunlabs.brazil.template.Template
      sunlabs.brazil.python.PythonServerTemplate (view source)

All Implemented Interfaces:

TemplateInterface

public class PythonServerTemplate
extends Template

The PythonServerTemplate looks for each <server language="python"> (or <python>) tag in an HTML page and treats the following data up to the next </server> (or </python>) tag as a python script to evaluate.

The reason that python scripts are included in an HTML page is usually to generate dynamic, server-side content. After running this template, everything between and including the <server> and </server> (or <python> and </python> tags is replaced by all output written to the Python standard output stream (if any).

All Python fragments within a given page are evaluated in the same Python interpreter. The Python interpreter actually lives for the entire duration of this Template object, so the user can implement persistence across requests.

The following configuration parameters are used to initialize this template.

script

The name of the Python script to evaluate when the interpreter is created. This script only evaluated when the interp is created, not on every request. The variables prefix and server are set before this file is evaluated, and are references to the parameters passed to a handler init method.

root

The document root, if the script is a relative file name. If the "root" property under the template prefix is not found, the global "root" property is used. If the global "root" property is not found, the current directory is used.

debug

If this configuration parameter is present, this class replaces the <server> and </server> tags with comments, so the user can keep track of where the dynamically generated content is coming from by examining the comments in the resultant HTML document. By default, the <server> and </server> are completely eliminated from the HTML document rather than changed into comments.

Before evaluating each HTML document, this class sets variables in the Python interpreter, which can be used to interact back with Java to do things like set the response headers:

request

Exposes the Request Java object. It is set anew at each request.

prefix

Exposes the handler prefix String.

server

Exposes the handler Server object.

If the attribute eval is present as an attribute, all constructs off the form ${...} are substituted before processing the script.

Field Summary

Fields inherited from class sunlabs.brazil.template.Template

debug

Constructor Summary

PythonServerTemplate()

Method Summary

boolean	init(RewriteContext hr) Called before this template processes any tags.
void	tag_python(RewriteContext hr) Processes the <python> tag.
void	tag_server(RewriteContext hr) Processes the <server> tag.

Methods inherited from class sunlabs.brazil.template.Template

done

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PythonServerTemplate

public PythonServerTemplate()

Method Detail

init

public boolean init(RewriteContext hr)

Description copied from class: Template

Called before this template processes any tags.

Specified by:

init in interface TemplateInterface

Overrides:

init in class Template

tag_server

public void tag_server(RewriteContext hr)

Processes the <server> tag. Substitues the result of evaluating the following Python script into the resultant HTML document.

Note: Currently, there is no mechanism for other language interpreters to share the same server tag.

Parameters:

hr - The request and associated HTML document that will be processed.

tag_python

public void tag_python(RewriteContext hr)

Processes the <python> tag. Substitues the result of evaluating the following Python script into the resultant HTML document.

Parameters:

hr - The request and associated HTML document that will be processed.