Именование логгеров Python
В Django у меня повсюду есть регистраторы с жестко запрограммированными именами.
Для ведения журнала на уровне модуля (то есть в модуле функций просмотра) у меня есть побуждение сделать это.
log = logging.getLogger(__name__)
Для ведения журнала на уровне класса (то есть в методе класса __init__) у меня есть побуждение сделать это.
self.log = logging.getLogger("%s.%s" % (
self.__module__, self.__class__.__name__))
Я ищу второе мнение, прежде чем рассмотрю несколько десятков случаев появления getLogger("hard.coded.name").
Это сработает? Кто-нибудь еще называет свои регистраторы такими же безумными способами?
Кроме того, следует ли мне разобрать и написать декоратор класса для этого определения журнала?
Ответы 3
Похоже, это будет работать, за исключением того, что у self не будет атрибута __module__; свой класс будет. Вызов регистратора на уровне класса должен выглядеть так:
self.log = logging.getLogger( "%s.%s" % ( self.__class__.__module__, self.__class__.__name__ ) )
Вы уверены, что у себя не будет атрибута модуль? Я попробовал, и, похоже, он есть.
self имеет атрибут модуль.
Странно ... >>> from datetime import date >>> d = date.today () >>> d .__ module__ Traceback (последний вызов последним): файл "<stdin>", строка 1, в <module> AttributeError : объект 'datetime.date' не имеет атрибута 'модуль' >>> d .__ class __.__ module__ 'datetime' >>>
Что ж, это было зарезано; очевидно, вы не можете поместить код в комментарий к комментарию. В любом случае, я посмотрел на datetime, чтобы узнать, есть ли у экземпляра атрибут модуль, и похоже, что это не так. Может быть, другие классы подойдут.
@Steve: модуль, вероятно, не определен для экземпляров C-API. Не на 100%, но у экземпляров определенных пользователем типов, похоже, есть это.
Обычно я не использую и не нахожу в нужде средства ведения журнала на уровне классов, но я храню свои модули максимум в нескольких классах. Просто:
import logging
LOG = logging.getLogger(__name__)
Вверху модуля и далее:
LOG.info('Spam and eggs are tasty!')
из любой точки файла я обычно попадаю туда, где я хочу быть. Это позволяет избежать повсеместной потребности в self.log, что меня беспокоит как с точки зрения «вставлять в каждый класс», так и делает меня на 5 символов ближе к 79 подходящим строкам символов.
Вы всегда можете использовать декоратор псевдокласса:
>>> import logging
>>> class Foo(object):
... def __init__(self):
... self.log.info('Meh')
...
>>> def logged_class(cls):
... cls.log = logging.getLogger('{0}.{1}'.format(__name__, cls.__name__))
...
>>> logged_class(Foo)
>>> logging.basicConfig(level=logging.DEBUG)
>>> f = Foo()
INFO:__main__.Foo:Meh
Интересный подход ... Мне кажется, я слишком долго занимался Java. Ведение журнала на уровне модуля может быть именно тем, что прописал врач.
Есть одна проблема с использованием __name__: когда модуль куда-то импортируется с использованием относительного импорта, его сообщения будут попадать в журнал с использованием этого более короткого __name__. Это не проблема, если вы избегаете этого относительного импорта, который в любом случае является плохим стилем (как указано в FAQ по python)
Для ведения журнала на уровне класса в качестве альтернативы декоратору псевдокласса вы можете использовать метакласс, чтобы сделать регистратор для вас во время создания класса ...
import logging
class Foo(object):
class __metaclass__(type):
def __init__(cls, name, bases, attrs):
type.__init__(name, bases, attrs)
cls.log = logging.getLogger('%s.%s' % (attrs['__module__'], name))
def __init__(self):
self.log.info('here I am, a %s!' % type(self).__name__)
if __name__ == '__main__':
logging.basicConfig(level=logging.DEBUG)
foo = Foo()
Мне пришлось сменить type.__init__(...) на object.__init__(...), иначе под python 2.7 будет ошибка: descriptor '__init__' requires a 'type' object but received a 'str'. Но я не могу заставить этот метод работать под python 3.x.
Я понял. Чтобы этот метод работал и для python 3.x, мне нужно написать метакласс отдельно и использовать хакерский метод, например logging_metaclass_hack = logging_metaclass("logging_metaclass_hack", (object, ), {}), и унаследовать его от Foo.
Мне любопытно: зачем вам вход в систему на уровне класса?