Хватит использовать “print” для отладки: пятиминутное введение в модуль logging Python’а (Перевод)

• Это руководство короткое
• Для поиска ошибок в коде Вы можете использовать print для просмотра значений переменных
• НЕ делайте этого. Используйте модуль logging

Модуль logging предпочтительнее, так как:

• Легко можно поместить указатель времени в каждое сообщение
• Вы можете использовать разные уровни срочности ваших сообщений и фильтровать их по этому уровню
• Когда Вы захотите позже найти / изменить лог-сообщения Вы не перепутаете их с другим выводом команды print
• Если Вы хотите вывести лог в файл, то очень легко будет игнорировать вывод лог-сообщений

Использование pirnt подходит для тех программистов, у которых достаточно времени. Но лучше использовать logging. Кроме того, научитесь использовать отладчик Python для отладки ошибок и Pylint для предотвращения появления ошибок и для того, чтобы сделать код более читаемым.

Для того, чтобы отобразить лог-сообщения на экране, используйте такой код:

import logging
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')
logging.debug('This is a log message.')

Для того, чтобы записывать логи в файл подходит такой код (отличие от предыдущего варианта выделено жирным):

import logging
logging.basicConfig(filename='log_filename.txt',level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')
logging.debug('This is a log message.')

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

Для того, чтобы отобразить сообщения и записать их в файл, используйте этот код:

import logging
logger = logging.getLogger()
logger.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
fh = logging.FileHandler('log_filename.txt')
fh.setLevel(logging.DEBUG)
fh.setFormatter(formatter)
logger.addHandler(fh)
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
ch.setFormatter(formatter)
logger.addHandler(ch)logger.debug('This is a test log message.')

Убедитесь, что переменная logging глобальная, так что её смогут видеть все функции (использовать в них gloval logger не нужно, так как эта переменная только для чтения, не для записи и изменения).

---

Уровни логирования, от более срочных до менее срочных:

1. CRITICAL
2. ERROR
3. WARNING
4. INFO
5. DEBUG

Вызов setLevel() устанавливает минимальный уровень логирования, нужный Вам. Например, если Вы используете fh.setLevel(logging.ERROR), тогда будут сообщения  с уровнем WARNING, INFO и DEBUG не будут записываться в файл (так как fh - обработчик лог-файла в нашем примере, в отличие от ch, который обрабатывает логи для отображения на экране).

Для записи сообщений разного уровня используйте:

1. logger.critical('This is a critical message.')
2. logger.error('This is an error message.')
3. logger.warning('This is a warning message.')
4. logger.info('This is an informative message.')
5. logger.debug('This is a low-level debug message.')

На самом деле Вы можете делать гораздо больше, но это всё, что Вам надо знать, чтобы больше не использовать print для отладки программ.

В документации Python есть больше информации, включая Базовое руководство, продвинутое  руководство , и книгу рецептов по логированию.

Кроме того, функция pprint.pprint() хороша для вывода словарей и списков, особенно вложенных. Попробуйте и увидите.

---

Последний совет: Вы можете использовать команду tail -f logfile.txt чтобы посмотреть файл, куда будет записываться информация. Опция -f означает “follow (следовать)”. Просто оставьте окно терминала открытым с запущенной командой, и в нем автоматически будет появляться записываемый в файл текст. Этот способ избавит Вас от необходимости открывать текстовый редактор.

Команда tail присутствует на Mac OS X и Linux / *nix. На Windows Вы можете использовать для её получения проект Cygwin.