get: безопасное чтение из словаря

В прошлом уроке строгий доступ d[ключ] падал с KeyError, стоило ключу отсутствовать. Иногда это ровно то, что нужно. Но чаще отсутствие ключа — нормальная ситуация: товара может не быть на складе, слова — в переводе, пользователя — в базе. Для таких случаев у словаря есть метод get — чтение без сюрпризов.

get: чтение без падений

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

stock = {'молоко': 12, 'хлеб': 5}

print(stock.get('молоко'))
print(stock.get('кефир'))

12
None

Второй аргумент: значение по умолчанию

Для 'кефир' метод вернул None — специальное значение «здесь ничего нет»: программа не упала, а честно ответила. Но слово «None» в отчётах выглядит странно, а в арифметике и вовсе опасно. Поэтому у get есть второй аргумент — запасное значение, которое вернётся, если ключа нет:

stock = {'молоко': 12, 'хлеб': 5}

print(stock.get('кефир', 0))

total = stock.get('кефир', 0) + stock.get('хлеб', 0)
print(total)

0
5

Умолчание работает только при отсутствии ключа: если 'хлеб' на месте, вернётся его 5, а не 0. Здесь и главная польза: складывать запасы можно одной строкой, не проверяя заранее, какие позиции есть, — отсутствующие просто посчитаются нулями.

stock = {'молоко': 12}

found = stock.get('кефир', 0)
print(found)
print(stock)

0
{'молоко': 12}

Сценарий: отчёт по складу за неделю

Соберём задачу, в которой get проявляет себя по-разному в зависимости от того, как написан код. Есть словарь остатков: {'молоко': 12, 'хлеб': 5, 'сыр': 8}. Нужно посчитать, сколько всего единиц товара лежит на складе, и вывести остаток по каждой позиции, включая ту, которой на складе нет.

stock = {'молоко': 12, 'хлеб': 5, 'сыр': 8}

total = 0
for item in stock.values():
    total += item
print('всего позиций:', len(stock))
print('сумма:', total)

всего позиций: 3
сумма: 25

Тут get вообще не понадобился: мы итерировались по значениям, а не искали ключ. Ошибка в этом коде другая и куда более коварная — если бы в словаре завелась позиция с количеством None, сложение сразу упало бы с TypeError. Значения словарей стоит проверять на тип так же внимательно, как ключи.

stock = {'молоко': 12}

for name in ['молоко', 'кефир']:
    amount = stock.get(name, 0)
    print(name, '-', amount)

молоко - 12
кефир - 0

Здесь get спасение: без него цикл упал бы на втором шаге. И заметьте — словарь не изменился, лишней пары 'кефир' не появилось. Если бы в коде вместо get стояло stock[name] = 0, в словаре появилась бы лишняя позиция с нулём, и len(stock) вырос бы на единицу. Иногда это безобидно, иногда — нет: в отчёте о товарах, которых нет в наличии, вдруг начинают числиться нули.

stock = {'молоко': 12, 'хлеб': 5}
stock.get('кефир', 0)
stock.get('сыр', 0)
print(stock)
print(len(stock))

{'молоко': 12, 'хлеб': 5}
2

Ловушка молчания: опечатка, которую никто не заметит

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

Есть и вторая сторона молчания: get возвращает None и тогда, когда ключ есть, но значение действительно None. Для словаря с необязательными полями это нормально, но сравнивать нужно с is None, а не с == None. Разница на практике небольшая, а вот ошибка if not d.get('поле') — уже настоящая: она считает поле отсутствующим и в случае с значением 0, и в случае с пустой строкой, хотя поле есть.

order = {'id': 7, 'discount': 0}

print('discount в заказе:', 'discount' in order)
print('значение через not:', not order.get('discount'))
print('значение через is None:', order.get('discount') is None)

discount в заказе: True
значение через not: True
значение через is None: False

Ключ в заказе есть, значение равно нулю — а not всё равно говорит «правда». Значит, проверка «есть ли скидка» через not order.get('discount') отбросит заказ с нулевой скидкой так же, как заказ без скидки. Скидка 0 процентов и отсутствие скидки — разные вещи, и код должен это различать.

get и setdefault: похожи, но не одно и то же

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

stock = {'молоко': 12}

print(stock.get('кефир', 0))
print(stock)

print(stock.setdefault('кефир', 0))
print(stock)

0
{'молоко': 12}
0
{'молоко': 12, 'кефир': 0}

Разница видна во второй строке вывода: после get в словаре по-прежнему одна пара, после setdefault — две. Метод удобен там, где пустой слот нужно действительно заполнить: накопление списка по ключу, счётчик, первое появление даты. Но в коде, который просто читает, setdefault становится ловушкой — он меняет словарь там, где этого никто не ждал.

В одном сервисе мы заменили d.get(key, []) на d.setdefault(key, []) — и через неделю словарь распух в десять раз: каждый запрос к несуществующему ключу оставлял после себя пустой список. Данные не испортились, но память уходила, а в логах было тихо. Если нужен именно список под ключом, берите defaultdict(list) — про него урок 12.

Что дальше

Теперь умеете читать мягко и понимаете, чем за это платите. Дальше — изменение словаря: как добавить пару, как заменить значение и почему ключ всегда остаётся один. В уроке 5 разбираем присваивание по ключу и историю с дубликатами, а в уроке 6 — удаление: del, pop и popitem.