@@ -25,10 +25,12 @@ or *severity*.
2525When to use logging
2626^^^^^^^^^^^^^^^^^^^
2727
28- Logging provides a set of convenience functions for simple logging usage. These
29- are :func: `debug `, :func: `info `, :func: `warning `, :func: `error ` and
30- :func: `critical `. To determine when to use logging, see the table below, which
31- states, for each of a set of common tasks, the best tool to use for it.
28+ You can access logging functionality by creating a logger via ``logger =
29+ getLogger(__name__) ``, and then calling the logger's :meth: `~Logger.debug `,
30+ :meth: `~Logger.info `, :meth: `~Logger.warning `, :meth: `~Logger.error ` and
31+ :meth: `~Logger.critical ` methods. To determine when to use logging, and to see
32+ which logger methods to use when, see the table below. It states, for each of a
33+ set of common tasks, the best tool to use for that task.
3234
3335+-------------------------------------+--------------------------------------+
3436| Task you want to perform | The best tool for the task |
@@ -37,8 +39,8 @@ states, for each of a set of common tasks, the best tool to use for it.
3739| usage of a command line script or | |
3840| program | |
3941+-------------------------------------+--------------------------------------+
40- | Report events that occur during | :func: ` logging .info ` (or |
41- | normal operation of a program (e.g. | :func: ` logging .debug ` for very |
42+ | Report events that occur during | A logger's :meth: ` ~Logger .info ` (or |
43+ | normal operation of a program (e.g. | :meth:`~Logger .debug` method for very|
4244| for status monitoring or fault | detailed output for diagnostic |
4345| investigation) | purposes) |
4446+-------------------------------------+--------------------------------------+
@@ -47,22 +49,23 @@ states, for each of a set of common tasks, the best tool to use for it.
4749| | the client application should be |
4850| | modified to eliminate the warning |
4951| | |
50- | | :func: `logging.warning ` if there is |
51- | | nothing the client application can do|
52- | | about the situation, but the event |
53- | | should still be noted |
52+ | | A logger's :meth: `~Logger.warning ` |
53+ | | method if there is nothing the client|
54+ | | application can do about the |
55+ | | situation, but the event should still|
56+ | | be noted |
5457+-------------------------------------+--------------------------------------+
5558| Report an error regarding a | Raise an exception |
5659| particular runtime event | |
5760+-------------------------------------+--------------------------------------+
58- | Report suppression of an error | :func: ` logging .error `, |
59- | without raising an exception (e.g. | :func: ` logging .exception ` or |
60- | error handler in a long-running | :func: ` logging .critical ` as |
61+ | Report suppression of an error | A logger's :meth: ` ~Logger .error `, |
62+ | without raising an exception (e.g. | :meth: ` ~Logger .exception ` or |
63+ | error handler in a long-running | :meth: ` ~Logger .critical ` method as |
6164| server process) | appropriate for the specific error |
6265| | and application domain |
6366+-------------------------------------+--------------------------------------+
6467
65- The logging functions are named after the level or severity of the events
68+ The logger methods are named after the level or severity of the events
6669they are used to track. The standard levels and their applicability are
6770described below (in increasing order of severity):
6871
@@ -115,12 +118,18 @@ If you type these lines into a script and run it, you'll see:
115118 WARNING:root:Watch out!
116119
117120 printed out on the console. The ``INFO `` message doesn't appear because the
118- default level is ``WARNING ``. The printed message includes the indication of
119- the level and the description of the event provided in the logging call, i.e.
120- 'Watch out!'. Don't worry about the 'root' part for now: it will be explained
121- later. The actual output can be formatted quite flexibly if you need that;
122- formatting options will also be explained later.
123-
121+ default level is ``WARNING ``. The printed message includes the indication of the
122+ level and the description of the event provided in the logging call, i.e.
123+ 'Watch out!'. The actual output can be formatted quite flexibly if you need
124+ that; formatting options will also be explained later.
125+
126+ Notice that in this example, we use functions directly on the ``logging ``
127+ module, like ``logging.debug ``, rather than creating a logger and calling
128+ functions on it. These functions operation on the root logger, but can be useful
129+ as they will call :func: `~logging.basicConfig ` for you if it has not been called yet, like in
130+ this example. In larger programs you'll usually want to control the logging
131+ configuration explicitly however - so for that reason as well as others, it's
132+ better to create loggers and call their methods.
124133
125134Logging to a file
126135^^^^^^^^^^^^^^^^^
@@ -130,11 +139,12 @@ look at that next. Be sure to try the following in a newly started Python
130139interpreter, and don't just continue from the session described above::
131140
132141 import logging
142+ logger = logging.getLogger(__name__)
133143 logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
134- logging .debug('This message should go to the log file')
135- logging .info('So should this')
136- logging .warning('And this, too')
137- logging .error('And non-ASCII stuff, too, like Øresund and Malmö')
144+ logger .debug('This message should go to the log file')
145+ logger .info('So should this')
146+ logger .warning('And this, too')
147+ logger .error('And non-ASCII stuff, too, like Øresund and Malmö')
138148
139149.. versionchanged :: 3.9
140150 The *encoding * argument was added. In earlier Python versions, or if not
@@ -148,10 +158,10 @@ messages:
148158
149159.. code-block :: none
150160
151- DEBUG:root :This message should go to the log file
152- INFO:root :So should this
153- WARNING:root :And this, too
154- ERROR:root :And non-ASCII stuff, too, like Øresund and Malmö
161+ DEBUG:__main__ :This message should go to the log file
162+ INFO:__main__ :So should this
163+ WARNING:__main__ :And this, too
164+ ERROR:__main__ :And non-ASCII stuff, too, like Øresund and Malmö
155165
156166 This example also shows how you can set the logging level which acts as the
157167threshold for tracking. In this case, because we set the threshold to
@@ -180,11 +190,9 @@ following example::
180190 raise ValueError('Invalid log level: %s' % loglevel)
181191 logging.basicConfig(level=numeric_level, ...)
182192
183- The call to :func: `basicConfig ` should come *before * any calls to
184- :func: `debug `, :func: `info `, etc. Otherwise, those functions will call
185- :func: `basicConfig ` for you with the default options. As it's intended as a
186- one-off simple configuration facility, only the first call will actually do
187- anything: subsequent calls are effectively no-ops.
193+ The call to :func: `basicConfig ` should come *before * any calls to a logger's
194+ methods such as :meth: `~Logger.debug `, :meth: `~Logger.info `, etc. Otherwise,
195+ that logging event may not be handled in the desired manner.
188196
189197If you run the above script several times, the messages from successive runs
190198are appended to the file *example.log *. If you want each run to start afresh,
@@ -197,50 +205,6 @@ The output will be the same as before, but the log file is no longer appended
197205to, so the messages from earlier runs are lost.
198206
199207
200- Logging from multiple modules
201- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
202-
203- If your program consists of multiple modules, here's an example of how you
204- could organize logging in it::
205-
206- # myapp.py
207- import logging
208- import mylib
209-
210- def main():
211- logging.basicConfig(filename='myapp.log', level=logging.INFO)
212- logging.info('Started')
213- mylib.do_something()
214- logging.info('Finished')
215-
216- if __name__ == '__main__':
217- main()
218-
219- ::
220-
221- # mylib.py
222- import logging
223-
224- def do_something():
225- logging.info('Doing something')
226-
227- If you run *myapp.py *, you should see this in *myapp.log *:
228-
229- .. code-block :: none
230-
231- INFO:root:Started
232- INFO:root:Doing something
233- INFO:root:Finished
234-
235- which is hopefully what you were expecting to see. You can generalize this to
236- multiple modules, using the pattern in *mylib.py *. Note that for this simple
237- usage pattern, you won't know, by looking in the log file, *where * in your
238- application your messages came from, apart from looking at the event
239- description. If you want to track the location of your messages, you'll need
240- to refer to the documentation beyond the tutorial level -- see
241- :ref: `logging-advanced-tutorial `.
242-
243-
244208Logging variable data
245209^^^^^^^^^^^^^^^^^^^^^
246210
0 commit comments