[Python-checkins] python/dist/src/Doc/lib liblogging.tex,1.10,1.11
fdrake@users.sourceforge.net
fdrake@users.sourceforge.net
Tue, 08 Jul 2003 08:38:42 -0700
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv31499
Modified Files:
liblogging.tex
Log Message:
- clean up table markup for readability
- don't use \constant for literals; it's for "defined" constants
- fix various consistency issues
Index: liblogging.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/liblogging.tex,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** liblogging.tex 8 Jul 2003 08:40:20 -0000 1.10
--- liblogging.tex 8 Jul 2003 15:38:40 -0000 1.11
***************
*** 2,6 ****
Logging facility for Python}
! \declaremodule{standard}{logging} % standard library, in Python
% These apply to all modules, and may be given more than once:
--- 2,6 ----
Logging facility for Python}
! \declaremodule{standard}{logging}
% These apply to all modules, and may be given more than once:
***************
*** 479,483 ****
Returns a new instance of the \class{FileHandler} class. The specified
file is opened and used as the stream for logging. If \var{mode} is
! not specified, \constant{"a"} is used. By default, the file grows
indefinitely.
\end{classdesc}
--- 479,483 ----
Returns a new instance of the \class{FileHandler} class. The specified
file is opened and used as the stream for logging. If \var{mode} is
! not specified, \constant{'a'} is used. By default, the file grows
indefinitely.
\end{classdesc}
***************
*** 495,500 ****
The \class{RotatingFileHandler} class supports rotation of disk log files.
! \begin{classdesc}{RotatingFileHandler}{filename\optional{, mode, maxBytes,
! backupCount}}
Returns a new instance of the \class{RotatingFileHandler} class. The
specified file is opened and used as the stream for logging. If
--- 495,500 ----
The \class{RotatingFileHandler} class supports rotation of disk log files.
! \begin{classdesc}{RotatingFileHandler}{filename\optional{, mode\optional{,
! maxBytes\optional{, backupCount}}}}
Returns a new instance of the \class{RotatingFileHandler} class. The
specified file is opened and used as the stream for logging. If
***************
*** 636,641 ****
installed.
! \begin{classdesc}{NTEventLogHandler}{appname
! \optional{, dllname\optional{, logtype}}}
Returns a new instance of the \class{NTEventLogHandler} class. The
\var{appname} is used to define the application name as it appears in the
--- 636,641 ----
installed.
! \begin{classdesc}{NTEventLogHandler}{appname\optional{,
! dllname\optional{, logtype}}}
Returns a new instance of the \class{NTEventLogHandler} class. The
\var{appname} is used to define the application name as it appears in the
***************
*** 643,647 ****
The \var{dllname} should give the fully qualified pathname of a .dll or .exe
which contains message definitions to hold in the log (if not specified,
! \constant{"win32service.pyd"} is used - this is installed with the Win32
extensions and contains some basic placeholder message definitions.
Note that use of these placeholders will make your event logs big, as the
--- 643,647 ----
The \var{dllname} should give the fully qualified pathname of a .dll or .exe
which contains message definitions to hold in the log (if not specified,
! \code{'win32service.pyd'} is used - this is installed with the Win32
extensions and contains some basic placeholder message definitions.
Note that use of these placeholders will make your event logs big, as the
***************
*** 649,654 ****
to pass in the name of your own .dll or .exe which contains the message
definitions you want to use in the event log). The \var{logtype} is one of
! \constant{"Application"}, \constant{"System"} or \constant{"Security"}, and
! defaults to \constant{"Application"}.
\end{classdesc}
--- 649,654 ----
to pass in the name of your own .dll or .exe which contains the message
definitions you want to use in the event log). The \var{logtype} is one of
! \code{'Application'}, \code{'System'} or \code{'Security'}, and
! defaults to \code{'Application'}.
\end{classdesc}
***************
*** 688,692 ****
you could use a dictionary lookup to get the message ID. This
version returns 1, which is the base message ID in
! \constant{win32service.pyd}.
\end{methoddesc}
--- 688,692 ----
you could use a dictionary lookup to get the message ID. This
version returns 1, which is the base message ID in
! \file{win32service.pyd}.
\end{methoddesc}
***************
*** 798,802 ****
base
\class{Formatter} allows a formatting string to be specified. If none is
! supplied, the default value of "\%s(message)\\n" is used.
A Formatter can be initialized with a format string which makes use of
--- 798,802 ----
base
\class{Formatter} allows a formatting string to be specified. If none is
! supplied, the default value of \code{'\%(message)s\e'} is used.
A Formatter can be initialized with a format string which makes use of
***************
*** 810,835 ****
Currently, the useful mapping keys in a LogRecord are:
! \begin{tableii}{l|l}{formats}{Format}{Description}
! \lineii{\%(name)s}{Name of the logger (logging channel).}
! \lineii{\%(levelno)s}{Numeric logging level for the message (DEBUG, INFO,
! WARNING, ERROR, CRITICAL).}
! \lineii{\%(levelname)s}{Text logging level for the message ("DEBUG", "INFO",
! "WARNING", "ERROR", "CRITICAL").}
! \lineii{\%(pathname)s}{Full pathname of the source file where the logging
! call was issued (if available).}
! \lineii{\%(filename)s}{Filename portion of pathname.}
! \lineii{\%(module)s}{Module (name portion of filename).}
! \lineii{\%(lineno)d}{Source line number where the logging call was issued
! (if available).}
! \lineii{\%(created)f}{Time when the LogRecord was created (as returned by
! \code{time.time()}).}
! \lineii{\%(asctime)s}{Human-readable time when the LogRecord was created.
! By default this is of the form ``2003-07-08 16:49:45,896'' (the numbers
! after the comma are millisecond portion of the time).}
! \lineii{\%(msecs)d}{Millisecond portion of the time when the LogRecord
! was created.}
! \lineii{\%(thread)d}{Thread ID (if available).}
! \lineii{\%(process)d}{Process ID (if available).}
! \lineii{\%(message)s}{The logged message, computed as msg \% args.}
\end{tableii}
--- 810,840 ----
Currently, the useful mapping keys in a LogRecord are:
! \begin{tableii}{l|l}{code}{Format}{Description}
! \lineii{\%(name)s} {Name of the logger (logging channel).}
! \lineii{\%(levelno)s} {Numeric logging level for the message
! (\constant{DEBUG}, \constant{INFO},
! \constant{WARNING}, \constant{ERROR},
! \constant{CRITICAL}).}
! \lineii{\%(levelname)s}{Text logging level for the message
! (\code{'DEBUG'}, \code{'INFO'},
! \code{'WARNING'}, \code{'ERROR'},
! \code{'CRITICAL'}).}
! \lineii{\%(pathname)s} {Full pathname of the source file where the logging
! call was issued (if available).}
! \lineii{\%(filename)s} {Filename portion of pathname.}
! \lineii{\%(module)s} {Module (name portion of filename).}
! \lineii{\%(lineno)d} {Source line number where the logging call was issued
! (if available).}
! \lineii{\%(created)f} {Time when the LogRecord was created (as
! returned by \function{time.time()}).}
! \lineii{\%(asctime)s} {Human-readable time when the LogRecord was created.
! By default this is of the form
! ``2003-07-08 16:49:45,896'' (the numbers after the
! comma are millisecond portion of the time).}
! \lineii{\%(msecs)d} {Millisecond portion of the time when the
! \class{LogRecord} was created.}
! \lineii{\%(thread)d} {Thread ID (if available).}
! \lineii{\%(process)d} {Process ID (if available).}
! \lineii{\%(message)s} {The logged message, computed as \code{msg \% args}.}
\end{tableii}
***************
*** 838,842 ****
instance is initialized with a format string for the message as a whole,
as well as a format string for the date/time portion of a message. If
! no \var{fmt} is specified, "\%(message)s" is used. If no \var{datefmt}
is specified, the ISO8601 date format is used.
\end{classdesc}
--- 843,847 ----
instance is initialized with a format string for the message as a whole,
as well as a format string for the date/time portion of a message. If
! no \var{fmt} is specified, \code{\%(message)s'} is used. If no \var{datefmt}
is specified, the ISO8601 date format is used.
\end{classdesc}
***************
*** 848,852 ****
are carried out. The \var{message} attribute of the record is computed
using \var{msg} \% \var{args}. If the formatting string contains
! \constant{"(asctime)"}, \method{formatTime()} is called to format the
event time. If there is exception information, it is formatted using
\method{formatException()} and appended to the message.
--- 853,857 ----
are carried out. The \var{message} attribute of the record is computed
using \var{msg} \% \var{args}. If the formatting string contains
! \code{'(asctime)'}, \method{formatTime()} is called to format the
event time. If there is exception information, it is formatted using
\method{formatException()} and appended to the message.
***************
*** 906,910 ****
\begin{classdesc}{LogRecord}{name, lvl, pathname, lineno, msg, args,
! exc_info}
Returns an instance of \class{LogRecord} initialized with interesting
information. The \var{name} is the logger name; \var{lvl} is the
--- 911,915 ----
\begin{classdesc}{LogRecord}{name, lvl, pathname, lineno, msg, args,
! exc_info}
Returns an instance of \class{LogRecord} initialized with interesting
information. The \var{name} is the logger name; \var{lvl} is the
***************
*** 932,939 ****
\subsubsection{Configuration functions}
! The following functions allow the logging module to be configured. Before
! they can be used, you must import \module{logging.config}. Their use is optional -
! you can configure the logging module entirely by making calls to the main
! API (defined in \module{logging} itself) and defining handlers which are declared
either in \module{logging} or \module{logging.handlers}.
--- 937,945 ----
\subsubsection{Configuration functions}
! The following functions allow the logging module to be
! configured. Before they can be used, you must import
! \module{logging.config}. Their use is optional --- you can configure
! the logging module entirely by making calls to the main API (defined
! in \module{logging} itself) and defining handlers which are declared
either in \module{logging} or \module{logging.handlers}.