|
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>configuration.HierarchicalConfiguration</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 <a href="configuration-module.html">Module configuration</a> :: |
|
38 Class HierarchicalConfiguration |
|
39 </span> |
|
40 </td> |
|
41 <td> |
|
42 <table cellpadding="0" cellspacing="0"> |
|
43 <!-- hide/show private --> |
|
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
45 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="configuration.HierarchicalConfiguration-class.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Class HierarchicalConfiguration</h1><span class="codelink"><a href="configuration-pysrc.html#HierarchicalConfiguration">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 UserDict.DictMixin --+ |
|
60 | |
|
61 <a href="configuration.Configuration-class.html">Configuration</a> --+ |
|
62 | |
|
63 <strong class="uidshort">HierarchicalConfiguration</strong> |
|
64 </pre> |
|
65 |
|
66 <hr /> |
|
67 Represents hierarchical configurations such as XML documents.<br /><br /> |
|
68 |
|
69 <!-- ==================== INSTANCE METHODS ==================== --> |
|
70 <a name="section-InstanceMethods"></a> |
|
71 <table class="summary" border="1" cellpadding="3" |
|
72 cellspacing="0" width="100%" bgcolor="white"> |
|
73 <tr bgcolor="#70b0f0" class="table-header"> |
|
74 <td colspan="2" class="table-header"> |
|
75 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
76 <tr valign="top"> |
|
77 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
78 <td align="right" valign="top" |
|
79 ><span class="options">[<a href="#section-InstanceMethods" |
|
80 class="privatelink" onclick="toggle_private();" |
|
81 >hide private</a>]</span></td> |
|
82 </tr> |
|
83 </table> |
|
84 </td> |
|
85 </tr> |
|
86 <tr> |
|
87 <td width="15%" align="right" valign="top" class="summary"> |
|
88 <span class="summary-type"> </span> |
|
89 </td><td class="summary"> |
|
90 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
91 <tr> |
|
92 <td><span class="summary-sig"><a href="configuration.HierarchicalConfiguration-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
93 Initialization.</td> |
|
94 <td align="right" valign="top"> |
|
95 <span class="codelink"><a href="configuration-pysrc.html#HierarchicalConfiguration.__init__">source code</a></span> |
|
96 |
|
97 </td> |
|
98 </tr> |
|
99 </table> |
|
100 |
|
101 </td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td width="15%" align="right" valign="top" class="summary"> |
|
105 <span class="summary-type"> </span> |
|
106 </td><td class="summary"> |
|
107 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
108 <tr> |
|
109 <td><span class="summary-sig"><a href="configuration.HierarchicalConfiguration-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>, |
|
110 <span class="summary-sig-arg">key</span>, |
|
111 <span class="summary-sig-arg">interpolate</span>=<span class="summary-sig-default">True</span>)</span><br /> |
|
112 Get an item as a dict.</td> |
|
113 <td align="right" valign="top"> |
|
114 <span class="codelink"><a href="configuration-pysrc.html#HierarchicalConfiguration.__getitem__">source code</a></span> |
|
115 |
|
116 </td> |
|
117 </tr> |
|
118 </table> |
|
119 |
|
120 </td> |
|
121 </tr> |
|
122 <tr> |
|
123 <td colspan="2" class="summary"> |
|
124 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="configuration.Configuration-class.html">Configuration</a></code></b>: |
|
125 <code><a href="configuration.Configuration-class.html#__delitem__">__delitem__</a></code>, |
|
126 <code><a href="configuration.Configuration-class.html#__setitem__">__setitem__</a></code>, |
|
127 <code><a href="configuration.Configuration-class.html#__str__">__str__</a></code>, |
|
128 <code><a href="configuration.Configuration-class.html#get">get</a></code>, |
|
129 <code><a href="configuration.Configuration-class.html#get_boolean">get_boolean</a></code>, |
|
130 <code><a href="configuration.Configuration-class.html#get_int">get_int</a></code>, |
|
131 <code><a href="configuration.Configuration-class.html#get_list">get_list</a></code>, |
|
132 <code><a href="configuration.Configuration-class.html#interpolate">interpolate</a></code>, |
|
133 <code><a href="configuration.Configuration-class.html#keys">keys</a></code>, |
|
134 <code><a href="configuration.Configuration-class.html#match_name">match_name</a></code> |
|
135 </p> |
|
136 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
137 <code>__delattr__</code>, |
|
138 <code>__getattribute__</code>, |
|
139 <code>__hash__</code>, |
|
140 <code>__new__</code>, |
|
141 <code>__reduce__</code>, |
|
142 <code>__reduce_ex__</code>, |
|
143 <code>__repr__</code>, |
|
144 <code>__setattr__</code> |
|
145 </p> |
|
146 <p class="indent-wrapped-lines"><b>Inherited from <code>UserDict.DictMixin</code></b>: |
|
147 <code>__cmp__</code>, |
|
148 <code>__contains__</code>, |
|
149 <code>__iter__</code>, |
|
150 <code>__len__</code>, |
|
151 <code>clear</code>, |
|
152 <code>has_key</code>, |
|
153 <code>items</code>, |
|
154 <code>iteritems</code>, |
|
155 <code>iterkeys</code>, |
|
156 <code>itervalues</code>, |
|
157 <code>pop</code>, |
|
158 <code>popitem</code>, |
|
159 <code>setdefault</code>, |
|
160 <code>update</code>, |
|
161 <code>values</code> |
|
162 </p> |
|
163 </td> |
|
164 </tr> |
|
165 </table> |
|
166 <!-- ==================== CLASS VARIABLES ==================== --> |
|
167 <a name="section-ClassVariables"></a> |
|
168 <table class="summary" border="1" cellpadding="3" |
|
169 cellspacing="0" width="100%" bgcolor="white"> |
|
170 <tr bgcolor="#70b0f0" class="table-header"> |
|
171 <td colspan="2" class="table-header"> |
|
172 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
173 <tr valign="top"> |
|
174 <td align="left"><span class="table-header">Class Variables</span></td> |
|
175 <td align="right" valign="top" |
|
176 ><span class="options">[<a href="#section-ClassVariables" |
|
177 class="privatelink" onclick="toggle_private();" |
|
178 >hide private</a>]</span></td> |
|
179 </tr> |
|
180 </table> |
|
181 </td> |
|
182 </tr> |
|
183 <tr> |
|
184 <td colspan="2" class="summary"> |
|
185 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="configuration.Configuration-class.html">Configuration</a></code></b>: |
|
186 <code><a href="configuration.Configuration-class.html#key_re">key_re</a></code> |
|
187 </p> |
|
188 </td> |
|
189 </tr> |
|
190 </table> |
|
191 <!-- ==================== PROPERTIES ==================== --> |
|
192 <a name="section-Properties"></a> |
|
193 <table class="summary" border="1" cellpadding="3" |
|
194 cellspacing="0" width="100%" bgcolor="white"> |
|
195 <tr bgcolor="#70b0f0" class="table-header"> |
|
196 <td colspan="2" class="table-header"> |
|
197 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
198 <tr valign="top"> |
|
199 <td align="left"><span class="table-header">Properties</span></td> |
|
200 <td align="right" valign="top" |
|
201 ><span class="options">[<a href="#section-Properties" |
|
202 class="privatelink" onclick="toggle_private();" |
|
203 >hide private</a>]</span></td> |
|
204 </tr> |
|
205 </table> |
|
206 </td> |
|
207 </tr> |
|
208 <tr> |
|
209 <td colspan="2" class="summary"> |
|
210 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
211 <code>__class__</code> |
|
212 </p> |
|
213 </td> |
|
214 </tr> |
|
215 </table> |
|
216 <!-- ==================== METHOD DETAILS ==================== --> |
|
217 <a name="section-MethodDetails"></a> |
|
218 <table class="details" border="1" cellpadding="3" |
|
219 cellspacing="0" width="100%" bgcolor="white"> |
|
220 <tr bgcolor="#70b0f0" class="table-header"> |
|
221 <td colspan="2" class="table-header"> |
|
222 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
223 <tr valign="top"> |
|
224 <td align="left"><span class="table-header">Method Details</span></td> |
|
225 <td align="right" valign="top" |
|
226 ><span class="options">[<a href="#section-MethodDetails" |
|
227 class="privatelink" onclick="toggle_private();" |
|
228 >hide private</a>]</span></td> |
|
229 </tr> |
|
230 </table> |
|
231 </td> |
|
232 </tr> |
|
233 </table> |
|
234 <a name="__init__"></a> |
|
235 <div> |
|
236 <table class="details" border="1" cellpadding="3" |
|
237 cellspacing="0" width="100%" bgcolor="white"> |
|
238 <tr><td> |
|
239 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
240 <tr valign="top"><td> |
|
241 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span> |
|
242 <br /><em class="fname">(Constructor)</em> |
|
243 </h3> |
|
244 </td><td align="right" valign="top" |
|
245 ><span class="codelink"><a href="configuration-pysrc.html#HierarchicalConfiguration.__init__">source code</a></span> |
|
246 </td> |
|
247 </table> |
|
248 |
|
249 Initialization. |
|
250 <dl class="fields"> |
|
251 <dt>Overrides: |
|
252 <a href="configuration.Configuration-class.html#__init__">Configuration.__init__</a> |
|
253 </dt> |
|
254 </dl> |
|
255 </td></tr></table> |
|
256 </div> |
|
257 <a name="__getitem__"></a> |
|
258 <div> |
|
259 <table class="details" border="1" cellpadding="3" |
|
260 cellspacing="0" width="100%" bgcolor="white"> |
|
261 <tr><td> |
|
262 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
263 <tr valign="top"><td> |
|
264 <h3 class="epydoc"><span class="sig"><span class="sig-name">__getitem__</span>(<span class="sig-arg">self</span>, |
|
265 <span class="sig-arg">key</span>, |
|
266 <span class="sig-arg">interpolate</span>=<span class="sig-default">True</span>)</span> |
|
267 <br /><em class="fname">(Indexing operator)</em> |
|
268 </h3> |
|
269 </td><td align="right" valign="top" |
|
270 ><span class="codelink"><a href="configuration-pysrc.html#HierarchicalConfiguration.__getitem__">source code</a></span> |
|
271 </td> |
|
272 </table> |
|
273 |
|
274 Get an item as a dict. |
|
275 <dl class="fields"> |
|
276 <dt>Overrides: |
|
277 <a href="configuration.Configuration-class.html#__getitem__">Configuration.__getitem__</a> |
|
278 </dt> |
|
279 </dl> |
|
280 </td></tr></table> |
|
281 </div> |
|
282 <br /> |
|
283 <!-- ==================== NAVIGATION BAR ==================== --> |
|
284 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
285 bgcolor="#a0c0ff" cellspacing="0"> |
|
286 <tr valign="middle"> |
|
287 |
|
288 <!-- Tree link --> |
|
289 <th> <a |
|
290 href="module-tree.html">Trees</a> </th> |
|
291 |
|
292 <!-- Index link --> |
|
293 <th> <a |
|
294 href="identifier-index.html">Indices</a> </th> |
|
295 |
|
296 <!-- Help link --> |
|
297 <th> <a |
|
298 href="help.html">Help</a> </th> |
|
299 |
|
300 <th class="navbar" width="100%"></th> |
|
301 </tr> |
|
302 </table> |
|
303 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
304 <tr> |
|
305 <td align="left" class="footer"> |
|
306 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009 |
|
307 </td> |
|
308 <td align="right" class="footer"> |
|
309 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
310 </td> |
|
311 </tr> |
|
312 </table> |
|
313 |
|
314 <script type="text/javascript"> |
|
315 <!-- |
|
316 // Private objects are initially displayed (because if |
|
317 // javascript is turned off then we want them to be |
|
318 // visible); but by default, we want to hide them. So hide |
|
319 // them unless we have a cookie that says to show them. |
|
320 checkCookie() |
|
321 // --> |
|
322 </script> |
|
323 |
|
324 </body> |
|
325 </html> |