KeyError в Python: ошибки словарей

Словарь — самая ходовая структура для данных из реального мира: настройки, ответы API, записи о пользователях. И самая частая ошибка при работе с ними — обращение к ключу, которого нет: опечатка, поле не пришло, ключ назван чуть иначе. Python не возвращает None и не молчит — он поднимает KeyError, и этот урок о том, как с ним обращаться.

Как воспроизводится KeyError

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

settings = {'theme': 'dark', 'lang': 'ru'}
print(settings['font'])

KeyError принадлежит семье LookupError — ветке поиска из девятого урока об иерархии: искомое не нашлось. Его брат IndexError возникает при той же ситуации в списках, только там вместо ключа — номер. В сообщении KeyError печатается отсутствующий ключ в кавычках: читая traceback, вы первым делом видите виновника.

Ловим и разбираем объект ошибки

settings = {'theme': 'dark', 'lang': 'ru'}

try:
    print(settings['font'])
except KeyError as e:
    print('поймали', type(e).__name__, 'для ключа', str(e))

поймали KeyError для ключа 'font'

Исключение несёт ключ внутри себя: str(e) возвращает его строковое представление вместе с кавычками. Если кавычки мешают — например, ключ идёт в журнал, где уже есть своё оформление — берите данные напрямую из e.args, кортежа аргументов, с которыми исключение было создано:

d = {}
try:
    d['город']
except KeyError as e:
    print('args:', e.args)
    print('первый аргумент:', e.args[0])

args: ('город',)
первый аргумент: город

e.args[0] — чистый ключ без кавычек: его можно сравнивать, подставлять в сообщения, писать в отчёт. Именно так ловля KeyError превращается из паники в обработку: программа знает, какого именно ключа не хватило, и решает, что с этим делать.

cities = {'Москва': 'Россия', 'Париж': 'Франция'}

for city in ['Москва', 'Рим', 'Париж']:
    try:
        print(city, '-', cities[city])
    except KeyError:
        print(city, '- в справочнике нет')

Москва - Россия
Рим - в справочнике нет
Париж - Франция

Три способа жить с возможным отсутствием

Ловля — не единственный путь. У словарей есть собственные инструменты против отсутствия, и выбор между ними зависит от смысла ситуации. Первый и самый частый — метод get, который вместо падения возвращает значение по умолчанию:

settings = {'theme': 'dark', 'lang': 'ru'}

font = settings.get('font', 'Arial')
theme = settings.get('theme', 'light')
print('шрифт:', font)
print('тема:', theme)

шрифт: Arial
тема: dark

settings = {'theme': 'dark'}

if 'lang' in settings:
    print('язык:', settings['lang'])
else:
    print('язык не задан — берём умолчание ru')

язык не задан — берём умолчание ru

Если для отсутствующего ключа есть разумное значение по умолчанию, словарный get решает вопрос без исключений — подробнее о нём в уроке словарей о get. Если отсутствие — нормальная ветка логики, с отдельными действиями на «есть» и «нет», удобна проверка in из урока о проверке ключа. А try с except KeyError остаётся правильным выбором, когда отсутствие ключа — аномалия: без этого словаря программа не может работать, и молчаливая подстановка спрятала бы проблему.

Ключ, которого нет, — самый рядовой случай из мира данных, и Python даёт на него три ответа. Какой из трёх выбрать при обходе коллекций с сомнительным содержимым — вопрос стиля, которому посвящён четырнадцатый урок об идиоме EAFP. А полный курс о словарях — от создания до частотных таблиц — ждёт в разделе Словари.