as e: объект ошибки в переменной

До сих пор запасные планы были слепыми: except сообщал «не число», но не говорил, что именно Python пытался разобрать и почему отказался. А ведь в traceback эта информация была: invalid literal for int() with base 10: 'двенадцать'. Хорошая новость — её не обязательно терять: исключение можно поймать не только для реакции, но и для разбора. Для этого у except есть вторая форма — с переменной.

Берём объект ошибки: as e

Запись except ValueError as e: делает две вещи: ловит ValueError и кладёт объект ошибки в переменную e. Объект — это не строка, а полноценное значение со своими данными: типом, сообщением, аргументами.

try:
    n = int('двенадцать')
except ValueError as e:
    print('Тип:', type(e).__name__)
    print('Сообщение:', e)
    print('Аргументы:', e.args)

Тип: ValueError
Сообщение: invalid literal for int() with base 10: 'двенадцать'
Аргументы: ("invalid literal for int() with base 10: 'двенадцать'",)

Три способа заглянуть в пойманную ошибку. type(e).__name__ — имя типа в виде строки: ValueError. Печать самого e даёт сообщение — тот же текст, что завершал traceback в первом уроке. e.args — кортеж аргументов, с которыми ошибка была создана; у нашего ValueError он из одного элемента. Для первых двух задач достаточно печати e — но имя типа пригождается, когда один обработчик обслуживает несколько типов и нужно понять, кто именно прилетел.

Сообщение ошибки: у каждого типа своё

Сообщение — самое ценное в объекте: это человеческое описание причины. Печать e в запасном плане делает его информативным:

try:
    n = int('двенадцать')
except ValueError as e:
    print('Не разобрали:', e)

Не разобрали: invalid literal for int() with base 10: 'двенадцать'

Теперь план Б не врёт обобщениями — он показывает, с каким значением разбор провалился. Сравните с «не разобрали» из прошлого урока: разница как между «заявка отклонена» и «заявка отклонена: не указана дата».

У разных типов сообщения разные по форме. KeyError вместо длинной фразы печатает сам недостающий ключ — в кавычках:

d = {'Анна': 5}
try:
    print(d['Пётр'])
except KeyError as e:
    print('Тип:', type(e).__name__)
    print('Сообщение:', e)

Тип: KeyError
Сообщение: 'Пётр'

Сообщение KeyError выглядит коротко: ключ в кавычках. Python печатает его так же, как в traceback первого урока, — это договорённость именно этого типа. Отсюда практический вывод: не полагайтесь на форму сообщения, полагайтесь на тип. Тип говорит, какая авария случилась; сообщение — детали для человека.

Лог в цикле: каждую аварию — в протокол

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

values = ['4', 'x', '9']
total = 0
for v in values:
    try:
        total += int(v)
    except ValueError as e:
        print('пропустил', repr(v), '-', e)
print('Итого:', total)

пропустил 'x' - invalid literal for int() with base 10: 'x'
Итого: 13

Протокол говорит всё: какую строку пропустили (repr показывает её в кавычках, чтобы пустые строки были видны) и почему именно. Четвёрка и девятка вошли в сумму, икс — в протокол. Такая строка в логе экономит минуты расследования: видно и значение-виновник, и формулировку ошибки.

Имя переменной выбираете вы

e в записи as e — не зарезервированное слово, а обычное имя, которое придумывает автор кода. Курс по циклам любит короткие имена в заголовках циклов — здесь так же: e, err, ex. Смысл от имени не меняется:

try:
    n = int('abc')
except ValueError as err:
    print(type(err).__name__, '-', err)

ValueError - invalid literal for int() with base 10: 'abc'

err напечатал то же, что печатал бы e: имя переменной — только ярлык для объекта ошибки. В одной программе стоит выбрать одно имя и держаться его, как выбирают единый стиль для переменных цикла.

e живёт только внутри except

Переменная из as e живёт только внутри except: на выходе из блока Python удаляет её сам. Проверим, что будет, если обратиться к e после блока:

try:
    n = int('двенадцать')
except ValueError as e:
    print('поймали:', e)
print(e)

поймали: invalid literal for int() with base 10: 'двенадцать'
Traceback (most recent call last):
  File "app.py", line 5, in <module>
    print(e)
          ^
NameError: name 'e' is not defined

Первая печать сработала — внутри блока переменная была жива. Печать после блока упала с NameError: имя больше не существует. Python делает это специально, чтобы объекты ошибок не болтались в программе дольше необходимого. Правило простое: разбираем ошибку внутри except; что нужно на будущее — сохраняем в свою переменную, например message = str(e), ещё внутри блока.

try:
    n = int('двенадцать')
except ValueError as e:
    print(e.upper())

Traceback (most recent call last):
  File "app.py", line 2, in <module>
    n = int('двенадцать')
        ~~~^^^^^^^^^^^^^^
ValueError: invalid literal for int() with base 10: 'двенадцать'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "app.py", line 4, in <module>
    print(e.upper())
          ^^^^^^^
AttributeError: 'ValueError' object has no attribute 'upper'

Шпаргалка по объекту ошибки

Мы научились не только ловить ошибку, но и забирать её данные: тип для ветвления, сообщение для протокола. Дальше — два хвоста try, которые расширяют конструкцию: else выполнится при успехе, а finally — при любом исходе. А цепочка обработчиков из четвёртого урока теперь может писать разные сообщения для разных типов.