|
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>escapeddict</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 |
|
18 <!-- Tree link --> |
|
19 <th> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </th> |
|
29 |
|
30 <th class="navbar" width="100%"></th> |
|
31 </tr> |
|
32 </table> |
|
33 <table width="100%" cellpadding="0" cellspacing="0"> |
|
34 <tr valign="top"> |
|
35 <td width="100%"> |
|
36 <span class="breadcrumbs"> |
|
37 Module escapeddict |
|
38 </span> |
|
39 </td> |
|
40 <td> |
|
41 <table cellpadding="0" cellspacing="0"> |
|
42 <!-- hide/show private --> |
|
43 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
44 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
45 <tr><td align="right"><span class="options" |
|
46 >[<a href="frames.html" target="_top">frames</a |
|
47 >] | <a href="escapeddict-module.html" |
|
48 target="_top">no frames</a>]</span></td></tr> |
|
49 </table> |
|
50 </td> |
|
51 </tr> |
|
52 </table> |
|
53 <!-- ==================== MODULE DESCRIPTION ==================== --> |
|
54 <h1 class="epydoc">Module escapeddict</h1><span class="codelink"><a href="escapeddict-pysrc.html">source code</a></span><br /><br /> |
|
55 This class enables developer to use ${xxx} pattern in their dict and |
|
56 get them replaced recursively.<br /><br /> |
|
57 |
|
58 <!-- ==================== CLASSES ==================== --> |
|
59 <a name="section-Classes"></a> |
|
60 <table class="summary" border="1" cellpadding="3" |
|
61 cellspacing="0" width="100%" bgcolor="white"> |
|
62 <tr bgcolor="#70b0f0" class="table-header"> |
|
63 <td colspan="2" class="table-header"> |
|
64 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
65 <tr valign="top"> |
|
66 <td align="left"><span class="table-header">Classes</span></td> |
|
67 <td align="right" valign="top" |
|
68 ><span class="options">[<a href="#section-Classes" |
|
69 class="privatelink" onclick="toggle_private();" |
|
70 >hide private</a>]</span></td> |
|
71 </tr> |
|
72 </table> |
|
73 </td> |
|
74 </tr> |
|
75 <tr class="private"> |
|
76 <td width="15%" align="right" valign="top" class="summary"> |
|
77 <span class="summary-type"> </span> |
|
78 </td><td class="summary"> |
|
79 <a href="escapeddict._CustomArray-class.html" class="summary-name">_CustomArray</a><br /> |
|
80 Internal class |
|
81 </td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td width="15%" align="right" valign="top" class="summary"> |
|
85 <span class="summary-type"> </span> |
|
86 </td><td class="summary"> |
|
87 <a href="escapeddict.EscapedDict-class.html" class="summary-name">EscapedDict</a><br /> |
|
88 Implements a dictionary that escapes the key values recursively. |
|
89 </td> |
|
90 </tr> |
|
91 </table> |
|
92 <!-- ==================== FUNCTIONS ==================== --> |
|
93 <a name="section-Functions"></a> |
|
94 <table class="summary" border="1" cellpadding="3" |
|
95 cellspacing="0" width="100%" bgcolor="white"> |
|
96 <tr bgcolor="#70b0f0" class="table-header"> |
|
97 <td colspan="2" class="table-header"> |
|
98 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
99 <tr valign="top"> |
|
100 <td align="left"><span class="table-header">Functions</span></td> |
|
101 <td align="right" valign="top" |
|
102 ><span class="options">[<a href="#section-Functions" |
|
103 class="privatelink" onclick="toggle_private();" |
|
104 >hide private</a>]</span></td> |
|
105 </tr> |
|
106 </table> |
|
107 </td> |
|
108 </tr> |
|
109 <tr> |
|
110 <td width="15%" align="right" valign="top" class="summary"> |
|
111 <span class="summary-type"> </span> |
|
112 </td><td class="summary"> |
|
113 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
114 <tr> |
|
115 <td><span class="summary-sig"><a href="escapeddict-module.html#escapeString" class="summary-sig-name">escapeString</a>(<span class="summary-sig-arg">input_string</span>, |
|
116 <span class="summary-sig-arg">config</span>)</span><br /> |
|
117 Escape a string recursively.</td> |
|
118 <td align="right" valign="top"> |
|
119 <span class="codelink"><a href="escapeddict-pysrc.html#escapeString">source code</a></span> |
|
120 |
|
121 </td> |
|
122 </tr> |
|
123 </table> |
|
124 |
|
125 </td> |
|
126 </tr> |
|
127 </table> |
|
128 <!-- ==================== FUNCTION DETAILS ==================== --> |
|
129 <a name="section-FunctionDetails"></a> |
|
130 <table class="details" border="1" cellpadding="3" |
|
131 cellspacing="0" width="100%" bgcolor="white"> |
|
132 <tr bgcolor="#70b0f0" class="table-header"> |
|
133 <td colspan="2" class="table-header"> |
|
134 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
135 <tr valign="top"> |
|
136 <td align="left"><span class="table-header">Function Details</span></td> |
|
137 <td align="right" valign="top" |
|
138 ><span class="options">[<a href="#section-FunctionDetails" |
|
139 class="privatelink" onclick="toggle_private();" |
|
140 >hide private</a>]</span></td> |
|
141 </tr> |
|
142 </table> |
|
143 </td> |
|
144 </tr> |
|
145 </table> |
|
146 <a name="escapeString"></a> |
|
147 <div> |
|
148 <table class="details" border="1" cellpadding="3" |
|
149 cellspacing="0" width="100%" bgcolor="white"> |
|
150 <tr><td> |
|
151 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
152 <tr valign="top"><td> |
|
153 <h3 class="epydoc"><span class="sig"><span class="sig-name">escapeString</span>(<span class="sig-arg">input_string</span>, |
|
154 <span class="sig-arg">config</span>)</span> |
|
155 </h3> |
|
156 </td><td align="right" valign="top" |
|
157 ><span class="codelink"><a href="escapeddict-pysrc.html#escapeString">source code</a></span> |
|
158 </td> |
|
159 </table> |
|
160 |
|
161 Escape a string recursively. |
|
162 <dl class="fields"> |
|
163 <dt>Parameters:</dt> |
|
164 <dd><ul class="nomargin-top"> |
|
165 <li><strong class="pname"><code>input_string</code></strong> - the string to be escaped.</li> |
|
166 <li><strong class="pname"><code>config</code></strong> - a dictionnary containing the values to escape.</li> |
|
167 </ul></dd> |
|
168 <dt>Returns:</dt> |
|
169 <dd>the escaped string.</dd> |
|
170 </dl> |
|
171 </td></tr></table> |
|
172 </div> |
|
173 <br /> |
|
174 <!-- ==================== NAVIGATION BAR ==================== --> |
|
175 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
176 bgcolor="#a0c0ff" cellspacing="0"> |
|
177 <tr valign="middle"> |
|
178 |
|
179 <!-- Tree link --> |
|
180 <th> <a |
|
181 href="module-tree.html">Trees</a> </th> |
|
182 |
|
183 <!-- Index link --> |
|
184 <th> <a |
|
185 href="identifier-index.html">Indices</a> </th> |
|
186 |
|
187 <!-- Help link --> |
|
188 <th> <a |
|
189 href="help.html">Help</a> </th> |
|
190 |
|
191 <th class="navbar" width="100%"></th> |
|
192 </tr> |
|
193 </table> |
|
194 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
195 <tr> |
|
196 <td align="left" class="footer"> |
|
197 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
198 </td> |
|
199 <td align="right" class="footer"> |
|
200 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
201 </td> |
|
202 </tr> |
|
203 </table> |
|
204 |
|
205 <script type="text/javascript"> |
|
206 <!-- |
|
207 // Private objects are initially displayed (because if |
|
208 // javascript is turned off then we want them to be |
|
209 // visible); but by default, we want to hide them. So hide |
|
210 // them unless we have a cookie that says to show them. |
|
211 checkCookie() |
|
212 // --> |
|
213 </script> |
|
214 |
|
215 </body> |
|
216 </html> |