mirror of
https://github.com/sqlalchemy/sqlalchemy.git
synced 2026-05-27 19:15:05 -04:00
Mike Bayer
78 lines
2.9 KiB
Python
78 lines
2.9 KiB
Python
# logging.py - adapt python logging module to SQLAlchemy
|
|
# Copyright (C) 2006, 2007 Michael Bayer mike_mp@zzzcomputing.com
|
|
#
|
|
# This module is part of SQLAlchemy and is released under
|
|
# the MIT License: http://www.opensource.org/licenses/mit-license.php
|
|
|
|
"""Provides a few functions used by instances to turn on/off their
|
|
logging, including support for the usual "echo" parameter.
|
|
|
|
Control of logging for SA can be performed from the regular python
|
|
logging module. The regular dotted module namespace is used, starting
|
|
at 'sqlalchemy'. For class-level logging, the class name is appended,
|
|
and for instance-level logging, the hex id of the instance is
|
|
appended.
|
|
|
|
The "echo" keyword parameter which is available on some SA objects
|
|
corresponds to an instance-level logger for that instance.
|
|
|
|
E.g.::
|
|
|
|
engine.echo = True
|
|
|
|
is equivalent to::
|
|
|
|
import logging
|
|
logging.getLogger('sqlalchemy.engine.Engine.%s' % hex(id(engine))).setLevel(logging.DEBUG)
|
|
"""
|
|
|
|
import sys
|
|
|
|
# py2.5 absolute imports will fix....
|
|
logging = __import__('logging')
|
|
|
|
# turn off logging at the root sqlalchemy level
|
|
logging.getLogger('sqlalchemy').setLevel(logging.ERROR)
|
|
|
|
default_enabled = False
|
|
def default_logging(name):
|
|
global default_enabled
|
|
if logging.getLogger(name).getEffectiveLevel() < logging.WARN:
|
|
default_enabled=True
|
|
if not default_enabled:
|
|
default_enabled = True
|
|
rootlogger = logging.getLogger('sqlalchemy')
|
|
handler = logging.StreamHandler(sys.stdout)
|
|
handler.setFormatter(logging.Formatter('%(asctime)s %(levelname)s %(name)s %(message)s'))
|
|
rootlogger.addHandler(handler)
|
|
|
|
def _get_instance_name(instance):
|
|
# since getLogger() does not have any way of removing logger objects from memory,
|
|
# instance logging displays the instance id as a modulus of 16 to prevent endless memory growth
|
|
# also speeds performance as logger initialization is apparently slow
|
|
return instance.__class__.__module__ + "." + instance.__class__.__name__ + ".0x.." + hex(id(instance))[-2:]
|
|
|
|
def instance_logger(instance):
|
|
return logging.getLogger(_get_instance_name(instance))
|
|
|
|
def class_logger(cls):
|
|
return logging.getLogger(cls.__module__ + "." + cls.__name__)
|
|
|
|
def is_debug_enabled(logger):
|
|
return logger.isEnabledFor(logging.DEBUG)
|
|
|
|
def is_info_enabled(logger):
|
|
return logger.isEnabledFor(logging.INFO)
|
|
|
|
class echo_property(object):
|
|
level_map={logging.DEBUG : "debug", logging.INFO:True}
|
|
def __get__(self, instance, owner):
|
|
level = logging.getLogger(_get_instance_name(instance)).getEffectiveLevel()
|
|
return echo_property.level_map.get(level, False)
|
|
def __set__(self, instance, value):
|
|
if value:
|
|
default_logging(_get_instance_name(instance))
|
|
logging.getLogger(_get_instance_name(instance)).setLevel(value == 'debug' and logging.DEBUG or logging.INFO)
|
|
else:
|
|
logging.getLogger(_get_instance_name(instance)).setLevel(logging.NOTSET)
|