Согласно официальной документации Python 3, ошибка KeyError возникает, когда ключ набора (словаря) не найден в наборе существующих ключей.
Эта ошибка встречается, когда мы пытаемся получить или удалить значение ключа из словаря, и этот ключ не существует в словаре.
rana@Brahma: ~$ python3
Python 3.5.2 (default, Jul 10 2019, 11:58:48)
[GCC 5.4.0 20160609] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> a = dict()
>>> a["key1"] = "value1"
>>> print(a["key2"])
Traceback (most recent call last):
File "", line 1, in
KeyError: 'key2'
>>> Доступ к ключам словаря:
Для доступа к ключам словаря мы используем квадратные скобки [ ].
>>> gender = dict()
>>> gender["m"] = "Male"
>>> gender["f"] = "Female"
>>> gender["m"]
'Male'
>>> Однако вышеуказанный способ, то есть использование квадратных скобок, имеет один недостаток. Если ключ не существует, мы получаем KeyError.
>>> gender["k"]
Traceback (most recent call last):
File "", line 1, in
KeyError: 'k'
>>> Удаление несуществующего ключа:
>>> del gender["h"]
Traceback (most recent call last):
File "", line 1, in
KeyError: 'h'
>>> Чтобы справиться с такими случаями, мы можем использовать один из следующих методов, основанных на сценарии.
— Используйте метод get()
Мы можем получить значение ключа из словаря, используя метод get. Если пара ключ-значение не существует для данного ключа в словаре, то возвращается None, иначе возвращается значение, соответствующее этому ключу. Это рекомендуемый способ.
>>> gender.get("m")
'Male'
>>> gender.get("k")
>>>
>>> print(gender.get("k") is None)
True
>>>
Вы можете передать второй необязательный параметр в вызове get(), который является значением, возвращаемым, если ключ не существует в словаре. Значением по умолчанию этого второго параметра является None.
— проверить наличие ключа
Мы можем проверить, существует ли какой-либо конкретный ключ в словаре или нет, и затем на основании этого можно предпринять действия. Например:
gender = dict()
gender["m"] = "Male"
gender["f"] = "Female"
if "k" in gender:
print("Key k exists in gender")
else:
print("Key k doesn't exists in gender")
— Используйте try-exc
Если вы не используете или не хотите использовать метод get для доступа к ключам в словаре, используйте блок try-exc.
gender = dict()
gender["m"] = "Male"
gender["f"] = "Female"
try:
value = gender["k"]
except KeyError:
print("Key error. Do something else")
except Exception:
print("Some other error")
— Получить все ключи и перебрать словарь
Мы можем использовать метод keys(), чтобы получить список всех ключей в словаре, а затем выполнить итерацию по этому списку и получить доступ к значениям в словаре.
gender = dict()
gender["m"] = "Male"
gender["f"] = "Female"
keys = gender.keys()
for key in keys:
print(gender[key])
— Или вы можете напрямую перебирать словарь для пар ключ и значение, используя метод items().
gender = dict()
gender["m"] = "Male"
gender["f"] = "Female"
for item in gender.items():
print(item[0], item[1])
Аналогично, для удаления значения ключа из словаря мы можем использовать метод pop() вместо del.
Однако, в отличие от метода get(), метод pop() выбрасывает keyError, если удаляемый ключ не существует и второй параметр не передается.
Таким образом, чтобы избежать ошибки KeyError в случае удаления ключа, мы должны передать значение по умолчанию, которое будет возвращено, если ключ не найден, в качестве второго параметра для pop()
>>>
>>> gender.pop("m")
'Male'
>>> gender.keys()
dict_keys(['f'])
>>> gender.pop("k")
Traceback (most recent call last):
File "", line 1, in
KeyError: 'k'
>>> gender.pop("k", None)
>>> 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:
Python3
subjects = {'Sree': 'Maths',
'Ram': 'Biology',
'Shyam': 'Science',
'Abdul': 'Hindi'}
print(subjects['Fharan'])
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:
Python3
subjects = {'Sree': 'Maths',
'Ram': 'Biology',
'Shyam': 'Science',
'Abdul': 'Hindi'}
try:
print('subject of Fharan is:',
subjects['Fharan'])
except KeyError:
print("Fharan's records doesn't exist")
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:
Python3
subjects = {'Sree': 'Maths',
'Ram': 'Biology',
'Shyam': 'Science',
'Abdul': 'Hindi'}
sub = subjects.get('sreelekha')
print(sub)
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 :
Python3
subjects = {'sree': 'Maths', 'ram': 'Biology'}
sub = subjects.get('sreeram', "Student doesn't exist")
print(sub)
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
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
KeyErrorusually means - Where else you might see a
KeyErrorin the standard library - How to handle a
KeyErrorwhen you see it
What a Python KeyError Usually Means
A Python KeyError exception is what is raised when you try to access a key that isn’t in a dictionary (dict).
Python’s official documentation says that the KeyError is raised when a mapping key is accessed and isn’t found in the mapping. A mapping is a data structure that maps one set of values to another. The most common mapping in Python is the dictionary.
The Python KeyError is a type of LookupError exception and denotes that there was an issue retrieving the key you were looking for. When you see a KeyError, the semantic meaning is that the key being looked for could not be found.
In the example below, you can see a dictionary (ages) defined with the ages of three people. When you try to access a key that is not in the dictionary, a KeyError is raised:
>>>
>>> ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
>>> ages['Michael']
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
KeyError: 'Michael'
Here, attempting to access the key 'Michael' in the ages dictionary results in a KeyError being raised. At the bottom of the traceback, you get the relevant information:
- The fact that a
KeyErrorwas raised - The key that couldn’t be found, which was
'Michael'
The second-to-last line tells you which line raised the exception. This information is more helpful when you execute Python code from a file.
In the program below, you can see the ages dictionary defined again. This time, you will be prompted to provide the name of the person to retrieve the age for:
1# ages.py
2
3ages = {'Jim': 30, 'Pam': 28, 'Kevin': 33}
4person = input('Get age for: ')
5print(f'{person} is {ages[person]} years old.')
This code will take the name that you provide at the prompt and attempt to retrieve the age for that person. Whatever you type in at the prompt will be used as the key to the ages dictionary, on line 4.
Repeating the failed example from above, we get another traceback, this time with information about the line in the file that the KeyError is raised from:
$ 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'
The program fails when you give a key that is not in the dictionary. Here, the traceback’s last few lines point to the problem. File "ages.py", line 4, in <module> tells you which line of which file raised the resulting KeyError exception. Then you are shown that line. Finally, the KeyError exception provides the missing key.
So you can see that the KeyError traceback’s final line doesn’t give you enough information on its own, but the lines before it can get you a lot closer to understanding what went wrong.
Where Else You Might See a Python KeyError in the Standard Library
The large majority of the time, a Python KeyError is raised because a key is not found in a dictionary or a dictionary subclass (such as os.environ).
In rare cases, you may also see it raised in other places in Python’s Standard Library, such as in the zipfile module, if an item is not found in a ZIP archive. However, these places keep the same semantic meaning of the Python KeyError, which is not finding the key requested.
In the following example, you can see using the zipfile.ZipFile class to extract information about a ZIP archive using .getinfo():
>>>
>>> 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"
This doesn’t really look like a dictionary key lookup. Instead, it is a call to zipfile.ZipFile.getinfo() that raises the exception.
The traceback also looks a little different with a little more information given than just the missing key: KeyError: "There is no item named 'something' in the archive".
The final thing to note here is that the line that raised the KeyError isn’t in your code. It is in the zipfile code, but previous lines of the traceback indicate which lines in your code caused the problem.
When You Need to Raise a Python KeyError in Your Own Code
There may be times when it makes sense for you to raise a Python KeyError exception in your own code. This can be done by using the raise keyword and calling the KeyError exception:
Usually, the message would be the missing key. However, as in the case of the zipfile package, you could opt to give a bit more information to help the next developer better understand what went wrong.
If you decide to raise a Python KeyError in your own code, just make sure that your use case matches the semantic meaning behind the exception. It should denote that the key being looked for could not be found.
How to Handle a Python KeyError When You See It
When you encounter a KeyError, there are a few standard ways to handle it. Depending on your use case, some of these solutions might be better than others. The ultimate goal is to stop unexpected KeyError exceptions from being raised.
The Usual Solution: .get()
If the KeyError is raised from a failed dictionary key lookup in your own code, you can use .get() to return either the value found at the specified key or a default value.
Much like the age retrieval example from before, the following example shows a better way to get the age from the dictionary using the key provided at the prompt:
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.")
Here, line 5 shows how you can get the age value from ages using .get(). This will result in the age variable having the age value found in the dictionary for the key provided or a default value, None in this case.
This time, you will not get a KeyError exception raised because of the use of the safer .get() method to get the age rather than attempting to access the key directly:
$ python ages.py
Get age for: Michael
Michael's age is unknown.
In the example execution above, the KeyError is no longer raised when a bad key is provided. The key 'Michael' is not found in the dictionary, but by using .get(), we get a None returned rather than a raised KeyError.
The age variable will either have the person’s age found in the dictionary or the default value (None by default). You can also specify a different default value in the .get() call by passing a second argument.
This is line 5 from the example above with a different default age specified using .get():
age = ages.get(person, 0)
Here, instead of 'Michael' returning None, it would return 0 because the key isn’t found, and the default value to return is now 0.
The Rare Solution: Checking for Keys
There are times when you need to determine the existence of a key in a dictionary. In these cases, using .get() might not give you the correct information. Getting a None returned from a call to .get() could mean that the key wasn’t found or that the value found at the key in the dictionary is actually None.
With a dictionary or dictionary-like object, you can use the in operator to determine whether a key is in the mapping. This operator will return a Boolean (True or False) value indicating whether the key is found in the dictionary.
In this example, you are getting a response dictionary from calling an API. This response might have an error key value defined in the response, which would indicate that the response is in an error state:
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
Here, there is a difference in checking to see if the error key exists in the response and getting a default value from the key. This is a rare case where what you are actually looking for is if the key is in the dictionary and not what the value at that key is.
The General Solution: try except
As with any exception, you can always use the try except block to isolate the potential exception-raising code and provide a backup solution.
You can use the try except block in a similar example as before, but this time providing a default message to be printed should a KeyError be raised in the normal case:
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.")
Here, you can see the normal case in the try block of printing the person’s name and age. The backup case is in the except block, where if a KeyError is raised in the normal case, then the backup case is to print a different message.
The try except block solution is also a great solution for other places that might not support .get() or the in operator. It is also the best solution if the KeyError is being raised from another person’s code.
Here is an example using the zipfile package again. This time, the try except block gives us a way to stop the KeyError exception from stopping the program:
>>>
>>> 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"
Since the ZipFile class does not provide .get(), like the dictionary does, you need to use the try except solution. In this example, you don’t have to know ahead of time what values are valid to pass to .getinfo().
Conclusion
You now know some common places where Python’s KeyError exception could be raised and some great solutions you could use to prevent them from stopping your program.
Now, the next time you see a KeyError raised, you will know that it is probably just a bad dictionary key lookup. You will also be able to find all the information you need to determine where the error is coming from by looking at the last few lines of the traceback.
If the problem is a dictionary key lookup in your own code, then you can switch from accessing the key directly on the dictionary to using the safer .get() method with a default return value. If the problem isn’t coming from your own code, then using the try except block is your best bet for controlling your code’s flow.
Exceptions don’t have to be scary. Once you know how to understand the information provided to you in their tracebacks and the root cause of the exception, then you can use these solutions to make your programs flow more predictably.
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
The Python KeyError is an exception that occurs when an attempt is made to access an item in a dictionary that does not exist. The key used to access the item is not found in the dictionary, which leads to the KeyError.
What Causes KeyError
The Python KeyError is raised when a mapping key is not found in the set of existing keys of the mapping. In Python, the most common mapping is the dictionary. When an item in a dictionary is accessed using a key, and the key is not found within the set of keys of the dictionary, the KeyError is raised.
Python KeyError Example
Here’s an example of a Python KeyError raised when trying to access a dictionary item that does not exist:
employees = {1: "John", 2: "Darren", 3: "Paul"}
print(employees[4])
In the above example, the dictionary employees contains some key-value pairs. An attempt is then made to access an item from employees using the key 4. Since 4 does not exist in the set of keys of the dictionary, a KeyError is raised:
File "test.py", line 2, in <module>
print(employees[4])
KeyError: 4
How to Fix KeyError in Python
To avoid the KeyError in Python, keys in a dictionary should be checked before using them to retrieve items. This will help ensure that the key exists in the dictionary and is only used if it does, thereby avoiding the KeyError. This can be done using the in keyword.
Another solution is to use the .get() function to either retrieve the item using the specified key, or None if it doesn’t exist.
Using the above approach, a check for the key can be added to the earlier example:
employees = {1: "John", 2: "Darren", 3: "Paul"}
if 4 in employees:
print(employees[4])
else:
print('Key not found')
Here, a check is performed to ensure that the key 4 exists in the employees dictionary before it is used to retrieve a value. If it does not exist, a message is displayed and the error is avoided:
Key not found
Track, Analyze and Manage Errors With Rollbar
Managing errors and exceptions in your code is challenging. It can make deploying production code an unnerving experience. Being able to track, analyze, and manage errors in real-time can help you to proceed with more confidence. Rollbar automates error monitoring and triaging, making fixing Python errors easier than ever. Try it today!
Отображение – это структура данных в 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 – лучший вариант для регулирования потока нашего кода.
Исключения не должны пугать. Мы можем использовать эти методы, чтобы наши программы выполнялись более предсказуемо, если мы понимаем информацию, представленную нам в их обратных трассировках, и первопричину ошибки.
Изучаю Python вместе с вами, читаю, собираю и записываю информацию опытных программистов.