`logging.md`

717 строк · 100.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.9/library/logging.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`logging`](https://python-all.ru/3.9/library/logging.html#module-logging) – Средство логирования для Python89**Исходный код:** [Lib/logging/\_\_init\_\_.py](https://python-all.ru/src/3.9/Lib/logging/__init__.py)1011Важно1213На этой странице содержится справочная информация по API. Обучающую информацию и обсуждение более сложных тем см. в1415- [Базовое руководство](https://python-all.ru/3.9/howto/logging.html#logging-basic-tutorial)16- [Продвинутое руководство](https://python-all.ru/3.9/howto/logging.html#logging-advanced-tutorial)17- [Поваренная книга по логированию](https://python-all.ru/3.9/howto/logging-cookbook.html#logging-cookbook)1819---2021Этот модуль определяет функции и классы, реализующие гибкую систему логирования событий для приложений и библиотек.2223Основное преимущество наличия API логирования, предоставляемого модулем стандартной библиотеки, заключается в том, что все модули Python могут участвовать в логировании, поэтому журнал вашего приложения может включать ваши собственные сообщения вместе с сообщениями от сторонних модулей.2425Модуль предоставляет множество функций и гибкость. Если вы не знакомы с логированием, лучше всего начать с учебных пособий (ссылки справа).2627Ниже перечислены основные классы модуля и их функции.2829- Регистраторы предоставляют интерфейс, который напрямую используется кодом приложения.30- Обработчики отправляют записи журнала (созданные регистраторами) в соответствующее назначение.31- Фильтры предоставляют более детальный механизм для определения того, какие записи журнала выводить.32- Форматировщики определяют расположение записей журнала в конечном выводе.3334## Объекты Logger3536Логгеры имеют следующие атрибуты и методы. Обратите внимание, что логгеры *НИКОГДА* не должны создаваться напрямую, а всегда через функцию уровня модуля `logging.getLogger(name)`. Многократные вызовы [`getLogger()`](https://python-all.ru/3.9/library/logging.html#logging.getLogger) с одним и тем же именем всегда будут возвращать ссылку на один и тот же объект Logger.3738Значение `name` потенциально является иерархическим, разделённым точками, например `foo.bar.baz` (хотя это может быть и просто `foo`). Логгеры, находящиеся ниже в иерархическом списке, являются дочерними по отношению к логгерам, находящимся выше. Например, если есть логгер с именем `foo`, то логгеры с именами `foo.bar`, `foo.bar.baz` и `foo.bam` – все являются потомками `foo`. Иерархия имён логгеров аналогична иерархии пакетов Python и совпадает с ней, если организовать логгеры по модулям, используя рекомендуемую конструкцию `logging.getLogger(__name__)`. Это потому, что в модуле `__name__` – это имя модуля в пространстве имён пакетов Python.3940#### `class logging.Logger`4142#### `propagate`4344Если этот атрибут истинен, события, записанные в этот логгер, будут передаваться обработчикам логгеров более высокого уровня (предков) в дополнение к любым обработчикам, прикреплённым к этому логгеру. Сообщения передаются напрямую обработчикам логгеров-предков – ни уровень, ни фильтры этих логгеров-предков не учитываются.4546Если это ложно, сообщения логирования не передаются обработчикам логгеров-предков.4748Поясним на примере: если атрибут 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, то это последний логгер, обработчикам которого предлагается обработать событие, и распространение на этом прекращается.4950Конструктор устанавливает этот атрибут в `True`.5152> **Примечание**53>54> Если вы прикрепите обработчик к логгеру *и* к одному или нескольким его предкам, он может выдать одну и ту же запись несколько раз. В общем случае нет необходимости прикреплять обработчик к более чем одному логгеру – если прикрепить его к соответствующему логгеру, который находится выше всех в иерархии логгеров, то он будет видеть все события, записанные всеми дочерними логгерами, при условии, что их параметр propagate оставлен равным `True`. Обычная практика – прикреплять обработчики только к корневому логгеру и позволить распространению заботиться об остальном.5556#### `setLevel(level)`5758Устанавливает порог для этого регистратора на *уровень*. Сообщения лога, менее серьёзные, чем *уровень*, будут игнорироваться; сообщения с серьёзностью *уровень* или выше будут отправлены любым обработчиком, обслуживающим этот регистратор, если только уровень обработчика не был установлен на более высокое значение серьёзности, чем *уровень*.5960При создании регистратора уровень устанавливается в `NOTSET` (что приводит к обработке всех сообщений, если регистратор является корневым, или к делегированию родительскому регистратору, если он не корневой). Обратите внимание, что корневой регистратор создаётся с уровнем `WARNING`.6162Термин «делегирование родительскому регистратору» означает, что если у регистратора уровень NOTSET, то просматривается цепочка его регистраторов-предков, пока не будет найден предок с уровнем, отличным от NOTSET, или не будет достигнут корень.6364Если найден предок с уровнем, отличным от NOTSET, то его уровень считается действующим уровнем регистратора, с которого начался поиск предка, и используется для определения обработки события логирования.6566Если достигнут корень и его уровень NOTSET, то будут обработаны все сообщения. В противном случае уровень корня будет использоваться как действующий уровень.6768Список уровней см. в [Уровни логирования](https://python-all.ru/3.9/library/logging.html#levels).6970Изменено в версии 3.2: Параметр *уровень* теперь принимает строковое представление уровня, например 'INFO', вместо целочисленных констант, таких как `INFO`. Однако обратите внимание, что уровни внутри хранятся как целые числа, и такие методы, как [`getEffectiveLevel()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.getEffectiveLevel) и [`isEnabledFor()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.isEnabledFor), будут возвращать/ожидать целые числа.7172#### `isEnabledFor(level)`7374Указывает, будет ли обработано сообщение с *уровнем* серьёзности этим регистратором. Этот метод сначала проверяет уровень модуля, заданный `logging.disable(level)`, а затем действующий уровень регистратора, определяемый [`getEffectiveLevel()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.getEffectiveLevel).7576#### `getEffectiveLevel()`7778Указывает действующий уровень для этого регистратора. Если с помощью [`setLevel()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.setLevel) было установлено значение, отличное от `NOTSET`, возвращается оно. В противном случае иерархия просматривается в сторону корня, пока не будет найдено значение, отличное от `NOTSET`, и возвращается оно. Возвращаемое значение – целое число, обычно одно из `logging.DEBUG`, `logging.INFO` и т.д.7980#### `getChild(suffix)`8182Возвращает регистратор, который является потомком данного регистратора в соответствии с суффиксом. Таким образом, `logging.getLogger('abc').getChild('def.ghi')` вернёт тот же регистратор, что и `logging.getLogger('abc.def.ghi')`. Это удобный метод, полезный, когда родительский регистратор именуется, например, через `__name__`, а не литеральной строкой.8384Новое в версии 3.2.8586#### `debug(msg, *args, **kwargs)`8788Регистрирует сообщение с уровнем `DEBUG` в этом регистраторе. *сообщение* – это строка форматирования сообщения, а *аргументы* – аргументы, которые объединяются с *сообщение* с помощью оператора форматирования строк. (Обратите внимание, что это означает возможность использовать ключевые слова в строке форматирования вместе с одним словарным аргументом.) Если *аргументы* не указаны, операция форматирования % над *сообщение* не выполняется.8990В *kwargs* проверяются четыре именованных аргумента: *exc\_info*, *stack\_info*, *stacklevel* и *extra*.9192Если *exc\_info* не равно false, к сообщению лога добавляется информация об исключении. Если предоставлен кортеж исключения (в формате, возвращаемом [`sys.exc_info()`](https://python-all.ru/3.9/library/sys.html#sys.exc_info)) или экземпляр исключения, используется он; в противном случае вызывается [`sys.exc_info()`](https://python-all.ru/3.9/library/sys.html#sys.exc_info) для получения информации об исключении.9394Второй необязательный именованный аргумент – *stack\_info*, по умолчанию `False`. Если true, к сообщению лога добавляется информация о стеке, включая сам вызов логирования. Обратите внимание, что это не та же информация о стеке, что отображается при указании *exc\_info*: первая – это кадры стека от низа стека до вызова логирования в текущем потоке, тогда как вторая – информация о кадрах стека, которые были размотаны после исключения в процессе поиска обработчиков исключений.9596Можно указать *stack\_info* независимо от *exc\_info*, например, чтобы просто показать, как был достигнут определённый участок кода, даже если исключения не возникали. Кадры стека выводятся после строки заголовка, которая гласит:9798```text99Stack (most recent call last):100```101102Это имитирует `Traceback (most recent call last):`, используемый при отображении кадров исключения.103104Третий необязательный именованный аргумент – *stacklevel*, по умолчанию `1`. Если больше 1, при вычислении номера строки и имени функции, устанавливаемых в [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord), создаваемом для события логирования, пропускается соответствующее количество кадров стека. Это можно использовать во вспомогательных функциях логирования, чтобы записываемые имя функции, имя файла и номер строки относились не к вспомогательной функции/методу, а к её вызывающему. Имя этого параметра соответствует эквивалентному параметру в модуле [`warnings`](https://python-all.ru/3.9/library/warnings.html#module-warnings).105106Четвёртый именованный аргумент – *extra*, который можно использовать для передачи словаря, заполняющего \_\_dict\_\_ объекта [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord), создаваемого для события логирования, пользовательскими атрибутами. Затем эти пользовательские атрибуты можно использовать по своему усмотрению. Например, их можно включить в логируемые сообщения. Например:107108```python109FORMAT = '%(asctime)s %(clientip)-15s %(user)-8s %(message)s'110logging.basicConfig(format=FORMAT)111d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}112logger = logging.getLogger('tcpserver')113logger.warning('Protocol problem: %s', 'connection reset', extra=d)114```115116выведет что-то вроде117118```text1192006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset120```121122Ключи в словаре, переданном в *extra*, не должны совпадать с ключами, используемыми системой логирования. (См. документацию [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter) для получения дополнительной информации о том, какие ключи используются системой логирования.)123124Если решено использовать эти атрибуты в регистрируемых сообщениях, следует соблюдать осторожность. В приведённом выше примере, например, [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter) настроен со строкой форматирования, которая ожидает 'clientip' и 'user' в словаре атрибутов [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord). Если они отсутствуют, сообщение не будет записано, так как возникнет исключение форматирования строки. В этом случае необходимо всегда передавать словарь *extra* с этими ключами.125126Хотя это может раздражать, эта функция предназначена для использования в специализированных ситуациях, например, в многопоточных серверах, где один и тот же код выполняется во многих контекстах, а интересующие условия зависят от этого контекста (такие как IP-адрес удаленного клиента и имя аутентифицированного пользователя в приведенном выше примере). В таких обстоятельствах, скорее всего, специализированные [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter)s будут использоваться с определенными [`Handler`](https://python-all.ru/3.9/library/logging.html#logging.Handler)s.127128Изменено в версии 3.2: Добавлен параметр *stack\_info*.129130Изменено в версии 3.5: Параметр *exc\_info* теперь может принимать экземпляры исключений.131132Изменено в версии 3.8: Добавлен параметр *stacklevel*.133134#### `info(msg, *args, **kwargs)`135136Записывает сообщение с уровнем `INFO` в этот логгер. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).137138#### `warning(msg, *args, **kwargs)`139140Записывает сообщение с уровнем `WARNING` в этот логгер. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).141142> **Примечание**143>144> Существует устаревший метод `warn`, который функционально идентичен `warning`. Поскольку `warn` устарел, не используйте его – используйте `warning`.145146#### `error(msg, *args, **kwargs)`147148Записывает сообщение с уровнем `ERROR` в этот логгер. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).149150#### `critical(msg, *args, **kwargs)`151152Записывает сообщение с уровнем `CRITICAL` в этот логгер. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).153154#### `log(level, msg, *args, **kwargs)`155156Записывает сообщение с целочисленным уровнем *level* в этот логгер. Остальные аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).157158#### `exception(msg, *args, **kwargs)`159160Записывает сообщение с уровнем `ERROR` в этот логгер. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug). К сообщению добавляется информация об исключении. Этот метод следует вызывать только из обработчика исключений.161162#### `addFilter(filter)`163164Добавляет указанный фильтр *filter* к этому логгеру.165166#### `removeFilter(filter)`167168Удаляет указанный фильтр *filter* из этого логгера.169170#### `filter(record)`171172Применяет фильтры этого логгера к записи и возвращает `True`, если запись должна быть обработана. Фильтры опрашиваются по очереди, пока один из них не вернет ложное значение. Если ни один из них не вернул ложное значение, запись будет обработана (передана обработчикам). Если какой-либо фильтр вернул ложное значение, дальнейшая обработка записи не происходит.173174#### `addHandler(hdlr)`175176Добавляет указанный обработчик *hdlr* к этому логгеру.177178#### `removeHandler(hdlr)`179180Удаляет указанный обработчик *hdlr* из этого логгера.181182#### `findCaller(stack_info=False, stacklevel=1)`183184Находит исходное имя файла и номер строки вызывающего кода. Возвращает имя файла, номер строки, имя функции и информацию о стеке в виде кортежа из 4 элементов. Информация о стеке возвращается как `None`, если *stack\_info* не равно `True`.185186Параметр *stacklevel* передается из кода, вызывающего [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug) и другие API. Если он больше 1, избыток используется для пропуска кадров стека перед определением возвращаемых значений. Обычно это полезно при вызове API логирования из вспомогательного/оберточного кода, чтобы информация в журнале событий относилась не к вспомогательному/оберточному коду, а к коду, который его вызывает.187188#### `handle(record)`189190Обрабатывает запись, передавая её всем обработчикам, связанным с этим регистратором и его предками (пока не встретится ложное значение *propagate*). Этот метод используется для распакованных записей, полученных через сокет, а также для созданных локально. Фильтрация на уровне регистратора применяется с помощью [`filter()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.filter).191192#### `makeRecord(name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)`193194Это фабричный метод, который можно переопределить в подклассах для создания специализированных экземпляров [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord).195196#### `hasHandlers()`197198Проверяет, есть ли у этого регистратора настроенные обработчики. Это делается путём поиска обработчиков в этом регистраторе и его родителях в иерархии регистраторов. Возвращает `True`, если обработчик найден, иначе `False`. Метод прекращает поиск вверх по иерархии, как только будет найден регистратор, у которого атрибут 'propagate' установлен в false – это будет последний регистратор, проверяемый на наличие обработчиков.199200Новое в версии 3.2.201202Изменено в версии 3.7: Регистраторы теперь можно сериализовать и десериализовать с помощью пикл.203204## Уровни журналирования205206Числовые значения уровней журналирования приведены в следующей таблице. Они представляют интерес в первую очередь, если вы хотите определить собственные уровни и хотите, чтобы они имели определенные значения относительно предопределенных уровней. Если вы определяете уровень с тем же числовым значением, он перезаписывает предопределенное значение; предопределенное имя теряется.207208| Уровень | Числовое значение |209| --- | --- |210| `CRITICAL` | 50 |211| `ERROR` | 40 |212| `WARNING` | 30 |213| `INFO` | 20 |214| `DEBUG` | 10 |215| `NOTSET` | 0 |216217## Объекты-обработчики218219Обработчики имеют следующие атрибуты и методы. Обратите внимание, что [`Handler`](https://python-all.ru/3.9/library/logging.html#logging.Handler) никогда не создаётся напрямую; этот класс служит базой для более полезных подклассов. Однако метод [`__init__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__init__) в подклассах должен вызывать [`Handler.__init__()`](https://python-all.ru/3.9/library/logging.html#logging.Handler.__init__).220221#### `class logging.Handler`222223#### `__init__(level=NOTSET)`224225Инициализирует экземпляр [`Handler`](https://python-all.ru/3.9/library/logging.html#logging.Handler), устанавливая его уровень, устанавливая список фильтров в пустой список и создавая блокировку (с помощью [`createLock()`](https://python-all.ru/3.9/library/logging.html#logging.Handler.createLock)) для сериализации доступа к механизму ввода-вывода.226227#### `createLock()`228229Инициализирует блокировку потока, которую можно использовать для сериализации доступа к нижележащей функциональности ввода-вывода, которая может не быть потокобезопасной.230231#### `acquire()`232233Захватывает блокировку потока, созданную с помощью [`createLock()`](https://python-all.ru/3.9/library/logging.html#logging.Handler.createLock).234235#### `release()`236237Освобождает блокировку потока, захваченную с помощью [`acquire()`](https://python-all.ru/3.9/library/logging.html#logging.Handler.acquire).238239#### `setLevel(level)`240241Устанавливает порог для этого обработчика в *level*. Сообщения журнала, которые менее серьёзны, чем *level*, будут игнорироваться. При создании обработчика уровень устанавливается в `NOTSET` (что приводит к обработке всех сообщений).242243Список уровней см. в [Уровни логирования](https://python-all.ru/3.9/library/logging.html#levels).244245Изменено в версии 3.2: Параметр *level* теперь принимает строковое представление уровня, например 'INFO', как альтернативу целочисленным константам таким как `INFO`.246247#### `setFormatter(fmt)`248249Устанавливает [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter) для этого обработчика в *fmt*.250251#### `addFilter(filter)`252253Добавляет указанный фильтр *filter* к данному обработчику.254255#### `removeFilter(filter)`256257Удаляет указанный фильтр *filter* из данного обработчика.258259#### `filter(record)`260261Применяет фильтры данного обработчика к записи и возвращает `True`, если запись должна быть обработана. Фильтры опрашиваются по очереди, пока один из них не вернёт ложное значение. Если ни один не вернул ложного значения, запись будет выдана. Если какой-то возвращает ложное значение, обработчик не выдаёт запись.262263#### `flush()`264265Обеспечивает сброс всего вывода логирования. Данная версия ничего не делает и предназначена для реализации в подклассах.266267#### `close()`268269Освобождает все ресурсы, используемые обработчиком. Данная версия не выводит ничего, но удаляет обработчик из внутреннего списка обработчиков, который закрывается при вызове [`shutdown()`](https://python-all.ru/3.9/library/logging.html#logging.shutdown). Подклассы должны обеспечить вызов этого метода из переопределённых методов [`close()`](https://python-all.ru/3.9/library/logging.html#logging.Handler.close).270271#### `handle(record)`272273Условно выдает указанную запись логирования в зависимости от фильтров, которые могут быть добавлены к обработчику. Оборачивает фактическую выдачу записи в захват/освобождение блокировки потока ввода-вывода.274275#### `handleError(record)`276277Этот метод должен вызываться из обработчиков при возникновении исключения во время вызова [`emit()`](https://python-all.ru/3.9/library/logging.html#logging.Handler.emit). Если атрибут уровня модуля `raiseExceptions` равен `False`, исключения молча игнорируются. Это обычно и нужно для системы логирования – большинство пользователей не заботятся об ошибках в системе логирования, их больше интересуют ошибки приложения. Однако при желании можно заменить этот метод собственным обработчиком. Указанная запись – та, что обрабатывалась в момент возникновения исключения. (Значение по умолчанию для `raiseExceptions` – `True`, так как это полезнее во время разработки.)278279#### `format(record)`280281Форматирует запись – если задан форматировщик, использует его. В противном случае использует форматировщик по умолчанию для модуля.282283#### `emit(record)`284285Делает всё необходимое для фактической записи указанной записи логирования. Эта версия предназначена для реализации в подклассах и поэтому возбуждает [`NotImplementedError`](https://python-all.ru/3.9/library/exceptions.html#NotImplementedError).286287Список стандартных обработчиков см. в [`logging.handlers`](https://python-all.ru/3.9/library/logging.handlers.html#module-logging.handlers).288289## Объекты Formatter290291Объекты [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter) имеют следующие атрибуты и методы. Они отвечают за преобразование [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) (обычно) в строку, которая может быть интерпретирована человеком или внешней системой. Базовый [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter) позволяет задать форматирующую строку. Если она не указана, используется значение по умолчанию `'%(message)s'`, которое просто включает сообщение из вызова логирования. Чтобы добавить дополнительные элементы информации в форматированный вывод (например, временную метку), читайте дальше.292293Formatter можно инициализировать строкой форматирования, которая использует знание атрибутов [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) – например, упомянутое выше значение по умолчанию, основанное на том, что сообщение пользователя и аргументы предварительно форматируются в атрибут *message* объекта [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord). Эта строка форматирования содержит стандартные ключи отображения в стиле % языка Python. Дополнительную информацию о форматировании строк см. в разделе [printf-style String Formatting](https://python-all.ru/3.9/library/stdtypes.html#old-string-formatting).294295Полезные ключи отображения в [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) приведены в разделе [LogRecord attributes](https://python-all.ru/3.9/library/logging.html#logrecord-attributes).296297#### `class logging.Formatter(fmt=None, datefmt=None, style='%', validate=True)`298299Возвращает новый экземпляр класса [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter). Экземпляр инициализируется строкой форматирования для всего сообщения, а также строкой форматирования для части даты/времени сообщения. Если *fmt* не указан, используется `'%(message)s'`. Если *datefmt* не указан, используется формат, описанный в документации [`formatTime()`](https://python-all.ru/3.9/library/logging.html#logging.Formatter.formatTime).300301Параметр *style* может быть одним из '%', '{' или '$' и определяет, как строка форматирования будет объединена с данными: с помощью одного из %-форматирования, [`str.format()`](https://python-all.ru/3.9/library/stdtypes.html#str.format) или [`string.Template`](https://python-all.ru/3.9/library/string.html#string.Template). Это относится только к строке форматирования *fmt* (например, `'%(message)s'` или `{message}`), а не к фактическим сообщениям журнала, передаваемым в `Logger.debug` и т.д.; см. [Using particular formatting styles throughout your application](https://python-all.ru/3.9/howto/logging-cookbook.html#formatting-styles) для получения дополнительной информации об использовании форматирования с { и $ для сообщений журнала.302303Изменено в версии 3.2: Добавлен параметр *style*.304305Изменено в версии 3.8: Добавлен параметр *validate*. Неправильный или несоответствующий стиль и fmt приведут к возникновению `ValueError`. Например: `logging.Formatter('%(asctime)s - %(message)s', style='{')`.306307#### `format(record)`308309Словарь атрибутов записи используется как операнд для операции форматирования строки. Возвращает результирующую строку. Перед форматированием словаря выполняется несколько подготовительных шагов. Атрибут *message* записи вычисляется с помощью *msg* % *args*. Если строка форматирования содержит `'(asctime)'`, вызывается [`formatTime()`](https://python-all.ru/3.9/library/logging.html#logging.Formatter.formatTime) для форматирования времени события. Если есть информация об исключении, она форматируется с помощью [`formatException()`](https://python-all.ru/3.9/library/logging.html#logging.Formatter.formatException) и добавляется к сообщению. Обратите внимание, что отформатированная информация об исключении кэшируется в атрибуте *exc\_text*. Это полезно, поскольку информацию об исключении можно сериализовать и передавать по сети, но следует быть осторожным, если имеется более одного подкласса [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter), который настраивает форматирование информации об исключении. В этом случае придётся очищать кэшированное значение после того, как форматер выполнит своё форматирование, чтобы следующий форматер, обрабатывающий событие, не использовал кэшированное значение, а пересчитал его заново.310311Если доступна информация о стеке, она добавляется после информации об исключении с использованием [`formatStack()`](https://python-all.ru/3.9/library/logging.html#logging.Formatter.formatStack) для её преобразования, если необходимо.312313#### `formatTime(record, datefmt=None)`314315Этот метод должен вызываться из [`format()`](https://python-all.ru/3.9/library/functions.html#format) форматтером, который хочет использовать отформатированное время. Этот метод можно переопределить в форматтерах для удовлетворения любых конкретных требований, но базовое поведение следующее: если указан *datefmt* (строка), он используется с [`time.strftime()`](https://python-all.ru/3.9/library/time.html#time.strftime) для форматирования времени создания записи. В противном случае используется формат '%Y-%m-%d %H:%M:%S,uuu', где часть uuu – это значение в миллисекундах, а остальные буквы – согласно документации [`time.strftime()`](https://python-all.ru/3.9/library/time.html#time.strftime). Пример времени в этом формате: `2003-01-23 00:29:50,411`. Возвращается результирующая строка.316317Эта функция использует настраиваемую пользователем функцию для преобразования времени создания в кортеж. По умолчанию используется [`time.localtime()`](https://python-all.ru/3.9/library/time.html#time.localtime); чтобы изменить это для конкретного экземпляра форматтера, установите атрибут `converter` на функцию с той же сигнатурой, что и [`time.localtime()`](https://python-all.ru/3.9/library/time.html#time.localtime) или [`time.gmtime()`](https://python-all.ru/3.9/library/time.html#time.gmtime). Чтобы изменить это для всех форматтеров, например, если вы хотите показывать все времена логирования в GMT, установите атрибут `converter` в классе `Formatter`.318319Изменено в версии 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` (для добавления значения в миллисекундах).320321Изменено в версии 3.9: `default_msec_format` может быть `None`.322323#### `formatException(exc_info)`324325Форматирует указанную информацию об исключении (стандартный кортеж исключения, возвращаемый [`sys.exc_info()`](https://python-all.ru/3.9/library/sys.html#sys.exc_info)) в строку. Эта реализация по умолчанию просто использует [`traceback.print_exception()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_exception). Возвращается результирующая строка.326327#### `formatStack(stack_info)`328329Форматирует указанную информацию о стеке (строку, возвращаемую [`traceback.print_stack()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_stack), но с удалённым последним символом новой строки) в строку. Эта реализация по умолчанию просто возвращает входное значение.330331## Объекты фильтров332333`Filters` могут использоваться `Handlers` и `Loggers` для более сложной фильтрации, чем та, что обеспечивается уровнями. Базовый класс фильтра пропускает только события, которые находятся ниже определённой точки в иерархии логгеров. Например, фильтр, инициализированный строкой 'A.B', будет пропускать события, записанные логгерами 'A.B', 'A.B.C', 'A.B.C.D', 'A.B.D' и т.д., но не 'A.BB', 'B.A.B' и т.д. Если инициализирован пустой строкой, пропускаются все события.334335#### `class logging.Filter(name='')`336337Возвращает экземпляр класса [`Filter`](https://python-all.ru/3.9/library/logging.html#logging.Filter). Если указан *name*, он задаёт имя логгера, который вместе со своими потомками будет пропускать свои события через фильтр. Если *name* – пустая строка, пропускаются все события.338339#### `filter(record)`340341Следует ли регистрировать указанную запись? Возвращает ноль, если нет, и ненулевое значение, если да. Если это уместно, запись может быть изменена на месте данным методом.342343Обратите внимание, что фильтры, прикреплённые к обработчикам, проверяются перед тем, как событие будет отправлено обработчиком, тогда как фильтры, прикреплённые к логгерам, проверяются всякий раз, когда событие регистрируется (с помощью [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug), [`info()`](https://python-all.ru/3.9/library/logging.html#logging.info) и т.д.), перед отправкой события обработчикам. Это означает, что события, созданные дочерними логгерами, не будут отфильтрованы настройкой фильтра логгера, если только фильтр не был также применён к этим дочерним логгерам.344345Не требуется создавать подкласс `Filter`: можно передать любой экземпляр, у которого есть метод `filter` с той же семантикой.346347Изменено в версии 3.2: Не требуется создавать специализированные классы `Filter` или использовать другие классы с методом `filter`: можно использовать функцию (или другой вызываемый объект) в качестве фильтра. Логика фильтрации проверяет, есть ли у объекта фильтра атрибут `filter`: если есть, считается, что это `Filter`, и вызывается его метод [`filter()`](https://python-all.ru/3.9/library/logging.html#logging.Filter.filter). В противном случае считается, что это вызываемый объект, и он вызывается с записью в качестве единственного параметра. Возвращаемое значение должно соответствовать тому, что возвращается [`filter()`](https://python-all.ru/3.9/library/logging.html#logging.Filter.filter).348349Хотя фильтры в первую очередь используются для фильтрации записей по более сложным критериям, чем уровни, они видят каждую запись, обрабатываемую обработчиком или регистратором, к которому они прикреплены: это может быть полезно, если нужно, например, подсчитать, сколько записей было обработано конкретным регистратором или обработчиком, или добавить, изменить или удалить атрибуты в обрабатываемом [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord). Очевидно, что изменение LogRecord требует осторожности, но это позволяет вставлять контекстную информацию в журналы (см. [Использование фильтров для добавления контекстной информации](https://python-all.ru/3.9/howto/logging-cookbook.html#filters-contextual)).350351## Объекты LogRecord352353Экземпляры [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) создаются автоматически [`Logger`](https://python-all.ru/3.9/library/logging.html#logging.Logger) каждый раз, когда что-то регистрируется, и могут быть созданы вручную через [`makeLogRecord()`](https://python-all.ru/3.9/library/logging.html#logging.makeLogRecord) (например, из сериализованного события, полученного по сети).354355#### `class logging.LogRecord(name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None)`356357Содержит всю информацию, относящуюся к регистрируемому событию.358359Основная информация передаётся через `msg` и `args`, которые объединяются с помощью `msg % args` для создания поля `message` записи.360361**Параметры**362363- **name** – Имя логгера, используемого для регистрации события, представленного этой LogRecord. Обратите внимание, что это имя всегда будет иметь данное значение, даже если событие может быть отправлено обработчиком, прикреплённым к другому (родительскому) логгеру.364- **level** – Числовой уровень события логирования (один из DEBUG, INFO и т.д.) Обратите внимание, что он преобразуется в *два* атрибута LogRecord: `levelno` для числового значения и `levelname` для соответствующего имени уровня.365- **pathname** – Полный путь к исходному файлу, в котором был выполнен вызов логирования.366- **lineno** – Номер строки в исходном файле, в которой был выполнен вызов логирования.367- **msg** – Описание события, возможно, строка форматирования с заполнителями для переменных данных.368- **args** – Переменные данные для подстановки в аргумент *msg* для получения описания события.369- **exc\_info** – Кортеж исключения с текущей информацией об исключении или `None`, если информация об исключении отсутствует.370- **func** – Имя функции или метода, из которого был выполнен вызов логирования.371- **sinfo** – Текстовая строка, представляющая информацию о стеке от основания стека в текущем потоке до вызова логирования.372373#### `getMessage()`374375Возвращает сообщение для этого экземпляра [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) после объединения любых аргументов, предоставленных пользователем, с сообщением. Если аргумент сообщения, предоставленный пользователем при вызове журналирования, не является строкой, для преобразования его в строку вызывается [`str()`](https://python-all.ru/3.9/library/stdtypes.html#str). Это позволяет использовать определённые пользователем классы в качестве сообщений, чей метод `__str__` может возвращать фактическую строку форматирования.376377Изменено в версии 3.2: Создание [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) стало более настраиваемым благодаря предоставлению фабрики, используемой для создания записи. Фабрику можно задать с помощью [`getLogRecordFactory()`](https://python-all.ru/3.9/library/logging.html#logging.getLogRecordFactory) и [`setLogRecordFactory()`](https://python-all.ru/3.9/library/logging.html#logging.setLogRecordFactory) (см. сигнатуру фабрики).378379Эта функциональность может быть использована для внедрения собственных значений в [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) во время создания. Можно использовать следующий шаблон:380381```python382old_factory = logging.getLogRecordFactory()383384def record_factory(*args, **kwargs):385    record = old_factory(*args, **kwargs)386    record.custom_attribute = 0xdecafbad387    return record388389logging.setLogRecordFactory(record_factory)390```391392При таком шаблоне можно объединять несколько фабрик, и пока они не перезаписывают атрибуты друг друга или случайно не перезаписывают стандартные атрибуты, перечисленные выше, сюрпризов быть не должно.393394## Атрибуты LogRecord395396LogRecord имеет ряд атрибутов, большинство из которых получены из параметров конструктора. (Обратите внимание, что имена не всегда точно соответствуют между параметрами конструктора LogRecord и атрибутами LogRecord.) Эти атрибуты можно использовать для объединения данных из записи в строку форматирования. В следующей таблице перечислены (в алфавитном порядке) имена атрибутов, их значения и соответствующий заполнитель в строке форматирования в стиле %.397398Если используется форматирование {} ([`str.format()`](https://python-all.ru/3.9/library/stdtypes.html#str.format)), можно использовать `{attrname}` в качестве заполнителя в строке форматирования. Если используется форматирование $ ([`string.Template`](https://python-all.ru/3.9/library/string.html#string.Template)), используйте форму `${attrname}`. В обоих случаях, конечно, замените `attrname` на фактическое имя атрибута.399400В случае форматирования {} можно указать флаги форматирования, поместив их после имени атрибута, отделив двоеточием. Например: заполнитель `{msecs:03d}` отформатирует значение миллисекунд `4` как `004`. Обратитесь к документации [`str.format()`](https://python-all.ru/3.9/library/stdtypes.html#str.format) для получения полной информации о доступных параметрах.401402| Имя атрибута | Формат | Описание |403| --- | --- | --- |404| аргументы | Форматировать это самостоятельно не требуется. | Кортеж аргументов, объединяемых в `msg` для получения `message`, или словарь, значения которого используются для объединения (когда есть только один аргумент, и это словарь). |405| asctime | `%(asctime)s` | Время создания [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) в удобочитаемом формате. По умолчанию оно имеет вид '2003-07-08 16:49:45,896' (цифры после запятой – миллисекундная часть времени). |406| created | `%(created)f` | Время создания [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) (возвращается [`time.time()`](https://python-all.ru/3.9/library/time.html#time.time)). |407| exc\_info | Форматировать это самостоятельно не требуется. | Кортеж с информацией об исключении (как в `sys.exc_info`) или `None`, если исключения не было. |408| filename | `%(filename)s` | Часть имени файла из `pathname`. |409| funcName | `%(funcName)s` | Имя функции, содержащей вызов логирования. |410| levelname | `%(levelname)s` | Текстовый уровень логирования для сообщения (`'DEBUG'`, `'INFO'`, `'WARNING'`, `'ERROR'`, `'CRITICAL'`). |411| levelno | `%(levelno)s` | Числовой уровень логирования для сообщения (`DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`). |412| lineno | `%(lineno)d` | Номер строки исходного кода, из которой был сделан вызов логирования (если доступен). |413| message | `%(message)s` | Журналируемое сообщение, вычисляемое как `msg % args`. Задаётся при вызове [`Formatter.format()`](https://python-all.ru/3.9/library/logging.html#logging.Formatter.format). |414| модуль | `%(module)s` | Модуль (часть имени из `filename`). |415| msecs | `%(msecs)d` | Миллисекундная часть времени создания [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord). |416| msg | Форматировать это самостоятельно не требуется. | Строка формата, переданная в исходном вызове логирования. Объединяется с `args` для получения `message`, или произвольный объект (см. [Использование произвольных объектов в качестве сообщений](https://python-all.ru/3.9/howto/logging.html#arbitrary-object-messages)). |417| имя | `%(name)s` | Имя регистратора, использованного для записи вызова. |418| pathname | `%(pathname)s` | Полный путь к исходному файлу, из которого был сделан вызов логирования (если доступен). |419| процесс | `%(process)d` | Идентификатор процесса (если доступен). |420| processName | `%(processName)s` | Имя процесса (если доступно). |421| relativeCreated | `%(relativeCreated)d` | Время в миллисекундах, когда LogRecord был создан, относительно времени загрузки модуля logging. |422| stack\_info | Форматировать это самостоятельно не требуется. | Информация о стековых фреймах (где доступна) от дна стека в текущем потоке до стекового фрейма включительно, соответствующего вызову логирования, который привёл к созданию этой записи. |423| поток | `%(thread)d` | Идентификатор потока (если доступен). |424| threadName | `%(threadName)s` | Имя потока (если доступно). |425426Изменено в версии 3.1: *processName* был добавлен.427428## Объекты LoggerAdapter429430Экземпляры [`LoggerAdapter`](https://python-all.ru/3.9/library/logging.html#logging.LoggerAdapter) используются для удобной передачи контекстной информации в вызовы логирования. Пример использования см. в разделе [добавления контекстной информации в вывод логирования](https://python-all.ru/3.9/howto/logging-cookbook.html#context-info).431432#### `class logging.LoggerAdapter(logger, extra)`433434Возвращает экземпляр [`LoggerAdapter`](https://python-all.ru/3.9/library/logging.html#logging.LoggerAdapter), инициализированный базовым экземпляром [`Logger`](https://python-all.ru/3.9/library/logging.html#logging.Logger) и объектом, подобным словарю.435436#### `process(msg, kwargs)`437438Изменяет сообщение и/или именованные аргументы, переданные в вызов логирования, чтобы вставить контекстную информацию. Эта реализация берёт объект, переданный как *extra* конструктору, и добавляет его в *kwargs* с ключом 'extra'. Возвращаемое значение – кортеж (*msg*, *kwargs*), содержащий (возможно изменённые) версии переданных аргументов.439440В дополнение к вышеперечисленному, [`LoggerAdapter`](https://python-all.ru/3.9/library/logging.html#logging.LoggerAdapter) поддерживает следующие методы [`Logger`](https://python-all.ru/3.9/library/logging.html#logging.Logger): [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.debug), [`info()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.info), [`warning()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.warning), [`error()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.error), [`exception()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.exception), [`critical()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.critical), [`log()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.log), [`isEnabledFor()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.isEnabledFor), [`getEffectiveLevel()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.getEffectiveLevel), [`setLevel()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.setLevel) и [`hasHandlers()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.hasHandlers). Эти методы имеют те же сигнатуры, что и их аналоги в [`Logger`](https://python-all.ru/3.9/library/logging.html#logging.Logger), поэтому можно использовать оба типа экземпляров взаимозаменяемо.441442Изменено в версии 3.2: Методы [`isEnabledFor()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.isEnabledFor), [`getEffectiveLevel()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.getEffectiveLevel), [`setLevel()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.setLevel) и [`hasHandlers()`](https://python-all.ru/3.9/library/logging.html#logging.Logger.hasHandlers) были добавлены в [`LoggerAdapter`](https://python-all.ru/3.9/library/logging.html#logging.LoggerAdapter). Эти методы делегируют выполнение базовому логгеру.443444Изменено в версии 3.6: Добавлены атрибут `manager` и метод `_log()`, которые делегируют выполнение базовому логгеру и позволяют вкладывать адаптеры.445446## Потокобезопасность447448Модуль logging спроектирован так, чтобы быть потокобезопасным без каких-либо специальных действий требуемых от его клиентов. Это достигается за счёт использования threading блокировок; одна блокировка сериализует доступ к общим данным модуля, а каждый обработчик также создаёт блокировку для сериализации доступа к своему нижележащему вводу-выводу.449450Если при реализации асинхронных обработчиков сигналов с помощью модуля [`signal`](https://python-all.ru/3.9/library/signal.html#module-signal) может оказаться, что использовать логирование внутри таких обработчиков невозможно. Это связано с тем, что реализации блокировок в модуле [`threading`](https://python-all.ru/3.9/library/threading.html#module-threading) не всегда реентерабельны и поэтому не могут быть вызваны из таких обработчиков сигналов.451452## Функции уровня модуля453454Помимо классов, описанных выше, существует ряд функций уровня модуля.455456#### `logging.getLogger(name=None)`457458Возвращает логгер с указанным именем или, если name равно `None`, возвращает корневой логгер иерархии. Если имя указано, оно обычно представляет собой иерархическое имя, разделённое точками, например *'a'*, *'a.b'* или *'a.b.c.d'*. Выбор этих имен полностью зависит от разработчика, использующего логирование.459460Все вызовы этой функции с одним и тем же именем возвращают один и тот же экземпляр логгера. Это означает, что экземпляры логгера никогда не нужно передавать между различными частями приложения.461462#### `logging.getLoggerClass()`463464Возвращает либо стандартный класс [`Logger`](https://python-all.ru/3.9/library/logging.html#logging.Logger), либо последний класс, переданный в [`setLoggerClass()`](https://python-all.ru/3.9/library/logging.html#logging.setLoggerClass). Эту функцию можно вызывать из определения нового класса, чтобы гарантировать, что установка пользовательского класса [`Logger`](https://python-all.ru/3.9/library/logging.html#logging.Logger) не отменит настройки, уже применённые другим кодом. Например:465466```python467class MyLogger(logging.getLoggerClass()):468    # ... переопределить поведение здесь469```470471#### `logging.getLogRecordFactory()`472473Возвращает вызываемый объект, который используется для создания [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord).474475Новое в версии 3.2: Эта функция была добавлена вместе с [`setLogRecordFactory()`](https://python-all.ru/3.9/library/logging.html#logging.setLogRecordFactory), чтобы разработчики могли лучше контролировать создание [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord), представляющего событие логирования.476477См. [`setLogRecordFactory()`](https://python-all.ru/3.9/library/logging.html#logging.setLogRecordFactory) для получения дополнительной информации о том, как вызывается фабрика.478479#### `logging.debug(msg, *args, **kwargs)`480481Записывает сообщение с уровнем `DEBUG` в корневой регистратор. Параметр *msg* – это строка форматирования сообщения, а *args* – аргументы, которые подставляются в *msg* с помощью оператора форматирования строк. (Обратите внимание: это означает, что в строке форматирования можно использовать ключевые слова вместе с одним словарным аргументом.)482483В *kwargs* проверяются три именованных аргумента: *exc\_info*, который, если не равен false, добавляет информацию об исключении в сообщение логирования. Если предоставлен кортеж исключения (в формате, возвращаемом [`sys.exc_info()`](https://python-all.ru/3.9/library/sys.html#sys.exc_info)) или экземпляр исключения, используется он; в противном случае вызывается [`sys.exc_info()`](https://python-all.ru/3.9/library/sys.html#sys.exc_info) для получения информации об исключении.484485Второй необязательный именованный аргумент – *stack\_info*, по умолчанию `False`. Если true, к сообщению лога добавляется информация о стеке, включая сам вызов логирования. Обратите внимание, что это не та же информация о стеке, что отображается при указании *exc\_info*: первая – это кадры стека от низа стека до вызова логирования в текущем потоке, тогда как вторая – информация о кадрах стека, которые были размотаны после исключения в процессе поиска обработчиков исключений.486487Можно указать *stack\_info* независимо от *exc\_info*, например, чтобы просто показать, как был достигнут определённый участок кода, даже если исключения не возникали. Кадры стека выводятся после строки заголовка, которая гласит:488489```text490Stack (most recent call last):491```492493Это имитирует `Traceback (most recent call last):`, используемый при отображении кадров исключения.494495Третий необязательный именованный аргумент – *extra*, с помощью которого можно передать словарь, используемый для заполнения \_\_dict\_\_ объекта LogRecord, созданного для события логирования, пользовательскими атрибутами. Затем эти пользовательские атрибуты можно использовать по своему усмотрению. Например, их можно включать в логируемые сообщения. Пример:496497```python498FORMAT = '%(asctime)s %(clientip)-15s %(user)-8s %(message)s'499logging.basicConfig(format=FORMAT)500d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}501logging.warning('Protocol problem: %s', 'connection reset', extra=d)502```503504выведет что-то вроде:505506```text5072006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset508```509510Ключи в словаре, переданном в *extra*, не должны совпадать с ключами, используемыми системой логирования. (См. документацию [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter) для получения дополнительной информации о том, какие ключи используются системой логирования.)511512Если вы решите использовать эти атрибуты в логируемых сообщениях, необходимо соблюдать осторожность. В приведённом выше примере, например, [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter) настроен с форматной строкой, которая ожидает ключи ‘clientip’ и ‘user’ в словаре атрибутов LogRecord. Если они отсутствуют, сообщение не будет записано, так как возникнет исключение форматирования строки. Поэтому в данном случае необходимо всегда передавать словарь *extra* с этими ключами.513514Хотя это может раздражать, эта функция предназначена для использования в специализированных ситуациях, например, в многопоточных серверах, где один и тот же код выполняется во многих контекстах, а интересующие условия зависят от этого контекста (такие как IP-адрес удаленного клиента и имя аутентифицированного пользователя в приведенном выше примере). В таких обстоятельствах, скорее всего, специализированные [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter)s будут использоваться с определенными [`Handler`](https://python-all.ru/3.9/library/logging.html#logging.Handler)s.515516Изменено в версии 3.2: Добавлен параметр *stack\_info*.517518#### `logging.info(msg, *args, **kwargs)`519520Записывает сообщение с уровнем `INFO` в корневой регистратор. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).521522#### `logging.warning(msg, *args, **kwargs)`523524Записывает сообщение с уровнем `WARNING` в корневой регистратор. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).525526> **Примечание**527>528> Существует устаревшая функция `warn`, которая функционально идентична `warning`. Поскольку `warn` устарела, не используйте её – вместо неё используйте `warning`.529530#### `logging.error(msg, *args, **kwargs)`531532Записывает сообщение с уровнем `ERROR` в корневой регистратор. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).533534#### `logging.critical(msg, *args, **kwargs)`535536Записывает сообщение с уровнем `CRITICAL` в корневой регистратор. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).537538#### `logging.exception(msg, *args, **kwargs)`539540Записывает сообщение с уровнем `ERROR` в корневой регистратор. Аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug). Информация об исключении добавляется в сообщение логирования. Эту функцию следует вызывать только из обработчика исключений.541542#### `logging.log(level, msg, *args, **kwargs)`543544Записывает сообщение с уровнем *level* в корневой регистратор. Остальные аргументы интерпретируются так же, как для [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug).545546#### `logging.disable(level=CRITICAL)`547548Предоставляет переопределяющий уровень *level* для всех логгеров, который имеет приоритет над собственным уровнем логгера. Эта функция может быть полезна, когда возникает необходимость временно снизить объём вывода логирования во всём приложении. Её действие заключается в отключении всех вызовов логирования с серьёзностью *level* и ниже, так что если вызвать её со значением INFO, то все события INFO и DEBUG будут отброшены, а события с серьёзностью WARNING и выше будут обрабатываться в соответствии с эффективным уровнем логгера. Если вызвать `logging.disable(logging.NOTSET)`, это переопределение уровня удаляется, и вывод логирования снова зависит от эффективных уровней отдельных логгеров.549550Обратите внимание: если вы определили какой-либо пользовательский уровень логирования выше `CRITICAL` (это не рекомендуется), вы не сможете полагаться на значение по умолчанию для параметра *level*, а придётся явно указать подходящее значение.551552Изменено в версии 3.7: Параметр *level* по умолчанию стал равен уровню `CRITICAL`. См. [bpo-28524](https://python-all.ru/3.9/library/logging.html) для получения дополнительной информации об этом изменении.553554#### `logging.addLevelName(level, levelName)`555556Связывает уровень *level* с текстом *levelName* во внутреннем словаре, который используется для преобразования числовых уровней в текстовое представление, например, когда [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter) форматирует сообщение. Эту функцию также можно использовать для определения собственных уровней. Единственные ограничения: все используемые уровни должны быть зарегистрированы с помощью этой функции, уровни должны быть положительными целыми числами и должны возрастать по степени серьезности.557558> **Примечание**559>560> Если вы планируете определять собственные уровни, обратитесь к разделу [Пользовательские уровни](https://python-all.ru/3.9/howto/logging.html#custom-levels).561562#### `logging.getLevelName(level)`563564Возвращает текстовое или числовое представление уровня логирования *level*.565566Если *level* является одним из предопределённых уровней `CRITICAL`, `ERROR`, `WARNING`, `INFO` или `DEBUG`, то возвращается соответствующая строка. Если вы связали уровни с именами с помощью [`addLevelName()`](https://python-all.ru/3.9/library/logging.html#logging.addLevelName), то возвращается имя, которое вы связали с *level*. Если передано числовое значение, соответствующее одному из определённых уровней, возвращается соответствующее строковое представление.567568Параметр *level* также принимает строковое представление уровня, например «INFO». В таких случаях эта функция возвращает соответствующее числовое значение уровня.569570Если не передано ни подходящего числового, ни строкового значения, возвращается строка ‘Level %s’ % level.571572> **Примечание**573>574> Уровни внутри себя являются целыми числами (так как их нужно сравнивать в логике логирования). Эта функция используется для преобразования между целочисленным уровнем и именем уровня, отображаемым в форматированном выводе лога с помощью спецификатора формата `%(levelname)s` (см. [атрибуты LogRecord](https://python-all.ru/3.9/library/logging.html#logrecord-attributes)), и наоборот.575576Изменено в версии 3.4: В версиях Python до 3.4 этой функции также можно было передать текстовый уровень, и она возвращала соответствующее числовое значение уровня. Это недокументированное поведение считалось ошибкой и было удалено в Python 3.4, но восстановлено в 3.4.2 для сохранения обратной совместимости.577578#### `logging.makeLogRecord(attrdict)`579580Создаёт и возвращает новый экземпляр [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord), атрибуты которого определяются *attrdict*. Эта функция полезна для получения сериализованного словаря атрибутов [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord), отправленного через сокет, и восстановления его в экземпляр [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord) на принимающей стороне.581582#### `logging.basicConfig(**kwargs)`583584Выполняет базовую настройку системы логирования, создавая [`StreamHandler`](https://python-all.ru/3.9/library/logging.handlers.html#logging.StreamHandler) с [`Formatter`](https://python-all.ru/3.9/library/logging.html#logging.Formatter) по умолчанию и добавляя его в корневой логгер. Функции [`debug()`](https://python-all.ru/3.9/library/logging.html#logging.debug), [`info()`](https://python-all.ru/3.9/library/logging.html#logging.info), [`warning()`](https://python-all.ru/3.9/library/logging.html#logging.warning), [`error()`](https://python-all.ru/3.9/library/logging.html#logging.error) и [`critical()`](https://python-all.ru/3.9/library/logging.html#logging.critical) будут вызывать [`basicConfig()`](https://python-all.ru/3.9/library/logging.html#logging.basicConfig) автоматически, если для корневого логгера не определены обработчики.585586Эта функция ничего не делает, если у корневого логгера уже настроены обработчики, если только аргумент ключевого слова *force* не установлен в `True`.587588> **Примечание**589>590> Эту функцию следует вызывать из главного потока до запуска других потоков. В версиях Python до 2.7.1 и 3.2, если эта функция вызывается из нескольких потоков, в редких случаях обработчик может быть добавлен в корневой логгер более одного раза, что приводит к неожиданным результатам, например, к дублированию сообщений в логе.591592Поддерживаются следующие аргументы ключевых слов.593594| Формат | Описание |595| --- | --- |596| *filename* | Указывает, что создаётся FileHandler, с использованием указанного имени файла, а не StreamHandler. |597| *filemode* | Если указан *filename*, открыть файл в этом [режиме](https://python-all.ru/3.9/library/functions.html#filemodes). По умолчанию `'a'`. |598| *format* | Использовать указанную строку формата для обработчика. По умолчанию – атрибуты `levelname`, `name` и `message`, разделённые двоеточиями. |599| *datefmt* | Использовать указанный формат даты/времени, как принимается [`time.strftime()`](https://python-all.ru/3.9/library/time.html#time.strftime). |600| *стиль* | Если указан *format*, используйте этот стиль для строки форматирования. Допустимы значения `'%'`, `'{'` или `'$'` для [printf-стиля](https://python-all.ru/3.9/library/stdtypes.html#old-string-formatting), [`str.format()`](https://python-all.ru/3.9/library/stdtypes.html#str.format) или [`string.Template`](https://python-all.ru/3.9/library/string.html#string.Template) соответственно. По умолчанию `'%'`. |601| *уровень* | Устанавливает уровень корневого регистратора в указанный [уровень](https://python-all.ru/3.9/library/logging.html#levels). |602| *поток данных* | Использовать указанный поток для инициализации StreamHandler. Обратите внимание, что этот аргумент несовместим с *filename* – если указаны оба, возникает `ValueError`. |603| *обработчики* | Если указано, это должна быть итерируемая последовательность уже созданных обработчиков для добавления в корневой регистратор. Любые обработчики, у которых ещё не установлен форматтер, получат форматтер по умолчанию, созданный в этой функции. Обратите внимание, что этот аргумент несовместим с *имя файла* или *поток данных* – если указаны оба, возбуждается `ValueError`. |604| *принудительно* | Если этот именованный аргумент указан как истина, все существующие обработчики, прикреплённые к корневому регистратору, удаляются и закрываются перед выполнением настройки, как указано другими аргументами. |605| *кодировка* | Если этот именованный аргумент указан вместе с *filename*, его значение используется при создании FileHandler и, следовательно, при открытии выходного файла. |606| *ошибки* | Если этот именованный аргумент указан вместе с *filename*, его значение используется при создании FileHandler и, следовательно, при открытии выходного файла. Если не указано, используется значение ‘backslashreplace’. Обратите внимание, что если указан `None`, он будет передан как есть в func:*open*, что означает, что он будет обработан так же, как передача ‘errors’. |607608Изменено в версии 3.2: Был добавлен аргумент *стиль*.609610Изменено в версии 3.3: Был добавлен аргумент *обработчики*. Были добавлены дополнительные проверки для выявления ситуаций, когда указаны несовместимые аргументы (например, *обработчики* вместе с *поток данных* или *имя файла*, или *поток данных* вместе с *имя файла*).611612Изменено в версии 3.8: Был добавлен аргумент *принудительно*.613614Изменено в версии 3.9: Были добавлены аргументы *кодировка* и *ошибки*.615616#### `logging.shutdown()`617618Сообщает системе логирования о необходимости выполнить упорядоченное завершение работы, сбрасывая и закрывая все обработчики. Эту функцию следует вызывать при завершении приложения, и после этого вызова не следует использовать систему логирования.619620При импорте модуля logging эта функция регистрируется как обработчик выхода (см. [`atexit`](https://python-all.ru/3.9/library/atexit.html#module-atexit)), поэтому обычно нет необходимости делать это вручную.621622#### `logging.setLoggerClass(klass)`623624Указывает системе логирования использовать класс *klass* при создании экземпляра регистратора. Класс должен определять [`__init__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__init__) таким образом, чтобы требовался только аргумент name, а [`__init__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__init__) должен вызывать `Logger.__init__()`. Эта функция обычно вызывается до создания каких-либо регистраторов приложениями, которым требуется нестандартное поведение регистратора. После этого вызова, как и в любое другое время, не создавайте регистраторы напрямую с помощью подкласса: продолжайте использовать API [`logging.getLogger()`](https://python-all.ru/3.9/library/logging.html#logging.getLogger) для получения регистраторов.625626#### `logging.setLogRecordFactory(factory)`627628Устанавливает вызываемый объект, используемый для создания [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord).629630**Параметры**631632**factory** – вызываемый объект фабрики, используемый для создания записи журнала.633634Новое в версии 3.2: Эта функция была добавлена вместе с [`getLogRecordFactory()`](https://python-all.ru/3.9/library/logging.html#logging.getLogRecordFactory), чтобы разработчики могли лучше контролировать создание [`LogRecord`](https://python-all.ru/3.9/library/logging.html#logging.LogRecord), представляющего событие логирования.635636Фабрика имеет следующую сигнатуру:637638`factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs)`639640> **имя**641>642> Имя регистратора.643>644> **level**645>646> Уровень логирования (числовой).647>648> **fn**649>650> Полный путь к файлу, в котором был выполнен вызов логирования.651>652> **lno**653>654> Номер строки в файле, в котором был выполнен вызов логирования.655>656> **msg**657>658> Сообщение логирования.659>660> **аргументы**661>662> Аргументы для сообщения логирования.663>664> **exc\_info**665>666> Кортеж исключения или `None`.667>668> **функция**669>670> Имя функции или метода, из которого был сделан вызов логирования.671>672> **sinfo**673>674> Трассировка стека, например, предоставляемая [`traceback.print_stack()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_stack), показывающая иерархию вызовов.675>676> **именованные аргументы**677>678> Дополнительные именованные аргументы.679680## Атрибуты уровня модуля681682#### `logging.lastResort`683684«Обработчик последней надежды» доступен через этот атрибут. Он представляет собой [`StreamHandler`](https://python-all.ru/3.9/library/logging.handlers.html#logging.StreamHandler), который пишет в `sys.stderr` с уровнем `WARNING` и используется для обработки событий логирования при отсутствии какой-либо конфигурации логирования. В результате сообщение просто выводится в `sys.stderr`. Это заменяет более раннее сообщение об ошибке, гласившее, «для регистратора XYZ не найдено обработчиков». Если по какой-то причине нужно вернуть прежнее поведение, `lastResort` можно установить в `None`.685686Новое в версии 3.2.687688## Интеграция с модулем warnings689690Функция [`captureWarnings()`](https://python-all.ru/3.9/library/logging.html#logging.captureWarnings) может использоваться для интеграции [`logging`](https://python-all.ru/3.9/library/logging.html#module-logging) с модулем [`warnings`](https://python-all.ru/3.9/library/warnings.html#module-warnings).691692#### `logging.captureWarnings(capture)`693694Эта функция используется для включения и выключения перехвата предупреждений системой логирования.695696Если *capture* имеет значение `True`, предупреждения, выдаваемые модулем [`warnings`](https://python-all.ru/3.9/library/warnings.html#module-warnings), будут перенаправляться в систему логирования. В частности, предупреждение будет отформатировано с помощью [`warnings.formatwarning()`](https://python-all.ru/3.9/library/warnings.html#warnings.formatwarning), и результирующая строка будет записана в регистратор с именем `'py.warnings'` с уровнем серьезности `WARNING`.697698Если *capture* имеет значение `False`, перенаправление предупреждений в систему логирования прекратится, и предупреждения будут направляться по своим исходным адресатам (т.е. тем, которые действовали до вызова `captureWarnings(True)`).699700> **См. также**701>702> **Модуль [`logging.config`](https://python-all.ru/3.9/library/logging.config.html#module-logging.config)**703>704> API конфигурации для модуля logging.705>706> **Модуль [`logging.handlers`](https://python-all.ru/3.9/library/logging.handlers.html#module-logging.handlers)**707>708> Полезные обработчики, входящие в состав модуля logging.709>710> **[**PEP 282**](https://python-all.ru/3.9/library/logging.html) – Система логирования**711>712> Предложение, описывающее эту возможность для включения в стандартную библиотеку Python.713>714> **[Оригинальный пакет логирования Python](https://python-all.ru/3.9/library/logging.html)**715>716> Это исходный код пакета [`logging`](https://python-all.ru/3.9/library/logging.html#module-logging). Версия пакета, доступная на этом сайте, подходит для использования с Python 1.5.2, 2.1.x и 2.2.x, в которых пакет [`logging`](https://python-all.ru/3.9/library/logging.html#module-logging) не входит в стандартную библиотеку.717