__init__.py 64.6 KB
Newer Older
1
# Copyright 2001-2012 by Vinay Sajip. All Rights Reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
#
# Permission to use, copy, modify, and distribute this software and its
# documentation for any purpose and without fee is hereby granted,
# provided that the above copyright notice appear in all copies and that
# both that copyright notice and this permission notice appear in
# supporting documentation, and that the name of Vinay Sajip
# not be used in advertising or publicity pertaining to distribution
# of the software without specific, written prior permission.
# VINAY SAJIP DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
# ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
# VINAY SAJIP BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
# ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
# IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

"""
Logging package for Python. Based on PEP 282 and comments thereto in
19
comp.lang.python.
20

21
Copyright (C) 2001-2012 Vinay Sajip. All Rights Reserved.
22 23 24 25

To use, simply 'import logging' and log away!
"""

26
import sys, os, time, io, traceback, warnings, weakref
27
from string import Template
28

Christian Heimes's avatar
Christian Heimes committed
29
__all__ = ['BASIC_FORMAT', 'BufferingFormatter', 'CRITICAL', 'DEBUG', 'ERROR',
30 31 32 33 34
           'FATAL', 'FileHandler', 'Filter', 'Formatter', 'Handler', 'INFO',
           'LogRecord', 'Logger', 'LoggerAdapter', 'NOTSET', 'NullHandler',
           'StreamHandler', 'WARN', 'WARNING', 'addLevelName', 'basicConfig',
           'captureWarnings', 'critical', 'debug', 'disable', 'error',
           'exception', 'fatal', 'getLevelName', 'getLogger', 'getLoggerClass',
35
           'info', 'log', 'makeLogRecord', 'setLoggerClass', 'warn', 'warning',
36
           'getLogRecordFactory', 'setLogRecordFactory', 'lastResort']
37

38 39
try:
    import threading
40
except ImportError: #pragma: no cover
41
    threading = None
42 43

__author__  = "Vinay Sajip <vinay_sajip@red-dove.com>"
44
__status__  = "production"
45 46
__version__ = "0.5.1.2"
__date__    = "07 February 2010"
47 48 49 50 51 52

#---------------------------------------------------------------------------
#   Miscellaneous module data
#---------------------------------------------------------------------------

#
53
# _srcfile is used when walking the stack to check when we've got the first
54
# caller stack frame.
55
#
56 57
if hasattr(sys, 'frozen'): #support for py2exe
    _srcfile = "logging%s__init__%s" % (os.sep, __file__[-4:])
58
else:
59 60
    _srcfile = __file__
_srcfile = os.path.normcase(_srcfile)
61

62

63 64 65 66 67 68 69 70 71
if hasattr(sys, '_getframe'):
    currentframe = lambda: sys._getframe(3)
else: #pragma: no cover
    def currentframe():
        """Return the frame object for the caller's stack frame."""
        try:
            raise Exception
        except:
            return sys.exc_info()[2].tb_frame.f_back
72

73 74 75 76
# _srcfile is only used in conjunction with sys._getframe().
# To provide compatibility with older versions of Python, set _srcfile
# to None if _getframe() is not available; this value will prevent
# findCaller() from being called.
77 78
#if not hasattr(sys, "_getframe"):
#    _srcfile = None
79

80 81 82 83 84 85 86 87 88
#
#_startTime is used as the base when calculating the relative time of events
#
_startTime = time.time()

#
#raiseExceptions is used to see if exceptions during handling should be
#propagated
#
89
raiseExceptions = True
90

91 92 93
#
# If you don't want threading information in the log, set this to zero
#
94
logThreads = True
95

Jesse Noller's avatar
Jesse Noller committed
96 97 98
#
# If you don't want multiprocessing information in the log, set this to zero
#
99
logMultiprocessing = True
Jesse Noller's avatar
Jesse Noller committed
100

101 102 103
#
# If you don't want process information in the log, set this to zero
#
104
logProcesses = True
105

106 107 108 109 110 111 112 113 114 115
#---------------------------------------------------------------------------
#   Level related stuff
#---------------------------------------------------------------------------
#
# Default levels and level names, these can be replaced with any positive set
# of values having corresponding names. There is a pseudo-level, NOTSET, which
# is only really there as a lower limit for user-defined levels. Handlers and
# loggers are initialized with NOTSET so that they will log all messages, even
# at user-defined levels.
#
116

117 118 119
CRITICAL = 50
FATAL = CRITICAL
ERROR = 40
120 121
WARNING = 30
WARN = WARNING
122 123 124 125 126 127 128
INFO = 20
DEBUG = 10
NOTSET = 0

_levelNames = {
    CRITICAL : 'CRITICAL',
    ERROR : 'ERROR',
129
    WARNING : 'WARNING',
130 131 132 133 134
    INFO : 'INFO',
    DEBUG : 'DEBUG',
    NOTSET : 'NOTSET',
    'CRITICAL' : CRITICAL,
    'ERROR' : ERROR,
135 136
    'WARN' : WARNING,
    'WARNING' : WARNING,
137 138 139 140 141 142 143 144 145
    'INFO' : INFO,
    'DEBUG' : DEBUG,
    'NOTSET' : NOTSET,
}

def getLevelName(level):
    """
    Return the textual representation of logging level 'level'.

146
    If the level is one of the predefined levels (CRITICAL, ERROR, WARNING,
147 148
    INFO, DEBUG) then you get the corresponding string. If you have
    associated levels with names using addLevelName then the name you have
149 150 151 152 153 154
    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.
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
    """
    return _levelNames.get(level, ("Level %s" % level))

def addLevelName(level, levelName):
    """
    Associate 'levelName' with 'level'.

    This is used when converting levels to text during message formatting.
    """
    _acquireLock()
    try:    #unlikely to cause an exception, but you never know...
        _levelNames[level] = levelName
        _levelNames[levelName] = level
    finally:
        _releaseLock()

171 172 173 174 175 176 177 178 179 180 181
def _checkLevel(level):
    if isinstance(level, int):
        rv = level
    elif str(level) == level:
        if level not in _levelNames:
            raise ValueError("Unknown level: %r" % level)
        rv = _levelNames[level]
    else:
        raise TypeError("Level not an integer or a valid string: %r" % level)
    return rv

182 183 184 185 186 187
#---------------------------------------------------------------------------
#   Thread-related stuff
#---------------------------------------------------------------------------

#
#_lock is used to serialize access to shared data structures in this module.
188 189 190
#This needs to be an RLock because fileConfig() creates and configures
#Handlers, and so might arbitrary user threads. Since Handler code updates the
#shared dictionary _handlers, it needs to acquire the lock. But if configuring,
191 192 193
#the lock would already have been acquired - so we need an RLock.
#The same argument applies to Loggers and Manager.loggerDict.
#
194
if threading:
195
    _lock = threading.RLock()
196
else: #pragma: no cover
197 198
    _lock = None

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219

def _acquireLock():
    """
    Acquire the module-level lock for serializing access to shared data.

    This should be released with _releaseLock().
    """
    if _lock:
        _lock.acquire()

def _releaseLock():
    """
    Release the module-level lock acquired by calling _acquireLock().
    """
    if _lock:
        _lock.release()

#---------------------------------------------------------------------------
#   The logging record
#---------------------------------------------------------------------------

220
class LogRecord(object):
221 222 223 224 225 226 227 228 229 230 231
    """
    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.
    """
232
    def __init__(self, name, level, pathname, lineno,
233
                 msg, args, exc_info, func=None, sinfo=None, **kwargs):
234 235 236 237 238 239
        """
        Initialize a logging record with interesting information.
        """
        ct = time.time()
        self.name = name
        self.msg = msg
240 241 242 243 244 245 246 247 248
        #
        # The following statement allows passing of a dictionary as a sole
        # argument, so that you can do something like
        #  logging.debug("a %(a)d b %(b)s", {'a':1, 'b':2})
        # Suggested by Stefan Behnel.
        # Note that without the test for args[0], we get a problem because
        # during formatting, we test to see if the arg is present using
        # 'if self.args:'. If the event being logged is e.g. 'Value is %d'
        # and if the passed arg fails 'if self.args:' then no formatting
249
        # is done. For example, logger.warning('Value is %d', 0) would log
250 251 252
        # 'Value is %d' instead of 'Value is 0'.
        # For the use case of passing a dictionary, this should not be a
        # problem.
253
        if args and len(args) == 1 and isinstance(args[0], dict) and args[0]:
254
            args = args[0]
255 256 257 258 259 260 261
        self.args = args
        self.levelname = getLevelName(level)
        self.levelno = level
        self.pathname = pathname
        try:
            self.filename = os.path.basename(pathname)
            self.module = os.path.splitext(self.filename)[0]
262
        except (TypeError, ValueError, AttributeError):
263 264 265
            self.filename = pathname
            self.module = "Unknown module"
        self.exc_info = exc_info
266
        self.exc_text = None      # used to cache the traceback text
267
        self.stack_info = sinfo
268
        self.lineno = lineno
269
        self.funcName = func
270
        self.created = ct
271
        self.msecs = (ct - int(ct)) * 1000
272
        self.relativeCreated = (self.created - _startTime) * 1000
273 274
        if logThreads and threading:
            self.thread = threading.get_ident()
275
            self.threadName = threading.current_thread().name
276
        else: # pragma: no cover
277
            self.thread = None
278
            self.threadName = None
279
        if not logMultiprocessing: # pragma: no cover
Jesse Noller's avatar
Jesse Noller committed
280
            self.processName = None
Benjamin Peterson's avatar
Benjamin Peterson committed
281
        else:
282 283 284 285 286 287 288 289 290
            self.processName = 'MainProcess'
            mp = sys.modules.get('multiprocessing')
            if mp is not None:
                # Errors may occur if multiprocessing has not finished loading
                # yet - e.g. if a custom import hook causes third-party code
                # to run when multiprocessing calls import. See issue 8200
                # for an example
                try:
                    self.processName = mp.current_process().name
291
                except Exception: #pragma: no cover
292
                    pass
293
        if logProcesses and hasattr(os, 'getpid'):
294 295 296
            self.process = os.getpid()
        else:
            self.process = None
297 298 299 300 301 302 303 304 305 306 307 308

    def __str__(self):
        return '<LogRecord: %s, %s, %s, %s, "%s">'%(self.name, self.levelno,
            self.pathname, self.lineno, self.msg)

    def getMessage(self):
        """
        Return the message for this LogRecord.

        Return the message for this LogRecord after merging any user-supplied
        arguments with the message.
        """
309
        msg = str(self.msg)
310 311 312 313
        if self.args:
            msg = msg % self.args
        return msg

314 315 316
#
#   Determine which class to use when instantiating log records.
#
317
_logRecordFactory = LogRecord
318

319
def setLogRecordFactory(factory):
320
    """
321
    Set the factory to be used when instantiating a log record.
322 323 324

    :param factory: A callable which will be called to instantiate
    a log record.
325
    """
326 327
    global _logRecordFactory
    _logRecordFactory = factory
328

329
def getLogRecordFactory():
330
    """
331
    Return the factory to be used when instantiating a log record.
332 333
    """

334
    return _logRecordFactory
335

336 337 338 339 340 341 342
def makeLogRecord(dict):
    """
    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.
    """
343
    rv = _logRecordFactory(None, None, "", 0, "", (), None, None)
344 345 346
    rv.__dict__.update(dict)
    return rv

347 348 349 350
#---------------------------------------------------------------------------
#   Formatter classes and functions
#---------------------------------------------------------------------------

351 352 353 354
class PercentStyle(object):

    default_format = '%(message)s'
    asctime_format = '%(asctime)s'
355
    asctime_search = '%(asctime)'
356 357 358 359 360

    def __init__(self, fmt):
        self._fmt = fmt or self.default_format

    def usesTime(self):
361
        return self._fmt.find(self.asctime_search) >= 0
362 363 364 365 366 367 368

    def format(self, record):
        return self._fmt % record.__dict__

class StrFormatStyle(PercentStyle):
    default_format = '{message}'
    asctime_format = '{asctime}'
369
    asctime_search = '{asctime'
370 371 372 373 374 375 376 377

    def format(self, record):
        return self._fmt.format(**record.__dict__)


class StringTemplateStyle(PercentStyle):
    default_format = '${message}'
    asctime_format = '${asctime}'
378
    asctime_search = '${asctime}'
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396

    def __init__(self, fmt):
        self._fmt = fmt or self.default_format
        self._tpl = Template(self._fmt)

    def usesTime(self):
        fmt = self._fmt
        return fmt.find('$asctime') >= 0 or fmt.find(self.asctime_format) >= 0

    def format(self, record):
        return self._tpl.substitute(**record.__dict__)

_STYLES = {
    '%': PercentStyle,
    '{': StrFormatStyle,
    '$': StringTemplateStyle
}

397
class Formatter(object):
398 399 400 401 402 403 404
    """
    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
405
    default value of "%s(message)" is used.
406 407 408 409 410 411 412 413 414

    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,
415
                        WARNING, ERROR, CRITICAL)
416
    %(levelname)s       Text logging level for the message ("DEBUG", "INFO",
417
                        "WARNING", "ERROR", "CRITICAL")
418 419 420 421 422 423
    %(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)
424
    %(funcName)s        Function name
425 426 427 428 429 430 431 432
    %(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)
433
    %(threadName)s      Thread name (if available)
434
    %(process)d         Process ID (if available)
435 436 437 438 439 440
    %(message)s         The result of record.getMessage(), computed just as
                        the record is emitted
    """

    converter = time.localtime

441
    def __init__(self, fmt=None, datefmt=None, style='%'):
442 443 444 445 446 447
        """
        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 omitted, you get the ISO8601 format).
448 449 450 451 452 453 454

        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.
455
        """
456 457 458 459 460
        if style not in _STYLES:
            raise ValueError('Style must be one of: %s' % ','.join(
                             _STYLES.keys()))
        self._style = _STYLES[style](fmt)
        self._fmt = self._style._fmt
461 462
        self.datefmt = datefmt

463 464 465
    default_time_format = '%Y-%m-%d %H:%M:%S'
    default_msec_format = '%s,%03d'

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
    def formatTime(self, record, datefmt=None):
        """
        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, the ISO8601 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.
        """
        ct = self.converter(record.created)
        if datefmt:
            s = time.strftime(datefmt, ct)
        else:
488 489
            t = time.strftime(self.default_time_format, ct)
            s = self.default_msec_format % (t, record.msecs)
490 491 492 493 494 495 496 497 498
        return s

    def formatException(self, ei):
        """
        Format and return the specified exception information as a string.

        This default implementation just uses
        traceback.print_exception()
        """
499
        sio = io.StringIO()
500 501 502 503 504
        tb = ei[2]
        # See issues #9427, #1553375. Commented out for now.
        #if getattr(self, 'fullstack', False):
        #    traceback.print_stack(tb.tb_frame.f_back, file=sio)
        traceback.print_exception(ei[0], ei[1], tb, None, sio)
505 506
        s = sio.getvalue()
        sio.close()
507
        if s[-1:] == "\n":
508 509 510
            s = s[:-1]
        return s

Benjamin Peterson's avatar
Benjamin Peterson committed
511 512 513 514
    def usesTime(self):
        """
        Check if the format uses the creation time of the record.
        """
515
        return self._style.usesTime()
Benjamin Peterson's avatar
Benjamin Peterson committed
516

517
    def formatMessage(self, record):
518
        return self._style.format(record)
519

520 521 522 523 524 525 526 527 528 529 530 531 532
    def formatStack(self, stack_info):
        """
        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.
        """
        return stack_info

533 534 535 536 537 538 539 540
    def format(self, record):
        """
        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
Benjamin Peterson's avatar
Benjamin Peterson committed
541 542 543 544
        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.
545 546
        """
        record.message = record.getMessage()
Benjamin Peterson's avatar
Benjamin Peterson committed
547
        if self.usesTime():
548
            record.asctime = self.formatTime(record, self.datefmt)
549
        s = self.formatMessage(record)
550
        if record.exc_info:
551 552 553 554 555
            # Cache the traceback text to avoid converting it multiple times
            # (it's constant anyway)
            if not record.exc_text:
                record.exc_text = self.formatException(record.exc_info)
        if record.exc_text:
556
            if s[-1:] != "\n":
557
                s = s + "\n"
558
            s = s + record.exc_text
559 560 561 562
        if record.stack_info:
            if s[-1:] != "\n":
                s = s + "\n"
            s = s + self.formatStack(record.stack_info)
563 564 565 566 567 568 569
        return s

#
#   The default formatter to use when no other is specified
#
_defaultFormatter = Formatter()

570
class BufferingFormatter(object):
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
    """
    A formatter suitable for formatting a number of records.
    """
    def __init__(self, linefmt=None):
        """
        Optionally specify a formatter which will be used to format each
        individual record.
        """
        if linefmt:
            self.linefmt = linefmt
        else:
            self.linefmt = _defaultFormatter

    def formatHeader(self, records):
        """
        Return the header string for the specified records.
        """
        return ""

    def formatFooter(self, records):
        """
        Return the footer string for the specified records.
        """
        return ""

    def format(self, records):
        """
        Format the specified records and return the result as a string.
        """
        rv = ""
        if len(records) > 0:
            rv = rv + self.formatHeader(records)
            for record in records:
                rv = rv + self.linefmt.format(record)
            rv = rv + self.formatFooter(records)
        return rv

#---------------------------------------------------------------------------
#   Filter classes and functions
#---------------------------------------------------------------------------

612
class Filter(object):
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
    """
    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.
    """
    def __init__(self, name=''):
        """
        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.
        """
        self.name = name
        self.nlen = len(name)

    def filter(self, record):
        """
        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.
        """
        if self.nlen == 0:
642
            return True
643
        elif self.name == record.name:
644
            return True
645
        elif record.name.find(self.name, 0, self.nlen) != 0:
646
            return False
647 648
        return (record.name[self.nlen] == ".")

649
class Filterer(object):
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
    """
    A base class for loggers and handlers which allows them to share
    common code.
    """
    def __init__(self):
        """
        Initialize the list of filters to be an empty list.
        """
        self.filters = []

    def addFilter(self, filter):
        """
        Add the specified filter to this handler.
        """
        if not (filter in self.filters):
            self.filters.append(filter)

    def removeFilter(self, filter):
        """
        Remove the specified filter from this handler.
        """
        if filter in self.filters:
            self.filters.remove(filter)

    def filter(self, record):
        """
        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.
681 682 683 684

        .. versionchanged: 3.2

           Allow filters to be just callables.
685
        """
686
        rv = True
687
        for f in self.filters:
688 689 690
            if hasattr(f, 'filter'):
                result = f.filter(record)
            else:
691
                result = f(record) # assume callable - will raise if not
692
            if not result:
693
                rv = False
694 695 696 697 698 699 700
                break
        return rv

#---------------------------------------------------------------------------
#   Handler classes and functions
#---------------------------------------------------------------------------

701
_handlers = weakref.WeakValueDictionary()  #map of handler names to handlers
702
_handlerList = [] # added to allow handlers to be removed in reverse of order initialized
703

704 705 706 707
def _removeHandlerRef(wr):
    """
    Remove a handler reference from the internal cleanup list.
    """
708 709 710 711 712 713 714 715 716 717
    # This function can be called during module teardown, when globals are
    # set to None. If _acquireLock is None, assume this is the case and do
    # nothing.
    if _acquireLock is not None:
        _acquireLock()
        try:
            if wr in _handlerList:
                _handlerList.remove(wr)
        finally:
            _releaseLock()
718 719 720 721 722 723 724 725 726 727 728

def _addHandlerRef(handler):
    """
    Add a handler to the internal cleanup list using a weak reference.
    """
    _acquireLock()
    try:
        _handlerList.append(weakref.ref(handler, _removeHandlerRef))
    finally:
        _releaseLock()

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
class Handler(Filterer):
    """
    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.
    """
    def __init__(self, level=NOTSET):
        """
        Initializes the instance - basically setting the formatter to None
        and the filter list to empty.
        """
        Filterer.__init__(self)
744
        self._name = None
745
        self.level = _checkLevel(level)
746
        self.formatter = None
747 748 749 750 751 752 753 754
        # Add the handler to the global _handlerList (for cleanup on shutdown)
        _addHandlerRef(self)
        self.createLock()

    def get_name(self):
        return self._name

    def set_name(self, name):
755
        _acquireLock()
756 757 758 759 760 761
        try:
            if self._name in _handlers:
                del _handlers[self._name]
            self._name = name
            if name:
                _handlers[name] = self
762 763
        finally:
            _releaseLock()
764 765

    name = property(get_name, set_name)
766 767 768 769 770

    def createLock(self):
        """
        Acquire a thread lock for serializing access to the underlying I/O.
        """
771
        if threading:
772
            self.lock = threading.RLock()
773
        else: #pragma: no cover
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
            self.lock = None

    def acquire(self):
        """
        Acquire the I/O thread lock.
        """
        if self.lock:
            self.lock.acquire()

    def release(self):
        """
        Release the I/O thread lock.
        """
        if self.lock:
            self.lock.release()

    def setLevel(self, level):
        """
792
        Set the logging level of this handler.  level must be an int or a str.
793
        """
794
        self.level = _checkLevel(level)
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815

    def format(self, record):
        """
        Format the specified record.

        If a formatter is set, use it. Otherwise, use the default formatter
        for the module.
        """
        if self.formatter:
            fmt = self.formatter
        else:
            fmt = _defaultFormatter
        return fmt.format(record)

    def emit(self, record):
        """
        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.
        """
816 817
        raise NotImplementedError('emit must be implemented '
                                  'by Handler subclasses')
818 819 820 821 822 823 824

    def handle(self, record):
        """
        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
825 826
        the I/O thread lock. Returns whether the filter passed the record for
        emission.
827
        """
828 829
        rv = self.filter(record)
        if rv:
830 831 832 833 834
            self.acquire()
            try:
                self.emit(record)
            finally:
                self.release()
835
        return rv
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855

    def setFormatter(self, fmt):
        """
        Set the formatter for this handler.
        """
        self.formatter = fmt

    def flush(self):
        """
        Ensure all logging output has been flushed.

        This version does nothing and is intended to be implemented by
        subclasses.
        """
        pass

    def close(self):
        """
        Tidy up any resources used by the handler.

856 857
        This version removes the handler from an internal map of handlers,
        _handlers, which is used for handler lookup by name. Subclasses
858 859
        should ensure that this gets called from overridden close()
        methods.
860
        """
861 862 863
        #get the module data lock, as we're updating a shared structure.
        _acquireLock()
        try:    #unlikely to raise an exception, but you never know...
864 865
            if self._name and self._name in _handlers:
                del _handlers[self._name]
866 867
        finally:
            _releaseLock()
868

869
    def handleError(self, record):
870 871 872 873
        """
        Handle errors which occur during an emit() call.

        This method should be called from handlers when an exception is
874
        encountered during an emit() call. If raiseExceptions is false,
875 876 877 878
        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.
879
        The record which was being processed is passed in to this method.
880
        """
881
        if raiseExceptions and sys.stderr:  # see issue 13807
882
            ei = sys.exc_info()
Benjamin Peterson's avatar
Benjamin Peterson committed
883
            try:
884 885 886 887
                traceback.print_exception(ei[0], ei[1], ei[2],
                                          None, sys.stderr)
                sys.stderr.write('Logged from file %s, line %s\n' % (
                                 record.filename, record.lineno))
888
            except IOError: #pragma: no cover
Benjamin Peterson's avatar
Benjamin Peterson committed
889 890 891
                pass    # see issue 5971
            finally:
                del ei
892 893 894 895 896 897 898

class StreamHandler(Handler):
    """
    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.
    """
Benjamin Peterson's avatar
Benjamin Peterson committed
899

900 901
    terminator = '\n'

Benjamin Peterson's avatar
Benjamin Peterson committed
902
    def __init__(self, stream=None):
903 904 905
        """
        Initialize the handler.

Benjamin Peterson's avatar
Benjamin Peterson committed
906
        If stream is not specified, sys.stderr is used.
907 908
        """
        Handler.__init__(self)
Benjamin Peterson's avatar
Benjamin Peterson committed
909 910 911
        if stream is None:
            stream = sys.stderr
        self.stream = stream
912 913 914 915 916

    def flush(self):
        """
        Flushes the stream.
        """
917 918
        self.acquire()
        try:
919 920
            if self.stream and hasattr(self.stream, "flush"):
                self.stream.flush()
921 922
        finally:
            self.release()
923 924 925 926 927 928

    def emit(self, record):
        """
        Emit a record.

        If a formatter is specified, it is used to format the record.
Benjamin Peterson's avatar
Benjamin Peterson committed
929 930 931
        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
Benjamin Peterson's avatar
Benjamin Peterson committed
932
        has an 'encoding' attribute, it is used to determine how to do the
Benjamin Peterson's avatar
Benjamin Peterson committed
933
        output to the stream.
934 935 936
        """
        try:
            msg = self.format(record)
Benjamin Peterson's avatar
Benjamin Peterson committed
937
            stream = self.stream
938 939
            stream.write(msg)
            stream.write(self.terminator)
940
            self.flush()
941
        except (KeyboardInterrupt, SystemExit): #pragma: no cover
942
            raise
943
        except:
944
            self.handleError(record)
945 946 947 948 949

class FileHandler(StreamHandler):
    """
    A handler class which writes formatted logging records to disk files.
    """
950
    def __init__(self, filename, mode='a', encoding=None, delay=False):
951 952 953
        """
        Open the specified file and use it as the stream for logging.
        """
954 955 956
        #keep the absolute path, otherwise derived classes which use this
        #may come a cropper when the current directory changes
        self.baseFilename = os.path.abspath(filename)
957
        self.mode = mode
958
        self.encoding = encoding
959
        if delay:
960 961 962
            #We don't open the stream, but we still need to call the
            #Handler constructor to set level, formatter, lock etc.
            Handler.__init__(self)
963 964
            self.stream = None
        else:
965
            StreamHandler.__init__(self, self._open())
966 967 968 969 970

    def close(self):
        """
        Closes the stream.
        """
971 972
        self.acquire()
        try:
973 974 975 976 977 978
            if self.stream:
                self.flush()
                if hasattr(self.stream, "close"):
                    self.stream.close()
                StreamHandler.close(self)
                self.stream = None
979 980
        finally:
            self.release()
981

982 983 984 985 986
    def _open(self):
        """
        Open the current base file with the (original) mode and encoding.
        Return the resulting stream.
        """
987
        return open(self.baseFilename, self.mode, encoding=self.encoding)
988

989 990 991 992 993 994 995 996
    def emit(self, record):
        """
        Emit a record.

        If the stream was not opened because 'delay' was specified in the
        constructor, open it before calling the superclass's emit.
        """
        if self.stream is None:
997
            self.stream = self._open()
998 999
        StreamHandler.emit(self, record)

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
class _StderrHandler(StreamHandler):
    """
    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.
    """
    def __init__(self, level=NOTSET):
        """
        Initialize the handler.
        """
        Handler.__init__(self, level)

    @property
    def stream(self):
        return sys.stderr


_defaultLastResort = _StderrHandler(WARNING)
lastResort = _defaultLastResort

1020 1021 1022 1023
#---------------------------------------------------------------------------
#   Manager classes and functions
#---------------------------------------------------------------------------

1024
class PlaceHolder(object):
1025 1026
    """
    PlaceHolder instances are used in the Manager logger hierarchy to take
1027 1028
    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.
1029 1030 1031 1032 1033
    """
    def __init__(self, alogger):
        """
        Initialize with the specified logger being a child of this placeholder.
        """
1034
        self.loggerMap = { alogger : None }
1035 1036 1037 1038 1039

    def append(self, alogger):
        """
        Add the specified logger as a child of this placeholder.
        """
Guido van Rossum's avatar
Guido van Rossum committed
1040
        if alogger not in self.loggerMap:
1041
            self.loggerMap[alogger] = None
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055

#
#   Determine which class to use when instantiating loggers.
#
_loggerClass = None

def setLoggerClass(klass):
    """
    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__()
    """
    if klass != Logger:
        if not issubclass(klass, Logger):
1056 1057
            raise TypeError("logger not derived from logging.Logger: "
                            + klass.__name__)
1058 1059 1060
    global _loggerClass
    _loggerClass = klass

Vinay Sajip's avatar
Vinay Sajip committed
1061 1062 1063 1064 1065 1066 1067
def getLoggerClass():
    """
    Return the class to be used when instantiating a logger.
    """

    return _loggerClass

1068
class Manager(object):
1069 1070 1071 1072
    """
    There is [under normal circumstances] just one Manager instance, which
    holds the hierarchy of loggers.
    """
1073
    def __init__(self, rootnode):
1074 1075 1076
        """
        Initialize the manager with the root node of the logger hierarchy.
        """
1077
        self.root = rootnode
1078
        self.disable = 0
1079
        self.emittedNoHandlerWarning = False
1080
        self.loggerDict = {}
1081
        self.loggerClass = None
1082
        self.logRecordFactory = None
1083 1084 1085 1086

    def getLogger(self, name):
        """
        Get a logger with the specified name (channel name), creating it
Vinay Sajip's avatar
Vinay Sajip committed
1087 1088
        if it doesn't yet exist. This name is a dot-separated hierarchical
        name, such as "a", "a.b", "a.b.c" or similar.
1089 1090 1091 1092 1093 1094 1095

        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.
        """
        rv = None
1096
        if not isinstance(name, str):
1097
            raise TypeError('A logger name must be a string')
1098 1099
        _acquireLock()
        try:
Guido van Rossum's avatar
Guido van Rossum committed
1100
            if name in self.loggerDict:
1101 1102 1103
                rv = self.loggerDict[name]
                if isinstance(rv, PlaceHolder):
                    ph = rv
1104
                    rv = (self.loggerClass or _loggerClass)(name)
1105 1106 1107 1108 1109
                    rv.manager = self
                    self.loggerDict[name] = rv
                    self._fixupChildren(ph, rv)
                    self._fixupParents(rv)
            else:
1110
                rv = (self.loggerClass or _loggerClass)(name)
1111 1112 1113 1114 1115 1116 1117
                rv.manager = self
                self.loggerDict[name] = rv
                self._fixupParents(rv)
        finally:
            _releaseLock()
        return rv

1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
    def setLoggerClass(self, klass):
        """
        Set the class to be used when instantiating a logger with this Manager.
        """
        if klass != Logger:
            if not issubclass(klass, Logger):
                raise TypeError("logger not derived from logging.Logger: "
                                + klass.__name__)
        self.loggerClass = klass

1128
    def setLogRecordFactory(self, factory):
1129
        """
1130
        Set the factory to be used when instantiating a log record with this
1131 1132
        Manager.
        """
1133
        self.logRecordFactory = factory
1134

1135 1136 1137 1138 1139 1140
    def _fixupParents(self, alogger):
        """
        Ensure that there are either loggers or placeholders all the way
        from the specified logger to the root of the logger hierarchy.
        """
        name = alogger.name
1141
        i = name.rfind(".")
1142 1143 1144
        rv = None
        while (i > 0) and not rv:
            substr = name[:i]
Guido van Rossum's avatar
Guido van Rossum committed
1145
            if substr not in self.loggerDict:
1146 1147 1148 1149 1150 1151 1152 1153
                self.loggerDict[substr] = PlaceHolder(alogger)
            else:
                obj = self.loggerDict[substr]
                if isinstance(obj, Logger):
                    rv = obj
                else:
                    assert isinstance(obj, PlaceHolder)
                    obj.append(alogger)
1154
            i = name.rfind(".", 0, i - 1)
1155 1156 1157 1158 1159 1160 1161 1162 1163
        if not rv:
            rv = self.root
        alogger.parent = rv

    def _fixupChildren(self, ph, alogger):
        """
        Ensure that children of the placeholder ph are connected to the
        specified logger.
        """
1164 1165
        name = alogger.name
        namelen = len(name)
1166
        for c in ph.loggerMap.keys():
1167 1168
            #The if means ... if not c.parent.name.startswith(nm)
            if c.parent.name[:namelen] != name:
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
                alogger.parent = c.parent
                c.parent = alogger

#---------------------------------------------------------------------------
#   Logger classes and functions
#---------------------------------------------------------------------------

class Logger(Filterer):
    """
    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.
    """
    def __init__(self, name, level=NOTSET):
        """
        Initialize the logger with a name and an optional level.
        """
        Filterer.__init__(self)
        self.name = name
1197
        self.level = _checkLevel(level)
1198
        self.parent = None
1199
        self.propagate = True
1200
        self.handlers = []
1201
        self.disabled = False
1202 1203 1204

    def setLevel(self, level):
        """
1205
        Set the logging level of this logger.  level must be an int or a str.
1206
        """
1207
        self.level = _checkLevel(level)
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217

    def debug(self, msg, *args, **kwargs):
        """
        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)
        """
1218
        if self.isEnabledFor(DEBUG):
Neal Norwitz's avatar
Neal Norwitz committed
1219
            self._log(DEBUG, msg, args, **kwargs)
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229

    def info(self, msg, *args, **kwargs):
        """
        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)
        """
1230
        if self.isEnabledFor(INFO):
Neal Norwitz's avatar
Neal Norwitz committed
1231
            self._log(INFO, msg, args, **kwargs)
1232

1233
    def warning(self, msg, *args, **kwargs):
1234
        """
1235
        Log 'msg % args' with severity 'WARNING'.
1236 1237 1238 1239

        To pass exception information, use the keyword argument exc_info with
        a true value, e.g.

1240
        logger.warning("Houston, we have a %s", "bit of a problem", exc_info=1)
1241
        """
1242
        if self.isEnabledFor(WARNING):
Neal Norwitz's avatar
Neal Norwitz committed
1243
            self._log(WARNING, msg, args, **kwargs)
1244

1245 1246
    def warn(self, msg, *args, **kwargs):
        warnings.warn("The 'warn' method is deprecated, "
1247
            "use 'warning' instead", DeprecationWarning, 2)
1248
        self.warning(msg, *args, **kwargs)
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259

    def error(self, msg, *args, **kwargs):
        """
        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)
        """
        if self.isEnabledFor(ERROR):
Neal Norwitz's avatar
Neal Norwitz committed
1260
            self._log(ERROR, msg, args, **kwargs)
1261

1262
    def exception(self, msg, *args, **kwargs):
1263 1264 1265
        """
        Convenience method for logging an ERROR with exception information.
        """
1266 1267
        kwargs['exc_info'] = True
        self.error(msg, *args, **kwargs)
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277

    def critical(self, msg, *args, **kwargs):
        """
        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)
        """
1278
        if self.isEnabledFor(CRITICAL):
Neal Norwitz's avatar
Neal Norwitz committed
1279
            self._log(CRITICAL, msg, args, **kwargs)
1280 1281 1282 1283 1284

    fatal = critical

    def log(self, level, msg, *args, **kwargs):
        """
1285
        Log 'msg % args' with the integer severity 'level'.
1286 1287 1288 1289 1290 1291

        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)
        """
1292
        if not isinstance(level, int):
1293
            if raiseExceptions:
1294
                raise TypeError("level must be an integer")
1295 1296
            else:
                return
1297
        if self.isEnabledFor(level):
Neal Norwitz's avatar
Neal Norwitz committed
1298
            self._log(level, msg, args, **kwargs)
1299

1300
    def findCaller(self, stack_info=False):
1301 1302
        """
        Find the stack frame of the caller so that we can note the source
1303
        file name, line number and function name.
1304
        """
Benjamin Peterson's avatar
Benjamin Peterson committed
1305 1306 1307 1308 1309
        f = currentframe()
        #On some versions of IronPython, currentframe() returns None if
        #IronPython isn't run with -X:Frames.
        if f is not None:
            f = f.f_back
1310
        rv = "(unknown file)", 0, "(unknown function)", None
1311
        while hasattr(f, "f_code"):
1312 1313 1314 1315 1316
            co = f.f_code
            filename = os.path.normcase(co.co_filename)
            if filename == _srcfile:
                f = f.f_back
                continue
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
            sinfo = None
            if stack_info:
                sio = io.StringIO()
                sio.write('Stack (most recent call last):\n')
                traceback.print_stack(f, file=sio)
                sinfo = sio.getvalue()
                if sinfo[-1] == '\n':
                    sinfo = sinfo[:-1]
                sio.close()
            rv = (co.co_filename, f.f_lineno, co.co_name, sinfo)
1327 1328
            break
        return rv
1329

1330 1331
    def makeRecord(self, name, level, fn, lno, msg, args, exc_info,
                   func=None, extra=None, sinfo=None):
1332 1333 1334 1335
        """
        A factory method which can be overridden in subclasses to create
        specialized LogRecords.
        """
1336
        rv = _logRecordFactory(name, level, fn, lno, msg, args, exc_info, func,
1337
                             sinfo)
1338
        if extra is not None:
1339 1340 1341 1342 1343
            for key in extra:
                if (key in ["message", "asctime"]) or (key in rv.__dict__):
                    raise KeyError("Attempt to overwrite %r in LogRecord" % key)
                rv.__dict__[key] = extra[key]
        return rv
1344

1345
    def _log(self, level, msg, args, exc_info=None, extra=None, stack_info=False):
1346 1347 1348 1349
        """
        Low-level logging routine which creates a LogRecord and then calls
        all the handlers of this logger to handle the record.
        """
1350
        sinfo = None
1351
        if _srcfile:
1352
            #IronPython doesn't track Python frames, so findCaller throws an
Benjamin Peterson's avatar
Benjamin Peterson committed
1353 1354
            #exception on some versions of IronPython. We trap it here so that
            #IronPython can use logging.
1355
            try:
1356
                fn, lno, func, sinfo = self.findCaller(stack_info)
1357
            except ValueError: # pragma: no cover
1358
                fn, lno, func = "(unknown file)", 0, "(unknown function)"
1359
        else: # pragma: no cover
1360
            fn, lno, func = "(unknown file)", 0, "(unknown function)"
1361
        if exc_info:
1362
            if not isinstance(exc_info, tuple):
1363
                exc_info = sys.exc_info()
1364 1365
        record = self.makeRecord(self.name, level, fn, lno, msg, args,
                                 exc_info, func, extra, sinfo)
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
        self.handle(record)

    def handle(self, record):
        """
        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.
        """
        if (not self.disabled) and self.filter(record):
            self.callHandlers(record)

    def addHandler(self, hdlr):
        """
        Add the specified handler to this logger.
        """
1382 1383 1384 1385 1386 1387
        _acquireLock()
        try:
            if not (hdlr in self.handlers):
                self.handlers.append(hdlr)
        finally:
            _releaseLock()
1388 1389 1390 1391 1392

    def removeHandler(self, hdlr):
        """
        Remove the specified handler from this logger.
        """
1393 1394 1395
        _acquireLock()
        try:
            if hdlr in self.handlers:
1396
                self.handlers.remove(hdlr)
1397 1398
        finally:
            _releaseLock()
1399

1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
    def hasHandlers(self):
        """
        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.
        """
        c = self
        rv = False
        while c:
            if c.handlers:
                rv = True
                break
            if not c.propagate:
                break
            else:
                c = c.parent
        return rv

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
    def callHandlers(self, record):
        """
        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.
        """
        c = self
        found = 0
        while c:
            for hdlr in c.handlers:
                found = found + 1
                if record.levelno >= hdlr.level:
                    hdlr.handle(record)
            if not c.propagate:
                c = None    #break out
            else:
                c = c.parent
1443 1444
        if (found == 0):
            if lastResort:
1445 1446
                if record.levelno >= lastResort.level:
                    lastResort.handle(record)
1447 1448 1449 1450
            elif raiseExceptions and not self.manager.emittedNoHandlerWarning:
                sys.stderr.write("No handlers could be found for logger"
                                 " \"%s\"\n" % self.name)
                self.manager.emittedNoHandlerWarning = True
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470

    def getEffectiveLevel(self):
        """
        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.
        """
        logger = self
        while logger:
            if logger.level:
                return logger.level
            logger = logger.parent
        return NOTSET

    def isEnabledFor(self, level):
        """
        Is this logger enabled for level 'level'?
        """
        if self.manager.disable >= level:
1471
            return False
1472 1473
        return level >= self.getEffectiveLevel()

1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
    def getChild(self, suffix):
        """
        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.
        """
        if self.root is not self:
            suffix = '.'.join((self.name, suffix))
        return self.manager.getLogger(suffix)

1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506
class RootLogger(Logger):
    """
    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.
    """
    def __init__(self, level):
        """
        Initialize the logger with the name "root".
        """
        Logger.__init__(self, "root", level)

_loggerClass = Logger

1507
class LoggerAdapter(object):
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
    """
    An adapter for loggers which makes it easier to specify contextual
    information in logging output.
    """

    def __init__(self, logger, extra):
        """
        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"))
        """
        self.logger = logger
        self.extra = extra

    def process(self, msg, kwargs):
        """
        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.
        """
        kwargs["extra"] = self.extra
        return msg, kwargs

1540 1541 1542
    #
    # Boilerplate convenience methods
    #
1543 1544
    def debug(self, msg, *args, **kwargs):
        """
1545
        Delegate a debug call to the underlying logger.
1546
        """
1547
        self.log(DEBUG, msg, *args, **kwargs)
1548 1549 1550

    def info(self, msg, *args, **kwargs):
        """
1551
        Delegate an info call to the underlying logger.
1552
        """
1553
        self.log(INFO, msg, *args, **kwargs)
1554 1555 1556

    def warning(self, msg, *args, **kwargs):
        """
1557
        Delegate a warning call to the underlying logger.
1558
        """
1559
        self.log(WARNING, msg, *args, **kwargs)
1560

1561 1562
    def warn(self, msg, *args, **kwargs):
        warnings.warn("The 'warn' method is deprecated, "
1563
            "use 'warning' instead", DeprecationWarning, 2)
1564
        self.warning(msg, *args, **kwargs)
1565

1566 1567
    def error(self, msg, *args, **kwargs):
        """
1568
        Delegate an error call to the underlying logger.
1569
        """
1570
        self.log(ERROR, msg, *args, **kwargs)
1571 1572 1573

    def exception(self, msg, *args, **kwargs):
        """
1574
        Delegate an exception call to the underlying logger.
1575
        """
1576
        kwargs["exc_info"] = True
1577
        self.log(ERROR, msg, *args, **kwargs)
1578 1579 1580

    def critical(self, msg, *args, **kwargs):
        """
1581
        Delegate a critical call to the underlying logger.
1582
        """
1583
        self.log(CRITICAL, msg, *args, **kwargs)
1584 1585 1586 1587 1588 1589

    def log(self, level, msg, *args, **kwargs):
        """
        Delegate a log call to the underlying logger, after adding
        contextual information from this adapter instance.
        """
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
        if self.isEnabledFor(level):
            msg, kwargs = self.process(msg, kwargs)
            self.logger._log(level, msg, args, **kwargs)

    def isEnabledFor(self, level):
        """
        Is this logger enabled for level 'level'?
        """
        if self.logger.manager.disable >= level:
            return False
        return level >= self.getEffectiveLevel()
1601

1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
    def setLevel(self, level):
        """
        Set the specified level on the underlying logger.
        """
        self.logger.setLevel(level)

    def getEffectiveLevel(self):
        """
        Get the effective level for the underlying logger.
        """
        return self.logger.getEffectiveLevel()

1614 1615 1616 1617 1618 1619
    def hasHandlers(self):
        """
        See if the underlying logger has any handlers.
        """
        return self.logger.hasHandlers()

1620
root = RootLogger(WARNING)
1621 1622 1623 1624 1625 1626 1627 1628 1629
Logger.root = root
Logger.manager = Manager(Logger.root)

#---------------------------------------------------------------------------
# Configuration classes and functions
#---------------------------------------------------------------------------

BASIC_FORMAT = "%(levelname)s:%(name)s:%(message)s"

1630
def basicConfig(**kwargs):
1631
    """
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
    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
1648
              (if filemode is unspecified, it defaults to 'a').
1649 1650
    format    Use the specified format string for the handler.
    datefmt   Use the specified date/time format.
1651 1652 1653 1654
    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 '%').
1655 1656 1657 1658
    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.
1659 1660 1661 1662
    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.
1663 1664 1665 1666 1667 1668

    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.
1669

1670
    .. versionchanged:: 3.2
1671
       Added the ``style`` parameter.
Vinay Sajip's avatar
Vinay Sajip committed
1672

1673 1674 1675 1676 1677 1678
    .. 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``.
1679
    """
1680 1681 1682 1683 1684
    # Add thread safety in case someone mistakenly calls
    # basicConfig() from multiple threads
    _acquireLock()
    try:
        if len(root.handlers) == 0:
1685 1686 1687 1688 1689
            handlers = kwargs.get("handlers")
            if handlers is None:
                if "stream" in kwargs and "filename" in kwargs:
                    raise ValueError("'stream' and 'filename' should not be "
                                     "specified together")
1690
            else:
1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
                if "stream" in kwargs or "filename" in kwargs:
                    raise ValueError("'stream' or 'filename' should not be "
                                     "specified together with 'handlers'")
            if handlers is None:
                filename = kwargs.get("filename")
                if filename:
                    mode = kwargs.get("filemode", 'a')
                    h = FileHandler(filename, mode)
                else:
                    stream = kwargs.get("stream")
                    h = StreamHandler(stream)
                handlers = [h]
1703 1704
            fs = kwargs.get("format", BASIC_FORMAT)
            dfs = kwargs.get("datefmt", None)
1705 1706
            style = kwargs.get("style", '%')
            fmt = Formatter(fs, dfs, style)
1707 1708 1709 1710
            for h in handlers:
                if h.formatter is None:
                    h.setFormatter(fmt)
                root.addHandler(h)
1711 1712 1713 1714 1715
            level = kwargs.get("level")
            if level is not None:
                root.setLevel(level)
    finally:
        _releaseLock()
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734

#---------------------------------------------------------------------------
# Utility functions at module level.
# Basically delegate everything to the root logger.
#---------------------------------------------------------------------------

def getLogger(name=None):
    """
    Return a logger with the specified name, creating it if necessary.

    If no name is specified, return the root logger.
    """
    if name:
        return Logger.manager.getLogger(name)
    else:
        return root

def critical(msg, *args, **kwargs):
    """
1735 1736 1737
    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.
1738 1739 1740
    """
    if len(root.handlers) == 0:
        basicConfig()
Neal Norwitz's avatar
Neal Norwitz committed
1741
    root.critical(msg, *args, **kwargs)
1742 1743 1744 1745 1746

fatal = critical

def error(msg, *args, **kwargs):
    """
1747 1748 1749
    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.
1750 1751 1752
    """
    if len(root.handlers) == 0:
        basicConfig()
Neal Norwitz's avatar
Neal Norwitz committed
1753
    root.error(msg, *args, **kwargs)
1754

1755
def exception(msg, *args, **kwargs):
1756
    """
1757 1758 1759
    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.
1760
    """
1761 1762
    kwargs['exc_info'] = True
    error(msg, *args, **kwargs)
1763

1764
def warning(msg, *args, **kwargs):
1765
    """
1766 1767 1768
    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.
1769 1770 1771
    """
    if len(root.handlers) == 0:
        basicConfig()
Neal Norwitz's avatar
Neal Norwitz committed
1772
    root.warning(msg, *args, **kwargs)
1773

1774 1775
def warn(msg, *args, **kwargs):
    warnings.warn("The 'warn' function is deprecated, "
1776
        "use 'warning' instead", DeprecationWarning, 2)
1777
    warning(msg, *args, **kwargs)
1778 1779 1780

def info(msg, *args, **kwargs):
    """
1781 1782 1783
    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.
1784 1785 1786
    """
    if len(root.handlers) == 0:
        basicConfig()
Neal Norwitz's avatar
Neal Norwitz committed
1787
    root.info(msg, *args, **kwargs)
1788 1789 1790

def debug(msg, *args, **kwargs):
    """
1791 1792 1793
    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.
1794 1795 1796
    """
    if len(root.handlers) == 0:
        basicConfig()
Neal Norwitz's avatar
Neal Norwitz committed
1797
    root.debug(msg, *args, **kwargs)
1798

Vinay Sajip's avatar
Vinay Sajip committed
1799 1800
def log(level, msg, *args, **kwargs):
    """
1801 1802 1803
    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.
Vinay Sajip's avatar
Vinay Sajip committed
1804 1805 1806
    """
    if len(root.handlers) == 0:
        basicConfig()
Neal Norwitz's avatar
Neal Norwitz committed
1807
    root.log(level, msg, *args, **kwargs)
Vinay Sajip's avatar
Vinay Sajip committed
1808

1809 1810
def disable(level):
    """
Benjamin Peterson's avatar
Benjamin Peterson committed
1811
    Disable all logging calls of severity 'level' and below.
1812 1813 1814
    """
    root.manager.disable = level

1815
def shutdown(handlerList=_handlerList):
1816 1817 1818 1819 1820 1821
    """
    Perform any cleanup actions in the logging system (e.g. flushing
    buffers).

    Should be called at application exit.
    """
1822
    for wr in reversed(handlerList[:]):
1823
        #errors might occur, for example, if files are locked
1824
        #we just ignore them if raiseExceptions is not set
1825
        try:
1826
            h = wr()
1827 1828
            if h:
                try:
1829
                    h.acquire()
1830 1831 1832 1833 1834 1835 1836 1837
                    h.flush()
                    h.close()
                except (IOError, ValueError):
                    # Ignore errors which might be caused
                    # because handlers have been closed but
                    # references to them are still around at
                    # application exit.
                    pass
1838 1839
                finally:
                    h.release()
1840
        except:
1841 1842 1843
            if raiseExceptions:
                raise
            #else, swallow
1844 1845

#Let's try and shutdown automatically on application exit...
1846 1847
import atexit
atexit.register(shutdown)
1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860

# Null handler

class NullHandler(Handler):
    """
    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.
    """
1861
    def handle(self, record):
1862
        """Stub."""
1863

1864
    def emit(self, record):
1865
        """Stub."""
1866

1867 1868 1869
    def createLock(self):
        self.lock = None

1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
# Warnings integration

_warnings_showwarning = None

def _showwarning(message, category, filename, lineno, file=None, line=None):
    """
    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.
    """
    if file is not None:
        if _warnings_showwarning is not None:
            _warnings_showwarning(message, category, filename, lineno, file, line)
    else:
        s = warnings.formatwarning(message, category, filename, lineno, line)
        logger = getLogger("py.warnings")
        if not logger.handlers:
            logger.addHandler(NullHandler())
        logger.warning("%s", s)

def captureWarnings(capture):
    """
    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.
    """
    global _warnings_showwarning
    if capture:
        if _warnings_showwarning is None:
            _warnings_showwarning = warnings.showwarning
            warnings.showwarning = _showwarning
    else:
        if _warnings_showwarning is not None:
            warnings.showwarning = _warnings_showwarning
            _warnings_showwarning = None