Python обработка ошибок keyerror

In this article, we will learn how to handle KeyError exceptions in Python programming language.

What are Exceptions?

• It is an unwanted event, which occurs during the execution of the program and actually halts the normal flow of execution of the instructions.
• Exceptions are runtime errors because, they are not identified at compile time just like syntax errors which occur due to wrong indentation, missing parentheses, and misspellings. 
• Examples of built-in exceptions in Python – KeyError exception, NameError, ImportError, ZeroDivisionError, FloatingPointError, etc.

What is KeyError Exception?

A KeyError Exception occurs when we try to access a key that is not present. For example, we have stored subjects taken by students in a dictionary with their names as a key and subjects as a value and if we want to get the value of a key that doesn’t exist then we get a KeyError exception. Let’s understand this by an example.

Example:

Explanation: In the above example we have created a dictionary and tried to print the subject of ‘Fharan’ but we got an error in the output as shown below because that key is not present in our dictionary which is called a Python KeyError exception.

Output:

Traceback (most recent call last):
  File "4119e772-3398-41b7-816b-6b20791538e9.py", line 7, in <module>
    print(subjects['Fharan'])
KeyError: 'Fharan'

Methods to handle KeyError exception

Method 1: Using Try, Except keywords

The code that can(may) cause an error can be put in the try block and the code that handles it is to be included in the except block so that abrupt termination of the program will not happen because the exception is being handled here by the code in the expected block. To know more about try, except refer to this article Python Try Except.

Example:

Explanation: In this example, subjects[‘Fharan’] raises an exception but doesn’t halt the program because the exception is caught by expect block where some action is being done (printing a message that “Fharan’s records doesn’t exist”)

Output:

Fharan's records doesn't exist

Method 2: Using get() method

The get() method will return the value specified by the given key, if a key is present in the dictionary, if not it will return a default value given by the programmer. If no default value is specified by the programmer, it returns “None” as output.

Example:

Output: In the above example, there is no key “sreeram” hence, it returns “None”.

None

If a default value is to be returned instead of “None”, we need to specify the default value in this way:  

sub = subjects.get(‘sreeram’, “Student doesn’t exist”)

Example :

Output:

Student doesn't exist

To know more about exception handling in python please refer to this article Python Exception Handling.

Last Updated :
30 Dec, 2022

Like Article

Save Article

Отображение – это структура данных в Python, которая отображает один набор в другом наборе значений. Словарь Python является наиболее широко используемым для отображения. Каждому значению назначается ключ, который можно использовать для просмотра значения. Ошибка ключа возникает, когда ключ не существует в сопоставлении, которое используется для поиска значения.

В этой статье мы собираемся обсудить ошибки keyerror в Python и их обработку с примерами. Но прежде чем обсуждать ошибку ключа Python, мы узнаем о словаре.

Словарь (dict) в Python – это дискретный набор значений, содержащий сохраненные значения данных, эквивалентные карте. Он отличается от других типов данных тем, что имеет только один элемент, который является единственным значением. Он содержит пару ключей и значений. Это более эффективно из-за ключевого значения.

Двоеточие обозначает разделение пары ключа и значения, а запятая обозначает разделение каждого ключа. Этот словарь Python работает так же, как и обычный словарь. Ключи должны быть уникальными и состоять из неизменяемых типов данных, включая строки, целые числа и кортежи.

Давайте рассмотрим пример, чтобы понять, как мы можем использовать словарь (dict) в Python:

 
# A null Dictionary  
Dict = {}  
print("Null dict: ")  
print(Dict)  
  
# A Dictionary using Integers  
Dict = {1: 'Hill', 2: 'And', 3: 'Mountin'}  
print("nDictionary with the use of Integers: ")  
print(Dict)  
  
# A Dictionary using Mixed keys  
Dict = {'Name': 'John', 1: [17, 43, 22, 51]}  
print("nDictionary with the use of Mixed Keys: ")  
print(Dict)  
  
# A Dictionary using the dict() method  
Dict = dict({1: 'London', 2: 'America', 3:'France'})  
print("nDictionary with the use of dict(): ")  
print(Dict)  
  
# A Dictionary having each item as a Pair  
Dict = dict([(1, 'Hello'),(2, 'World')])  
print("nDictionary with each item as a pair: ")  
print(Dict) 

Вывод:

Null dict:  
{} 
nDictionary with the use of Integers:  
{1: 'Hill', 2: 'And', 3: 'Mountin'} 
nDictionary with the use of Mixed Keys:  
{'Name': 'John', 1: [17, 43, 22, 51]} 
nDictionary with the use of dict():  
{1: 'London', 2: 'America', 3: 'France'} 
nDictionary with each item as a pair:  
{1: 'Hello', 2: 'World'} 

Keyerror в Python

Когда мы пытаемся получить доступ к ключу из несуществующего dict, Python вызывает ошибку Keyerror. Это встроенный класс исключений, созданный несколькими модулями, которые взаимодействуют с dicts или объектами, содержащими пары ключ-значение.

Теперь мы знаем, что такое словарь Python и как он работает. Давайте посмотрим, что определяет Keyerror. Python вызывает Keyerror всякий раз, когда мы хотим получить доступ к ключу, которого нет в словаре Python.

Логика сопоставления – это структура данных, которая связывает один фрагмент данных с другими важными данными. В результате, когда к сопоставлению обращаются, но не находят, возникает ошибка. Это похоже на ошибку поиска, где семантическая ошибка заключается в том, что искомого ключа нет в его памяти.

Давайте рассмотрим пример, чтобы понять, как мы можем увидеть Keyerror в Python. Берем ключи A, B, C и D, у которых D нет в словаре Python. Хотя оставшиеся ключи, присутствующие в словаре, показывают вывод правильно, а D показывает ошибку ключа.

 
# Check the Keyerror 
ages={'A':45,'B':51,'C':67} 
print(ages['A']) 
print(ages['B']) 
print(ages['C']) 
print(ages['D']) 

Вывод:

45 
51 
67 
Traceback(most recent call last): 
File "", line 6, in  
KeyError: 'D' 

Механизм обработки ключевой ошибки в Python

Любой, кто сталкивается с ошибкой Keyerror, может с ней справиться. Он может проверять все возможные входные данные для конкретной программы и правильно управлять любыми рискованными входами. Когда мы получаем KeyError, есть несколько обычных методов борьбы с ним. Кроме того, некоторые методы могут использоваться для обработки механизма ошибки ключа.

Обычное решение: метод .get()

Некоторые из этих вариантов могут быть лучше или не могут быть точным решением, которое мы ищем, в зависимости от нашего варианта использования. Однако наша конечная цель – предотвратить возникновение неожиданных исключений из ключевых ошибок.

Например, если мы получаем ошибку из словаря в нашем собственном коде, мы можем использовать метод .get() для получения либо указанного ключа, либо значения по умолчанию.

Давайте рассмотрим пример, чтобы понять, как мы можем обработать механизм ошибки ключа в Python:

 
# List of vehicles and their prices.  
vehicles = {"Car=": 300000, "Byke": 115000, "Bus": 250000} 
vehicle = input("Get price for: ") 
vehicle1 = vehicles.get(vehicle) 
if vehicle1: 
    print("{vehicle} is {vehicle1} rupees.") 
else: 
    print("{vehicle}'s cost is unknown.") 

Вывод:

Get price for: Car 
Car is 300000 rupees. 

Общее решение для keyerror: метод try-except

Общий подход заключается в использовании блока try-except для решения таких проблем путем создания соответствующего кода и предоставления решения для резервного копирования.

Давайте рассмотрим пример, чтобы понять, как мы можем применить общее решение для keyerror:

 
# Creating a dictionary to store items and prices 
items = {"Pen" : "12", "Book" : "45", "Pencil" : "10"} 
try: 
  print(items["Book"]) 
except: 
  print("The items does not contain a record for this key.")   

Вывод:

45 

Здесь мы видим, что мы получаем стоимость книги из предметов. Следовательно, если мы хотим напечатать любую другую пару «ключ-значение», которой нет в элементах, она напечатает этот вывод.

 
# Creating a dictionary to store items and prices 
items = {"Pen" : "12", "Book" : "45", "Pencil" : "10"} 
try: 
  print(items["Notebook"]) 
except: 
  print("The items does not contain a record for this key.")  

Вывод:

The items does not contain a record for this key. 

Заключение

Теперь мы понимаем некоторые распространенные сценарии, в которых может быть выброшено исключение Python Keyerror, а также несколько отличных стратегий для предотвращения их завершения нашей программы.

В следующий раз, когда мы столкнемся с ошибкой Keyerror, мы будем знать, что это, скорее всего, связано с ошибочным поиском ключа словаря. Посмотрев на последние несколько строк трассировки, мы можем получить всю информацию, которая нам понадобится, чтобы выяснить, откуда взялась проблема.

Если проблема заключается в поиске ключа словаря в нашем собственном коде, мы можем использовать более безопасную функцию .get() с возвращаемым значением по умолчанию вместо запроса ключа непосредственно в словаре. Если наш код не вызывает проблемы, блок try-except – лучший вариант для регулирования потока нашего кода.

Исключения не должны пугать. Мы можем использовать эти методы, чтобы наши программы выполнялись более предсказуемо, если мы понимаем информацию, представленную нам в их обратных трассировках, и первопричину ошибки.

Watch Now This tutorial has a related video course created by the Real Python team. Watch it together with the written tutorial to deepen your understanding: Python KeyError Exceptions and How to Handle Them

Python’s KeyError exception is a common exception encountered by beginners. Knowing why a KeyError can be raised and some solutions to prevent it from stopping your program are essential steps to improving as a Python programmer.

By the end of this tutorial, you’ll know:

• What a Python KeyError usually means
• Where else you might see a KeyError in the standard library
• How to handle a KeyError when you see it

>>> ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
>>> ages['Michael']
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'Michael'

 1# ages.py
 2
 3ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
 4person = input('Get age for: ')
 5print(f'{person} is {ages[person]} years old.')

$ python ages.py
Get age for: Michael
Traceback (most recent call last):
File "ages.py", line 4, in <module>
  print(f'{person} is {ages[person]} years old.')
KeyError: 'Michael'

>>> from zipfile import ZipFile
>>> zip_file = ZipFile('the_zip_file.zip')
>>> zip_file.getinfo('something')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/path/to/python/installation/zipfile.py", line 1304, in getinfo
  'There is no item named %r in the archive' % name)
KeyError: "There is no item named 'something' in the archive"

 1# ages.py
 2
 3ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
 4person = input('Get age for: ')
 5age = ages.get(person)
 6
 7if age:
 8    print(f'{person} is {age} years old.')
 9else:
10    print(f"{person}'s age is unknown.")

$ python ages.py
Get age for: Michael
Michael's age is unknown.

age = ages.get(person, 0)

 1# parse_api_response.py
 2...
 3# Assuming you got a `response` from calling an API that might
 4# have an error key in the `response` if something went wrong
 5
 6if 'error' in response:
 7    ...  # Parse the error state
 8else:
 9    ...  # Parse the success state

 1# ages.py
 2
 3ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
 4person = input('Get age for: ')
 5
 6try:
 7    print(f'{person} is {ages[person]} years old.')
 8except KeyError:
 9    print(f"{person}'s age is unknown.")

>>> from zipfile import ZipFile
>>> zip = ZipFile('the_zip_file.zip')
>>> try:
...     zip.getinfo('something')
... except KeyError:
...     print('Can not find "something"')
...
Can not find "something"

Watch Now This tutorial has a related video course created by the Real Python team. Watch it together with the written tutorial to deepen your understanding: Python KeyError Exceptions and How to Handle Them

Исключения Python KeyError и как их обработать

>>> ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
>>> ages['Michael']
Traceback (most recent call last):
  File "", line 1, in 
KeyError: 'Michael'

 1 # ages.py
 2
 3 ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
 4 person = input('Get age for: ')
 5 print(f'{person} is {ages[person]} years old.')

$ python ages.py
Get age for: Michael
Traceback (most recent call last):
File "ages.py", line 4, in 
  print(f'{person} is {ages[person]} years old.')
KeyError: 'Michael'

>>> from zipfile import ZipFile
>>> zip_file = ZipFile('the_zip_file.zip')
>>> zip_file.getinfo('something')
Traceback (most recent call last):
File "", line 1, in 
File "/path/to/python/installation/zipfile.py", line 1304, in getinfo
  'There is no item named %r in the archive' % name)
KeyError: "There is no item named 'something' in the archive"

 1 # ages.py
 2
 3 ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
 4 person = input('Get age for: ')
 5 age = ages.get(person)
 6
 7 if age:
 8     print(f'{person} is {age} years old.')
 9 else:
10     print(f"{person}'s age is unknown.")

$ python ages.py
Get age for: Michael
Michael's age is unknown.

age = ages.get(person, 0)

 1 # parse_api_response.py
 2 ...
 3 # Assuming you got a `response` from calling an API that might
 4 # have an error key in the `response` if something went wrong
 5
 6 if 'error' in response:
 7     ...  # Parse the error state
 8 else:
 9     ...  # Parse the success state

 1 # ages.py
 2
 3 ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
 4 person = input('Get age for: ')
 5
 6 try:
 7     print(f'{person} is {ages[person]} years old.')
 8 except KeyError:
 9     print(f"{person}'s age is unknown.")

>>> from zipfile import ZipFile
>>> zip = ZipFile('the_zip_file.zip')
>>> try:
...     zip.getinfo('something')
... except KeyError:
...     print('Can not find "something"')
...
Can not find "something"