3
\e * @ s d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl m
Z
dddddd d
d d d
ddddddddddddddd d d d d d!d"d#d$d%d&d'd(d)d*d+d,d-g*Z y ddl Z W n e
k
r dZ Y nX d.Zd/Zd0Zd1Zej Zd2Zd2Zd2Zd2Zd3ZeZd4Zd5ZeZd6Z d7Z dZ ededede de de diZ eeeeee e e d8Z d9d Z!d:d Z"e#ed;rndd? Z$ej%j&e"j'j(Z)d@dA Z*e re j+ Z,ndZ,dBdC Z-dDdE Z.G dFd de/Z0e0a1dGd+ Z2dHd* Z3dId% Z4G dJdK dKe/Z5G dLdM dMe5Z6G dNdO dOe5Z7dPZ8e5e8fe6dQfe7dRfdSZ9G dTd d e/Z:e: Z;G dUd de/Zej? Z@g ZAdYdZ ZBd[d\ ZCG d]d
d
e>ZDG d^d deDZEG d_d
d
eEZFG d`da daeEZGeGeZHeHZIG dbdc dce/ZJddd& ZKded" ZLG dfdg dge/ZMG dhd de>ZNG didj djeNZOeNaPG dkd de/ZQeOeZReReN_ReMeNjReN_Sdld ZTd}dmd!ZUdnd ZVeVZWdod ZXd2dpdqd ZYdrd) ZZdsd( Z[dtd# Z\dud Z]dvd$ Z^dwd Z_eAfdxd'Z`ddlaZaeajbe` G dyd deDZcdadd~dzd{Zed|d ZfdS )z
Logging package for Python. Based on PEP 282 and comments thereto in
comp.lang.python.
Copyright (C) 2001-2016 Vinay Sajip. All Rights Reserved.
To use, simply 'import logging' and log away!
N)Template BASIC_FORMATBufferingFormatterCRITICALDEBUGERRORFATAL FileHandlerFilter FormatterHandlerINFO LogRecordLogger
LoggerAdapterNOTSET NullHandler
StreamHandlerWARNWARNING addLevelName basicConfigcaptureWarningscriticaldebugdisableerror exceptionfatal getLevelName getLoggergetLoggerClassinfolog
makeLogRecordsetLoggerClassshutdownwarnwarninggetLogRecordFactorysetLogRecordFactory
lastResortraiseExceptionsz&Vinay Sajip Z
productionz0.5.1.2z07 February 2010T2 (
)r r r r r r
r r c C s4 t j| }|dk r|S tj| }|dk r,|S d| S )a
Return the textual representation of logging level 'level'.
If the level is one of the predefined levels (CRITICAL, ERROR, WARNING,
INFO, DEBUG) then you get the corresponding string. If you have
associated levels with names using addLevelName then the name you have
associated with 'level' is returned.
If a numeric value corresponding to one of the defined levels is passed
in, the corresponding string representation is returned.
Otherwise, the string "Level %s" % level is returned.
NzLevel %s) _levelToNameget _nameToLevel)levelresult r7 (/usr/lib64/python3.6/logging/__init__.pyr x s
c
C s( t z|t| < | t|< W dt X dS )zy
Associate 'levelName' with 'level'.
This is used when converting levels to text during message formatting.
N) _acquireLockr2 r4 _releaseLock)r5 Z levelNamer7 r7 r8 r s
_getframec C s
t jdS )N )sysr; r7 r7 r7 r8 s r> c C s. yt W n t k
r( tj d jjS X dS )z5Return the frame object for the caller's stack frame. N) Exceptionr= exc_infotb_framef_backr7 r7 r7 r8 currentframe s rD c C sJ t | tr| }n6t| | kr:| tkr0td| t| }n td| |S )NzUnknown level: %rz*Level not an integer or a valid string: %r)
isinstanceintstrr4
ValueError TypeError)r5 rvr7 r7 r8 _checkLevel s
rK c C s t r t j dS )z
Acquire the module-level lock for serializing access to shared data.
This should be released with _releaseLock().
N)_lockacquirer7 r7 r7 r8 r9 s r9 c C s t r t j dS )zK
Release the module-level lock acquired by calling _acquireLock().
N)rL releaser7 r7 r7 r8 r: s r: c @ s. e Zd ZdZd ddZdd ZeZdd ZdS )
r a
A LogRecord instance represents an event being logged.
LogRecord instances are created every time something is logged. They
contain all the information pertinent to the event being logged. The
main information passed in is in msg and args, which are combined
using str(msg) % args to create the message field of the record. The
record also includes information such as when the record was created,
the source line where the logging call was made, and any exception
information to be logged.
Nc
K s t j } || _|| _|rDt|dkrDt|d tjrD|d rD|d }|| _t|| _ || _
|| _ y&t j
j|| _t j
j| jd | _W n& tttfk
r || _d| _Y nX || _d| _| | _|| _|| _| | _| t| d | _ | jt d | _ t ot rt j! | _"t j# j| _$n d| _"d| _$t%s0d| _&nDd| _&t'j(j)d} | dk rty| j* j| _&W n t+k
rr Y nX t,rt-t drt j. | _/nd| _/dS ) zK
Initialize a logging record with interesting information.
r zUnknown moduleNi Z MainProcessZmultiprocessinggetpid)0timenamemsglenrE collectionsMappingargsr Z levelnamelevelnopathnameospathbasenamefilenamesplitextmodulerI rH AttributeErrorrA exc_text
stack_infolinenoZfuncNamecreatedrF msecs
_startTimeZrelativeCreated
logThreads threading get_identZthreadZcurrent_threadZ
threadNamelogMultiprocessingZ processNamer= modulesr3 Zcurrent_processr@ logProcesseshasattrrP process)
selfrR r5 rY rc rS rW rA funcsinfokwargsctZmpr7 r7 r8 __init__ sR
zLogRecord.__init__c C s d| j | j| j| j| jf S )Nz!)rR rX rY rc rS )ro r7 r7 r8 __str__C s
zLogRecord.__str__c C s t | j}| jr|| j }|S )z
Return the message for this LogRecord.
Return the message for this LogRecord after merging any user-supplied
arguments with the message.
)rG rS rW )ro rS r7 r7 r8
getMessageI s
zLogRecord.getMessage)NN)__name__
__module__ __qualname____doc__rt ru __repr__rv r7 r7 r7 r8 r s
Gc C s | a dS )z
Set the factory to be used when instantiating a log record.
:param factory: A callable which will be called to instantiate
a log record.
N)_logRecordFactory)factoryr7 r7 r8 r* Z s c C s t S )zH
Return the factory to be used when instantiating a log record.
)r| r7 r7 r7 r8 r) d s c C s& t dddddf dd}|jj| |S )z
Make a LogRecord whose attributes are defined by the specified dictionary,
This function is useful for converting a logging event received over
a socket connection (which is sent as a dictionary) into a LogRecord
instance.
N r )r| __dict__update)dictrJ r7 r7 r8 r$ k s c @ s0 e Zd ZdZdZdZdd Zdd Zdd Zd
S ) PercentStylez %(message)sz %(asctime)sz
%(asctime)c C s |p| j | _d S )N)default_format_fmt)ro fmtr7 r7 r8 rt s zPercentStyle.__init__c C s | j j| jdkS )Nr )r findasctime_search)ro r7 r7 r8 usesTime s zPercentStyle.usesTimec C s | j |j S )N)r r )ro recordr7 r7 r8 format s zPercentStyle.formatN) rw rx ry r asctime_formatr rt r r r7 r7 r7 r8 r z s r c @ s e Zd ZdZdZdZdd ZdS )StrFormatStylez {message}z {asctime}z{asctimec C s | j jf |jS )N)r r r )ro r r7 r7 r8 r s zStrFormatStyle.formatN)rw rx ry r r r r r7 r7 r7 r8 r s r c @ s0 e Zd ZdZdZdZdd Zdd Zdd Zd S )
StringTemplateStylez
${message}z
${asctime}c C s |p| j | _t| j| _d S )N)r r r _tpl)ro r r7 r7 r8 rt s z StringTemplateStyle.__init__c C s$ | j }|jddkp"|j| jdkS )Nz$asctimer )r r r )ro r r7 r7 r8 r s z StringTemplateStyle.usesTimec C s | j jf |jS )N)r Z
substituter )ro r r7 r7 r8 r s zStringTemplateStyle.formatN) rw rx ry r r r rt r r r7 r7 r7 r8 r s r z"%(levelname)s:%(name)s:%(message)sz {levelname}:{name}:{message}z ${levelname}:${name}:${message})%{$c @ sZ e Zd ZdZejZdddZdZdZ ddd Z
d
d Z d d
Z dd Z
dd Zdd ZdS )r a
Formatter instances are used to convert a LogRecord to text.
Formatters need to know how a LogRecord is constructed. They are
responsible for converting a LogRecord to (usually) a string which can
be interpreted by either a human or an external system. The base Formatter
allows a formatting string to be specified. If none is supplied, the
the style-dependent default value, "%(message)s", "{message}", or
"${message}", is used.
The Formatter can be initialized with a format string which makes use of
knowledge of the LogRecord attributes - e.g. the default value mentioned
above makes use of the fact that the user's message and arguments are pre-
formatted into a LogRecord's message attribute. Currently, the useful
attributes in a LogRecord are described by:
%(name)s Name of the logger (logging channel)
%(levelno)s Numeric logging level for the message (DEBUG, INFO,
WARNING, ERROR, CRITICAL)
%(levelname)s Text logging level for the message ("DEBUG", "INFO",
"WARNING", "ERROR", "CRITICAL")
%(pathname)s Full pathname of the source file where the logging
call was issued (if available)
%(filename)s Filename portion of pathname
%(module)s Module (name portion of filename)
%(lineno)d Source line number where the logging call was issued
(if available)
%(funcName)s Function name
%(created)f Time when the LogRecord was created (time.time()
return value)
%(asctime)s Textual time when the LogRecord was created
%(msecs)d Millisecond portion of the creation time
%(relativeCreated)d Time in milliseconds when the LogRecord was created,
relative to the time the logging module was loaded
(typically at application startup time)
%(thread)d Thread ID (if available)
%(threadName)s Thread name (if available)
%(process)d Process ID (if available)
%(message)s The result of record.getMessage(), computed just as
the record is emitted
Nr c C sD |t kr tddjt j t | d || _| jj| _|| _dS )a
Initialize the formatter with specified format strings.
Initialize the formatter either with the specified format string, or a
default as described above. Allow for specialized date formatting with
the optional datefmt argument. If datefmt is omitted, you get an
ISO8601-like (or RFC 3339-like) format.
Use a style parameter of '%', '{' or '$' to specify that you want to
use one of %-formatting, :meth:`str.format` (``{}``) formatting or
:class:`string.Template` formatting in your format string.
.. versionchanged:: 3.2
Added the ``style`` parameter.
zStyle must be one of: %s,r N)_STYLESrH joinkeys_styler datefmt)ro r r styler7 r7 r8 rt s
zFormatter.__init__z%Y-%m-%d %H:%M:%Sz%s,%03dc C s@ | j |j}|r tj||}n tj| j|}| j||jf }|S )a%
Return the creation time of the specified LogRecord as formatted text.
This method should be called from format() by a formatter which
wants to make use of a formatted time. This method can be overridden
in formatters to provide for any specific requirement, but the
basic behaviour is as follows: if datefmt (a string) is specified,
it is used with time.strftime() to format the creation time of the
record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used.
The resulting string is returned. This function uses a user-configurable
function to convert the creation time to a tuple. By default,
time.localtime() is used; to change this for a particular formatter
instance, set the 'converter' attribute to a function with the same
signature as time.localtime() or 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.
) converterrd rQ Zstrftimedefault_time_formatdefault_msec_formatre )ro r r rs str7 r7 r8
formatTime s zFormatter.formatTimec C sZ t j }|d }tj|d |d |d| |j }|j |dd dkrV|dd }|S )z
Format and return the specified exception information as a string.
This default implementation just uses
traceback.print_exception()
r? r rO N
r )ioStringIO tracebackprint_exceptiongetvalueclose)ro Zeisiotbr r7 r7 r8 formatException s zFormatter.formatExceptionc C s
| j j S )zK
Check if the format uses the creation time of the record.
)r r )ro r7 r7 r8 r s zFormatter.usesTimec C s | j j|S )N)r r )ro r r7 r7 r8
formatMessage$ s zFormatter.formatMessagec C s |S )aU
This method is provided as an extension point for specialized
formatting of stack information.
The input data is a string as returned from a call to
:func:`traceback.print_stack`, but with the last trailing newline
removed.
The base implementation just returns the value passed in.
r7 )ro rb r7 r7 r8 formatStack' s zFormatter.formatStackc C s |j |_| j r"| j|| j|_| j|}|jrF|jsF| j |j|_|jrn|dd dkrd|d }||j }|j
r|dd dkr|d }|| j |j
}|S )az
Format the specified record as text.
The record's attribute dictionary is used as the operand to a
string formatting operation which yields the returned string.
Before formatting the dictionary, a couple of preparatory steps
are carried out. The message attribute of the record is computed
using LogRecord.getMessage(). If the formatting string uses the
time (as determined by a call to usesTime(), formatTime() is
called to format the event time. If there is exception information,
it is formatted using formatException() and appended to the message.
rO Nr r r ) rv messager r r asctimer rA ra r rb r )ro r r r7 r7 r8 r 4 s
zFormatter.format)NNr )N)rw rx ry rz rQ Z localtimer rt r r r r r r r r r7 r7 r7 r8 r s )
c @ s2 e Zd ZdZd ddZdd Zdd Zd d
ZdS ) r zB
A formatter suitable for formatting a number of records.
Nc C s |r || _ nt| _ dS )zm
Optionally specify a formatter which will be used to format each
individual record.
N)linefmt_defaultFormatter)ro r r7 r7 r8 rt ] s zBufferingFormatter.__init__c C s dS )zE
Return the header string for the specified records.
r~ r7 )ro recordsr7 r7 r8 formatHeaderg s z BufferingFormatter.formatHeaderc C s dS )zE
Return the footer string for the specified records.
r~ r7 )ro r r7 r7 r8 formatFooterm s z BufferingFormatter.formatFooterc C sN d}t |dkrJ|| j| }x |D ]}|| jj| }q$W || j| }|S )zQ
Format the specified records and return the result as a string.
r~ r )rT r r r r )ro r rJ r r7 r7 r8 r s s
zBufferingFormatter.format)N)rw rx ry rz rt r r r r7 r7 r7 r8 r Y s
c @ s" e Zd ZdZdddZdd ZdS ) r
a
Filter instances are used to perform arbitrary filtering of LogRecords.
Loggers and Handlers can optionally use Filter instances to filter
records as desired. The base filter class only allows events which are
below a certain point in the logger hierarchy. For example, a filter
initialized with "A.B" will allow events logged by loggers "A.B",
"A.B.C", "A.B.C.D", "A.B.D" etc. but not "A.BB", "B.A.B" etc. If
initialized with the empty string, all events are passed.
r~ c C s || _ t|| _dS )z
Initialize a filter.
Initialize with the name of the logger which, together with its
children, will have its events allowed through the filter. If no
name is specified, allow every event.
N)rR rT nlen)ro rR r7 r7 r8 rt s zFilter.__init__c C sJ | j dkrdS | j|jkr dS |jj| jd| j dkr:dS |j| j dkS )z
Determine if the specified record is to be logged.
Is the specified record to be logged? Returns 0 for no, nonzero for
yes. If deemed appropriate, the record may be modified in-place.
r TF.)r rR r )ro r r7 r7 r8 filter s
z
Filter.filterN)r~ )rw rx ry rz rt r r7 r7 r7 r8 r
s
c @ s0 e Zd ZdZdd Zdd Zdd Zdd Zd
S ) Filtererz[
A base class for loggers and handlers which allows them to share
common code.
c C s
g | _ dS )zE
Initialize the list of filters to be an empty list.
N)filters)ro r7 r7 r8 rt s zFilterer.__init__c C s || j kr| j j| dS )z;
Add the specified filter to this handler.
N)r append)ro r r7 r7 r8 addFilter s
zFilterer.addFilterc C s || j kr| j j| dS )z@
Remove the specified filter from this handler.
N)r remove)ro r r7 r7 r8 removeFilter s
zFilterer.removeFilterc C s@ d}x6| j D ],}t|dr&|j|}n||}|s d}P q W |S )ah
Determine if a record is loggable by consulting all the filters.
The default is to allow the record to be logged; any filter can veto
this and the record is then dropped. Returns a zero value if a record
is to be dropped, else non-zero.
.. versionchanged:: 3.2
Allow filters to be just callables.
Tr F)r rm r )ro r rJ fr6 r7 r7 r8 r s
zFilterer.filterN)rw rx ry rz rt r r r r7 r7 r7 r8 r s
r c
C sF t tt }}}|rB|rB|rB| z| |kr6|j| W d| X dS )zD
Remove a handler reference from the internal cleanup list.
N)r9 r: _handlerListr )wrrM rN handlersr7 r7 r8 _removeHandlerRef s r c
C s* t ztjtj| t W dt X dS )zL
Add a handler to the internal cleanup list using a weak reference.
N)r9 r r weakrefrefr r: )Zhandlerr7 r7 r8 _addHandlerRef s r c @ s e Zd ZdZefddZdd Zdd ZeeeZ dd Z
d
d Z d d
Z dd Z
dd Zdd Zdd Zdd Zdd Zdd Zd d Zd d Zd S )!r aq
Handler instances dispatch logging events to specific destinations.
The base handler class. Acts as a placeholder which defines the Handler
interface. Handlers can optionally use Formatter instances to format
records as desired. By default, no formatter is specified; in this case,
the 'raw' message as determined by record.message is logged.
c C s4 t j| d| _t|| _d| _t| | j dS )zz
Initializes the instance - basically setting the formatter to None
and the filter list to empty.
N)r rt _namerK r5 formatterr
createLock)ro r5 r7 r7 r8 rt s
zHandler.__init__c C s | j S )N)r )ro r7 r7 r8 get_name s zHandler.get_namec
C s< t z(| jtkrt| j= || _|r,| t|< W d t X d S )N)r9 r _handlersr: )ro rR r7 r7 r8 set_name s
zHandler.set_namec C s t rt j | _nd| _dS )zU
Acquire a thread lock for serializing access to the underlying I/O.
N)rh RLocklock)ro r7 r7 r8 r s zHandler.createLockc C s | j r| j j dS )z.
Acquire the I/O thread lock.
N)r rM )ro r7 r7 r8 rM ) s zHandler.acquirec C s | j r| j j dS )z.
Release the I/O thread lock.
N)r rN )ro r7 r7 r8 rN 0 s zHandler.releasec C s t || _dS )zX
Set the logging level of this handler. level must be an int or a str.
N)rK r5 )ro r5 r7 r7 r8 setLevel7 s zHandler.setLevelc C s | j r| j }nt}|j|S )z
Format the specified record.
If a formatter is set, use it. Otherwise, use the default formatter
for the module.
)r r r )ro r r r7 r7 r8 r = s zHandler.formatc C s t ddS )z
Do whatever it takes to actually log the specified logging record.
This version is intended to be implemented by subclasses and so
raises a NotImplementedError.
z.emit must be implemented by Handler subclassesN)NotImplementedError)ro r r7 r7 r8 emitJ s z Handler.emitc
C s4 | j |}|r0| j z| j| W d| j X |S )a<
Conditionally emit the specified logging record.
Emission depends on filters which may have been added to the handler.
Wrap the actual emission of the record with acquisition/release of
the I/O thread lock. Returns whether the filter passed the record for
emission.
N)r rM r rN )ro r rJ r7 r7 r8 handleT s
zHandler.handlec C s
|| _ dS )z5
Set the formatter for this handler.
N)r )ro r r7 r7 r8 setFormatterf s zHandler.setFormatterc C s dS )z
Ensure all logging output has been flushed.
This version does nothing and is intended to be implemented by
subclasses.
Nr7 )ro r7 r7 r8 flushl s z
Handler.flushc
C s0 t z | jr | jtkr t| j= W dt X dS )a%
Tidy up any resources used by the handler.
This version removes the handler from an internal map of handlers,
_handlers, which is used for handler lookup by name. Subclasses
should ensure that this gets called from overridden close()
methods.
N)r9 r r r: )ro r7 r7 r8 r u s
z
Handler.closec C s t otjrtj \}}}zytjjd tj|||dtj tjjd |j}x&|rvtj j
|j j t
d krv|j}qRW |rtj|tjd ntjjd|j|jf y tjjd|j|jf W n tk
r tjjd Y nX W n tk
r Y nX W d~~~X dS ) aD
Handle errors which occur during an emit() call.
This method should be called from handlers when an exception is
encountered during an emit() call. If raiseExceptions is false,
exceptions get silently ignored. This is what is mostly wanted
for a logging system - most users will not care about errors in
the logging system, they are more interested in application errors.
You could, however, replace this with a custom handler if you wish.
The record which was being processed is passed in to this method.
z--- Logging error ---
Nz Call stack:
r )filez Logged from file %s, line %s
zMessage: %r
Arguments: %s
zwUnable to print the message and arguments - possible formatting error.
Use the traceback above to help find the error.
)r, r= stderrrA writer r rB rZ r[ dirnamef_code co_filename__path__rC print_stackr] rc rS rW r@ OSError)ro r r vr framer7 r7 r8 handleError s.
zHandler.handleErrorc C s t | j}d| jj|f S )Nz <%s (%s)>)r r5 __class__rw )ro r5 r7 r7 r8 r{ s
zHandler.__repr__N)rw rx ry rz r rt r r propertyrR r rM rN r r r r r r r r r{ r7 r7 r7 r8 r s"
-c @ s6 e Zd ZdZdZd ddZdd Zdd Zd
d ZdS )
r z
A handler class which writes logging records, appropriately formatted,
to a stream. Note that this class does not close the stream, as
sys.stdout or sys.stderr may be used.
r Nc C s" t j| |dkrtj}|| _dS )zb
Initialize the handler.
If stream is not specified, sys.stderr is used.
N)r rt r= r stream)ro r r7 r7 r8 rt s
zStreamHandler.__init__c
C s8 | j z | jr&t| jdr&| jj W d| j X dS )z%
Flushes the stream.
r N)rM r rm r rN )ro r7 r7 r8 r s
zStreamHandler.flushc C sV y2| j |}| j}|j| |j| j | j W n tk
rP | j| Y nX dS )a
Emit a record.
If a formatter is specified, it is used to format the record.
The record is then written to the stream with a trailing newline. If
exception information is present, it is formatted using
traceback.print_exception and appended to the stream. If the stream
has an 'encoding' attribute, it is used to determine how to do the
output to the stream.
N)r r r
terminatorr r@ r )ro r rS r r7 r7 r8 r s
zStreamHandler.emitc C s6 t | j}t| jdd}|r$|d7 }d| jj||f S )NrR r~ z <%s %s(%s)>)r r5 getattrr r rw )ro r5 rR r7 r7 r8 r{ s
zStreamHandler.__repr__)N) rw rx ry rz r rt r r r{ r7 r7 r7 r8 r s
c @ s: e Zd ZdZdddZdd Zd d
Zd d Zd
d ZdS )r zO
A handler class which writes formatted logging records to disk files.
aNFc C sT t j|}t jj|| _|| _|| _|| _|r@tj | d| _
nt j | | j dS )zO
Open the specified file and use it as the stream for logging.
N)
rZ fspathr[ abspath baseFilenamemodeencodingdelayr rt r r _open)ro r] r r r r7 r7 r8 rt s
zFileHandler.__init__c C sb | j zJz8| jr@z | j W d| j}d| _t|dr>|j X W dtj| X W d| j X dS )z$
Closes the stream.
Nr )rM r r rm r r rN )ro r r7 r7 r8 r
s
zFileHandler.closec C s t | j| j| jdS )zx
Open the current base file with the (original) mode and encoding.
Return the resulting stream.
)r )openr r r )ro r7 r7 r8 r s zFileHandler._openc C s$ | j dkr| j | _ tj| | dS )z
Emit a record.
If the stream was not opened because 'delay' was specified in the
constructor, open it before calling the superclass's emit.
N)r r r r )ro r r7 r7 r8 r ' s
zFileHandler.emitc C s t | j}d| jj| j|f S )Nz <%s %s (%s)>)r r5 r rw r )ro r5 r7 r7 r8 r{ 2 s
zFileHandler.__repr__)r NF) rw rx ry rz rt r r r r{ r7 r7 r7 r8 r s
c @ s( e Zd ZdZefddZedd ZdS )_StderrHandlerz
This class is like a StreamHandler using sys.stderr, but always uses
whatever sys.stderr is currently set to rather than the value of
sys.stderr at handler construction time.
c C s t j| | dS )z)
Initialize the handler.
N)r rt )ro r5 r7 r7 r8 rt = s z_StderrHandler.__init__c C s t jS )N)r= r )ro r7 r7 r8 r C s z_StderrHandler.streamN)rw rx ry rz r rt r r r7 r7 r7 r8 r 7 s r c @ s e Zd ZdZdd Zdd ZdS ) PlaceHolderz
PlaceHolder instances are used in the Manager logger hierarchy to take
the place of nodes for which no loggers have been defined. This class is
intended for internal use only and not as part of the public API.
c C s |di| _ dS )zY
Initialize with the specified logger being a child of this placeholder.
N) loggerMap)ro aloggerr7 r7 r8 rt U s zPlaceHolder.__init__c C s || j krd| j |< dS )zJ
Add the specified logger as a child of this placeholder.
N)r )ro r r7 r7 r8 r [ s
zPlaceHolder.appendN)rw rx ry rz rt r r7 r7 r7 r8 r O s r c C s( | t kr t| t s td| j | adS )z
Set the class to be used when instantiating a logger. The class should
define __init__() such that only a name argument is required, and the
__init__() should call Logger.__init__()
z(logger not derived from logging.Logger: N)r
issubclassrI rw _loggerClass)klassr7 r7 r8 r% f s
c C s t S )zB
Return the class to be used when instantiating a logger.
)r r7 r7 r7 r8 r! s s c @ s@ e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dS )Managerzt
There is [under normal circumstances] just one Manager instance, which
holds the hierarchy of loggers.
c C s( || _ d| _d| _i | _d| _d| _dS )zT
Initialize the manager with the root node of the logger hierarchy.
r FN)rootr emittedNoHandlerWarning
loggerDict loggerClasslogRecordFactory)ro Zrootnoder7 r7 r8 rt ~ s zManager.__init__c
C s d}t |tstdt z|| jkrv| j| }t |tr|}| jpHt|}| |_|| j|< | j || | j
| n(| jp~t|}| |_|| j|< | j
| W dt X |S )a
Get a logger with the specified name (channel name), creating it
if it doesn't yet exist. This name is a dot-separated hierarchical
name, such as "a", "a.b", "a.b.c" or similar.
If a PlaceHolder existed for the specified name [i.e. the logger
didn't exist but a child of it did], replace it with the created
logger and fix up the parent/child references which pointed to the
placeholder to now point to the logger.
Nz A logger name must be a string) rE rG rI r9 r r r r manager_fixupChildren
_fixupParentsr: )ro rR rJ phr7 r7 r8 r s(
zManager.getLoggerc C s* |t kr t|t s td|j || _dS )zY
Set the class to be used when instantiating a logger with this Manager.
z(logger not derived from logging.Logger: N)r r rI rw r )ro r r7 r7 r8 r% s
zManager.setLoggerClassc C s
|| _ dS )zg
Set the factory to be used when instantiating a log record with this
Manager.
N)r )ro r} r7 r7 r8 r* s zManager.setLogRecordFactoryc C s |j }|jd}d}xn|dkr| r|d| }|| jkrJt|| j|< n$| j| }t|trd|}n
|j| |jdd|d }qW |s| j}||_dS )z
Ensure that there are either loggers or placeholders all the way
from the specified logger to the root of the logger hierarchy.
r Nr rO ) rR rfindr r rE r r r parent)ro r rR irJ Zsubstrobjr7 r7 r8 r s
zManager._fixupParentsc C sH |j }t|}x4|jj D ]&}|jj d| |kr|j|_||_qW dS )zk
Ensure that children of the placeholder ph are connected to the
specified logger.
N)rR rT r r r )ro r r rR Znamelencr7 r7 r8 r s zManager._fixupChildrenN)
rw rx ry rz rt r r% r* r r r7 r7 r7 r8 r y s "
r c @ s e Zd ZdZefddZdd Zdd Zdd Zd
d Z d d
Z
dd Z ddddZ dd Z
e
Zdd Zd2ddZd3d d Zd4d d Zd d! Zd"d# Zd$d% Zd&d' Zd(d) Zd*d+ Zd,d- Zd.d/ Zd0d1 ZdS )5r ar
Instances of the Logger class represent a single logging channel. A
"logging channel" indicates an area of an application. Exactly how an
"area" is defined is up to the application developer. Since an
application can have any number of areas, logging channels are identified
by a unique string. Application areas can be nested (e.g. an area
of "input processing" might include sub-areas "read CSV files", "read
XLS files" and "read Gnumeric files"). To cater for this natural nesting,
channel names are organized into a namespace hierarchy where levels are
separated by periods, much like the Java or Python package namespace. So
in the instance given above, channel names might be "input" for the upper
level, and "input.csv", "input.xls" and "input.gnu" for the sub-levels.
There is no arbitrary limit to the depth of nesting.
c C s6 t j| || _t|| _d| _d| _g | _d| _dS )zJ
Initialize the logger with a name and an optional level.
NTF) r rt rR rK r5 r propagater disabled)ro rR r5 r7 r7 r8 rt s
zLogger.__init__c C s t || _dS )zW
Set the logging level of this logger. level must be an int or a str.
N)rK r5 )ro r5 r7 r7 r8 r s zLogger.setLevelc O s | j tr | jt||f| dS )z
Log 'msg % args' with severity 'DEBUG'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
logger.debug("Houston, we have a %s", "thorny problem", exc_info=1)
N) isEnabledForr _log)ro rS rW rr r7 r7 r8 r s
z Logger.debugc O s | j tr | jt||f| dS )z
Log 'msg % args' with severity 'INFO'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
logger.info("Houston, we have a %s", "interesting problem", exc_info=1)
N)r r
r )ro rS rW rr r7 r7 r8 r" s
z Logger.infoc O s | j tr | jt||f| dS )z
Log 'msg % args' with severity 'WARNING'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
logger.warning("Houston, we have a %s", "bit of a problem", exc_info=1)
N)r r r )ro rS rW rr r7 r7 r8 r( s
zLogger.warningc O s$ t jdtd | j|f|| d S )Nz6The 'warn' method is deprecated, use 'warning' insteadr? )warningsr' DeprecationWarningr( )ro rS rW rr r7 r7 r8 r' * s z Logger.warnc O s | j tr | jt||f| dS )z
Log 'msg % args' with severity 'ERROR'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
logger.error("Houston, we have a %s", "major problem", exc_info=1)
N)r r r )ro rS rW rr r7 r7 r8 r / s
z Logger.errorT)rA c O s | j |f|d|i| dS )zU
Convenience method for logging an ERROR with exception information.
rA N)r )ro rS rA rW rr r7 r7 r8 r ; s zLogger.exceptionc O s | j tr | jt||f| dS )z
Log 'msg % args' with severity 'CRITICAL'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
logger.critical("Houston, we have a %s", "major disaster", exc_info=1)
N)r r r )ro rS rW rr r7 r7 r8 r A s
zLogger.criticalc O s< t |ts trtdndS | j|r8| j|||f| dS )z
Log 'msg % args' with the integer severity 'level'.
To pass exception information, use the keyword argument exc_info with
a true value, e.g.
logger.log(level, "We have a %s", "mysterious problem", exc_info=1)
zlevel must be an integerN)rE rF r, rI r r )ro r5 rS rW rr r7 r7 r8 r# O s
z
Logger.logFc C s t }|dk r|j}d
}xt|dr|j}tjj|j}|tkrH|j}qd}|rt j
}|j d t j
||d |j }|d d kr|dd }|j |j|j|j|f}P qW |S )
z
Find the stack frame of the caller so that we can note the source
file name, line number and function name.
N(unknown file)r (unknown function)r z Stack (most recent call last):
)r rO r )r r r
Nr r )rD rC rm r rZ r[ normcaser _srcfiler r r r r r r f_linenoco_name)ro rb r rJ cor] rq r r7 r7 r8
findCaller` s,
zLogger.findCallerNc
C s^ t |||||||||
} | dk rZx8| D ]0} | dks<| | jkrHtd| | | | j| < q&W | S )zr
A factory method which can be overridden in subclasses to create
specialized LogRecords.
Nr r z$Attempt to overwrite %r in LogRecord)r r )r| r KeyError)
ro rR r5 fnlnorS rW rA rp extrarq rJ keyr7 r7 r8
makeRecord~ s
zLogger.makeRecordc C s d}t r@y| j|\}} }
}W qJ tk
r< d\}} }
Y qJX n
d\}} }
|r|t|trjt|||jf}nt|ts|tj }| j
| j ||| ||||
||
} | j | dS )z
Low-level logging routine which creates a LogRecord and then calls
all the handlers of this logger to handle the record.
N(unknown file)r (unknown function))r r r )r r r )
r r rH rE
BaseExceptiontype
__traceback__tupler= rA r rR r ) ro r5 rS rW rA r rb rq r r rp r r7 r7 r8 r s
z Logger._logc C s | j r | j|r | j| dS )z
Call the handlers for the specified record.
This method is used for unpickled records received from a socket, as
well as those created locally. Logger-level filtering is applied.
N)r r callHandlers)ro r r7 r7 r8 r s z
Logger.handlec
C s. t z|| jkr | jj| W dt X dS )z;
Add the specified handler to this logger.
N)r9 r r r: )ro hdlrr7 r7 r8
addHandler s
zLogger.addHandlerc
C s. t z|| jkr | jj| W dt X dS )z@
Remove the specified handler from this logger.
N)r9 r r r: )ro r r7 r7 r8
removeHandler s
zLogger.removeHandlerc C s2 | }d}x$|r,|j rd}P |js$P q
|j}q
W |S )a
See if this logger has any handlers configured.
Loop through all handlers for this logger and its parents in the
logger hierarchy. Return True if a handler was found, else False.
Stop searching up the hierarchy whenever a logger with the "propagate"
attribute set to zero is found - that will be the last logger which
is checked for the existence of handlers.
FT)r r r )ro r rJ r7 r7 r8 hasHandlers s
zLogger.hasHandlersc C s | }d}xH|rPx,|j D ]"}|d }|j|jkr|j| qW |jsHd}q
|j}q
W |dkrtrv|jtjkrtj| n(tr| jj rt
j j d| j
d| j_ dS )a
Pass a record to all relevant handlers.
Loop through all handlers for this logger and its parents in the
logger hierarchy. If no handler was found, output a one-off error
message to sys.stderr. Stop searching up the hierarchy whenever a
logger with the "propagate" attribute set to zero is found - that
will be the last logger whose handlers are called.
r rO Nz+No handlers could be found for logger "%s"
T)r rX r5 r r r r+ r, r r r= r r rR )ro r r foundr r7 r7 r8 r s$
zLogger.callHandlersc C s$ | }x|r |j r|j S |j}qW tS )z
Get the effective level for this logger.
Loop through this logger and its parents in the logger hierarchy,
looking for a non-zero logging level. Return the first one found.
)r5 r r )ro loggerr7 r7 r8 getEffectiveLevel s
zLogger.getEffectiveLevelc C s | j j|krdS || j kS )z;
Is this logger enabled for level 'level'?
F)r r r$ )ro r5 r7 r7 r8 r s zLogger.isEnabledForc C s& | j | k rdj| j|f}| jj|S )ab
Get a logger which is a descendant to this one.
This is a convenience method, such that
logging.getLogger('abc').getChild('def.ghi')
is the same as
logging.getLogger('abc.def.ghi')
It's useful, for example, when the parent logger is named using
__name__ rather than a literal string.
r )r r rR r r )ro suffixr7 r7 r8 getChild s
zLogger.getChildc C s t | j }d| jj| j|f S )Nz <%s %s (%s)>)r r$ r rw rR )ro r5 r7 r7 r8 r{ # s zLogger.__repr__)F)NNN)NNF) rw rx ry rz r rt r r r" r( r' r r r r r# r r r r r r r! r r$ r r& r{ r7 r7 r7 r8 r s0
c @ s e Zd ZdZdd ZdS )
RootLoggerz
A root logger is not that different to any other logger, except that
it must have a logging level and there is only one instance of it in
the hierarchy.
c C s t j| d| dS )z=
Initialize the logger with the name "root".
r N)r rt )ro r5 r7 r7 r8 rt . s zRootLogger.__init__N)rw rx ry rz rt r7 r7 r7 r8 r' ( s r' c @ s e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
ddddZ dd Z dd Z
dd Zdd Zd d Zd d Zd+d"d#Zed$d% Zejd&d% Zed'd( Zd)d* Zd S ),r zo
An adapter for loggers which makes it easier to specify contextual
information in logging output.
c C s || _ || _dS )ax
Initialize the adapter with a logger and a dict-like object which
provides contextual information. This constructor signature allows
easy stacking of LoggerAdapters, if so desired.
You can effectively pass keyword arguments as shown in the
following example:
adapter = LoggerAdapter(someLogger, dict(p1=v1, p2="v2"))
N)r# r )ro r# r r7 r7 r8 rt < s zLoggerAdapter.__init__c C s | j |d< ||fS )a
Process the logging message and keyword arguments passed in to
a logging call to insert contextual information. You can either
manipulate the message itself, the keyword args or both. Return
the message and kwargs modified (or not) to suit your needs.
Normally, you'll only need to override this one method in a
LoggerAdapter subclass for your specific needs.
r )r )ro rS rr r7 r7 r8 rn J s
zLoggerAdapter.processc O s | j t|f|| dS )zA
Delegate a debug call to the underlying logger.
N)r# r )ro rS rW rr r7 r7 r8 r Z s zLoggerAdapter.debugc O s | j t|f|| dS )zA
Delegate an info call to the underlying logger.
N)r# r
)ro rS rW rr r7 r7 r8 r" ` s zLoggerAdapter.infoc O s | j t|f|| dS )zC
Delegate a warning call to the underlying logger.
N)r# r )ro rS rW rr r7 r7 r8 r( f s zLoggerAdapter.warningc O s$ t jdtd | j|f|| d S )Nz6The 'warn' method is deprecated, use 'warning' insteadr? )r r' r r( )ro rS rW rr r7 r7 r8 r' l s zLoggerAdapter.warnc O s | j t|f|| dS )zB
Delegate an error call to the underlying logger.
N)r# r )ro rS rW rr r7 r7 r8 r q s zLoggerAdapter.errorT)rA c O s | j t|f|d|i| dS )zF
Delegate an exception call to the underlying logger.
rA N)r# r )ro rS rA rW rr r7 r7 r8 r w s zLoggerAdapter.exceptionc O s | j t|f|| dS )zD
Delegate a critical call to the underlying logger.
N)r# r )ro rS rW rr r7 r7 r8 r } s zLoggerAdapter.criticalc O s4 | j |r0| j||\}}| jj||f|| dS )z
Delegate a log call to the underlying logger, after adding
contextual information from this adapter instance.
N)r rn r# r# )ro r5 rS rW rr r7 r7 r8 r# s
zLoggerAdapter.logc C s | j jj|krdS || j kS )z;
Is this logger enabled for level 'level'?
F)r# r r r$ )ro r5 r7 r7 r8 r s zLoggerAdapter.isEnabledForc C s | j j| dS )zC
Set the specified level on the underlying logger.
N)r# r )ro r5 r7 r7 r8 r s zLoggerAdapter.setLevelc C s
| j j S )zD
Get the effective level for the underlying logger.
)r# r$ )ro r7 r7 r8 r$ s z LoggerAdapter.getEffectiveLevelc C s
| j j S )z@
See if the underlying logger has any handlers.
)r# r! )ro r7 r7 r8 r! s zLoggerAdapter.hasHandlersNFc C s | j j||||||dS )zX
Low-level log implementation, proxied to allow nested logger adapters.
)rA r rb )r# r )ro r5 rS rW rA r rb r7 r7 r8 r s zLoggerAdapter._logc C s | j jS )N)r# r )ro r7 r7 r8 r s zLoggerAdapter.managerc C s || j _d S )N)r# r )ro valuer7 r7 r8 r s c C s | j jS )N)r# rR )ro r7 r7 r8 rR s zLoggerAdapter.namec C s& | j }t|j }d| jj|j|f S )Nz <%s %s (%s)>)r# r r$ r rw rR )ro r# r5 r7 r7 r8 r{ s zLoggerAdapter.__repr__)NNF)rw rx ry rz rt rn r r" r( r' r r r r# r r r$ r! r r r setterrR r{ r7 r7 r7 r8 r 6 s(
c
K s t zjttjdkrp| jdd}|dkrHd| kr`d| kr`tdnd| ksXd| kr`td|dkr| jdd}| jdd }|rt||}n| jdd}t|}|g}| jd
d}| jd d }|tkrtd
dj tj
| jdt| d }t |||} x.|D ]&}|j dkr |j
| tj| qW | jdd}
|
dk rPtj|
| rpdj | j
} td| W dt X dS )a
Do basic configuration for the logging system.
This function does nothing if the root logger already has handlers
configured. It is a convenience method intended for use by simple scripts
to do one-shot configuration of the logging package.
The default behaviour is to create a StreamHandler which writes to
sys.stderr, set a formatter using the BASIC_FORMAT format string, and
add the handler to the root logger.
A number of optional keyword arguments may be specified, which can alter
the default behaviour.
filename Specifies that a FileHandler be created, using the specified
filename, rather than a StreamHandler.
filemode Specifies the mode to open the file, if filename is specified
(if filemode is unspecified, it defaults to 'a').
format Use the specified format string for the handler.
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.
stream Use the specified stream to initialize the StreamHandler. Note
that this argument is incompatible with 'filename' - if both
are present, 'stream' is ignored.
handlers If specified, this should be an iterable of already created
handlers, which will be added to the root handler. Any handler
in the list which does not have a formatter assigned will be
assigned the formatter created in this function.
Note that you could specify a stream created using open(filename, mode)
rather than passing the filename and mode in. However, it should be
remembered that StreamHandler does not close its stream (since it may be
using sys.stdout or sys.stderr), whereas FileHandler closes its stream
when the handler is closed.
.. versionchanged:: 3.2
Added the ``style`` parameter.
.. versionchanged:: 3.3
Added the ``handlers`` parameter. A ``ValueError`` is now thrown for
incompatible arguments (e.g. ``handlers`` specified together with
``filename``/``filemode``, or ``filename``/``filemode`` specified
together with ``stream``, or ``handlers`` specified together with
``stream``.
r r Nr r] z8'stream' and 'filename' should not be specified togetherzG'stream' or 'filename' should not be specified together with 'handlers'filemoder r r r zStyle must be one of: %sr r rO r5 z, z Unrecognised argument(s): %s)r9 rT r r poprH r r r r r r r r r r r: ) rr r r] r hr Zdfsr Zfsr r5 r r7 r7 r8 r sF 4
c C s | rt jj| S tS dS )z
Return a logger with the specified name, creating it if necessary.
If no name is specified, return the root logger.
N)r r r r )rR r7 r7 r8 r . s c O s* t tjdkrt tj| f|| dS )z
Log a message with severity 'CRITICAL' on the root logger. If the logger
has no handlers, call basicConfig() to add a console handler with a
pre-defined format.
r N)rT r r r r )rS rW rr r7 r7 r8 r 9 s c O s* t tjdkrt tj| f|| dS )z
Log a message with severity 'ERROR' on the root logger. If the logger has
no handlers, call basicConfig() to add a console handler with a pre-defined
format.
r N)rT r r r r )rS rW rr r7 r7 r8 r E s )rA c O s t | f|d|i| dS )z
Log a message with severity 'ERROR' on the root logger, with exception
information. If the logger has no handlers, basicConfig() is called to add
a console handler with a pre-defined format.
rA N)r )rS rA rW rr r7 r7 r8 r O s c O s* t tjdkrt tj| f|| dS )z
Log a message with severity 'WARNING' on the root logger. If the logger has
no handlers, call basicConfig() to add a console handler with a pre-defined
format.
r N)rT r r r r( )rS rW rr r7 r7 r8 r( W s c O s" t jdtd t| f|| d S )Nz8The 'warn' function is deprecated, use 'warning' insteadr? )r r' r r( )rS rW rr r7 r7 r8 r' a s c O s* t tjdkrt tj| f|| dS )z
Log a message with severity 'INFO' on the root logger. If the logger has
no handlers, call basicConfig() to add a console handler with a pre-defined
format.
r N)rT r r r r" )rS rW rr r7 r7 r8 r" f s c O s* t tjdkrt tj| f|| dS )z
Log a message with severity 'DEBUG' on the root logger. If the logger has
no handlers, call basicConfig() to add a console handler with a pre-defined
format.
r N)rT r r r r )rS rW rr r7 r7 r8 r p s c O s, t tjdkrt tj| |f|| dS )z
Log 'msg % args' with the integer severity 'level' on the root logger. If
the logger has no handlers, call basicConfig() to add a console handler
with a pre-defined format.
r N)rT r r r r# )r5 rS rW rr r7 r7 r8 r# z s c C s | t j_dS )zB
Disable all logging calls of severity 'level' and below.
N)r r r )r5 r7 r7 r8 r s c C s xt | dd D ]l}yT| }|rhz:y |j |j |j W n ttfk
rX Y nX W d|j X W q trx Y qX qW dS )z
Perform any cleanup actions in the logging system (e.g. flushing
buffers).
Should be called at application exit.
N)reversedrM r r r rH rN r, )Z handlerListr r, r7 r7 r8 r& s
c @ s( e Zd ZdZdd Zdd Zdd ZdS ) r a
This handler does nothing. It's intended to be used to avoid the
"No handlers could be found for logger XXX" one-off warning. This is
important for library code, which may contain code to log events. If a user
of the library does not configure logging, the one-off warning might be
produced; to avoid this, the library developer simply needs to instantiate
a NullHandler and add it to the top-level logger of the library module or
package.
c C s dS )zStub.Nr7 )ro r r7 r7 r8 r s zNullHandler.handlec C s dS )zStub.Nr7 )ro r r7 r7 r8 r s zNullHandler.emitc C s
d | _ d S )N)r )ro r7 r7 r8 r s zNullHandler.createLockN)rw rx ry rz r r r r7 r7 r7 r8 r s c C s` |dk r$t dk r\t | ||||| n8tj| ||||}td}|jsP|jt |jd| dS )a
Implementation of showwarnings which redirects to logging, which will first
check to see if the file parameter is None. If a file is specified, it will
delegate to the original warnings implementation of showwarning. Otherwise,
it will call warnings.formatwarning and will log the resulting string to a
warnings logger named "py.warnings" with level logging.WARNING.
Nz py.warningsz%s)_warnings_showwarningr
formatwarningr r r r r( )r categoryr] rc r liner r# r7 r7 r8 _showwarning s r2 c C s0 | rt dkr,tja tt_nt dk r,t t_da dS )z
If capture is true, redirect all warnings to the logging package.
If capture is False, ensure that warnings are not redirected to logging
but to their original destinations.
N)r. r showwarningr2 )Zcapturer7 r7 r8 r s )N)NN)grz r= rZ rQ r r r r rU stringr __all__rh ImportError
__author__Z
__status__ __version__Z__date__rf r, rg rj rl r r r r r r
r r r2 r4 r r rm rD r[ r __code__r r rK r rL r9 r: objectr r| r* r) r$ r r r r r r r r r
r WeakValueDictionaryr r r r r r r r Z_defaultLastResortr+ r r% r! r r r' r r r r r r r r r r r( r' r" r r# r r& atexitregisterr r. r2 r r7 r7 r7 r8 s @
i
.*%4
>;E
l E b