root/site_resources/oldapi/cherrypy.config-module.html

Revision 1733, 14.6 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</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         Module&nbsp;config
33       </b></font></br>
34     </td>
35     <td><table cellpadding="0" cellspacing="0">
36       <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="cherrypy.config-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
37     </table></td>
38 </tr></table>
39
40 <!-- =========== START OF MODULE DESCRIPTION =========== -->
41 <h2 class="module">Module cherrypy.config <a href="source/cherrypy.config-module.html" class="source">[source]</a></h2>
42
43 Configuration system for CherryPy.
44 <hr/>
45
46 <!-- =========== START OF CLASSES =========== -->
47 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
48 <tr bgcolor="#70b0f0" class="summary">
49   <th colspan="2">Classes</th></tr>
50 <tr><td width="15%">
51   <b><a href="cherrypy.config.CaseSensitiveConfigParser-class.html"><code>CaseSensitiveConfigParser</code></a></b></td>
52   <td>Sub-class of ConfigParser that keeps the case of options and that
53 raises an exception if the file cannot be read.</td></tr>
54 </table><br />
55
56
57 <!-- =========== START OF FUNCTION SUMMARY =========== -->
58 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
59 <tr bgcolor="#70b0f0" class="summary">
60   <th colspan="2">Function Summary</th></tr>
61 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
62   <td><code><span class="summary-sig"><a href="cherrypy.config-module.html#dict_from_config_file" class="summary-sig-name"><code>dict_from_config_file</code></a>(<span class=summary-sig-arg>configFile</span>)</span></code>
63  <a href="source/cherrypy.config-module.html#175" class="source">[source]</a>
64 <br />
65 Convert an INI file to a dictionary</td></tr>
66 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
67   <td><code><span class="summary-sig"><a href="cherrypy.config-module.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>key</span>,
68           <span class=summary-sig-arg>defaultValue</span>,
69           <span class=summary-sig-arg>returnSection</span>,
70           <span class=summary-sig-arg>path</span>)</span></code>
71  <a href="source/cherrypy.config-module.html#89" class="source">[source]</a>
72 <br />
73 Return the configuration value corresponding to key If specified,
74 return defaultValue on lookup failure.</td></tr>
75 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
76   <td><code><span class="summary-sig"><a href="cherrypy.config-module.html#getAll" class="summary-sig-name"><code>getAll</code></a>(<span class=summary-sig-arg>key</span>)</span></code>
77  <a href="source/cherrypy.config-module.html#125" class="source">[source]</a>
78 <br />
79 Lookup key in the current node and all of its parent nodes as a list
80 of path, value pairs.</td></tr>
81 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
82   <td><code><span class="summary-sig"><a href="cherrypy.config-module.html#outputConfigMap" class="summary-sig-name"><code>outputConfigMap</code></a>()</span></code>
83  <a href="source/cherrypy.config-module.html#219" class="source">[source]</a>
84 <br />
85 Log server configuration parameters</td></tr>
86 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
87   <td><code><span class="summary-sig"><a href="cherrypy.config-module.html#reset" class="summary-sig-name"><code>reset</code></a>(<span class=summary-sig-arg>useDefaults</span>)</span></code>
88  <a href="source/cherrypy.config-module.html#59" class="source">[source]</a>
89 <br />
90 Clear configuration and restore defaults</td></tr>
91 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
92   <td><code><span class="summary-sig"><a href="cherrypy.config-module.html#update" class="summary-sig-name"><code>update</code></a>(<span class=summary-sig-arg>updateMap</span>,
93           <span class=summary-sig-arg>file</span>,
94           <span class=summary-sig-arg>override</span>)</span></code>
95  <a href="source/cherrypy.config-module.html#66" class="source">[source]</a>
96 <br />
97 Update configMap from a dictionary or a config file If override is
98 True then the update will not modify values already defined in the
99 configMap.</td></tr>
100 </table><br />
101
102
103 <!-- =========== START OF VARIABLE SUMMARY =========== -->
104 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
105 <tr bgcolor="#70b0f0" class="summary">
106   <th colspan="2">Variable Summary</th></tr>
107 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
108 <td><b><a href="cherrypy.config-module.html#configMap"><code>configMap</code></a></b> = <span title="{'/style.css': {'staticFilter.file': 'style.css', 'staticFilter.on': True}, 'global': {'server.socketHost': '', 'session.storageFileDir': '', 'cacheFilter.on': True, 'session.timeout': 60, 'server.socketQueueSize': 5, 'session.cleanUpDelay': 60, 'server.socketPort': 8080, 'server.reverseDNS': False, 'virtualHostFilter.prefix': '/index2', 'session.storageType': 'ram', 'server.logToScreen': False, 'gzipFilter.on': True, 'sessionFilter.on': True, 'virtualHostFilter.on': True, 'logDebugInfoFilter.on': True, 'server.environment': 'production', 'encodingFilter.on': True, 'server.httpErrors': Fals..."><code>{'/style.css':&nbsp;{'staticFilter.file':&nbsp;'style.<span class="variable-ellipsis">...</span></code>
109 </span></td></tr>
110 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
111 <td><b><a href="cherrypy.config-module.html#defaultGlobal"><code>defaultGlobal</code></a></b> = <span title="{'server.socketHost': '', 'server.logFile': '', 'server.socketQueueSize': 5, 'server.socketFile': '', 'server.socketPort': 8080, 'server.reverseDNS': False, 'server.logToScreen': True, 'server.protocolVersion': 'HTTP/1.0', 'server.environment': 'development', 'server.httpErrors': True, 'server.threadPool': 0}"><code>{'server.socketHost':&nbsp;'',&nbsp;'server.logFil<span class="variable-ellipsis">...</span></code>
112 </span></td></tr>
113 </table><br />
114
115
116 <!-- =========== START OF FUNCTION DETAILS =========== -->
117 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
118 <tr bgcolor="#70b0f0" class="details">
119   <th colspan="2">Function Details</th></tr>
120 </table>
121
122 <a name="dict_from_config_file"></a>
123 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
124   <h3><span class="sig"><span class="sig-name">dict_from_config_file</span>(<span class=sig-arg>configFile</span>)</span>
125  <a href="source/cherrypy.config-module.html#175" class="source">[source]</a>  </h3>
126   Convert an INI file to a dictionary
127   <dl><dt></dt><dd>
128   </dd></dl>
129 </td></tr></table>
130
131 <a name="get"></a>
132 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
133   <h3><span class="sig"><span class="sig-name">get</span>(<span class=sig-arg>key</span>,
134           <span class=sig-arg>defaultValue</span>=<span class=sig-default>None</span>,
135           <span class=sig-arg>returnSection</span>=<span class=sig-default>False</span>,
136           <span class=sig-arg>path</span>=<span class=sig-default>None</span>)</span>
137  <a href="source/cherrypy.config-module.html#89" class="source">[source]</a>  </h3>
138   Return the configuration value corresponding to key If specified,
139   return defaultValue on lookup failure. If returnSection is specified,
140   return the path to the value, instead of the value itself.
141   <dl><dt></dt><dd>
142   </dd></dl>
143 </td></tr></table>
144
145 <a name="getAll"></a>
146 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
147   <h3><span class="sig"><span class="sig-name">getAll</span>(<span class=sig-arg>key</span>)</span>
148  <a href="source/cherrypy.config-module.html#125" class="source">[source]</a>  </h3>
149   Lookup key in the current node and all of its parent nodes as a list
150   of path, value pairs.
151   <dl><dt></dt><dd>
152   </dd></dl>
153 </td></tr></table>
154
155 <a name="outputConfigMap"></a>
156 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
157   <h3><span class="sig"><span class="sig-name">outputConfigMap</span>()</span>
158  <a href="source/cherrypy.config-module.html#219" class="source">[source]</a>  </h3>
159   Log server configuration parameters
160   <dl><dt></dt><dd>
161   </dd></dl>
162 </td></tr></table>
163
164 <a name="reset"></a>
165 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
166   <h3><span class="sig"><span class="sig-name">reset</span>(<span class=sig-arg>useDefaults</span>=<span class=sig-default>True</span>)</span>
167  <a href="source/cherrypy.config-module.html#59" class="source">[source]</a>  </h3>
168   Clear configuration and restore defaults
169   <dl><dt></dt><dd>
170   </dd></dl>
171 </td></tr></table>
172
173 <a name="update"></a>
174 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
175   <h3><span class="sig"><span class="sig-name">update</span>(<span class=sig-arg>updateMap</span>=<span class=sig-default>None</span>,
176           <span class=sig-arg>file</span>=<span class=sig-default>None</span>,
177           <span class=sig-arg>override</span>=<span class=sig-default>True</span>)</span>
178  <a href="source/cherrypy.config-module.html#66" class="source">[source]</a>  </h3>
179   Update configMap from a dictionary or a config file If override is
180   True then the update will not modify values already defined in the
181   configMap.
182   <dl><dt></dt><dd>
183   </dd></dl>
184 </td></tr></table>
185 <br />
186
187
188 <!-- =========== START OF VARIABLE DETAILS =========== -->
189 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
190 <tr bgcolor="#70b0f0" class="details">
191   <th colspan="2">Variable Details</th></tr>
192 </table>
193 <table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
194 <a name="configMap"></a>
195 <h3>configMap</h3>
196 <dl>
197   <dt></dt>
198   <dd>
199     <dl>
200       <dt><b>Type:</b></dt>
201       <dd>
202           <code>dict</code>
203
204       </dd>
205 <span title="{'/style.css': {'staticFilter.file': 'style.css', 'staticFilter.on': True}, 'global': {'server.socketHost': '', 'session.storageFileDir': '', 'cacheFilter.on': True, 'session.timeout': 60, 'server.socketQueueSize': 5, 'session.cleanUpDelay': 60, 'server.socketPort': 8080, 'server.reverseDNS': False, 'virtualHostFilter.prefix': '/index2', 'session.storageType': 'ram', 'server.logToScreen': False, 'gzipFilter.on': True, 'sessionFilter.on': True, 'virtualHostFilter.on': True, 'logDebugInfoFilter.on': True, 'server.environment': 'production', 'encodingFilter.on': True, 'server.httpErrors': Fals...">      <dt><b>Value:</b></dt>
206       <dd><table><tr><td>
207 <pre class="variable">
208 {'/docroot': {'staticFilter.dir': 'static',
209               'staticFilter.on': True,
210               'staticFilter.root': '/Users/tazzzzz/projects/thirdparty<span class="variable-linewrap">\</span>
211 /cherrypy/cherrypy/test'},
212  '/static': {'staticFilter.dir': 'static', 'staticFilter.on': True},
213  '/style.css': {'staticFilter.file': 'style.css', 'staticFilter.on': T<span class="variable-linewrap">\</span>
214 rue},
215  '/turbogearsjs': {'logDebugInfoFilter.on': False,
216 <span class="variable-ellipsis">...</span>                                                                    </pre>
217         </td></tr></table></dd>
218 </span>    </dl>
219   </dd>
220 </dl></td></tr></table>
221 <table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
222 <a name="defaultGlobal"></a>
223 <h3>defaultGlobal</h3>
224 <dl>
225   <dt></dt>
226   <dd>
227     <dl>
228       <dt><b>Type:</b></dt>
229       <dd>
230           <code>dict</code>
231
232       </dd>
233 <span title="{'server.socketHost': '', 'server.logFile': '', 'server.socketQueueSize': 5, 'server.socketFile': '', 'server.socketPort': 8080, 'server.reverseDNS': False, 'server.logToScreen': True, 'server.protocolVersion': 'HTTP/1.0', 'server.environment': 'development', 'server.httpErrors': True, 'server.threadPool': 0}">      <dt><b>Value:</b></dt>
234       <dd><table><tr><td>
235 <pre class="variable">
236 {'server.environment': 'development',
237  'server.httpErrors': True,
238  'server.logFile': '',
239  'server.logToScreen': True,
240  'server.protocolVersion': 'HTTP/1.0',
241  'server.reverseDNS': False,
242  'server.socketFile': '',
243  'server.socketHost': '',
244 <span class="variable-ellipsis">...</span>                                                                    </pre>
245         </td></tr></table></dd>
246 </span>    </dl>
247   </dd>
248 </dl></td></tr></table>
249 <br />
250
251
252 <!-- =========== START OF NAVBAR =========== -->
253 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
254   <tr valign="center">
255     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
256     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
257     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
258     <th class="navbar" align="right" width="100%">
259       <table border="0" cellpadding="0" cellspacing="0">
260       <tr><th class="navbar" align="center">
261         <p class="nomargin">
262           <a class="navbar" target="_top" href="http://www.turbogears.org">TurboGears</a>
263       </p></th></tr></table>
264     </th>
265   </tr>
266 </table>
267
268 <table border="0" cellpadding="0" cellspacing="0" width="100%">
269   <tr>
270     <td align="left"><font size="-2">Generated by Epydoc 2.1.99 on Wed Sep 14 13:09:38 2005</font></td>
271     <td align="right"><a href="http://epydoc.sourceforge.net"
272                       ><font size="-2">http://epydoc.sf.net</font></a></td>
273   </tr>
274 </table>
275 </body>
276 </html>
Note: See TracBrowser for help on using the browser.