root/site_resources/oldapi/cherrypy.config.CaseSensitiveConfigParser-class.html

Revision 1733, 16.3 kB (checked in by kevin, 2 years ago)

various resources used for building the site

Line 
1 <?xml version="1.0" encoding="iso-8859-1"?>
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>cherrypy.config.CaseSensitiveConfigParser</title>
7   <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8 </head>
9 <body bgcolor="white" text="black" link="blue" vlink="#204080"
10       alink="#204080">
11
12 <!-- =========== START OF NAVBAR =========== -->
13 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14   <tr valign="center">
15     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
16     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
17     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
18     <th class="navbar" align="right" width="100%">
19       <table border="0" cellpadding="0" cellspacing="0">
20       <tr><th class="navbar" align="center">
21         <p class="nomargin">
22           <a class="navbar" target="_top" href="http://www.turbogears.org">TurboGears</a>
23       </p></th></tr></table>
24     </th>
25   </tr>
26 </table>
27 <table width="100%" cellpadding="0" cellspacing="0">
28   <tr valign="top">
29     <td width="100%">
30       <font size="-1"><b class="breadcrumbs">
31         <a href="cherrypy-module.html">Package&nbsp;cherrypy</a> ::
32         <a href="cherrypy.config-module.html">Module&nbsp;config</a> ::
33         Class&nbsp;CaseSensitiveConfigParser
34       </b></font></br>
35     </td>
36     <td><table cellpadding="0" cellspacing="0">
37       <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="cherrypy.config.CaseSensitiveConfigParser-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
38     </table></td>
39 </tr></table>
40
41 <!-- =========== START OF CLASS DESCRIPTION =========== -->
42 <h2 class="class">Class CaseSensitiveConfigParser</h2>
43
44 <pre class="base-tree">
45 <a href="ConfigParser.RawConfigParser-class.html"><code>RawConfigParser</code></a> --+   
46                   |   
47        <a href="ConfigParser.ConfigParser-class.html"><code>ConfigParser</code></a> --+
48                       |
49                      <b>CaseSensitiveConfigParser</b>
50 </pre><br />
51
52 <hr/>
53
54 Sub-class of ConfigParser that keeps the case of options and that
55 raises an exception if the file cannot be read.
56 <hr/>
57
58
59 <!-- =========== START OF METHOD SUMMARY =========== -->
60 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
61 <tr bgcolor="#70b0f0" class="summary">
62   <th colspan="2">Method Summary</th></tr>
63 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
64   <td><code><a name="optionxform"></a><span class="summary-sig"><span class="summary-sig-name">optionxform</span>(<span class=summary-sig-arg>self</span>,
65           <span class=summary-sig-arg>optionstr</span>)</span></code>
66  <a href="source/cherrypy.config-module.html#158" class="source">[source]</a>
67 </td></tr>
68 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
69   <td><code><span class="summary-sig"><a href="cherrypy.config.CaseSensitiveConfigParser-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>,
70           <span class=summary-sig-arg>filenames</span>)</span></code>
71  <a href="source/ConfigParser-module.html#247" class="source">[source]</a>
72 <br />
73 Read and parse a filename or a list of filenames.</td></tr>
74 <tr bgcolor="#e8f0f8" class="group">
75   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from ConfigParser</th></tr>
76 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
77   <td><code><span class="summary-sig"><a href="ConfigParser.ConfigParser-class.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>self</span>,
78           <span class=summary-sig-arg>section</span>,
79           <span class=summary-sig-arg>option</span>,
80           <span class=summary-sig-arg>raw</span>,
81           <span class=summary-sig-arg>vars</span>)</span></code>
82  <a href="source/ConfigParser-module.html#495" class="source">[source]</a>
83 <br />
84 Get an option value for a given section.</td></tr>
85 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
86   <td><code><span class="summary-sig"><a href="ConfigParser.ConfigParser-class.html#items" class="summary-sig-name"><code>items</code></a>(<span class=summary-sig-arg>self</span>,
87           <span class=summary-sig-arg>section</span>,
88           <span class=summary-sig-arg>raw</span>,
89           <span class=summary-sig-arg>vars</span>)</span></code>
90  <a href="source/ConfigParser-module.html#527" class="source">[source]</a>
91 <br />
92 Return a list of tuples with (name, value) for each option in the
93 section.</td></tr>
94 <tr bgcolor="#e8f0f8" class="group">
95   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from RawConfigParser</th></tr>
96 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
97   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
98           <span class=summary-sig-arg>defaults</span>)</span></code>
99  <a href="source/ConfigParser-module.html#204" class="source">[source]</a>
100 </td></tr>
101 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
102   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#add_section" class="summary-sig-name"><code>add_section</code></a>(<span class=summary-sig-arg>self</span>,
103           <span class=summary-sig-arg>section</span>)</span></code>
104  <a href="source/ConfigParser-module.html#219" class="source">[source]</a>
105 <br />
106 Create a new section in the configuration.</td></tr>
107 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
108   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#defaults" class="summary-sig-name"><code>defaults</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
109  <a href="source/ConfigParser-module.html#211" class="source">[source]</a>
110 </td></tr>
111 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
112   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#getboolean" class="summary-sig-name"><code>getboolean</code></a>(<span class=summary-sig-arg>self</span>,
113           <span class=summary-sig-arg>section</span>,
114           <span class=summary-sig-arg>option</span>)</span></code>
115  <a href="source/ConfigParser-module.html#329" class="source">[source]</a>
116 </td></tr>
117 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
118   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#getfloat" class="summary-sig-name"><code>getfloat</code></a>(<span class=summary-sig-arg>self</span>,
119           <span class=summary-sig-arg>section</span>,
120           <span class=summary-sig-arg>option</span>)</span></code>
121  <a href="source/ConfigParser-module.html#323" class="source">[source]</a>
122 </td></tr>
123 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
124   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#getint" class="summary-sig-name"><code>getint</code></a>(<span class=summary-sig-arg>self</span>,
125           <span class=summary-sig-arg>section</span>,
126           <span class=summary-sig-arg>option</span>)</span></code>
127  <a href="source/ConfigParser-module.html#320" class="source">[source]</a>
128 </td></tr>
129 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
130   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#has_option" class="summary-sig-name"><code>has_option</code></a>(<span class=summary-sig-arg>self</span>,
131           <span class=summary-sig-arg>section</span>,
132           <span class=summary-sig-arg>option</span>)</span></code>
133  <a href="source/ConfigParser-module.html#338" class="source">[source]</a>
134 <br />
135 Check for the existence of a given option in a given section.</td></tr>
136 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
137   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#has_section" class="summary-sig-name"><code>has_section</code></a>(<span class=summary-sig-arg>self</span>,
138           <span class=summary-sig-arg>section</span>)</span></code>
139  <a href="source/ConfigParser-module.html#229" class="source">[source]</a>
140 <br />
141 Indicate whether the named section is present in the
142 configuration.</td></tr>
143 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
144   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#options" class="summary-sig-name"><code>options</code></a>(<span class=summary-sig-arg>self</span>,
145           <span class=summary-sig-arg>section</span>)</span></code>
146  <a href="source/ConfigParser-module.html#236" class="source">[source]</a>
147 <br />
148 Return a list of option names for the given section name.</td></tr>
149 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
150   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#readfp" class="summary-sig-name"><code>readfp</code></a>(<span class=summary-sig-arg>self</span>,
151           <span class=summary-sig-arg>fp</span>,
152           <span class=summary-sig-arg>filename</span>)</span></code>
153  <a href="source/ConfigParser-module.html#272" class="source">[source]</a>
154 <br />
155 Like read() but the argument must be a file-like object.</td></tr>
156 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
157   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#remove_option" class="summary-sig-name"><code>remove_option</code></a>(<span class=summary-sig-arg>self</span>,
158           <span class=summary-sig-arg>section</span>,
159           <span class=summary-sig-arg>option</span>)</span></code>
160  <a href="source/ConfigParser-module.html#376" class="source">[source]</a>
161 <br />
162 Remove an option.</td></tr>
163 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
164   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#remove_section" class="summary-sig-name"><code>remove_section</code></a>(<span class=summary-sig-arg>self</span>,
165           <span class=summary-sig-arg>section</span>)</span></code>
166  <a href="source/ConfigParser-module.html#391" class="source">[source]</a>
167 <br />
168 Remove a file section.</td></tr>
169 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
170   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#sections" class="summary-sig-name"><code>sections</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
171  <a href="source/ConfigParser-module.html#214" class="source">[source]</a>
172 <br />
173 Return a list of section names, excluding [DEFAULT]</td></tr>
174 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
175   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#set" class="summary-sig-name"><code>set</code></a>(<span class=summary-sig-arg>self</span>,
176           <span class=summary-sig-arg>section</span>,
177           <span class=summary-sig-arg>option</span>,
178           <span class=summary-sig-arg>value</span>)</span></code>
179  <a href="source/ConfigParser-module.html#350" class="source">[source]</a>
180 <br />
181 Set an option.</td></tr>
182 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
183   <td><code><span class="summary-sig"><a href="ConfigParser.RawConfigParser-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>,
184           <span class=summary-sig-arg>fp</span>)</span></code>
185  <a href="source/ConfigParser-module.html#361" class="source">[source]</a>
186 <br />
187 Write an .ini-format representation of the configuration state.</td></tr>
188 </table><br />
189
190
191 <!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
192 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
193 <tr bgcolor="#70b0f0" class="summary">
194   <th colspan="2">Class Variable Summary</th></tr>
195 <tr bgcolor="#e8f0f8" class="group">
196   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from RawConfigParser</th></tr>
197 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
198 <td><b><a href="ConfigParser.RawConfigParser-class.html#OPTCRE"><code>OPTCRE</code></a></b> = <span title="&lt;_sre.SRE_Pattern object at 0x1def8&gt;"><code><span class="re"><span class="re-group">(</span><span class="re-group">[</span><span class="re-group">^</span>:=<span class="re-char">\s</span><span class="re-group">]</span><span class="re-group">[</span><span class="re-group">^</span>:=<span class="re-group">]</span><span class="re-op">*</span><span class="re-group">)</span><span class="re-char">\s</span><span class="re-op">*</span><span class="re-group">(</span><span class="re-group">[</span>:=<span class="re-group">]</span><span class="re-group">)</span><span class="re-char">\s</span><span class="re-op">*</span><span class="re-group">(</span><span class="re-char">.</span><span class="re-op">*</span><span class="re-group">)</span><span class="re-char">$</span></span>                </code>
199 </span></td></tr>
200 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
201 <td><b><a href="ConfigParser.RawConfigParser-class.html#SECTCRE"><code>SECTCRE</code></a></b> = <span title="&lt;_sre.SRE_Pattern object at 0x218920&gt;"><code><span class="re"><span class="re-char">\[</span><span class="re-group">(</span><span class="re-group">[^</span><span class="re-char">\]</span><span class="re-group">]</span><span class="re-op">+</span><span class="re-group">)</span><span class="re-char">\]</span></span>                                   </code>
202 </span></td></tr>
203 </table><br />
204
205
206 <!-- =========== START OF METHOD DETAILS =========== -->
207 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
208 <tr bgcolor="#70b0f0" class="details">
209   <th colspan="2">Method Details</th></tr>
210 </table>
211
212 <a name="read"></a>
213 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
214   <h3><span class="sig"><span class="sig-name">read</span>(<span class=sig-arg>self</span>,
215           <span class=sig-arg>filenames</span>)</span>
216  <a href="source/ConfigParser-module.html#247" class="source">[source]</a>  </h3>
217   <p>Read and parse a filename or a list of filenames.</p>
218   <p>Files that cannot be opened are silently ignored; this is designed
219   so that you can specify a list of potential configuration file
220   locations (e.g. current directory, user's home directory, systemwide
221   directory), and all existing configuration files in the list will be
222   read. A single filename may also be given.</p>
223   Return list of successfully read files.
224   <dl><dt></dt><dd>
225     <dl><dt><b>Overrides:</b></dt>
226       <dd><a href="ConfigParser.RawConfigParser-class.html#read"><code>ConfigParser.RawConfigParser.read</code></a> <i>(inherited documentation)</i>
227 </dd>
228     </dl>
229   </dd></dl>
230 </td></tr></table>
231 <br />
232
233
234 <!-- =========== START OF NAVBAR =========== -->
235 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
236   <tr valign="center">
237     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
238     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
239     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
240     <th class="navbar" align="right" width="100%">
241       <table border="0" cellpadding="0" cellspacing="0">
242       <tr><th class="navbar" align="center">
243         <p class="nomargin">
244           <a class="navbar" target="_top" href="http://www.turbogears.org">TurboGears</a>
245       </p></th></tr></table>
246     </th>
247   </tr>
248 </table>
249
250 <table border="0" cellpadding="0" cellspacing="0" width="100%">
251   <tr>
252     <td align="left"><font size="-2">Generated by Epydoc 2.1.99 on Wed Sep 14 13:09:29 2005</font></td>
253     <td align="right"><a href="http://epydoc.sourceforge.net"
254                       ><font size="-2">http://epydoc.sf.net</font></a></td>
255   </tr>
256 </table>
257 </body>
258 </html>
Note: See TracBrowser for help on using the browser.