← Back to branch summary

~lifeless/zconfig/bug-481512

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: chrisw
  • Date: 2009-06-11 08:57:44 UTC
  • Revision ID: svn-v4:62d5b8a3-27da-0310-9561-8e5933582275:ZConfig/trunk:100855
add tested documentation for configureLoggers.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
23
23
 
24
24
Reference documentation is available in the doc/ directory.
25
25
 
 
26
One common use of ZConfig is to configure the Python logging
 
27
framework. This is extremely simple to do as the following example
 
28
demonstrates:
 
29
 
 
30
    >>> from ZConfig import configureLoggers
 
31
    >>> configureLoggers('''
 
32
    ... <logger>
 
33
    ...    level INFO
 
34
    ...    <logfile>
 
35
    ...       PATH STDOUT
 
36
    ...       format %(levelname)s %(name)s %(message)s
 
37
    ...    </logfile>
 
38
    ... </logger>
 
39
    ... ''')
 
40
 
 
41
The above configures the root logger to output messages logged at INFO
 
42
or above to the console, as we can see in the following example:
 
43
 
 
44
    >>> from logging import getLogger
 
45
    >>> logger = getLogger()
 
46
    >>> logger.info('An info message')
 
47
    INFO root An info message
 
48
    >>> logger.debug('A debug message')
 
49
 
 
50
A more common configuration would see STDOUT replaced with a path to
 
51
the file into which log entries would be written.
 
52
 
 
53
For more information, see section 5.2 on the ZConfig documentation and
 
54
the examples in ZConfig/components/logger/tests.
 
55
 
26
56
Information on the latest released version of the ZConfig package is
27
57
available at
28
58