<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"logging-config-fileformat.html" />
<link rel=
"prev" href=
"node361.html" />
<link rel=
"parent" href=
"node361.html" />
<link rel=
"next" href=
"logging-config-fileformat.html" />
<meta name='aesop' content='information'
/>
<title>6.29.10.1 Configuration functions
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"6.29.10 Configuration"
href=
"node361.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"6.29.10 Configuration"
href=
"node361.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"6.29.10.2 Configuration file format"
href=
"logging-config-fileformat.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node361.html">6.29.10 Configuration
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"node361.html">6.29.10 Configuration
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"logging-config-fileformat.html">6.29.10.2 Configuration file format
</A>
<!--End of Navigation Panel-->
<H3><A NAME=
"SECTION00829101000000000000000"></A><A NAME=
"logging-config-api"></A>
6.29.10.1 Configuration functions
The following functions allow the logging module to be
configured. Before they can be used, you must import
<tt class=
"module">logging.config
</tt>. Their use is optional -- you can configure
the logging module entirely by making calls to the main API (defined
in
<tt class=
"module">logging
</tt> itself) and defining handlers which are declared
either in
<tt class=
"module">logging
</tt> or
<tt class=
"module">logging.handlers
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
2563' xml:id='l2h-
2563'
class=
"function">fileConfig
</tt></b>(
</nobr></td>
<td><var>fname
</var><big>[
</big><var>, defaults
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Reads the logging configuration from a ConfigParser-format file named
<var>fname
</var>. This function can be called several times from an application,
allowing an end user the ability to select from various pre-canned
configurations (if the developer provides a mechanism to present the
choices and load the chosen configuration). Defaults to be passed to
ConfigParser can be specified in the
<var>defaults
</var> argument.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
2564' xml:id='l2h-
2564'
class=
"function">listen
</tt></b>(
</nobr></td>
<td><var></var><big>[
</big><var>port
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Starts up a socket server on the specified port, and listens for new
configurations. If no port is specified, the module's default
<tt class=
"constant">DEFAULT_LOGGING_CONFIG_PORT
</tt> is used. Logging configurations
will be sent as a file suitable for processing by
<tt class=
"function">fileConfig()
</tt>.
Returns a
<tt class=
"class">Thread
</tt> instance on which you can call
<tt class=
"method">start()
</tt>
to start the server, and which you can
<tt class=
"method">join()
</tt> when appropriate.
To stop the server, call
<tt class=
"function">stopListening()
</tt>. To send a configuration
to the socket, read in the configuration file and send it to the socket
as a string of bytes preceded by a four-byte length packed in binary using
struct.
<code>pack(
">L", n)
</code>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
2565' xml:id='l2h-
2565'
class=
"function">stopListening
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Stops the listening server which was created with a call to
<tt class=
"function">listen()
</tt>. This is typically called before calling
<tt class=
"method">join()
</tt>
on the return value from
<tt class=
"function">listen()
</tt>.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"6.29.10 Configuration"
href=
"node361.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"6.29.10 Configuration"
href=
"node361.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"6.29.10.2 Configuration file format"
href=
"logging-config-fileformat.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node361.html">6.29.10 Configuration
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"node361.html">6.29.10 Configuration
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"logging-config-fileformat.html">6.29.10.2 Configuration file format
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.