logging.md
1> **Источник:** https://python-all.ru/3.11/howto/logging.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Руководство по логированию89**Автор:**1011Vinay Sajip \<vinay\_sajip at red-dove dot com\>1213## Базовое руководство по логированию1415Логирование – это средство отслеживания событий, происходящих при выполнении программного обеспечения. Разработчик добавляет в код вызовы логирования, чтобы указать, что произошли определенные события. Событие описывается информационным сообщением, которое может содержать переменные данные (т. е. данные, которые потенциально различаются для каждого экземпляра события). События также имеют важность, которую разработчик присваивает событию; эту важность также называют *уровнем* или *серьезностью*.1617### Когда использовать логирование1819Вы можете получить доступ к функциям логирования, создав логгер через `logger = getLogger(__name__)`, а затем вызывая методы логгера [`debug()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.debug), [`info()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.info), [`warning()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.warning), [`error()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.error) и [`critical()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.critical). Чтобы определить, когда использовать логирование, и увидеть, какие методы логгера применять в том или ином случае, обратитесь к таблице ниже. Для каждой из распространенных задач в ней указан наилучший инструмент.2021| Задача, которую нужно выполнить | Лучший инструмент для решения задачи |22| --- | --- |23| Вывод на консоль при обычном использовании скрипта или программы командной строки | [`print()`](https://python-all.ru/3.11/library/functions.html#print) |24| Сообщать о событиях, происходящих при нормальной работе программы (например, для мониторинга состояния или анализа неисправностей) | Метод [`info()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.info) логгера (или метод [`debug()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.debug) для очень подробного вывода в диагностических целях) |25| Выдавать предупреждение о конкретном событии времени выполнения | [`warnings.warn()`](https://python-all.ru/3.11/library/warnings.html#warnings.warn) в библиотечном коде, если проблема устранима и клиентское приложение следует изменить для устранения предупреждения Метод [`warning()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.warning) логгера, если клиентское приложение не может повлиять на ситуацию, но событие всё же следует отметить |26| Сообщить об ошибке, связанной с конкретным событием времени выполнения | Вызвать исключение |27| Сообщить о подавлении ошибки без вызова исключения (например, обработчик ошибок в долго работающем серверном процессе) | Метод [`error()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.error), [`exception()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.exception) или [`critical()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.critical) логгера, в зависимости от конкретной ошибки и области применения |2829Методы логгера названы в соответствии с уровнем или серьезностью событий, которые они отслеживают. Стандартные уровни и их применимость описаны ниже (в порядке возрастания серьезности):3031| Уровень | Когда применяется |32| --- | --- |33| `DEBUG` | Подробная информация, обычно представляющая интерес только при диагностике проблем. |34| `INFO` | Подтверждение того, что всё работает как ожидается. |35| `WARNING` | Указание на то, что произошло что-то неожиданное, или признак возможной проблемы в ближайшем будущем (например, «мало места на диске»). Программа по-прежнему работает как ожидается. |36| `ERROR` | Из-за более серьезной проблемы программа не смогла выполнить некоторую функцию. |37| `CRITICAL` | Серьезная ошибка, указывающая на то, что программа, возможно, не сможет продолжить работу. |3839Уровень по умолчанию – `WARNING`, что означает, что будут отслеживаться только события этого уровня и выше, если пакет logging не настроен иначе.4041Отслеживаемые события можно обрабатывать разными способами. Самый простой способ – выводить их на консоль. Другой распространенный способ – записывать их в файл на диске.4243### Простой пример4445Вот очень простой пример:4647```python48import logging49logging.warning('Watch out!') # выведет сообщение в консоль50logging.info('I told you so') # ничего не выведет51```5253Если ввести эти строки в скрипт и запустить его, на консоли появится:5455```text56WARNING:root:Watch out!57```5859выводится на консоль. Сообщение `INFO` не появляется, потому что уровень по умолчанию – `WARNING`. Выводимое сообщение включает указание уровня и описание события, переданное в вызове логирования, то есть «Watch out!». Фактический вывод можно форматировать довольно гибко, если это необходимо; параметры форматирования будут объяснены позже.6061Обратите внимание: в этом примере функции используются непосредственно из модуля `logging`, например `logging.debug`, вместо создания регистратора и вызова его методов. Эти функции работают с корневым регистратором, но могут быть удобны, так как они вызывают [`basicConfig()`](https://python-all.ru/3.11/library/logging.html#logging.basicConfig) автоматически, если он ещё не был вызван, как в этом примере. Однако в больших программах обычно требуется явно управлять конфигурацией логирования, поэтому по этой и другим причинам лучше создавать регистраторы и вызывать их методы.6263### Запись логов в файл6465Очень распространенная ситуация – запись событий логирования в файл, так что давайте рассмотрим это далее. Обязательно попробуйте следующий код в только что запущенном интерпретаторе Python, а не продолжайте сессию, описанную выше:6667```python68import logging69logger = logging.getLogger(__name__)70logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)71logger.debug('This message should go to the log file')72logger.info('So should this')73logger.warning('And this, too')74logger.error('And non-ASCII stuff, too, like Øresund and Malmö')75```7677Изменено в версии 3.9: Был добавлен аргумент *encoding*. В более ранних версиях Python или если аргумент не указан, используется кодировка по умолчанию, применяемая [`open()`](https://python-all.ru/3.11/library/functions.html#open). Хотя это не показано в примере выше, теперь также можно передать аргумент *errors*, который определяет, как обрабатывать ошибки кодирования. Допустимые значения и значение по умолчанию см. в документации [`open()`](https://python-all.ru/3.11/library/functions.html#open).7879Теперь, если мы откроем файл и посмотрим, что получилось, мы должны увидеть сообщения журнала:8081```text82DEBUG:__main__:This message should go to the log file83INFO:__main__:So should this84WARNING:__main__:And this, too85ERROR:__main__:And non-ASCII stuff, too, like Øresund and Malmö86```8788Этот пример также показывает, как можно задать уровень логирования, который служит порогом для отслеживания. В данном случае, поскольку мы установили порог `DEBUG`, были выведены все сообщения.8990Чтобы задать уровень логирования из параметра командной строки, например:9192```text93--log=INFO94```9596а значение параметра, переданного для `--log`, хранится в переменной *loglevel*, можно использовать:9798```python99getattr(logging, loglevel.upper())100```101102чтобы получить значение, которое затем передаётся в [`basicConfig()`](https://python-all.ru/3.11/library/logging.html#logging.basicConfig) через аргумент *level*. Стоит проверить любые вводимые пользователем значения на ошибки, как в следующем примере:103104```python105# предполагая, что loglevel привязан к строковому значению, полученному из106# аргумента командной строки. Преобразование в верхний регистр позволяет пользователю107# указать --log=DEBUG или --log=debug108numeric_level = getattr(logging, loglevel.upper(), None)109if not isinstance(numeric_level, int):110 raise ValueError('Invalid log level: %s' % loglevel)111logging.basicConfig(level=numeric_level, ...)112```113114Вызов [`basicConfig()`](https://python-all.ru/3.11/library/logging.html#logging.basicConfig) должен выполняться *до* любых вызовов методов логгера, таких как [`debug()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.debug), [`info()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.info) и т.д. В противном случае это событие логирования может быть обработано не так, как нужно.115116Если запускать этот скрипт несколько раз, сообщения от последовательных запусков добавляются в файл *example.log*. Чтобы каждый запуск начинался с чистого листа, без сохранения сообщений от предыдущих запусков, можно указать аргумент *filemode*, изменив вызов в предыдущем примере на:117118```python119logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)120```121122Вывод будет таким же, как и раньше, но лог-файл больше не дополняется, поэтому сообщения от предыдущих запусков теряются.123124### Логирование переменных данных125126Для логирования переменных данных используется строка формата сообщения описания события, а сами переменные данные передаются в качестве аргументов. Например:127128```python129import logging130logging.warning('%s before you %s', 'Look', 'leap!')131```132133выведет:134135```text136WARNING:root:Look before you leap!137```138139Как видно, встраивание переменных данных в сообщение описания события использует старый, %-стиль форматирования строк. Это сделано для обратной совместимости: пакет logging появился раньше, чем новые способы форматирования, такие как [`str.format()`](https://python-all.ru/3.11/library/stdtypes.html#str.format) и [`string.Template`](https://python-all.ru/3.11/library/string.html#string.Template). Эти новые способы форматирования *поддерживаются*, но их рассмотрение выходит за рамки этого руководства: см. [Использование определённых стилей форматирования во всём приложении](https://python-all.ru/3.11/howto/logging-cookbook.html#formatting-styles) для получения дополнительной информации.140141### Изменение формата отображаемых сообщений142143Для изменения формата отображения сообщений нужно указать нужный формат:144145```python146import logging147logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)148logging.debug('This message should appear on the console')149logging.info('So should this')150logging.warning('And this, too')151```152153что выведет:154155```text156DEBUG:This message should appear on the console157INFO:So should this158WARNING:And this, too159```160161Обратите внимание, что ‘root’, который появлялся в предыдущих примерах, исчез. Полный список того, что может присутствовать в строках формата, можно найти в документации [атрибутов LogRecord](https://python-all.ru/3.11/library/logging.html#logrecord-attributes), но для простого использования достаточно *levelname* (уровень серьёзности), *message* (описание события, включая переменные данные) и, возможно, отображения времени события. Это описано в следующем разделе.162163### Отображение даты/времени в сообщениях164165Для отображения даты и времени события в строку формата помещается ‘%(asctime)s’:166167```python168import logging169logging.basicConfig(format='%(asctime)s %(message)s')170logging.warning('is when this event was logged.')171```172173что выведет примерно следующее:174175```text1762010-12-12 11:41:42,612 is when this event was logged.177```178179Формат отображения даты/времени по умолчанию (показан выше) похож на ISO8601 или [**RFC 3339**](https://python-all.ru/3.11/howto/logging.html). Если требуется более точный контроль форматирования даты/времени, укажите аргумент *datefmt* для `basicConfig`, как в этом примере:180181```python182import logging183logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')184logging.warning('is when this event was logged.')185```186187что отобразит примерно следующее:188189```text19012/12/2010 11:46:36 AM is when this event was logged.191```192193Формат аргумента *datefmt* такой же, как поддерживается [`time.strftime()`](https://python-all.ru/3.11/library/time.html#time.strftime).194195### Следующие шаги196197На этом базовое руководство заканчивается. Этого должно быть достаточно, чтобы начать работу с логированием. Пакет logging предлагает гораздо больше возможностей, но чтобы извлечь из него максимум, потребуется уделить немного времени чтению следующих разделов. Если готовы, возьмите любимый напиток и продолжайте.198199Если требования к логированию просты, используйте приведённые выше примеры, чтобы добавить логирование в свои скрипты. При возникновении проблем или непонимания задайте вопрос в группе Usenet comp.lang.python (доступной по адресу [https://groups.google.com/g/comp.lang.python](https://python-all.ru/3.11/howto/logging.html)), и вы довольно скоро получите помощь.200201Всё ещё здесь? Можно продолжить чтение следующих разделов, которые представляют собой немного более продвинутое/углублённое руководство по сравнению с базовым. После этого можно заглянуть в [Logging Cookbook](https://python-all.ru/3.11/howto/logging-cookbook.html#logging-cookbook).202203## Расширенное руководство по логированию204205Библиотека logging использует модульный подход и предлагает несколько категорий компонентов: регистраторы, обработчики, фильтры и форматировщики.206207- Регистраторы предоставляют интерфейс, который напрямую используется кодом приложения.208- Обработчики отправляют записи журнала (созданные регистраторами) в соответствующее назначение.209- Фильтры предоставляют более детальный механизм для определения того, какие записи журнала выводить.210- Форматировщики определяют расположение записей журнала в конечном выводе.211212Информация о событии логирования передаётся между регистраторами, обработчиками, фильтрами и форматировщиками в экземпляре [`LogRecord`](https://python-all.ru/3.11/library/logging.html#logging.LogRecord).213214Логирование выполняется вызовом методов экземпляров класса [`Logger`](https://python-all.ru/3.11/library/logging.html#logging.Logger) (далее называемых *регистраторами*). Каждый экземпляр имеет имя, и они концептуально организованы в иерархию пространств имён с использованием точек в качестве разделителей. Например, регистратор с именем ‘scan’ является родителем для регистраторов ‘scan.text’, ‘scan.html’ и ‘scan.pdf’. Имена регистраторов могут быть любыми, они указывают на область приложения, в которой возникло регистрируемое сообщение.215216Хороший подход при именовании логгеров – использовать модульный логгер в каждом модуле, где используется логирование, названный следующим образом:217218```python219logger = logging.getLogger(__name__)220```221222Это означает, что имена логгеров отслеживают иерархию пакетов/модулей, и из одного только имени логгера интуитивно понятно, где регистрируются события.223224Корень иерархии логгеров называется корневым логгером. Это логгер, используемый функциями [`debug()`](https://python-all.ru/3.11/library/logging.html#logging.debug), [`info()`](https://python-all.ru/3.11/library/logging.html#logging.info), [`warning()`](https://python-all.ru/3.11/library/logging.html#logging.warning), [`error()`](https://python-all.ru/3.11/library/logging.html#logging.error) и [`critical()`](https://python-all.ru/3.11/library/logging.html#logging.critical), которые просто вызывают одноимённый метод корневого логгера. Функции и методы имеют одинаковые сигнатуры. Имя корневого логгера выводится как 'root' в записях журнала.225226It is, of course, possible to log messages to different destinations. Support is included in the package for writing log messages to files, HTTP GET/POST locations, email via SMTP, generic sockets, queues, or OS-specific logging mechanisms such as syslog or the Windows NT event log. Destinations are served by *handler* classes. You can create your own log destination class if you have special requirements not met by any of the built-in handler classes.227228По умолчанию ни одно место назначения не задано для сообщений журнала. Вы можете указать место назначения (например, консоль или файл) с помощью [`basicConfig()`](https://python-all.ru/3.11/library/logging.html#logging.basicConfig), как в примерах из руководства. Если вызвать функции [`debug()`](https://python-all.ru/3.11/library/logging.html#logging.debug), [`info()`](https://python-all.ru/3.11/library/logging.html#logging.info), [`warning()`](https://python-all.ru/3.11/library/logging.html#logging.warning), [`error()`](https://python-all.ru/3.11/library/logging.html#logging.error) и [`critical()`](https://python-all.ru/3.11/library/logging.html#logging.critical), они проверят, не задано ли место назначения; и если не задано, то установят местом назначения консоль (`sys.stderr`) и формат по умолчанию для отображаемого сообщения, прежде чем делегировать вывод корневому логгеру для фактической записи сообщения.229230Формат по умолчанию, устанавливаемый [`basicConfig()`](https://python-all.ru/3.11/library/logging.html#logging.basicConfig) для сообщений:231232```text233severity:logger name:message234```235236Вы можете изменить это, передав строку формата в [`basicConfig()`](https://python-all.ru/3.11/library/logging.html#logging.basicConfig) с именованным аргументом *format*. Все параметры построения строки формата описаны в [Объекты Formatter](https://python-all.ru/3.11/library/logging.html#formatter-objects).237238### Поток логирования239240Поток информации о событиях логирования в логгерах и обработчиках показан на следующей диаграмме.241242243244### Логгеры245246[`Logger`](https://python-all.ru/3.11/library/logging.html#logging.Logger) объекты выполняют тройную задачу. Во-первых, они предоставляют прикладному коду несколько методов, чтобы приложения могли регистрировать сообщения во время выполнения. Во-вторых, объекты логгера определяют, на какие сообщения журнала следует реагировать, на основе важности (механизм фильтрации по умолчанию) или объектов-фильтров. В-третьих, объекты логгера передают соответствующие сообщения журнала всем заинтересованным обработчикам.247248Наиболее часто используемые методы объектов логгера делятся на две категории: настройка и отправка сообщений.249250Ниже приведены наиболее распространённые методы настройки:251252- [`Logger.setLevel()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.setLevel) задаёт наименьший уровень важности сообщения журнала, которое будет обрабатывать логгер, где DEBUG – это наименьший встроенный уровень важности, а CRITICAL – наибольший. Например, если уровень важности – INFO, логгер будет обрабатывать только сообщения уровней INFO, WARNING, ERROR и CRITICAL и будет игнорировать сообщения DEBUG.253- [`Logger.addHandler()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.addHandler) и [`Logger.removeHandler()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.removeHandler) добавляют и удаляют объекты-обработчики из объекта логгера. Обработчики подробно рассматриваются в разделе [Обработчики](https://python-all.ru/3.11/howto/logging.html#handler-basic).254- [`Logger.addFilter()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.addFilter) и [`Logger.removeFilter()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.removeFilter) добавляют и удаляют объекты фильтров из объекта регистратора. Фильтры более подробно рассмотрены в разделе [Объекты фильтров](https://python-all.ru/3.11/library/logging.html#filter).255256Необязательно всегда вызывать эти методы для каждого создаваемого регистратора. См. два последних абзаца в этом разделе.257258После настройки объекта регистратора следующие методы создают сообщения журнала:259260- [`Logger.debug()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.debug), [`Logger.info()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.info), [`Logger.warning()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.warning), [`Logger.error()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.error) и [`Logger.critical()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.critical) – все они создают записи журнала с сообщением и уровнем, соответствующим названию метода. Сообщение на самом деле является строкой форматирования, которая может содержать стандартный синтаксис подстановки строк `%s`, `%d`, `%f` и так далее. Остальные аргументы – это список объектов, соответствующих полям подстановки в сообщении. Что касается `**kwargs`, методы журналирования учитывают только ключевое слово `exc_info` и используют его для определения необходимости записи информации об исключении.261- [`Logger.exception()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.exception) создаёт сообщение журнала, похожее на [`Logger.error()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.error). Отличие в том, что [`Logger.exception()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.exception) дополнительно выводит трассировку стека. Вызывайте этот метод только из обработчика исключений.262- [`Logger.log()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.log) принимает уровень журнала как явный аргумент. Это немного многословнее для записи сообщений, чем использование перечисленных выше удобных методов по уровню, но так можно записывать сообщения с пользовательскими уровнями.263264[`getLogger()`](https://python-all.ru/3.11/library/logging.html#logging.getLogger) возвращает ссылку на экземпляр регистратора с указанным именем, если оно задано, или `root`, если нет. Имена представляют собой иерархические структуры, разделённые точками. При многократных вызовах [`getLogger()`](https://python-all.ru/3.11/library/logging.html#logging.getLogger) с одним и тем же именем возвращается ссылка на тот же объект регистратора. Регистраторы, находящиеся ниже в иерархическом списке, являются дочерними по отношению к регистраторам выше. Например, для регистратора с именем `foo` регистраторы с именами `foo.bar`, `foo.bar.baz` и `foo.bam` являются потомками `foo`.265266У регистраторов есть понятие *эффективного уровня*. Если уровень явно не задан для регистратора, вместо него используется уровень его родителя. Если у родителя нет явно заданного уровня, проверяется *его* родитель, и так далее – перебираются все предки, пока не будет найден явно заданный уровень. Корневой регистратор всегда имеет явно заданный уровень (`WARNING` по умолчанию). При принятии решения об обработке события используется эффективный уровень регистратора, чтобы определить, передаётся ли событие обработчикам регистратора.267268Дочерние регистраторы распространяют сообщения вверх к обработчикам, связанным с их родительскими регистраторами. Из-за этого нет необходимости определять и настраивать обработчики для всех регистраторов, используемых в приложении. Достаточно настроить обработчики для регистратора верхнего уровня и по мере необходимости создавать дочерние регистраторы. (Однако можно отключить распространение, установив для атрибута *propagate* регистратора значение `False`.)269270### Обработчики271272Объекты [`Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler) отвечают за отправку соответствующих сообщений журнала (на основе их серьёзности) в указанное назначение обработчика. Объекты [`Logger`](https://python-all.ru/3.11/library/logging.html#logging.Logger) могут добавлять к себе ноль или более объектов-обработчиков с помощью метода [`addHandler()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.addHandler). Например, приложение может захотеть отправлять все сообщения журнала в файл, все сообщения уровня ERROR и выше – в stdout, а все критические сообщения – на адрес электронной почты. Для этого потребуется три отдельных обработчика, каждый из которых отвечает за отправку сообщений определённого уровня в конкретное место.273274Стандартная библиотека включает множество типов обработчиков (см. [Полезные обработчики](https://python-all.ru/3.11/howto/logging.html#useful-handlers)); в руководствах в основном используются [`StreamHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.StreamHandler) и [`FileHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.FileHandler) в примерах.275276В обработчике очень мало методов, которые должны беспокоить разработчиков приложений. Единственные методы обработчика, актуальные для разработчиков, использующих встроенные объекты-обработчики (то есть не создающих собственные обработчики), – это следующие методы настройки:277278- Метод [`setLevel()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.setLevel), как и в объектах регистратора, задаёт наименьший уровень серьёзности, который будет отправлен в соответствующее место назначения. Зачем нужны два метода [`setLevel()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.setLevel)? Уровень, установленный в регистраторе, определяет, сообщения какой серьёзности он будет передавать своим обработчикам. Уровень, установленный в каждом обработчике, определяет, какие сообщения этот обработчик будет отправлять дальше.279- [`setFormatter()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.setFormatter) выбирает объект Formatter для использования этим обработчиком.280- [`addFilter()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.addFilter) и [`removeFilter()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.removeFilter) соответственно настраивают и удаляют объекты фильтров для обработчиков.281282Код приложения не должен напрямую создавать экземпляры [`Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler) и использовать их. Вместо этого класс [`Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler) является базовым, который определяет интерфейс для всех обработчиков и устанавливает некоторое поведение по умолчанию, которое могут использовать (или переопределять) дочерние классы.283284### Форматировщики285286Объекты Formatter настраивают окончательный порядок, структуру и содержимое сообщения журнала. В отличие от базового класса [`logging.Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler), код приложения может создавать экземпляры классов форматировщиков, хотя, возможно, потребуется создать подкласс форматировщика, если приложению требуется особое поведение. Конструктор принимает три необязательных аргумента: строку формата сообщения, строку формата даты и указатель стиля.287288#### `logging.Formatter.__init__(fmt=None, datefmt=None, style='%')`289290Если строка формата сообщения не задана, по умолчанию используется исходное сообщение. Если строка формата даты не задана, формат даты по умолчанию:291292```text293%Y-%m-%d %H:%M:%S294```295296с добавлением миллисекунд в конце. `style` – это одно из значений `'%'`, `'{'` или `'$'`. Если ни одно из них не указано, будет использоваться `'%'`.297298Если `style` равен `'%'`, строка формата сообщения использует подстановку строк в стиле `%(<dictionary key>)s`; возможные ключи описаны в разделе [Атрибуты LogRecord](https://python-all.ru/3.11/library/logging.html#logrecord-attributes). Если стиль `'{'`, предполагается, что строка формата сообщения совместима с [`str.format()`](https://python-all.ru/3.11/library/stdtypes.html#str.format) (с использованием именованных аргументов), а если стиль `'$'`, строка формата сообщения должна соответствовать тому, что ожидается от [`string.Template.substitute()`](https://python-all.ru/3.11/library/string.html#string.Template.substitute).299300Изменено в версии 3.2: Добавлен параметр `style`.301302Следующая строка формата сообщения будет записывать время в удобочитаемом формате, уровень серьёзности сообщения и содержимое сообщения в указанном порядке:303304```python305'%(asctime)s - %(levelname)s - %(message)s'306```307308Форматировщики используют настраиваемую пользователем функцию для преобразования времени создания записи в кортеж. По умолчанию используется [`time.localtime()`](https://python-all.ru/3.11/library/time.html#time.localtime); чтобы изменить это для конкретного экземпляра форматировщика, установите атрибут `converter` экземпляра в функцию с той же сигнатурой, что и [`time.localtime()`](https://python-all.ru/3.11/library/time.html#time.localtime) или [`time.gmtime()`](https://python-all.ru/3.11/library/time.html#time.gmtime). Чтобы изменить это для всех форматировщиков (например, если нужно показывать всё время в GMT), установите атрибут `converter` в классе Formatter (в `time.gmtime` для отображения GMT).309310### Настройка журналирования311312Программисты могут настраивать журналирование тремя способами:3133141. Создание регистраторов, обработчиков и форматировщиков явно с помощью кода Python, вызывающего перечисленные выше методы настройки.3152. Создание файла конфигурации журналирования и его чтение с помощью функции [`fileConfig()`](https://python-all.ru/3.11/library/logging.config.html#logging.config.fileConfig).3163. Создание словаря с информацией о конфигурации и передача его функции [`dictConfig()`](https://python-all.ru/3.11/library/logging.config.html#logging.config.dictConfig).317318Справочную документацию по двум последним вариантам см. в разделе [Функции конфигурации](https://python-all.ru/3.11/library/logging.config.html#logging-config-api). Следующий пример настраивает очень простой регистратор, обработчик для консоли и простой форматировщик с помощью кода Python:319320```python321import logging322323# создать логгер324logger = logging.getLogger('simple_example')325logger.setLevel(logging.DEBUG)326327# создать обработчик консоли и установить уровень DEBUG328ch = logging.StreamHandler()329ch.setLevel(logging.DEBUG)330331# создать форматтер332formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')333334# добавить форматтер в ch335ch.setFormatter(formatter)336337# добавить ch в логгер338logger.addHandler(ch)339340# код 'приложения'341logger.debug('debug message')342logger.info('info message')343logger.warning('warn message')344logger.error('error message')345logger.critical('critical message')346```347348Запуск этого модуля из командной строки выдает следующий результат:349350```console351$ python simple_logging_module.py3522005-03-19 15:10:26,618 - simple_example - DEBUG - debug message3532005-03-19 15:10:26,620 - simple_example - INFO - info message3542005-03-19 15:10:26,695 - simple_example - WARNING - warn message3552005-03-19 15:10:26,697 - simple_example - ERROR - error message3562005-03-19 15:10:26,773 - simple_example - CRITICAL - critical message357```358359Следующий модуль Python создает логгер, обработчик и форматтер, почти идентичные приведенным в примере выше, с единственным отличием – имена объектов.360361```python362import logging363import logging.config364365logging.config.fileConfig('logging.conf')366367# создать логгер368logger = logging.getLogger('simpleExample')369370# код 'приложения'371logger.debug('debug message')372logger.info('info message')373logger.warning('warn message')374logger.error('error message')375logger.critical('critical message')376```377378Вот файл logging.conf:379380```ini381[loggers]382keys=root,simpleExample383384[handlers]385keys=consoleHandler386387[formatters]388keys=simpleFormatter389390[logger_root]391level=DEBUG392handlers=consoleHandler393394[logger_simpleExample]395level=DEBUG396handlers=consoleHandler397qualname=simpleExample398propagate=0399400[handler_consoleHandler]401class=StreamHandler402level=DEBUG403formatter=simpleFormatter404args=(sys.stdout,)405406[formatter_simpleFormatter]407format=%(asctime)s - %(name)s - %(levelname)s - %(message)s408```409410Результат почти идентичен примеру без файла конфигурации:411412```console413$ python simple_logging_config.py4142005-03-19 15:38:55,977 - simpleExample - DEBUG - debug message4152005-03-19 15:38:55,979 - simpleExample - INFO - info message4162005-03-19 15:38:56,054 - simpleExample - WARNING - warn message4172005-03-19 15:38:56,055 - simpleExample - ERROR - error message4182005-03-19 15:38:56,130 - simpleExample - CRITICAL - critical message419```420421Видно, что подход с файлом конфигурации имеет несколько преимуществ перед подходом с кодом Python: в первую очередь разделение конфигурации и кода, а также возможность для не-программистов легко изменять параметры журналирования.422423> **Предупреждение**424>425> Функция [`fileConfig()`](https://python-all.ru/3.11/library/logging.config.html#logging.config.fileConfig) принимает параметр по умолчанию `disable_existing_loggers`, который по умолчанию равен `True` из соображений обратной совместимости. Это может быть как желательно, так и нет, поскольку это приведет к отключению любых не корневых логгеров, существовавших до вызова [`fileConfig()`](https://python-all.ru/3.11/library/logging.config.html#logging.config.fileConfig), если они (или их предок) не указаны явно в конфигурации. Обратитесь к справочной документации за дополнительной информацией и укажите `False` для этого параметра, если хотите.426>427> Словарь, передаваемый в [`dictConfig()`](https://python-all.ru/3.11/library/logging.config.html#logging.config.dictConfig), может также содержать логическое значение с ключом `disable_existing_loggers`; если оно не указано явно в словаре, оно по умолчанию интерпретируется как `True`. Это приводит к описанному выше поведению отключения логгера, которое может быть нежелательным – в таком случае укажите ключ явно со значением `False`.428429Обратите внимание, что имена классов, указанные в файлах конфигурации, должны быть либо относительными к модулю logging, либо абсолютными значениями, которые можно разрешить с помощью обычных механизмов импорта. Таким образом, можно использовать либо [`WatchedFileHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.WatchedFileHandler) (относительно модуля logging), либо `mypackage.mymodule.MyHandler` (для класса, определенного в пакете `mypackage` и модуле `mymodule`, где `mypackage` доступен в пути импорта Python).430431В Python 3.2 был представлен новый способ настройки журналирования с использованием словарей для хранения информации о конфигурации. Он предоставляет расширенный функционал по сравнению с подходом на основе файлов конфигурации, описанным выше, и является рекомендуемым методом настройки для новых приложений и развертываний. Поскольку для хранения информации о конфигурации используется словарь Python, и вы можете заполнять этот словарь различными способами, у вас появляется больше возможностей для настройки. Например, вы можете использовать файл конфигурации в формате JSON или, если у вас есть доступ к функциям обработки YAML, файл в формате YAML для заполнения словаря конфигурации. Или, конечно, вы можете создать словарь в коде Python, получить его в сериализованном виде через сокет или использовать любой другой подход, подходящий для вашего приложения.432433Вот пример той же конфигурации, что и выше, в формате YAML для нового подхода на основе словарей:434435```yaml436version: 1437formatters:438 simple:439 format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'440handlers:441 console:442 class: logging.StreamHandler443 level: DEBUG444 formatter: simple445 stream: ext://sys.stdout446loggers:447 simpleExample:448 level: DEBUG449 handlers: [console]450 propagate: no451root:452 level: DEBUG453 handlers: [console]454```455456Для получения дополнительной информации о журналировании с использованием словаря см. [функции конфигурации](https://python-all.ru/3.11/library/logging.config.html#logging-config-api).457458### Что произойдет, если конфигурация не предоставлена459460Если конфигурация журналирования не предоставлена, может возникнуть ситуация, когда требуется вывести событие журналирования, но не найдено ни одного обработчика для его вывода.461462Событие выводится с помощью «обработчика последней надежды», хранящегося в [`lastResort`](https://python-all.ru/3.11/library/logging.html#logging.lastResort). Этот внутренний обработчик не связан ни с одним логгером и действует как [`StreamHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.StreamHandler), который записывает сообщение с описанием события в текущее значение `sys.stderr` (таким образом, учитывая любые перенаправления, которые могут быть активны). Сообщение не форматируется – печатается только само описание события. Уровень обработчика установлен на `WARNING`, поэтому все события этого и более высоких уровней серьезности будут выводиться.463464Изменено в версии 3.2: Для версий Python до 3.2 поведение следующее:465466- Если [`raiseExceptions`](https://python-all.ru/3.11/library/logging.html#logging.raiseExceptions) равен `False` (рабочий режим), событие молча отбрасывается.467- Если [`raiseExceptions`](https://python-all.ru/3.11/library/logging.html#logging.raiseExceptions) равен `True` (режим разработки), один раз выводится сообщение «Не найдено обработчиков для логгера X.Y.Z».468469Чтобы получить поведение до версии 3.2, [`lastResort`](https://python-all.ru/3.11/library/logging.html#logging.lastResort) может быть установлен в `None`.470471### Настройка журналирования для библиотеки472473При разработке библиотеки, использующей журналирование, следует позаботиться о документировании того, как библиотека использует журналирование – например, имена используемых логгеров. Также необходимо уделить внимание конфигурации журналирования. Если использующее приложение не использует журналирование, а код библиотеки делает вызовы журналирования, то (как описано в предыдущем разделе) события уровня `WARNING` и выше будут выводиться в `sys.stderr`. Это считается наилучшим поведением по умолчанию.474475Если по какой-то причине вы *не* хотите, чтобы эти сообщения печатались при отсутствии конфигурации журналирования, вы можете прикрепить пустой обработчик к корневому логгеру вашей библиотеки. Это предотвратит печать сообщения, так как для событий библиотеки всегда будет найден обработчик: он просто не выдает никакого вывода. Если пользователь библиотеки настраивает журналирование для приложения, предполагается, что эта конфигурация добавит несколько обработчиков, и если уровни настроены соответствующим образом, то вызовы журналирования из кода библиотеки будут отправлять вывод на эти обработчики, как обычно.476477В пакете logging есть пустой обработчик: [`NullHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.NullHandler) (начиная с Python 3.1). Экземпляр этого обработчика можно добавить к корневому логгеру пространства имен журналирования, используемого библиотекой (*если* вы хотите предотвратить вывод зарегистрированных событий вашей библиотеки в `sys.stderr` при отсутствии конфигурации журналирования). Если все журналирование библиотеки *foo* выполняется с использованием логгеров с именами вида 'foo.x', 'foo.x.y' и т.д., то код:478479```python480import logging481logging.getLogger('foo').addHandler(logging.NullHandler())482```483484должен дать желаемый эффект. Если организация выпускает несколько библиотек, то имя логгера может быть 'orgname.foo', а не просто 'foo'.485486> **Примечание**487>488> It is strongly advised that you *do not log to the root logger* in your library. Instead, use a logger with a unique and easily identifiable name, such as the `__name__` for your library’s top-level package or module. Logging to the root logger will make it difficult or impossible for the application developer to configure the logging verbosity or handlers of your library as they wish.489490> **Примечание**491>492> It is strongly advised that you *do not add any handlers other than* [`NullHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.NullHandler) *to your library’s loggers*. This is because the configuration of handlers is the prerogative of the application developer who uses your library. The application developer knows their target audience and what handlers are most appropriate for their application: if you add handlers ‘under the hood’, you might well interfere with their ability to carry out unit tests and deliver logs which suit their requirements.493494## Уровни журналирования495496Числовые значения уровней журналирования приведены в следующей таблице. Они представляют интерес в первую очередь, если вы хотите определить собственные уровни и хотите, чтобы они имели определенные значения относительно предопределенных уровней. Если вы определяете уровень с тем же числовым значением, он перезаписывает предопределенное значение; предопределенное имя теряется.497498| Уровень | Числовое значение |499| --- | --- |500| `CRITICAL` | 50 |501| `ERROR` | 40 |502| `WARNING` | 30 |503| `INFO` | 20 |504| `DEBUG` | 10 |505| `NOTSET` | 0 |506507Уровни также могут быть связаны с логгерами: они устанавливаются разработчиком или загружаются из сохраненной конфигурации журналирования. Когда на логгере вызывается метод журналирования, логгер сравнивает свой собственный уровень с уровнем, связанным с вызовом метода. Если уровень логгера выше уровня вызова метода, сообщение журналирования фактически не создается. Это базовый механизм, управляющий подробностью вывода журналирования.508509Сообщения журналирования кодируются как экземпляры класса [`LogRecord`](https://python-all.ru/3.11/library/logging.html#logging.LogRecord). Когда логгер решает действительно зарегистрировать событие, из сообщения журналирования создается экземпляр [`LogRecord`](https://python-all.ru/3.11/library/logging.html#logging.LogRecord).510511Logging messages are subjected to a dispatch mechanism through the use of *handlers*, which are instances of subclasses of the [`Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler) class. Handlers are responsible for ensuring that a logged message (in the form of a [`LogRecord`](https://python-all.ru/3.11/library/logging.html#logging.LogRecord)) ends up in a particular location (or set of locations) which is useful for the target audience for that message (such as end users, support desk staff, system administrators, developers). Handlers are passed [`LogRecord`](https://python-all.ru/3.11/library/logging.html#logging.LogRecord) instances intended for particular destinations. Each logger can have zero, one or more handlers associated with it (via the [`addHandler()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.addHandler) method of [`Logger`](https://python-all.ru/3.11/library/logging.html#logging.Logger)). In addition to any handlers directly associated with a logger, *all handlers associated with all ancestors of the logger* are called to dispatch the message (unless the *propagate* flag for a logger is set to a false value, at which point the passing to ancestor handlers stops).512513Как и у логгеров, у обработчиков могут быть связанные с ними уровни. Уровень обработчика действует как фильтр так же, как и уровень логгера. Если обработчик решает на самом деле отправить событие, используется метод [`emit()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.emit) для отправки сообщения по назначению. Большинству пользовательских подклассов [`Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler) потребуется переопределить этот [`emit()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.emit).514515### Пользовательские уровни516517Определение собственных уровней возможно, но обычно в этом нет необходимости, так как существующие уровни были выбраны на основе практического опыта. Однако если вы уверены, что вам нужны пользовательские уровни, делайте это с большой осторожностью, и это, возможно, *очень плохая идея определять пользовательские уровни, если вы разрабатываете библиотеку*. Это связано с тем, что если несколько авторов библиотек определят свои собственные пользовательские уровни, то вывод журнала от таких нескольких библиотек, используемых вместе, будет трудно контролировать и/или интерпретировать разработчику-пользователю, так как одно и то же числовое значение может означать разные вещи для разных библиотек.518519## Полезные обработчики520521В дополнение к базовому классу [`Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler) предоставляется множество полезных подклассов:5225231. Экземпляры [`StreamHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.StreamHandler) отправляют сообщения в потоки данных (файлоподобные объекты).5242. Экземпляры [`FileHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.FileHandler) отправляют сообщения в файлы на диске.5253. [`BaseRotatingHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.BaseRotatingHandler) – это базовый класс для обработчиков, которые выполняют ротацию файлов журнала в определенный момент. Он не предназначен для прямого создания экземпляров. Вместо этого используйте [`RotatingFileHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.RotatingFileHandler) или [`TimedRotatingFileHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.TimedRotatingFileHandler).5264. Экземпляры [`RotatingFileHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.RotatingFileHandler) отправляют сообщения в файлы на диске с поддержкой максимального размера файлов журнала и ротации файлов журнала.5275. Экземпляры [`TimedRotatingFileHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.TimedRotatingFileHandler) отправляют сообщения в файлы на диске, выполняя ротацию файла журнала через определенные интервалы времени.5286. Экземпляры [`SocketHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.SocketHandler) отправляют сообщения в сокеты TCP/IP. Начиная с версии 3.4 также поддерживаются сокеты домена Unix.5297. Экземпляры [`DatagramHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.DatagramHandler) отправляют сообщения в сокеты UDP. Начиная с версии 3.4 также поддерживаются сокеты домена Unix.5308. Экземпляры [`SMTPHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.SMTPHandler) отправляют сообщения на указанный адрес электронной почты.5319. Экземпляры [`SysLogHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.SysLogHandler) отправляют сообщения демону syslog в Unix, возможно, на удаленной машине.53210. Экземпляры [`NTEventLogHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.NTEventLogHandler) отправляют сообщения в журнал событий Windows NT/2000/XP.53311. Экземпляры [`MemoryHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.MemoryHandler) отправляют сообщения в буфер в памяти, который сбрасывается при выполнении определенных условий.53412. Экземпляры [`HTTPHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.HTTPHandler) отправляют сообщения на HTTP-сервер, используя семантику `GET` или `POST`.53513. Экземпляры [`WatchedFileHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.WatchedFileHandler) следят за файлом, в который они ведут журнал. Если файл изменяется, он закрывается и открывается заново с использованием того же имени файла. Этот обработчик полезен только в Unix-подобных системах; Windows не поддерживает используемый механизм.53614. Экземпляры [`QueueHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.QueueHandler) отправляют сообщения в очередь, например, такие, как реализованные в модулях [`queue`](https://python-all.ru/3.11/library/queue.html#module-queue) или [`multiprocessing`](https://python-all.ru/3.11/library/multiprocessing.html#module-multiprocessing).53715. Экземпляры [`NullHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.NullHandler) ничего не делают с сообщениями об ошибках. Они используются разработчиками библиотек, которые хотят использовать журналирование, но хотят избежать сообщения «Не найдено обработчиков для логгера *XXX*», которое может отображаться, если пользователь библиотеки не настроил журналирование. Дополнительную информацию см. в разделе [Настройка журналирования для библиотеки](https://python-all.ru/3.11/howto/logging.html#library-config).538539New in version 3.1: The [`NullHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.NullHandler) class.540541New in version 3.2: The [`QueueHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.QueueHandler) class.542543Классы [`NullHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.NullHandler), [`StreamHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.StreamHandler) и [`FileHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.FileHandler) определены в основном пакете logging. Остальные обработчики определены в подмодуле [`logging.handlers`](https://python-all.ru/3.11/library/logging.handlers.html#module-logging.handlers). (Также существует еще один подмодуль, [`logging.config`](https://python-all.ru/3.11/library/logging.config.html#module-logging.config), для функциональности конфигурации.)544545Записанные сообщения форматируются для представления через экземпляры класса [`Formatter`](https://python-all.ru/3.11/library/logging.html#logging.Formatter). Они инициализируются строкой форматирования, подходящей для использования с оператором % и словарем.546547Для форматирования нескольких сообщений в пакете можно использовать экземпляры [`BufferingFormatter`](https://python-all.ru/3.11/library/logging.html#logging.BufferingFormatter). В дополнение к строке форматирования (которая применяется к каждому сообщению в пакете) предусмотрены строки форматирования заголовка и окончания.548549Когда фильтрации на основе уровня логгера и/или уровня обработчика недостаточно, экземпляры [`Filter`](https://python-all.ru/3.11/library/logging.html#logging.Filter) могут быть добавлены как к экземплярам [`Logger`](https://python-all.ru/3.11/library/logging.html#logging.Logger), так и [`Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler) (через их метод [`addFilter()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.addFilter)). Прежде чем принять решение о дальнейшей обработке сообщения, и логгеры, и обработчики запрашивают разрешение у всех своих фильтров. Если любой фильтр возвращает ложное значение, сообщение не обрабатывается дальше.550551Базовая функциональность [`Filter`](https://python-all.ru/3.11/library/logging.html#logging.Filter) позволяет фильтровать по конкретному имени логгера. Если эта функция используется, сообщения, отправленные указанному логгеру и его дочерним элементам, пропускаются через фильтр, а все остальные отбрасываются.552553## Исключения, возникшие во время журналирования554555Пакет logging спроектирован таким образом, чтобы проглатывать исключения, возникающие при журналировании в рабочей среде. Это делается для того, чтобы ошибки, возникающие при обработке событий журналирования – такие как неверная конфигурация журналирования, сетевые или другие подобные ошибки – не приводили к преждевременному завершению приложения, использующего журналирование.556557Исключения [`SystemExit`](https://python-all.ru/3.11/library/exceptions.html#SystemExit) и [`KeyboardInterrupt`](https://python-all.ru/3.11/library/exceptions.html#KeyboardInterrupt) никогда не проглатываются. Другие исключения, возникающие во время выполнения метода [`emit()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.emit) подкласса [`Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler), передаются его методу [`handleError()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.handleError).558559Реализация [`handleError()`](https://python-all.ru/3.11/library/logging.html#logging.Handler.handleError) по умолчанию в [`Handler`](https://python-all.ru/3.11/library/logging.html#logging.Handler) проверяет, установлена ли переменная уровня модуля [`raiseExceptions`](https://python-all.ru/3.11/library/logging.html#logging.raiseExceptions). Если установлена, обратная трассировка выводится в [`sys.stderr`](https://python-all.ru/3.11/library/sys.html#sys.stderr). Если не установлена, исключение проглатывается.560561> **Примечание**562>563> Значение по умолчанию для [`raiseExceptions`](https://python-all.ru/3.11/library/logging.html#logging.raiseExceptions) – `True`. Это связано с тем, что в процессе разработки обычно требуется получать уведомления о любых возникающих исключениях. Рекомендуется установить [`raiseExceptions`](https://python-all.ru/3.11/library/logging.html#logging.raiseExceptions) в `False` для рабочего использования.564565## Использование произвольных объектов в качестве сообщений566567В предыдущих разделах и примерах предполагалось, что сообщение, передаваемое при логировании события, является строкой. Однако это не единственная возможность. Можно передавать произвольный объект в качестве сообщения, и его метод [`__str__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__str__) будет вызван, когда системе логирования потребуется преобразовать его в строковое представление. Фактически, при желании можно вообще избежать вычисления строкового представления – например, [`SocketHandler`](https://python-all.ru/3.11/library/logging.handlers.html#logging.handlers.SocketHandler) отправляет событие, сериализуя его и передавая по сети.568569## Оптимизация570571Форматирование аргументов сообщения откладывается до тех пор, пока его нельзя избежать. Однако вычисление аргументов, передаваемых методу логирования, также может быть затратным, и, возможно, стоит избегать этого, если логгер всё равно отбросит ваше событие. Чтобы принять решение, можно вызвать метод [`isEnabledFor()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.isEnabledFor), который принимает аргумент уровня и возвращает true, если событие будет создано Логгером для этого уровня вызова. Можно написать такой код:572573```python574if logger.isEnabledFor(logging.DEBUG):575 logger.debug('Message with %s, %s', expensive_func1(),576 expensive_func2())577```578579так что если порог логгера установлен выше `DEBUG`, вызовы `expensive_func1` и `expensive_func2` никогда не выполняются.580581> **Примечание**582>583> В некоторых случаях сам [`isEnabledFor()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.isEnabledFor) может быть более затратным, чем хотелось бы (например, для глубоко вложенных логгеров, где явный уровень установлен только высоко в иерархии логгеров). В таких случаях (или если нужно избегать вызова метода в тесных циклах) можно кэшировать результат вызова [`isEnabledFor()`](https://python-all.ru/3.11/library/logging.html#logging.Logger.isEnabledFor) в локальной переменной или атрибуте экземпляра и использовать его вместо вызова метода каждый раз. Такое кэшированное значение потребуется пересчитывать только при динамическом изменении конфигурации логирования во время работы приложения (что бывает не так часто).584585Существуют и другие оптимизации, которые можно выполнить для конкретных приложений, требующих более точного контроля над тем, какая информация логирования собирается. Вот список действий, которые можно предпринять, чтобы избежать ненужной обработки во время логирования:586587| Что не нужно собирать | Как избежать сбора |588| --- | --- |589| Информация о том, откуда были сделаны вызовы. | Установите `logging._srcfile` в `None`. Это позволяет избежать вызова [`sys._getframe()`](https://python-all.ru/3.11/library/sys.html#sys._getframe), что может помочь ускорить код в таких средах, как PyPy (который не может ускорить код, использующий [`sys._getframe()`](https://python-all.ru/3.11/library/sys.html#sys._getframe)). |590| Информация о потоках. | Устанавливает `logging.logThreads` в `False`. |591| Идентификатор текущего процесса ([`os.getpid()`](https://python-all.ru/3.11/library/os.html#os.getpid)) | Устанавливает `logging.logProcesses` в `False`. |592| Имя текущего процесса при использовании `multiprocessing` для управления несколькими процессами. | Устанавливает `logging.logMultiprocessing` в `False`. |593594Также обратите внимание, что ядро модуля logging включает только базовые обработчики. Если не импортировать [`logging.handlers`](https://python-all.ru/3.11/library/logging.handlers.html#module-logging.handlers) и [`logging.config`](https://python-all.ru/3.11/library/logging.config.html#module-logging.config), они не будут занимать память.595596> **См. также**597>598> **Модуль [`logging`](https://python-all.ru/3.11/library/logging.html#module-logging)**599>600> Справочник API для модуля logging.601>602> **Модуль [`logging.config`](https://python-all.ru/3.11/library/logging.config.html#module-logging.config)**603>604> API конфигурации для модуля logging.605>606> **Модуль [`logging.handlers`](https://python-all.ru/3.11/library/logging.handlers.html#module-logging.handlers)**607>608> Полезные обработчики, входящие в состав модуля logging.609>610> [Кулинарная книга по логированию](https://python-all.ru/3.11/howto/logging-cookbook.html#logging-cookbook)611