Реєстрація нездійснених винятків у Python

Як ви спричиняєте неприховані винятки для виведення через loggingмодуль, а не для stderr?

Я усвідомлюю, що найкращий спосіб зробити це:

try:
    raise Exception, 'Throwing a boring exception'
except Exception, e:
    logging.exception(e)

Але моя ситуація така, що було б дуже приємно, якби logging.exception(...)їх викликали автоматично, коли не було вилучено виняток.

Як зауважив Нед, sys.excepthookйого викликають щоразу, коли виняток і неприхований. Практичне значення цього полягає в тому, що у своєму коді ви можете змінити поведінку за замовчуванням, sys.excepthookщоб робити все, що завгодно (включаючи використання logging.exception).

Як приклад солом'яної людини:

>>> import sys
>>> def foo(exctype, value, tb):
...     print 'My Error Information'
...     print 'Type:', exctype
...     print 'Value:', value
...     print 'Traceback:', tb
... 

Заміна sys.excepthook:

>>> sys.excepthook = foo

Зробіть очевидну синтаксичну помилку (залиште двокрапку) та отримайте власну інформацію про помилку:

>>> def bar(a, b)
My Error Information
Type: <type 'exceptions.SyntaxError'>
Value: invalid syntax (<stdin>, line 1)
Traceback: None

Для отримання додаткової інформації про те sys.excepthook, прочитайте документи .

Ось повний невеликий приклад, який також включає кілька інших хитрощів:

import sys
import logging
logger = logging.getLogger(__name__)
handler = logging.StreamHandler(stream=sys.stdout)
logger.addHandler(handler)

def handle_exception(exc_type, exc_value, exc_traceback):
    if issubclass(exc_type, KeyboardInterrupt):
        sys.__excepthook__(exc_type, exc_value, exc_traceback)
        return

    logger.error("Uncaught exception", exc_info=(exc_type, exc_value, exc_traceback))

sys.excepthook = handle_exception

if __name__ == "__main__":
    raise RuntimeError("Test unhandled")

• Ігноруйте KeyboardInterrupt, щоб програма консольного пітона могла вийти за допомогою Ctrl + C.

• Цілком покладайтеся на модуль реєстрації python для форматування винятку.

• Використовуйте користувальницький реєстратор із прикладом обробника. Це змінює необроблений виняток, щоб перейти до stdout, а не stderr, але ви можете додати всілякі обробники в цьому ж стилі до об’єкта реєстратора.

Цей метод sys.excepthookбуде застосовано, якщо виняток не знайдено: http://docs.python.org/library/sys.html#sys.excepthook

Коли виняток піднімається та є нездійсненним, інтерпретатор викликає sys.excepthook з трьома аргументами, класом виключень, екземпляром винятку та об'єктом trackback. В інтерактивному сеансі це відбувається безпосередньо перед поверненням контролю в підказку; в програмі Python це відбувається безпосередньо перед виходом програми. Обробку таких винятків верхнього рівня можна налаштувати шляхом призначення іншої функції три аргументу sys.excepthook.

Чому ні:

import sys
import logging
import traceback

def log_except_hook(*exc_info):
    text = "".join(traceback.format_exception(*exc_info))
    logging.error("Unhandled exception: %s", text)

sys.excepthook = log_except_hook

None()

Ось вихід з, sys.excepthookяк видно вище:

$ python tb.py
ERROR:root:Unhandled exception: Traceback (most recent call last):
  File "tb.py", line 11, in <module>
    None()
TypeError: 'NoneType' object is not callable

Ось вихід із sys.excepthookпрокоментованим:

$ python tb.py
Traceback (most recent call last):
  File "tb.py", line 11, in <module>
    None()
TypeError: 'NoneType' object is not callable

Єдина відмінність полягає в тому, що у першого є ERROR:root:Unhandled exception:на початку першого рядка.

Щоб побудувати на відповіді Джасінда, але використовуючи об’єкт реєстратора:

def catchException(logger, typ, value, traceback):
    logger.critical("My Error Information")
    logger.critical("Type: %s" % typ)
    logger.critical("Value: %s" % value)
    logger.critical("Traceback: %s" % traceback)

# Use a partially applied function
func = lambda typ, value, traceback: catchException(logger, typ, value, traceback)
sys.excepthook = func

Оберніть виклик для входу в try...exceptблок, щоб ви могли ловити та реєструвати (і, можливо, повторно підвищувати) всі невловимі винятки. Наприклад, замість:

if __name__ == '__main__':
    main()

Зробити це:

if __name__ == '__main__':
    try:
        main()
    except Exception as e:
        logger.exception(e)
        raise

Можливо, ви могли б зробити щось у верхній частині модуля, який перенаправляє stderr до файлу, а потім заносить цей файл внизу

sock = open('error.log', 'w')               
sys.stderr = sock

doSomething() #makes errors and they will log to error.log

logging.exception(open('error.log', 'r').read() )

Хоча відповідь @ gnu_lorien дала мені гарну вихідну точку, моя програма виходить з ладу за першим винятком.

Я придумав вдосконалене (та / або) вдосконалене рішення, яке мовчки записує винятки з функцій, декорованих @handle_error.

import logging

__author__ = 'ahmed'
logging.basicConfig(filename='error.log', level=logging.DEBUG)


def handle_exception(exc_type, exc_value, exc_traceback):
    import sys
    if issubclass(exc_type, KeyboardInterrupt):
        sys.__excepthook__(exc_type, exc_value, exc_traceback)
        return
    logging.critical(exc_value.message, exc_info=(exc_type, exc_value, exc_traceback))


def handle_error(func):
    import sys

    def __inner(*args, **kwargs):
        try:
            return func(*args, **kwargs)
        except Exception, e:
            exc_type, exc_value, exc_tb = sys.exc_info()
            handle_exception(exc_type, exc_value, exc_tb)
        finally:
            print(e.message)
    return __inner


@handle_error
def main():
    raise RuntimeError("RuntimeError")


if __name__ == "__main__":
    for _ in xrange(1, 20):
        main()

Щоб відповісти на запитання Mr.Zeus, обговорене в розділі коментарів прийнятої відповіді, я використовую це для того, щоб записувати невиконані винятки в інтерактивній консолі (протестовано з PyCharm 2018-2019). Я виявив, sys.excepthookщо не працює в оболонці пітона, тому я заглянув глибше і виявив, що можу використовувати sys.exc_infoзамість цього. Однак sys.exc_infoне бере аргументів на відміну від того, sys.excepthookщо бере 3 аргументи.

Тут я використовую обидва sys.excepthookі sys.exc_infoзаписую обидва винятки в інтерактивній консолі та скрипті з функцією обгортки. Щоб прикріпити функцію гака до обох функцій, у мене є два різних інтерфейсу залежно від того, подано аргументи чи ні.

Ось код:

def log_exception(exctype, value, traceback):
    logger.error("Uncaught exception occurred!",
                 exc_info=(exctype, value, traceback))


def attach_hook(hook_func, run_func):
    def inner(*args, **kwargs):
        if not (args or kwargs):
            # This condition is for sys.exc_info
            local_args = run_func()
            hook_func(*local_args)
        else:
            # This condition is for sys.excepthook
            hook_func(*args, **kwargs)
        return run_func(*args, **kwargs)
    return inner


sys.exc_info = attach_hook(log_exception, sys.exc_info)
sys.excepthook = attach_hook(log_exception, sys.excepthook)

Налаштування журналу можна знайти у відповіді gnu_lorien.

У моєму випадку (використовуючи python 3) при використанні відповіді @Jacinda зміст відстеження не було надруковано. Замість цього, він просто друкує сам об'єкт: <traceback object at 0x7f90299b7b90>.

Натомість я роблю:

import sys
import logging
import traceback

def custom_excepthook(exc_type, exc_value, exc_traceback):
    # Do not print exception when user cancels the program
    if issubclass(exc_type, KeyboardInterrupt):
        sys.__excepthook__(exc_type, exc_value, exc_traceback)
        return

    logging.error("An uncaught exception occurred:")
    logging.error("Type: %s", exc_type)
    logging.error("Value: %s", exc_value)

    if exc_traceback:
        format_exception = traceback.format_tb(exc_traceback)
        for line in format_exception:
            logging.error(repr(line))

sys.excepthook = custom_excepthook