logging – Средство логирования для Python¶logging – Logging facility for Python

Объекты Logger¶Logger Objects

Логгеры имеют следующие атрибуты и методы. Обратите внимание, что логгеры НИКОГДА не должны создаваться напрямую, а всегда через функцию уровня модуля logging.getLogger(name). Многократные вызовы getLogger() с одним и тем же именем всегда будут возвращать ссылку на один и тот же объект Logger.

Значение name потенциально является иерархическим, разделённым точками, например foo.bar.baz (хотя это может быть и просто foo). Логгеры, находящиеся ниже в иерархическом списке, являются дочерними по отношению к логгерам, находящимся выше. Например, если есть логгер с именем foo, то логгеры с именами foo.bar, foo.bar.baz и foo.bam – все являются потомками foo. Иерархия имён логгеров аналогична иерархии пакетов Python и совпадает с ней, если организовать логгеры по модулям, используя рекомендуемую конструкцию logging.getLogger(__name__). Это потому, что в модуле __name__ – это имя модуля в пространстве имён пакетов Python.

class logging.Logger¶

propagate¶

Если этот атрибут истинен, события, записанные в этот логгер, будут передаваться обработчикам логгеров более высокого уровня (предков) в дополнение к любым обработчикам, прикреплённым к этому логгеру. Сообщения передаются напрямую обработчикам логгеров-предков – ни уровень, ни фильтры этих логгеров-предков не учитываются.

Если это ложно, сообщения логирования не передаются обработчикам логгеров-предков.

Конструктор устанавливает этот атрибут в True.

Примечание

Если вы прикрепите обработчик к логгеру и к одному или нескольким его предкам, он может выдать одну и ту же запись несколько раз. В общем случае нет необходимости прикреплять обработчик к более чем одному логгеру – если прикрепить его к соответствующему логгеру, который находится выше всех в иерархии логгеров, то он будет видеть все события, записанные всеми дочерними логгерами, при условии, что их параметр propagate оставлен равным True. Обычная практика – прикреплять обработчики только к корневому логгеру и позволить распространению заботиться об остальном.

setLevel(level)¶

Устанавливает порог для этого регистратора на уровень. Сообщения лога, менее серьёзные, чем уровень, будут игнорироваться; сообщения с серьёзностью уровень или выше будут отправлены любым обработчиком, обслуживающим этот регистратор, если только уровень обработчика не был установлен на более высокое значение серьёзности, чем уровень.

При создании регистратора уровень устанавливается в NOTSET (что приводит к обработке всех сообщений, если регистратор является корневым, или к делегированию родительскому регистратору, если он не корневой). Обратите внимание, что корневой регистратор создаётся с уровнем WARNING.

Термин «делегирование родительскому регистратору» означает, что если у регистратора уровень NOTSET, то просматривается цепочка его регистраторов-предков, пока не будет найден предок с уровнем, отличным от NOTSET, или не будет достигнут корень.

Если найден предок с уровнем, отличным от NOTSET, то его уровень считается действующим уровнем регистратора, с которого начался поиск предка, и используется для определения обработки события логирования.

Если достигнут корень и его уровень NOTSET, то будут обработаны все сообщения. В противном случае уровень корня будет использоваться как действующий уровень.

Список уровней см. в Уровни логирования.

Изменено в версии 3.2: Параметр уровень теперь принимает строковое представление уровня, например 'INFO', вместо целочисленных констант, таких как INFO. Однако обратите внимание, что уровни внутри хранятся как целые числа, и такие методы, как getEffectiveLevel() и isEnabledFor(), будут возвращать/ожидать целые числа.

isEnabledFor(level)¶

Указывает, будет ли обработано сообщение с уровнем серьёзности этим регистратором. Этот метод сначала проверяет уровень модуля, заданный logging.disable(level), а затем действующий уровень регистратора, определяемый getEffectiveLevel().

getEffectiveLevel()¶

Указывает действующий уровень для этого регистратора. Если с помощью setLevel() было установлено значение, отличное от NOTSET, возвращается оно. В противном случае иерархия просматривается в сторону корня, пока не будет найдено значение, отличное от NOTSET, и возвращается оно. Возвращаемое значение – целое число, обычно одно из logging.DEBUG, logging.INFO и т.д.

getChild(suffix)¶

Возвращает регистратор, который является потомком данного регистратора в соответствии с суффиксом. Таким образом, logging.getLogger('abc').getChild('def.ghi') вернёт тот же регистратор, что и logging.getLogger('abc.def.ghi'). Это удобный метод, полезный, когда родительский регистратор именуется, например, через __name__, а не литеральной строкой.

Новое в версии 3.2.

debug(msg, *args, **kwargs)¶

Регистрирует сообщение с уровнем DEBUG в этом регистраторе. msg – это строка формата сообщения, а args – аргументы, которые объединяются в msg с помощью оператора форматирования строк. (Обратите внимание: это означает, что можно использовать ключевые слова в строке формата вместе с одним аргументом-словарём.)

В kwargs проверяются три именованных аргумента: exc_info, stack_info и extra.

Если exc_info не равно false, к сообщению лога добавляется информация об исключении. Если предоставлен кортеж исключения (в формате, возвращаемом sys.exc_info()) или экземпляр исключения, используется он; в противном случае вызывается sys.exc_info() для получения информации об исключении.

Второй необязательный именованный аргумент – stack_info, по умолчанию False. Если true, к сообщению лога добавляется информация о стеке, включая сам вызов логирования. Обратите внимание, что это не та же информация о стеке, что отображается при указании exc_info: первая – это кадры стека от низа стека до вызова логирования в текущем потоке, тогда как вторая – информация о кадрах стека, которые были размотаны после исключения в процессе поиска обработчиков исключений.

Можно указать stack_info независимо от exc_info, например, чтобы просто показать, как был достигнут определённый участок кода, даже если исключения не возникали. Кадры стека выводятся после строки заголовка, которая гласит:

Stack (most recent call last):

Это имитирует Traceback (most recent call last):, используемый при отображении кадров исключения.

Третий именованный аргумент – extra, который можно использовать для передачи словаря, который заполняет __dict__ объекта LogRecord, созданного для события журналирования, пользовательскими атрибутами. Затем эти пользовательские атрибуты можно использовать по своему усмотрению. Например, их можно включать в журналируемые сообщения. Например:

FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s'
logging.basicConfig(format=FORMAT)
d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
logger = logging.getLogger('tcpserver')
logger.warning('Protocol problem: %s', 'connection reset', extra=d)

выведет что-то вроде

2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset

Ключи в словаре, переданном в extra, не должны совпадать с ключами, используемыми системой логирования. (См. документацию Formatter для получения дополнительной информации о том, какие ключи используются системой логирования.)

Если вы решите использовать эти атрибуты в логируемых сообщениях, необходимо соблюдать осторожность. В приведённом выше примере, например, Formatter настроен с форматной строкой, которая ожидает ключи ‘clientip’ и ‘user’ в словаре атрибутов LogRecord. Если они отсутствуют, сообщение не будет записано, так как возникнет исключение форматирования строки. Поэтому в данном случае необходимо всегда передавать словарь extra с этими ключами.

Хотя это может раздражать, эта функция предназначена для использования в специализированных ситуациях, например, в многопоточных серверах, где один и тот же код выполняется во многих контекстах, а интересующие условия зависят от этого контекста (такие как IP-адрес удаленного клиента и имя аутентифицированного пользователя в приведенном выше примере). В таких обстоятельствах, скорее всего, специализированные Formatters будут использоваться с определенными Handlers.

Новое в версии 3.2: Добавлен параметр stack_info.

Изменено в версии 3.5: Параметр exc_info теперь может принимать экземпляры исключений.

info(msg, *args, **kwargs)¶

Записывает сообщение с уровнем INFO в этот логгер. Аргументы интерпретируются так же, как для debug().

warning(msg, *args, **kwargs)¶

Записывает сообщение с уровнем WARNING в этот логгер. Аргументы интерпретируются так же, как для debug().

Примечание

Существует устаревший метод warn, который функционально идентичен warning. Поскольку warn устарел, не используйте его – используйте warning.

error(msg, *args, **kwargs)¶

Записывает сообщение с уровнем ERROR в этот логгер. Аргументы интерпретируются так же, как для debug().

critical(msg, *args, **kwargs)¶

Записывает сообщение с уровнем CRITICAL в этот логгер. Аргументы интерпретируются так же, как для debug().

log(level, msg, *args, **kwargs)¶

Записывает сообщение с целочисленным уровнем level в этот логгер. Остальные аргументы интерпретируются так же, как для debug().

exception(msg, *args, **kwargs)¶

Записывает сообщение с уровнем ERROR в этот логгер. Аргументы интерпретируются так же, как для debug(). К сообщению добавляется информация об исключении. Этот метод следует вызывать только из обработчика исключений.

addFilter(filter)¶

Добавляет указанный фильтр filter к этому логгеру.

removeFilter(filter)¶

Удаляет указанный фильтр filter из этого логгера.

filter(record)¶

Применяет фильтры этого логгера к записи и возвращает True, если запись должна быть обработана. Фильтры опрашиваются по очереди, пока один из них не вернет ложное значение. Если ни один из них не вернул ложное значение, запись будет обработана (передана обработчикам). Если какой-либо фильтр вернул ложное значение, дальнейшая обработка записи не происходит.

addHandler(hdlr)¶

Добавляет указанный обработчик hdlr к этому логгеру.

removeHandler(hdlr)¶

Удаляет указанный обработчик hdlr из этого логгера.

findCaller(stack_info=False)¶

Находит исходное имя файла и номер строки вызывающего кода. Возвращает имя файла, номер строки, имя функции и информацию о стеке в виде кортежа из 4 элементов. Информация о стеке возвращается как None, если stack_info не равно True.

handle(record)¶

Обрабатывает запись, передавая её всем обработчикам, связанным с этим регистратором и его предками (пока не встретится ложное значение propagate). Этот метод используется для распакованных записей, полученных через сокет, а также для созданных локально. Фильтрация на уровне регистратора применяется с помощью filter().

makeRecord(name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)¶

Это фабричный метод, который можно переопределить в подклассах для создания специализированных экземпляров LogRecord.

hasHandlers()¶

Проверяет, есть ли у этого регистратора настроенные обработчики. Это делается путём поиска обработчиков в этом регистраторе и его родителях в иерархии регистраторов. Возвращает True, если обработчик найден, иначе False. Метод прекращает поиск вверх по иерархии, как только будет найден регистратор, у которого атрибут 'propagate' установлен в false – это будет последний регистратор, проверяемый на наличие обработчиков.

Новое в версии 3.2.

Изменено в версии 3.7: Регистраторы теперь можно сериализовать и десериализовать с помощью пикл.

Уровни журналирования¶Logging Levels

Числовые значения уровней журналирования приведены в следующей таблице. Они представляют интерес в первую очередь, если вы хотите определить собственные уровни и хотите, чтобы они имели определенные значения относительно предопределенных уровней. Если вы определяете уровень с тем же числовым значением, он перезаписывает предопределенное значение; предопределенное имя теряется.

Объекты-обработчики¶Handler Objects

Обработчики имеют следующие атрибуты и методы. Обратите внимание, что Handler никогда не создаётся напрямую; этот класс служит базой для более полезных подклассов. Однако метод __init__() в подклассах должен вызывать Handler.__init__().

class logging.Handler¶

__init__(level=NOTSET)¶

Инициализирует экземпляр Handler, устанавливая его уровень, устанавливая список фильтров в пустой список и создавая блокировку (с помощью createLock()) для сериализации доступа к механизму ввода-вывода.

createLock()¶

Инициализирует блокировку потока, которую можно использовать для сериализации доступа к нижележащей функциональности ввода-вывода, которая может не быть потокобезопасной.

acquire()¶

Захватывает блокировку потока, созданную с помощью createLock().

release()¶

Освобождает блокировку потока, захваченную с помощью acquire().

setLevel(level)¶

Устанавливает порог для этого обработчика в level. Сообщения журнала, которые менее серьёзны, чем level, будут игнорироваться. При создании обработчика уровень устанавливается в NOTSET (что приводит к обработке всех сообщений).

Список уровней см. в Уровни логирования.

Изменено в версии 3.2: Параметр level теперь принимает строковое представление уровня, например 'INFO', как альтернативу целочисленным константам таким как INFO.

setFormatter(fmt)¶

Устанавливает Formatter для этого обработчика в fmt.

addFilter(filter)¶

Добавляет указанный фильтр filter к данному обработчику.

removeFilter(filter)¶

Удаляет указанный фильтр filter из данного обработчика.

filter(record)¶

Применяет фильтры данного обработчика к записи и возвращает True, если запись должна быть обработана. Фильтры опрашиваются по очереди, пока один из них не вернёт ложное значение. Если ни один не вернул ложного значения, запись будет выдана. Если какой-то возвращает ложное значение, обработчик не выдаёт запись.

flush()¶

Обеспечивает сброс всего вывода логирования. Данная версия ничего не делает и предназначена для реализации в подклассах.

close()¶

Освобождает все ресурсы, используемые обработчиком. Данная версия не выводит ничего, но удаляет обработчик из внутреннего списка обработчиков, который закрывается при вызове shutdown(). Подклассы должны обеспечить вызов этого метода из переопределённых методов close().

handle(record)¶

Условно выдает указанную запись логирования в зависимости от фильтров, которые могут быть добавлены к обработчику. Оборачивает фактическую выдачу записи в захват/освобождение блокировки потока ввода-вывода.

handleError(record)¶

Этот метод должен вызываться из обработчиков при возникновении исключения во время вызова emit(). Если атрибут уровня модуля raiseExceptions равен False, исключения молча игнорируются. Это обычно и нужно для системы логирования – большинство пользователей не заботятся об ошибках в системе логирования, их больше интересуют ошибки приложения. Однако при желании можно заменить этот метод собственным обработчиком. Указанная запись – та, что обрабатывалась в момент возникновения исключения. (Значение по умолчанию для raiseExceptions – True, так как это полезнее во время разработки.)

format(record)¶

Форматирует запись – если задан форматировщик, использует его. В противном случае использует форматировщик по умолчанию для модуля.

emit(record)¶

Делает всё необходимое для фактической записи указанной записи логирования. Эта версия предназначена для реализации в подклассах и поэтому возбуждает NotImplementedError.

Список стандартных обработчиков см. в logging.handlers.

Объекты Formatter¶Formatter Objects

Объекты Formatter имеют следующие атрибуты и методы. Они отвечают за преобразование LogRecord (обычно) в строку, которая может быть интерпретирована человеком или внешней системой. Базовый Formatter позволяет задать форматирующую строку. Если она не указана, используется значение по умолчанию '%(message)s', которое просто включает сообщение из вызова логирования. Чтобы добавить дополнительные элементы информации в форматированный вывод (например, временную метку), читайте дальше.

Formatter можно инициализировать строкой форматирования, которая использует знание атрибутов LogRecord – например, упомянутое выше значение по умолчанию, основанное на том, что сообщение пользователя и аргументы предварительно форматируются в атрибут message объекта LogRecord. Эта строка форматирования содержит стандартные ключи отображения в стиле % языка Python. Дополнительную информацию о форматировании строк см. в разделе printf-style String Formatting.

Полезные ключи отображения в LogRecord приведены в разделе LogRecord attributes.

class logging.Formatter(fmt=None, datefmt=None, style='%')¶

Возвращает новый экземпляр класса Formatter. Экземпляр инициализируется строкой форматирования для всего сообщения, а также строкой форматирования для части даты/времени сообщения. Если fmt не указан, используется '%(message)s'. Если datefmt не указан, используется формат, описанный в документации formatTime().

Параметр style может быть одним из ‘%’, ‘{’ или ‘$’ и определяет, как строка форматирования будет объединена с данными: с использованием %-форматирования, str.format() или string.Template. См. Использование определённых стилей форматирования в приложении для получения дополнительной информации об использовании {- и $-форматирования для сообщений лога.

Изменено в версии 3.2: Добавлен параметр style.

format(record)¶

Словарь атрибутов записи используется как операнд для операции форматирования строки. Возвращает результирующую строку. Перед форматированием словаря выполняется несколько подготовительных шагов. Атрибут message записи вычисляется с помощью msg % args. Если строка форматирования содержит '(asctime)', вызывается formatTime() для форматирования времени события. Если есть информация об исключении, она форматируется с помощью formatException() и добавляется к сообщению. Обратите внимание, что отформатированная информация об исключении кэшируется в атрибуте exc_text. Это полезно, поскольку информацию об исключении можно сериализовать и передавать по сети, но следует быть осторожным, если имеется более одного подкласса Formatter, который настраивает форматирование информации об исключении. В этом случае придётся очищать кэшированное значение после того, как форматер выполнит своё форматирование, чтобы следующий форматер, обрабатывающий событие, не использовал кэшированное значение, а пересчитал его заново.

Если доступна информация о стеке, она добавляется после информации об исключении с использованием formatStack() для её преобразования, если необходимо.

formatTime(record, datefmt=None)¶

Этот метод должен вызываться из format() форматтером, который хочет использовать отформатированное время. Этот метод можно переопределить в форматтерах для удовлетворения любых конкретных требований, но базовое поведение следующее: если указан datefmt (строка), он используется с time.strftime() для форматирования времени создания записи. В противном случае используется формат '%Y-%m-%d %H:%M:%S,uuu', где часть uuu – это значение в миллисекундах, а остальные буквы – согласно документации time.strftime(). Пример времени в этом формате: 2003-01-23 00:29:50,411. Возвращается результирующая строка.

Эта функция использует настраиваемую пользователем функцию для преобразования времени создания в кортеж. По умолчанию используется time.localtime(); чтобы изменить это для конкретного экземпляра форматтера, установите атрибут converter на функцию с той же сигнатурой, что и time.localtime() или time.gmtime(). Чтобы изменить это для всех форматтеров, например, если вы хотите показывать все времена логирования в GMT, установите атрибут converter в классе Formatter.

Изменено в версии 3.3: Ранее формат по умолчанию был жестко задан, как в этом примере: 2010-09-06 22:38:15,292, где часть до запятой обрабатывается строкой формата strptime ('%Y-%m-%d %H:%M:%S'), а часть после запятой – значение в миллисекундах. Поскольку в strptime нет заполнителя для миллисекунд, значение в миллисекундах добавляется с помощью другой строки формата, '%s,%03d' – и обе эти строки формата были жестко закодированы в этом методе. С этим изменением данные строки определяются как атрибуты уровня класса, которые можно переопределить на уровне экземпляра при необходимости. Имена атрибутов: default_time_format (для строки формата strptime) и default_msec_format (для добавления значения в миллисекундах).

formatException(exc_info)¶

Форматирует указанную информацию об исключении (стандартный кортеж исключения, возвращаемый sys.exc_info()) в строку. Эта реализация по умолчанию просто использует traceback.print_exception(). Возвращается результирующая строка.

formatStack(stack_info)¶

Форматирует указанную информацию о стеке (строку, возвращаемую traceback.print_stack(), но с удалённым последним символом новой строки) в строку. Эта реализация по умолчанию просто возвращает входное значение.

Объекты фильтров¶Filter Objects

Filters могут использоваться Handlers и Loggers для более сложной фильтрации, чем та, что обеспечивается уровнями. Базовый класс фильтра пропускает только события, которые находятся ниже определённой точки в иерархии логгеров. Например, фильтр, инициализированный строкой 'A.B', будет пропускать события, записанные логгерами 'A.B', 'A.B.C', 'A.B.C.D', 'A.B.D' и т.д., но не 'A.BB', 'B.A.B' и т.д. Если инициализирован пустой строкой, пропускаются все события.

class logging.Filter(name='')¶

Возвращает экземпляр класса Filter. Если указан name, он задаёт имя логгера, который вместе со своими потомками будет пропускать свои события через фильтр. Если name – пустая строка, пропускаются все события.

filter(record)¶

Следует ли регистрировать указанную запись? Возвращает ноль, если нет, и ненулевое значение, если да. Если это уместно, запись может быть изменена на месте данным методом.

Обратите внимание, что фильтры, прикреплённые к обработчикам, проверяются перед тем, как событие будет отправлено обработчиком, тогда как фильтры, прикреплённые к логгерам, проверяются всякий раз, когда событие регистрируется (с помощью debug(), info() и т.д.), перед отправкой события обработчикам. Это означает, что события, созданные дочерними логгерами, не будут отфильтрованы настройкой фильтра логгера, если только фильтр не был также применён к этим дочерним логгерам.

Не требуется создавать подкласс Filter: можно передать любой экземпляр, у которого есть метод filter с той же семантикой.

Хотя фильтры в первую очередь используются для фильтрации записей на основе более сложных критериев, чем уровни, они видят каждую запись, которая обрабатывается обработчиком или регистратором, к которому они прикреплены: это может быть полезно, если нужно, например, подсчитать, сколько записей было обработано конкретным регистратором или обработчиком, или добавить, изменить или удалить атрибуты в обрабатываемом LogRecord. Очевидно, что изменение LogRecord требует определённой осторожности, но это позволяет внедрять контекстную информацию в журналы (см. Использование фильтров для передачи контекстной информации).

Объекты LogRecord¶LogRecord Objects

Экземпляры LogRecord создаются автоматически Logger каждый раз, когда что-то регистрируется, и могут быть созданы вручную через makeLogRecord() (например, из сериализованного события, полученного по сети).

class logging.LogRecord(name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None)¶

Содержит всю информацию, относящуюся к регистрируемому событию.

Основная информация передаётся через msg и args, которые объединяются с помощью msg % args для создания поля message записи.

Параметры

• name – Имя логгера, используемого для регистрации события, представленного этой LogRecord. Обратите внимание, что это имя всегда будет иметь данное значение, даже если событие может быть отправлено обработчиком, прикреплённым к другому (родительскому) логгеру.

• level – Числовой уровень события логирования (один из DEBUG, INFO и т.д.) Обратите внимание, что он преобразуется в два атрибута LogRecord: levelno для числового значения и levelname для соответствующего имени уровня.

• pathname – Полный путь к исходному файлу, в котором был выполнен вызов логирования.

• lineno – Номер строки в исходном файле, в которой был выполнен вызов логирования.

• msg – Описание события, возможно, строка форматирования с заполнителями для переменных данных.

• args – Переменные данные для подстановки в аргумент msg для получения описания события.

• exc_info – Кортеж исключения с текущей информацией об исключении или None, если информация об исключении отсутствует.

• func – Имя функции или метода, из которого был выполнен вызов логирования.

• sinfo – Текстовая строка, представляющая информацию о стеке от основания стека в текущем потоке до вызова логирования.

getMessage()¶

Возвращает сообщение для этого экземпляра LogRecord после объединения любых аргументов, предоставленных пользователем, с сообщением. Если аргумент сообщения, предоставленный пользователем при вызове журналирования, не является строкой, для преобразования его в строку вызывается str(). Это позволяет использовать определённые пользователем классы в качестве сообщений, чей метод __str__ может возвращать фактическую строку форматирования.

Изменено в версии 3.2: Создание LogRecord стало более настраиваемым благодаря предоставлению фабрики, используемой для создания записи. Фабрику можно задать с помощью getLogRecordFactory() и setLogRecordFactory() (см. сигнатуру фабрики).

Эту функциональность можно использовать для внедрения собственных значений в LogRecord при его создании. Можно воспользоваться следующим шаблоном:

old_factory = logging.getLogRecordFactory()

def record_factory(*args, **kwargs):
    record = old_factory(*args, **kwargs)
    record.custom_attribute = 0xdecafbad
    return record

logging.setLogRecordFactory(record_factory)

При таком шаблоне можно объединять несколько фабрик, и пока они не перезаписывают атрибуты друг друга или случайно не перезаписывают стандартные атрибуты, перечисленные выше, сюрпризов быть не должно.

Атрибуты LogRecord¶LogRecord attributes

LogRecord имеет ряд атрибутов, большинство из которых получены из параметров конструктора. (Обратите внимание, что имена не всегда точно соответствуют между параметрами конструктора LogRecord и атрибутами LogRecord.) Эти атрибуты можно использовать для объединения данных из записи в строку форматирования. В следующей таблице перечислены (в алфавитном порядке) имена атрибутов, их значения и соответствующий заполнитель в строке форматирования в стиле %.

Если используется форматирование {} (str.format()), можно использовать {attrname} в качестве заполнителя в строке форматирования. Если используется форматирование $ (string.Template), используйте форму ${attrname}. В обоих случаях, конечно, замените attrname на фактическое имя атрибута.

В случае форматирования {} можно указать флаги форматирования, поместив их после имени атрибута, отделив двоеточием. Например: заполнитель {msecs:03d} отформатирует значение миллисекунд 4 как 004. Обратитесь к документации str.format() для получения полной информации о доступных параметрах.

Объекты LoggerAdapter¶LoggerAdapter Objects

Экземпляры LoggerAdapter используются для удобной передачи контекстной информации в вызовы логирования. Пример использования см. в разделе добавления контекстной информации в вывод логирования.

class logging.LoggerAdapter(logger, extra)¶

Возвращает экземпляр LoggerAdapter, инициализированный базовым экземпляром Logger и объектом, подобным словарю.

process(msg, kwargs)¶

Изменяет сообщение и/или именованные аргументы, переданные в вызов логирования, чтобы вставить контекстную информацию. Эта реализация берёт объект, переданный как extra конструктору, и добавляет его в kwargs с ключом 'extra'. Возвращаемое значение – кортеж (msg, kwargs), содержащий (возможно изменённые) версии переданных аргументов.

В дополнение к вышеперечисленному, LoggerAdapter поддерживает следующие методы Logger: debug(), info(), warning(), error(), exception(), critical(), log(), isEnabledFor(), getEffectiveLevel(), setLevel() и hasHandlers(). Эти методы имеют те же сигнатуры, что и их аналоги в Logger, поэтому можно использовать оба типа экземпляров взаимозаменяемо.

Потокобезопасность¶Thread Safety

Модуль logging спроектирован так, чтобы быть потокобезопасным без каких-либо специальных действий требуемых от его клиентов. Это достигается за счёт использования threading блокировок; одна блокировка сериализует доступ к общим данным модуля, а каждый обработчик также создаёт блокировку для сериализации доступа к своему нижележащему вводу-выводу.

Если при реализации асинхронных обработчиков сигналов с помощью модуля signal может оказаться, что использовать логирование внутри таких обработчиков невозможно. Это связано с тем, что реализации блокировок в модуле threading не всегда реентерабельны и поэтому не могут быть вызваны из таких обработчиков сигналов.

Функции уровня модуля¶Module-Level Functions

Помимо классов, описанных выше, существует ряд функций уровня модуля.

logging.getLogger(name=None)¶

Возвращает логгер с указанным именем или, если name равно None, возвращает корневой логгер иерархии. Если имя указано, оно обычно представляет собой иерархическое имя, разделённое точками, например 'a', 'a.b' или 'a.b.c.d'. Выбор этих имен полностью зависит от разработчика, использующего логирование.

Все вызовы этой функции с одним и тем же именем возвращают один и тот же экземпляр логгера. Это означает, что экземпляры логгера никогда не нужно передавать между различными частями приложения.

logging.getLoggerClass()¶

Возвращает либо стандартный класс Logger, либо последний класс, переданный в setLoggerClass(). Эту функцию можно вызывать из определения нового класса, чтобы гарантировать, что установка пользовательского класса Logger не отменит настройки, уже применённые другим кодом. Например:

class MyLogger(logging.getLoggerClass()):
    # ... переопределить поведение здесь

logging.getLogRecordFactory()¶

Возвращает вызываемый объект, который используется для создания LogRecord.

Новое в версии 3.2: Эта функция была добавлена вместе с setLogRecordFactory(), чтобы разработчики могли лучше контролировать создание LogRecord, представляющего событие логирования.

См. setLogRecordFactory() для получения дополнительной информации о том, как вызывается фабрика.

logging.debug(msg, *args, **kwargs)¶

Записывает сообщение с уровнем DEBUG в корневой регистратор. Параметр msg – это строка форматирования сообщения, а args – аргументы, которые подставляются в msg с помощью оператора форматирования строк. (Обратите внимание: это означает, что в строке форматирования можно использовать ключевые слова вместе с одним словарным аргументом.)

В kwargs проверяются три именованных аргумента: exc_info, который, если не равен false, добавляет информацию об исключении в сообщение логирования. Если предоставлен кортеж исключения (в формате, возвращаемом sys.exc_info()) или экземпляр исключения, используется он; в противном случае вызывается sys.exc_info() для получения информации об исключении.

Второй необязательный именованный аргумент – stack_info, по умолчанию False. Если true, к сообщению лога добавляется информация о стеке, включая сам вызов логирования. Обратите внимание, что это не та же информация о стеке, что отображается при указании exc_info: первая – это кадры стека от низа стека до вызова логирования в текущем потоке, тогда как вторая – информация о кадрах стека, которые были размотаны после исключения в процессе поиска обработчиков исключений.

Можно указать stack_info независимо от exc_info, например, чтобы просто показать, как был достигнут определённый участок кода, даже если исключения не возникали. Кадры стека выводятся после строки заголовка, которая гласит:

Stack (most recent call last):

Это имитирует Traceback (most recent call last):, используемый при отображении кадров исключения.

Третий необязательный именованный аргумент – extra, с помощью которого можно передать словарь, используемый для заполнения __dict__ объекта LogRecord, созданного для события логирования, пользовательскими атрибутами. Затем эти пользовательские атрибуты можно использовать по своему усмотрению. Например, их можно включать в логируемые сообщения. Пример:

FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s'
logging.basicConfig(format=FORMAT)
d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
logging.warning('Protocol problem: %s', 'connection reset', extra=d)

выведет что-то вроде:

2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset

Ключи в словаре, переданном в extra, не должны совпадать с ключами, используемыми системой логирования. (См. документацию Formatter для получения дополнительной информации о том, какие ключи используются системой логирования.)

Если вы решите использовать эти атрибуты в логируемых сообщениях, необходимо соблюдать осторожность. В приведённом выше примере, например, Formatter настроен с форматной строкой, которая ожидает ключи ‘clientip’ и ‘user’ в словаре атрибутов LogRecord. Если они отсутствуют, сообщение не будет записано, так как возникнет исключение форматирования строки. Поэтому в данном случае необходимо всегда передавать словарь extra с этими ключами.

Хотя это может раздражать, эта функция предназначена для использования в специализированных ситуациях, например, в многопоточных серверах, где один и тот же код выполняется во многих контекстах, а интересующие условия зависят от этого контекста (такие как IP-адрес удаленного клиента и имя аутентифицированного пользователя в приведенном выше примере). В таких обстоятельствах, скорее всего, специализированные Formatters будут использоваться с определенными Handlers.

Новое в версии 3.2: Был добавлен параметр stack_info.

logging.info(msg, *args, **kwargs)¶

Записывает сообщение с уровнем INFO в корневой регистратор. Аргументы интерпретируются так же, как для debug().

logging.warning(msg, *args, **kwargs)¶

Записывает сообщение с уровнем WARNING в корневой регистратор. Аргументы интерпретируются так же, как для debug().

Примечание

Существует устаревшая функция warn, которая функционально идентична warning. Поскольку warn устарела, не используйте её – вместо неё используйте warning.

logging.error(msg, *args, **kwargs)¶

Записывает сообщение с уровнем ERROR в корневой регистратор. Аргументы интерпретируются так же, как для debug().

logging.critical(msg, *args, **kwargs)¶

Записывает сообщение с уровнем CRITICAL в корневой регистратор. Аргументы интерпретируются так же, как для debug().

logging.exception(msg, *args, **kwargs)¶

Записывает сообщение с уровнем ERROR в корневой регистратор. Аргументы интерпретируются так же, как для debug(). Информация об исключении добавляется в сообщение логирования. Эту функцию следует вызывать только из обработчика исключений.

logging.log(level, msg, *args, **kwargs)¶

Записывает сообщение с уровнем level в корневой регистратор. Остальные аргументы интерпретируются так же, как для debug().

Примечание

Указанные выше удобные функции уровня модуля, которые делегируют корневому регистратору, вызывают basicConfig(), чтобы гарантировать наличие хотя бы одного обработчика. Из-за этого их не следует использовать в потоках в версиях Python ниже 2.7.1 и 3.2, если только до запуска потоков в корневой регистратор не был добавлен хотя бы один обработчик. В более ранних версиях Python из-за недостатка потокобезопасности в basicConfig() это (в редких случаях) может привести к многократному добавлению обработчиков в корневой регистратор, что в свою очередь может привести к появлению нескольких сообщений для одного и того же события.

logging.disable(level=CRITICAL)¶

Предоставляет переопределяющий уровень level для всех логгеров, который имеет приоритет над собственным уровнем логгера. Эта функция может быть полезна, когда возникает необходимость временно снизить объём вывода логирования во всём приложении. Её действие заключается в отключении всех вызовов логирования с серьёзностью level и ниже, так что если вызвать её со значением INFO, то все события INFO и DEBUG будут отброшены, а события с серьёзностью WARNING и выше будут обрабатываться в соответствии с эффективным уровнем логгера. Если вызвать logging.disable(logging.NOTSET), это переопределение уровня удаляется, и вывод логирования снова зависит от эффективных уровней отдельных логгеров.

Обратите внимание: если вы определили какой-либо пользовательский уровень логирования выше CRITICAL (это не рекомендуется), вы не сможете полагаться на значение по умолчанию для параметра level, а придётся явно указать подходящее значение.

Изменено в версии 3.7: Параметр level по умолчанию стал равен уровню CRITICAL. За дополнительной информацией об этом изменении обратитесь к задаче #28524.

logging.addLevelName(level, levelName)¶

Связывает уровень level с текстом levelName во внутреннем словаре, который используется для преобразования числовых уровней в текстовое представление, например, когда Formatter форматирует сообщение. Эту функцию также можно использовать для определения собственных уровней. Единственные ограничения: все используемые уровни должны быть зарегистрированы с помощью этой функции, уровни должны быть положительными целыми числами и должны возрастать по степени серьезности.

Примечание

Если вы планируете определять собственные уровни, обратитесь к разделу Пользовательские уровни.

logging.getLevelName(level)¶

Возвращает текстовое представление уровня логирования level. Если уровень является одним из предопределённых CRITICAL, ERROR, WARNING, INFO или DEBUG, возвращается соответствующая строка. Если уровни были связаны с именами с помощью addLevelName(), то возвращается имя, связанное с level. Если передан числовой код, соответствующий одному из определённых уровней, возвращается его строковое представление. В противном случае возвращается строка 'Level %s' % level.

Примечание

Уровни внутри представлены целыми числами (поскольку их нужно сравнивать в логике логирования). Эта функция используется для преобразования между целочисленным уровнем и названием уровня, отображаемым в форматированном выводе лога с помощью спецификатора формата %(levelname)s (см. атрибуты LogRecord).

Изменено в версии 3.4: В версиях Python до 3.4 этой функции также можно было передать текстовый уровень, и она возвращала соответствующее числовое значение уровня. Это недокументированное поведение считалось ошибкой и было удалено в Python 3.4, но восстановлено в 3.4.2 для сохранения обратной совместимости.

logging.makeLogRecord(attrdict)¶

Создаёт и возвращает новый экземпляр LogRecord, атрибуты которого определяются attrdict. Эта функция полезна для получения сериализованного словаря атрибутов LogRecord, отправленного через сокет, и восстановления его в экземпляр LogRecord на принимающей стороне.

logging.basicConfig(**kwargs)¶

Выполняет базовую настройку системы логирования, создавая StreamHandler с Formatter по умолчанию и добавляя его в корневой логгер. Функции debug(), info(), warning(), error() и critical() будут вызывать basicConfig() автоматически, если для корневого логгера не определены обработчики.

Эта функция ничего не делает, если для корневого логгера уже настроены обработчики.

Примечание

Эту функцию следует вызывать из главного потока до запуска других потоков. В версиях Python до 2.7.1 и 3.2, если эта функция вызывается из нескольких потоков, в редких случаях обработчик может быть добавлен в корневой логгер более одного раза, что приводит к неожиданным результатам, например, к дублированию сообщений в логе.

Поддерживаются следующие аргументы ключевых слов.

Формат	Описание
filename	Указывает, что создаётся FileHandler, с использованием указанного имени файла, а не StreamHandler.
filemode	Если указан filename, открыть файл в этом режиме. По умолчанию 'a'.
format	Использует указанную строку формата для обработчика.
datefmt	Использовать указанный формат даты/времени, как принимается time.strftime().
стиль	Если указан format, используйте этот стиль для строки форматирования. Допустимы значения '%', '{' или '$' для printf-стиля, str.format() или string.Template соответственно. По умолчанию '%'.
уровень	Устанавливает уровень корневого регистратора в указанный уровень.
поток данных	Использовать указанный поток для инициализации StreamHandler. Обратите внимание, что этот аргумент несовместим с filename – если указаны оба, возникает ValueError.
обработчики	Если указано, это должна быть итерируемая последовательность уже созданных обработчиков для добавления в корневой регистратор. Любые обработчики, у которых ещё не установлен форматтер, получат форматтер по умолчанию, созданный в этой функции. Обратите внимание, что этот аргумент несовместим с имя файла или поток данных – если указаны оба, возбуждается ValueError.

Изменено в версии 3.2: Был добавлен аргумент стиль.

Изменено в версии 3.3: Был добавлен аргумент обработчики. Были добавлены дополнительные проверки для выявления ситуаций, когда указаны несовместимые аргументы (например, обработчики вместе с поток данных или имя файла, или поток данных вместе с имя файла).

logging.shutdown()¶

Сообщает системе логирования о необходимости выполнить упорядоченное завершение работы, сбрасывая и закрывая все обработчики. Эту функцию следует вызывать при завершении приложения, и после этого вызова не следует использовать систему логирования.

logging.setLoggerClass(klass)¶

Указывает системе логирования использовать класс klass при создании экземпляра регистратора. Класс должен определять __init__() таким образом, чтобы требовался только аргумент name, а __init__() должен вызывать Logger.__init__(). Эта функция обычно вызывается до создания каких-либо регистраторов приложениями, которым требуется нестандартное поведение регистратора. После этого вызова, как и в любое другое время, не создавайте регистраторы напрямую с помощью подкласса: продолжайте использовать API logging.getLogger() для получения регистраторов.

logging.setLogRecordFactory(factory)¶

Устанавливает вызываемый объект, используемый для создания LogRecord.

Параметры

factory – вызываемый объект фабрики, используемый для создания записи журнала.

Новое в версии 3.2: Эта функция была добавлена вместе с getLogRecordFactory(), чтобы разработчики могли лучше контролировать создание LogRecord, представляющего событие логирования.

Фабрика имеет следующую сигнатуру:

factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs)

имя

Имя регистратора.

level

Уровень логирования (числовой).

fn

Полный путь к файлу, в котором был выполнен вызов логирования.

lno

Номер строки в файле, в котором был выполнен вызов логирования.

msg

Сообщение логирования.

аргументы

Аргументы для сообщения логирования.

exc_info

Кортеж исключения или None.

функция

Имя функции или метода, из которого был сделан вызов логирования.

sinfo

Трассировка стека, например, предоставляемая traceback.print_stack(), показывающая иерархию вызовов.

именованные аргументы

Дополнительные именованные аргументы.

Атрибуты уровня модуля¶Module-Level Attributes

logging.lastResort¶

«Обработчик последней надежды» доступен через этот атрибут. Он представляет собой StreamHandler, который пишет в sys.stderr с уровнем WARNING и используется для обработки событий логирования при отсутствии какой-либо конфигурации логирования. В результате сообщение просто выводится в sys.stderr. Это заменяет более раннее сообщение об ошибке, гласившее, «для регистратора XYZ не найдено обработчиков». Если по какой-то причине нужно вернуть прежнее поведение, lastResort можно установить в None.

Новое в версии 3.2.

Интеграция с модулем warnings¶Integration with the warnings module

Функция captureWarnings() может использоваться для интеграции logging с модулем warnings.

logging.captureWarnings(capture)¶

Эта функция используется для включения и выключения перехвата предупреждений системой логирования.

Если capture имеет значение True, предупреждения, выдаваемые модулем warnings, будут перенаправляться в систему логирования. В частности, предупреждение будет отформатировано с помощью warnings.formatwarning(), и результирующая строка будет записана в регистратор с именем 'py.warnings' с уровнем серьезности WARNING.

Если capture имеет значение False, перенаправление предупреждений в систему логирования прекратится, и предупреждения будут направляться по своим исходным адресатам (т.е. тем, которые действовали до вызова captureWarnings(True)).