Added style argument to logging.basicConfig() and documented this change.

This commit is contained in:
Vinay Sajip 2010-10-31 14:59:16 +00:00
parent 64474542eb
commit c5b273011b
2 changed files with 19 additions and 1 deletions

View File

@ -919,6 +919,12 @@ functions.
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
| ``datefmt`` | Use the specified date/time format. | | ``datefmt`` | Use the specified date/time format. |
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
| ``style`` | If ``format`` is specified, use this style |
| | for the format string. One of '%', '{' or |
| | '$' for %-formatting, :meth:`str.format` or |
| | :class:`string.Template` respectively, and |
| | defaulting to '%' if not specified. |
+--------------+---------------------------------------------+
| ``level`` | Set the root logger level to the specified | | ``level`` | Set the root logger level to the specified |
| | level. | | | level. |
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
@ -928,6 +934,10 @@ functions.
| | present, 'stream' is ignored. | | | present, 'stream' is ignored. |
+--------------+---------------------------------------------+ +--------------+---------------------------------------------+
.. versionchanged:: 3.2
The ``style`` argument was added.
.. function:: shutdown() .. function:: shutdown()
Informs the logging system to perform an orderly shutdown by flushing and Informs the logging system to perform an orderly shutdown by flushing and

View File

@ -1581,6 +1581,10 @@ def basicConfig(**kwargs):
(if filemode is unspecified, it defaults to 'a'). (if filemode is unspecified, it defaults to 'a').
format Use the specified format string for the handler. format Use the specified format string for the handler.
datefmt Use the specified date/time format. datefmt Use the specified date/time format.
style If a format string is specified, use this to specify the
type of format string (possible values '%', '{', '$', for
%-formatting, :meth:`str.format` and :class:`string.Template`
- defaults to '%').
level Set the root logger level to the specified level. level Set the root logger level to the specified level.
stream Use the specified stream to initialize the StreamHandler. Note stream Use the specified stream to initialize the StreamHandler. Note
that this argument is incompatible with 'filename' - if both that this argument is incompatible with 'filename' - if both
@ -1591,6 +1595,9 @@ def basicConfig(**kwargs):
remembered that StreamHandler does not close its stream (since it may be remembered that StreamHandler does not close its stream (since it may be
using sys.stdout or sys.stderr), whereas FileHandler closes its stream using sys.stdout or sys.stderr), whereas FileHandler closes its stream
when the handler is closed. when the handler is closed.
.. versionchanged: 3.2
Added the ``style`` parameter.
""" """
# Add thread safety in case someone mistakenly calls # Add thread safety in case someone mistakenly calls
# basicConfig() from multiple threads # basicConfig() from multiple threads
@ -1606,7 +1613,8 @@ def basicConfig(**kwargs):
hdlr = StreamHandler(stream) hdlr = StreamHandler(stream)
fs = kwargs.get("format", BASIC_FORMAT) fs = kwargs.get("format", BASIC_FORMAT)
dfs = kwargs.get("datefmt", None) dfs = kwargs.get("datefmt", None)
fmt = Formatter(fs, dfs) style = kwargs.get("style", '%')
fmt = Formatter(fs, dfs, style)
hdlr.setFormatter(fmt) hdlr.setFormatter(fmt)
root.addHandler(hdlr) root.addHandler(hdlr)
level = kwargs.get("level") level = kwargs.get("level")