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

Объекты Logger¶Logger Objects

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

The name is potentially a period-separated hierarchical value, like foo.bar.baz (though it could also be just plain foo, for example). Loggers that are further down in the hierarchical list are children of loggers higher up in the list. For example, given a logger with a name of foo, loggers with names of foo.bar, foo.bar.baz, and foo.bam are all descendants of foo. In addition, all loggers are descendants of the root logger. The logger name hierarchy is analogous to the Python package hierarchy, and identical to it if you organise your loggers on a per-module basis using the recommended construction logging.getLogger(__name__). That’s because in a module, __name__ is the module’s name in the Python package namespace.

class logging.Logger¶

name¶

Это имя логгера, то есть значение, которое было передано в getLogger() для получения логгера.

Примечание

Этот атрибут следует считать доступным только для чтения.

level¶

Пороговое значение этого логгера, установленное методом setLevel().

Примечание

Не устанавливайте этот атрибут напрямую – всегда используйте setLevel(), который проверяет переданный уровень.

parent¶

Родительский логгер этого логгера. Он может измениться при последующем создании логгеров, расположенных выше в иерархии пространства имён.

Примечание

Это значение следует рассматривать как доступное только для чтения.

propagate¶

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

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

Поясним на примере: если атрибут propagate логгера с именем A.B.C истинен, любое событие, записанное в A.B.C через вызов метода, например logging.getLogger('A.B.C').error(...), будет (при условии прохождения проверки уровня и фильтров этого логгера) последовательно передано всем обработчикам, прикреплённым к логгерам с именами A.B, A и корневому логгеру, после того как сначала будет передано обработчикам, прикреплённым к A.B.C. Если у любого логгера в цепочке A.B.C, A.B, A атрибут propagate установлен в false, то это последний логгер, обработчикам которого предлагается обработать событие, и распространение на этом прекращается.

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

Примечание

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

handlers¶

Список обработчиков, непосредственно прикреплённых к этому экземпляру логгера.

Примечание

Этот атрибут следует считать доступным только для чтения; обычно он изменяется через методы addHandler() и removeHandler(), которые используют блокировки для обеспечения потокобезопасной работы.

disabled¶

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

Примечание

Этот атрибут следует считать доступным только для чтения.

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.

getChildren()¶

Возвращает набор регистраторов, которые являются непосредственными дочерними элементами данного регистратора. Например, logging.getLogger().getChildren() может вернуть набор, содержащий регистраторы с именами foo и bar, но регистратор с именем foo.bar не будет включён в набор. Аналогично, logging.getLogger('foo').getChildren() может вернуть набор, включающий регистратор с именем foo.bar, но не включающий регистратор с именем foo.bar.baz.

Добавлено в версии 3.12.

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

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

В kwargs проверяются четыре именованных аргумента: exc_info, stack_info, stacklevel и 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):, используемый при отображении кадров исключения.

Третий необязательный именованный аргумент – stacklevel, по умолчанию 1. Если больше 1, при вычислении номера строки и имени функции, устанавливаемых в LogRecord, создаваемом для события логирования, пропускается соответствующее количество кадров стека. Это можно использовать во вспомогательных функциях логирования, чтобы записываемые имя функции, имя файла и номер строки относились не к вспомогательной функции/методу, а к её вызывающему. Имя этого параметра соответствует эквивалентному параметру в модуле warnings.

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

FORMAT = '%(asctime)s %(clientip)-15s %(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, не должны конфликтовать с ключами, используемыми системой логирования. (Подробнее о том, какие ключи используются системой логирования, см. в разделе Атрибуты LogRecord.)

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

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

Если к этому логгеру (или любому из его предков, с учетом соответствующих атрибутов Logger.propagate) не прикреплен обработчик, сообщение будет отправлено обработчику, установленному на lastResort.

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

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

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

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, stacklevel=1)¶

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

Параметр stacklevel передается из кода, вызывающего debug() и другие API. Если он больше 1, избыток используется для пропуска кадров стека перед определением возвращаемых значений. Обычно это полезно при вызове API логирования из вспомогательного/оберточного кода, чтобы информация в журнале событий относилась не к вспомогательному/оберточному коду, а к коду, который его вызывает.

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)¶

Устанавливает для данного обработчика форматировщик fmt. Аргумент fmt должен быть экземпляром Formatter или None.

addFilter(filter)¶

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

removeFilter(filter)¶

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

filter(record)¶

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

flush()¶

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

close()¶

Освобождает все ресурсы, используемые обработчиком. Данная версия не производит вывод, но удаляет обработчик из внутреннего словаря обработчиков, который используется для поиска обработчика по имени.

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

handle(record)¶

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

handleError(record)¶

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

format(record)¶

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

emit(record)¶

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

Предупреждение

Этот метод вызывается после захвата блокировки уровня обработчика, которая освобождается после возврата из этого метода. При переопределении этого метода следует быть осторожным при вызове чего-либо, что обращается к другим частям API логирования, которые могут выполнять блокировку, так как это может привести к взаимной блокировке. В частности:

• API конфигурации логирования захватывают блокировку уровня модуля, а затем индивидуальные блокировки уровня обработчика при настройке этих обработчиков.

• Многие API логирования блокируют блокировку уровня модуля. Если такой API вызывается из этого метода, это может привести к взаимной блокировке, если вызов конфигурации производится в другом потоке, потому что этот поток будет пытаться захватить блокировку уровня модуля до блокировки уровня обработчика, тогда как данный поток пытается захватить блокировку уровня модуля после блокировки уровня обработчика (поскольку в этом методе блокировка уровня обработчика уже захвачена).

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

Объекты Formatter¶Formatter Objects

class logging.Formatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)¶

Отвечает за преобразование LogRecord в выходную строку, предназначенную для чтения человеком или внешней системой.

Параметры:

• fmt (str) – строка форматирования в заданном style для всего вывода лога в целом. Возможные ключи отображения берутся из LogRecord объекта – атрибутов LogRecord. Если не указано, используется '%(message)s', что равняется самому сообщению лога.

• datefmt (str) – строка форматирования для части даты/времени вывода лога. Если не указано, используется значение по умолчанию, описанное в formatTime().

• style (str) – может быть одним из '%', '{' или '$' и определяет, как строка форматирования будет объединяться с данными: с помощью одного из стилей: printf-стиль форматирования строк (%), str.format() ({) или string.Template ($). Это относится только к fmt (например, '%(message)s' против '{message}'), а не к фактическим сообщениям лога, передаваемым в методы логирования. Однако существуют другие способы использовать {- и $-форматирование для сообщений лога.

• validate (bool) – Если True (по умолчанию), то неверные или несовпадающие fmt и style вызовут ValueError; например, logging.Formatter('%(asctime)s - %(message)s', style='{').

• defaults (dict[str, Any]) – Словарь со значениями по умолчанию для пользовательских полей. Например, logging.Formatter('%(ip)s %(message)s', defaults={"ip": None})

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

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

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

format(record)¶

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

Если доступна информация о стеке, она добавляется после информации об исключении с использованием 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 (для добавления значения в миллисекундах).

Изменено в версии 3.9: default_msec_format может быть None.

formatException(exc_info)¶

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

formatStack(stack_info)¶

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

class logging.BufferingFormatter(linefmt=None)¶

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

formatHeader(records)¶

Возвращает заголовок для списка records. Базовая реализация просто возвращает пустую строку. Этот метод нужно переопределить, если требуется определённое поведение, например, для отображения количества записей, заголовка или строки-разделителя.

formatFooter(records)¶

Возвращает нижний колонтитул для списка records. Базовая реализация просто возвращает пустую строку. Этот метод нужно переопределить, если требуется определённое поведение, например, для отображения количества записей или строки-разделителя.

format(records)¶

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

Объекты фильтров¶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)¶

Должна ли указанная запись быть записана в журнал? Возвращает false для «нет», true для «да». Фильтры могут либо изменять записи журнала на месте, либо возвращать совершенно другой экземпляр записи, который заменит исходную запись журнала при любой последующей обработке события.

Обратите внимание, что фильтры, прикреплённые к обработчикам, проверяются перед тем, как событие будет отправлено обработчиком, тогда как фильтры, прикреплённые к логгерам, проверяются всякий раз, когда событие регистрируется (с помощью 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 (str) – Имя регистратора, использованного для регистрации события, представленного этим LogRecord. Обратите внимание, что имя регистратора в LogRecord всегда будет иметь это значение, даже если оно может быть отправлено обработчиком, прикреплённым к другому (родительскому) регистратору.

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

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

• lineno (int) – Номер строки в исходном файле, из которой был сделан вызов журналирования.

• msg (Any) – Сообщение описания события, которое может быть строкой формата % с заполнителями для переменных данных или произвольным объектом (см. Использование произвольных объектов в качестве сообщений).

• args (tuple | dict[str, Any]) – Переменные данные для объединения с аргументом msg для получения описания события.

• exc_info (tuple[type[BaseException], BaseException, types.TracebackType] | None) – Кортеж исключения с информацией о текущем исключении, возвращаемый sys.exc_info(), или None, если информация об исключении отсутствует.

• func (str | None) – Имя функции или метода, из которого был вызван вызов журналирования.

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

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:03.0f} отформатирует значение миллисекунд 4 как 004. Обратитесь к документации str.format() для получения полной информации о доступных параметрах.

Объекты LoggerAdapter¶LoggerAdapter Objects

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

class logging.LoggerAdapter(logger, extra=None, merge_extra=False)¶

Возвращает экземпляр LoggerAdapter, инициализированный базовым экземпляром Logger, необязательным объектом, подобным словарю (extra), и необязательным булевым значением (merge_extra), указывающим, следует ли объединять аргумент extra отдельных вызовов логирования с extra базового объекта LoggerAdapter. По умолчанию аргумент extra отдельных вызовов логирования игнорируется и используется только extra экземпляра LoggerAdapter

process(msg, kwargs)¶

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

manager¶

Делегирует базовому manager объекта logger.

_log¶

Делегирует базовому методу _log() объекта logger.

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

Изменено в версии 3.2: Методы isEnabledFor(), getEffectiveLevel(), setLevel() и hasHandlers() были добавлены в LoggerAdapter. Эти методы делегируют выполнение базовому логгеру.

Изменено в версии 3.6: Добавлены атрибут manager и метод _log(), которые делегируют выполнение базовому логгеру и позволяют вкладывать адаптеры.

Изменено в версии 3.10: Аргумент extra теперь необязателен.

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

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

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

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

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

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

logging.getLogger(name=None)¶

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

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

logging.getLoggerClass()¶

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

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

logging.getLogRecordFactory()¶

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

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

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

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

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

Единственное отличие в том, что если у корневого логгера нет обработчиков, то вызывается basicConfig() перед вызовом debug на корневом логгере.

Для очень коротких скриптов или быстрых демонстраций возможностей logging могут быть удобны debug и другие функции уровня модуля. Однако большинству программ требуется тщательный и явный контроль конфигурации логирования, поэтому предпочтительнее создавать логгер уровня модуля и вызывать на нём Logger.debug() (или другие методы для конкретных уровней), как описано в начале этой документации.

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().

logging.disable(level=CRITICAL)¶

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

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

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

logging.addLevelName(level, levelName)¶

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

Примечание

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

logging.getLevelNamesMapping()¶

Возвращает отображение имён уровней на соответствующие уровни логирования. Например, строка «CRITICAL» сопоставляется с CRITICAL. Возвращаемое отображение копируется из внутреннего отображения при каждом вызове этой функции.

Добавлено в версии 3.12.

logging.getLevelName(level)¶

Возвращает текстовое или числовое представление уровня логирования level.

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

Параметр level также принимает строковое представление уровня, например «INFO». В таких случаях эта функция возвращает соответствующее числовое значение уровня.

Если не передано ни подходящего числового, ни строкового значения, возвращается строка ‘Level %s’ % level.

Примечание

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

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

logging.getHandlerByName(name)¶

Возвращает обработчик с указанным name или None, если обработчика с таким именем нет.

Добавлено в версии 3.12.

logging.getHandlerNames()¶

Возвращает неизменяемое множество всех известных имён обработчиков.

Добавлено в версии 3.12.

logging.makeLogRecord(attrdict)¶

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

logging.basicConfig(**kwargs)¶

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

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

Примечание

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

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

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

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

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

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

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

Изменено в версии 3.15: Добавлен аргумент formatter.

logging.shutdown()¶

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

При импорте модуля logging эта функция регистрируется как обработчик выхода (см. atexit), поэтому обычно нет необходимости делать это вручную.

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)

name:

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

level:

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

fn:

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

lno:

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

msg:

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

args:

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

exc_info:

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

func:

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

sinfo:

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

kwargs:

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

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

logging.lastResort¶

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

Добавлено в версии 3.2.

logging.raiseExceptions¶

Позволяет определить, нужно ли распространять исключения, возникающие во время обработки.

По умолчанию: True.

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

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

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

logging.captureWarnings(capture)¶

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

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

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