Использование метода __missing__() в Python

• 30.07.2023
• 289
• Основы Python
• ООП

__missing__() — это специальный метод в Python, который вызывается в словарях, когда пытаются получить доступ к элементу по ключу, который в словаре не существует.

Синтаксис и использование __missing__()

Метод __missing__() вызывается, когда оператор __getitem__() не может найти указанный ключ в словаре. Он принимает один аргумент: ключ, который не был найден.

В Python метод __missing__() должен быть определен в пользовательском классе, который наследуется от dict или его подкласса.

class MyDict(dict):
    def __missing__(self, key):
        print(f"{key} не найден в словаре")
        return None

В этом примере, если вы попытаетесь получить доступ к ключу, который не существует, будет выведено сообщение, и метод вернет None.

obj = MyDict({"one": 1, "two": 2})
print(obj["three"])  # Вывод: "three не найден в словаре"

Особенности и применения __missing__()

Метод __missing__() обеспечивает гибкость в том, как обрабатываются ситуации, когда ключ не найден в словаре.

Определение значения по умолчанию

Одним из распространенных применений __missing__() является определение значения по умолчанию, которое возвращается, когда ключ отсутствует:

class MyDict(dict):
    def __missing__(self, key):
        return "Значение по умолчанию"

obj = MyDict({"one": 1, "two": 2})
print(obj["three"])  # Вывод: "Значение по умолчанию"

Автоматическое добавление отсутствующих ключей

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

class MyDict(dict):
    def __missing__(self, key):
        self[key] = "Новый ключ"
        return self[key]

obj = MyDict({"one": 1, "two": 2})
print(obj["three"])  # Вывод: "Новый ключ"

Важные моменты

1. Метод __missing__() и get(): Если вы используете метод get() для доступа к элементу словаря, то __missing__() не будет вызван даже при отсутствии ключа, так как get() вместо этого просто возвращает значение по умолчанию.
2. Метод __missing__() и оператор in: Оператор in, используемый для проверки наличия ключа в словаре, также не вызывает __missing__().
3. Метод __missing__() и KeyError: Если метод __missing__() не определен и ключ не найден, Python вызывает исключение KeyError. Определение __missing__() позволяет вам перехватить эту ошибку и определить свое поведение для несуществующих ключей.

Применение

Одно из наиболее распространенных применений метода __missing__() — это создание словарей со значениями по умолчанию. Например, вы можете создать словарь, который автоматически присваивает новому ключу значение 0. Это удобно, например, при подсчете частоты слов в тексте, когда неизвестно, сколько раз каждое слово встречается в тексте. Такой словарь можно создать с помощью collections.defaultdict из стандартной библиотеки Python.

Заключение

__missing__() — это мощный специальный метод, который предоставляет вам больше контроля над тем, как ваши словари обрабатывают ситуации, когда ключ не найден. Это может быть особенно полезно для создания словарей с определенными значениями по умолчанию или словарей, которые автоматически добавляют новые ключи при попытке доступа к ним.