1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<!-- This file generated using Python HTMLgen module. -->
<HEAD>
<META NAME="GENERATOR" CONTENT="HTMLgen 2.2.2">
<TITLE>Class StringTemplate - Generate documents based on a template and a substitution mapping.</TITLE>
<LINK rel=stylesheet href="HTMLgen.css" type=text/css title="HTMLgen.css">
</HEAD>
<BODY BGCOLOR="#FFFFFF" BACKGROUND="../image/bg-dots.gif" TEXT="#000000" LINK="#EE0000" VLINK="#990000">
<A HREF="HTMLgen-Strike.html"><IMG src="../image/back.gif" height="22" width="66" alt="Previous" border="0"></A>
<A HREF="HTMLgen-Strong.html"><IMG src="../image/next.gif" height="22" width="66" alt="Next" border="0"></A>
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif">
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif">
<H3>Class StringTemplate - Generate documents based on a template and a substitution mapping.</H3>
<HR>
<H2>SYNOPSIS</H2>
<PRE>import HTMLgen</PRE>
<PRE>class StringTemplate
def __getitem__(self, name)
def __init__(self, template, substitutions=None, **kw)
string __module__ = 'HTMLgen'
def __setitem__(self, name, value)
def __str__(self)
def keys(self)
def set_template(self, template)
<A HREF="#def write(self, filename = None)">def write(self, filename = None)</A>
</PRE>
<H2>DESCRIPTION</H2>
<P>Must use Python 1.5 or newer. Uses re and the get method on dictionaries.</P>
<P>Usage:
T = TemplateDocument('Xfile')
T.substitutions = {'month': ObjectY, <CODE>town</CODE>
: 'Scarborough'}
T.write('Maine.html')</P>
<P>A dictionary, or object that behaves like a dictionary, is assigned to the
<EM>substitutions</EM> attribute which has symbols as keys to objects. Upon every
occurance of these symbols surrounded by braces {} in the source template,
the corresponding value is converted to a string and substituted in the output.</P>
<P>For example, source text which looks like:
I lost my heart at {town} Fair.
becomes:
I lost my heart at Scarborough Fair.</P>
<P>Symbols in braces which do not correspond to a key in the dictionary remain
unchanged.</P>
<P>An optional third argument to the class is a list or two strings to be
used as the delimiters instead of { } braces. They must be of the same
length; for example "<CODE>##+</CODE>
, '##'" is invalid.
</P>
<H3><A NAME="def write(self, filename = None)">def write(self, filename = None)</A></H3>
<P>Emit the Document HTML to a file or standard output.</P>
<P>Will not overwrite file is it exists and is textually the same.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument given.
</P>
<H2>SEE ALSO</H2>
<P><A HREF="HTMLgen_overview.html">HTMLgen</A></P>
<P><HR>
<A HREF="HTMLgen-Strike.html"><IMG src="../image/back.gif" height="22" width="66" alt="Previous" border="0"></A>
<A HREF="HTMLgen-Strong.html"><IMG src="../image/next.gif" height="22" width="66" alt="Next" border="0"></A>
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif">
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif">
<BR><IMG src="../image/Buzz.gif" height="51" width="56" alt="Buzz.gif" align="bottom">
<FONT SIZE="-1"><P>Copyright © Robin Friedrich<BR>All Rights Reserved<BR>
Comments to author: <A HREF="mailto:friedrich@pythonpros.com">friedrich@pythonpros.com</A><br>
Generated: Tue Apr 20, 1999 <BR><hr>
</FONT>
</BODY> </HTML>
|