Closes #12206: documentation update for LogRecord constructor and Formatter.formatTime.

This commit is contained in:
Vinay Sajip 2011-06-13 14:59:36 +01:00
parent 0eb4ac4c62
commit ad52cb2613
1 changed files with 10 additions and 0 deletions

View File

@ -416,6 +416,13 @@ The useful mapping keys in a :class:`LogRecord` are given in the section on
record. Otherwise, the ISO8601 format is used. The resulting string is record. Otherwise, the ISO8601 format is used. The resulting string is
returned. returned.
This function uses a user-configurable function to convert the creation
time to a tuple. By default, :func:`time.localtime` is used; to change
this for a particular formatter instance, set the ``converter`` attribute
to a function with the same signature as :func:`time.localtime` or
:func:`time.gmtime`. To change it for all formatters, for example if you
want all logging times to be shown in GMT, set the ``converter``
attribute in the ``Formatter`` class.
.. method:: formatException(exc_info) .. method:: formatException(exc_info)
@ -491,6 +498,9 @@ wire).
:param name: The name of the logger used to log the event represented by :param name: The name of the logger used to log the event represented by
this LogRecord. this LogRecord.
:param level: The numeric level of the logging event (one of DEBUG, INFO etc.) :param level: The numeric level of the logging event (one of DEBUG, INFO etc.)
Note that this is converted to *two* attributes of the LogRecord:
``levelno`` for the numeric value and ``levelname`` for the
corresponding level name.
:param pathname: The full pathname of the source file where the logging call :param pathname: The full pathname of the source file where the logging call
was made. was made.
:param lineno: The line number in the source file where the logging call was :param lineno: The line number in the source file where the logging call was