Python is a versatile and powerful programming language known for its simplicity and readability. However, like any other language, it comes with its own set of errors and exceptions. One common error that Python developers often encounter is the “KeyError” . In this article, we will explore what a KeyError is, why it occurs, and various methods to fix it.

Understanding KeyError in Python

A ‘KeyError’ occurs when you try to access a key in a dictionary that doesn’t exist. In Python, dictionaries are composed of key-value pairs, and keys are used to access the corresponding values. If you attempt to access a key that is not present in the dictionary, Python raises a ‘KeyError’ to inform you that the key is missing. Let’s look at some examples where a ‘KeyError’ can be generated and how to fix them.

Accessing Dictionary Element that is not present

Here in this code, we are trying to access the element in the dictionary which is not present.

Example: In this scenario, we have created a dictionary called ‘my_dict’ with the keys “name”, “age”, and “city”. However, we are attempting to access a key called “gender”, which does not exist in the dictionary.

Python3

Output

Error Explanation: When Python encounters the line print(my_dict[‘gender’]), it tries to find the key “gender” in my_dict. Since “gender” is not one of the keys in the dictionary, Python raises a ‘KeyError’ with the message “gender”.

---------------------------------------------------------------------------
KeyError                                  Traceback (most recent call last)
<ipython-input-8-e82a6939bd7b> in <module> Cell 1 line 5
      2 my_dict = {'name': 'Selena', 'age': 30, 'city': 'New York'}
      4 # Accessing a non-existent key
----> 5 print(my_dict['gender'])  # KeyError: 'gender'
KeyError: 'gender'

Solution

To avoid the ‘ KeyError’ , it’s essential to check if a key exists in the dictionary before attempting to access it. We can use the ‘in’ keyword or the ‘ get()’ method to handle this situation gracefully.

Python

KeyError in JSON Data

One common real-world scenario where people often encounter a ‘KeyError’ with nested dictionaries involves working with JSON data. JSON (JavaScript Object Notation) is a widely used data format for storing and exchanging structured data. When you load JSON data into Python , it is typically represented as a nested dictionary.

Example : Considering a situation where we have a JSON object representing information about products, and we want to access a specific property of a product.

In this example, we are trying to access the “description” key of the first product, which appears to be nested within the “products” list. However, the “description” key does not exist in the JSON data, which results in a ‘KeyError’.

Python

Output:

---------------------------------------------------------------------------
KeyError                                  Traceback (most recent call last)
<ipython-input-8-e82a6939bd7b> in <module> Cell 1 line 1
      2 product_data = {
      3     "products": [
      4         {
   (...)
     14     ]
     17 # Attempting to access the description of the first product
---> 18 description = product_data["products"][0]["description"]
KeyError: 'description'
Error Explanation: This type of ‘KeyError’ can be challenging to troubleshoot in real-world applications, especially when dealing with large and complex JSON structures, as it may not always be immediately obvious which key is missing.
Solution
To avoid this ‘KeyError’, you should check the existence of keys at each level of nesting before attempting to access them. Here’s how you can modify the code to handle this situation:
Python
if "products" in product_data and len(product_data["products"]) > 0:
    first_product = product_data["products"][0]
    if "description" in first_product:
        description = first_product["description"]
    else:
        description = "Description not available"
else:
    description = "No products found"
print(description)
Description not available
The solution systematically checks for the existence of keys within nested dictionaries. It verifies the presence of the “products” key in product_data and ensures a non-empty list. If found, it accesses the first product’s dictionary and checks for the “description” key, preventing ‘KeyError’ with a default value if absent. It also handles missing or empty “products” keys by providing an alternative message, ensuring robust handling of nested dictionaries in real-world data scenarios like JSON.
Alternative Method
We can also handle ‘KeyError’ situation by using an approach that uses “try”, “except” block. Let’s take the above example and here is the alternative code for the same:-
We attempt to access the “description” key within the first product, just like in the previous solution. We use a try…except block to catch any ‘KeyError’ that may occur when accessing the key. If a ‘KeyError’ occurs, we set description to “Description not available” . Additionally, we include an except block to catch other potential errors, such as IndexError (in case the “products” list is empty) and TypeError (if product_data is not a properly formatted dictionary). In either of these cases, we set description to “No products found”.
Python3
try:
    first_product = product_data["products"][0]
    description = first_product["description"]
except KeyError:
    print("Description not available")
except (IndexError, TypeError):
    print("No products found")
                
How to Fix: KeyError in Pandas
                
In this article, we will discuss how to fix the KeyError in pandas. Pandas KeyError occurs when we try to access some column/row label in our DataFrame that doesn't exist. Usually, this error occurs when you misspell a column/row name or include an unwanted space before or after the column/row name. The link to dataset used is here Example C/C++ Co
                
How to handle KeyError Exception in Python
                
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 sy
                
How to solve pywhatkit KeyError in python?
                
If you come across a KeyError when working with pywhatkit - a popular Python library for automating tasks like sending Whatsapp messages, playing Youtube videos, or searching Google - it means that you are trying to look up a key that does not exist in a particular dictionary. The article contains a lot of information about KeyError. We will try to
                
Python Value Error :Math Domain Error in Python
                
Errors are the problems in a program due to which the program will stop the execution. One of the errors is 'ValueError: math domain error' in Python. In this article, you will learn why this error occurs and how to fix it with examples. What is 'ValueError: math domain error' in Python?In mathematics, we have certain operations that we consider un
                
How to Navigating the "Error: subprocess-exited-with-error" in Python
                
In Python, running subprocesses is a common task especially when interfacing with the system or executing external commands and scripts. However, one might encounter the dreaded subprocess-exited-with-error error. This article will help we understand what this error means why it occurs and how to resolve it with different approaches. We will also p




    

                
How to fix: "fatal error: Python.h: No such file or directory"
                
The "fatal error: Python.h: No such file or directory" error is a common issue encountered when compiling C/C++ code that interacts with Python. This error occurs when the C/C++ compiler is unable to locate the Python.h header file, which is part of the Python development package required for compiling code that interacts with Python.In this articl
                
How to Fix Python Pandas Error Tokenizing Data
                
The Python library used to analyze data is known as Pandas. The most common way of reading data in Pandas is through the CSV file, but the limitation with the CSV file is it should be in a specific format, or else it will throw an error in tokenizing data. In this article, we will discuss the various ways to fix Python Pandas Error Tokenizing data.
                
How to Fix "Error: Metadata Generation Failed" in Python
                
The "Error: Metadata Generation Failed" in Python usually occurs when there's an issue with generating or reading metadata related to the Python package. This error can happen for various reasons such as: Missing or corrupted metadata files: If the metadata files associated with the Python package are missing or corrupted it can lead to the metadat
                
How to Fix 'Waiting in Queue' Error in Python
                
In Python, handling and managing queues efficiently is crucial especially when dealing with concurrent or parallel tasks. Sometimes, developers encounter a 'Waiting in Queue' error indicating that a process or thread is stuck waiting for the resource or a task to complete. This error can stem from several issues including deadlocks, insufficient re
                
How to Fix MXNet Error “Module 'numpy' Has No Attribute 'bool' in Python
                
In Python, while working with NumPy, you may encounter the error “Module 'numpy' has no attribute 'bool'” when importing MXNet. This issue arises due to the deprecation of the numpy.bool alias in newer versions of NumPy. In this article, we will explore various solutions to fix this error and ensure compatibility between NumPy and MXNet. What is Im
                
How to Fix the "No module named 'mpl_toolkits.basemap'" Error in Python
                
When working with the geographic data and plotting the maps in Python we might encounter the error: ModuleNotFoundError: No module named 'mpl_toolkits.basemap' This error occurs because of the mpl_toolkits.basemap module which is part of the base map toolkit is not installed in the Python environment. In this article, we will go through the steps t
                
How to fix "error: Unable to find vcvarsall.bat" in Python
                
If you're encountering the error "error: Unable to find vcvarsall.bat" while trying to install Python packages that require compilation, such as those involving C extensions, you're not alone. This error typically occurs on Windows systems when the necessary Visual Studio Build Tools are not installed or not properly configured. Here’s a comprehens
                
How to Fix 'No Module Named yfinance' Error in Python
                
If you encounter the 'No Module Named yfinance' error, it typically means that the library is not installed or not accessible in your current Python environment. This issue can be resolved by ensuring that yfinance is properly installed and that your Python environment is configured correctly. What is Python Code Error: No Module Named ‘yfinance’?T
                
How to Fix 'psycopg2 OperationalError: SSL SYSCALL Error: EOF Detected' in Python
                
Developers occasionally encounter the error psycopg2 OperationalError: SSL SYSCALL Error: EOF Detected. This error can be frustrating, as it often indicates an issue with the SSL connection between your application and the PostgreSQL server. In this article, we will explore what this error means, common causes, and how to fix it with practical code
                
How to fix "error 403 while installing package with Python PIP"?
                
When working with Python, pip is the go-to tool for managing packages. However, encountering a "403 Forbidden" error can be frustrating. This error typically indicates that the server refuses to fulfill the request, often due to permissions or access restrictions. In this article, we'll delve into the causes of this error and explore various soluti
                
Python | Pretty Print a dictionary with dictionary value
                
This article provides a quick way to pretty How to Print Dictionary in Python that has a dictionary as values. This is required many times nowadays with the advent of NoSQL databases. Let's code a way to perform this particular task in Python. Example Input:{'gfg': {'remark': 'good', 'rate': 5}, 'cs': {'rate': 3}} Output: gfg: remark: good rate: 5
                
How to Fix "ValueError: dictionary update sequence element #0 has length X; 2 is required" in Python
                
The "ValueError: dictionary update sequence element #0 has length X; 2 is required" error typically occurs when trying to update a dictionary with a sequence that does not contain exactly two elements for each key-value pair. This article explains the causes of this error and provides the solutions to fix it. Understanding the ErrorThe "ValueError:
                
Fix Type Error : NumPy array is not JSON serializable
                
In this article, we will see how to fix TypeError: Object of type ndarray is not JSON serializable when we are converting a NumPy ndarray object to a JSON string. What is "TypeError: Object of type ndarray is not JSON serializable"?The error "TypeError: Object of type ndarray is not JSON serializable" generally occurs in Python when we are converti
                
How to Fix Kernel Error in Jupyter Notebook
                
Jupyter Notebook is an open-source framework that comes under Anaconda software. It is a free cloud-based interactive platform used for computing in different types of languages. It is used for data analysis, visualizations, numerical calculations and simulations, equations, executing codes, machine learning, and sharing data easily. So, while perf
                
How to Fix The Module Not Found Error?
                
In this article, we are going to cover topics related to ' Module Not Found Error' and what the error means. the reason for the occurrence of this error and how can we handle this error. What is "ModuleNotFoundError"? A "ModuleNotFoundError" is a common error message in programming, particularly in languages like Python that depends upon modules an
                
How to fix - CSRF token mismatch error
                
In this article, we are looking for a possible solution to fix the "CSRF token mismatch error". we will start by understanding what is csrf ? and why we require it. how did this error occur? What is CSRF?CSRF stands for Cross Site Request Forgery is a type of malicious attack on a website. In this attack, a hacker sends you a link that actually loo
                
"How to Fix 'jupyter: command not found' Error After Installing with pip "
                
Encountering the "Jupyter command not found" error after installing Jupyter with pip can be frustrating. This common issue typically arises due to problems with the installation path or virtual environments. In this guide, we'll explore the root causes and provide step-by-step solutions to fix this error. Ensuring Jupyter Notebook is correctly inst
                
How to Fix "Import Error from PyCaret"?
                
"Import Error from PyCaret" is a common issue data scientists and machine learning enthusiasts encounter when working with the PyCaret library. This article will guide you through understanding the causes of this error and provide step-by-step solutions to fix it. What is PyCaret?PyCaret is an open-source, low-code machine learning library in Pytho
                
How to fix "Error:  'dict' object has no attribute 'iteritems'
                
The Error: " 'dict' object has no attribute 'iteritems'” occurs in Python 3.x because the iteritems() method, which was used in Python 2.x to iterate over dictionary items, was removed in Python 3.x. In Python 3.x, we use the items() method instead. This article will explain the causes of this error and provide methods to fix it. What is “Error: di
                
How to fix the Expected ":" Pylance error?
                
When working with Python, The errors and fixing them are a routine part of the development process. A common error developers might encounter when using the Pylance in Visual Studio Code is the "Expected ':'" error. This error typically arises due to the syntax issues in the code often related to missing colons after certain statements. In this art
                
How to Fix Django Error: DisallowedHost at / Invalid HTTP_HOST Header
                
Django is a full-stack Python framework for building websites. Sometimes, We might see a "DisallowedHost" error. This happens when the website’s address isn’t on a list of allowed addresses in your Django settings. Sometimes this error occurs when a proxy server tries to interact with our Django server for example gunicorn. In this article, we’ll g
                
Python | Set 4 (Dictionary, Keywords in Python)
                
In the previous two articles (Set 2 and Set 3), we discussed the basics of python. In this article, we will learn more about python and feel the power of python. Dictionary in Python In python, the dictionary is similar to hash or maps in other languages. It consists of key-value pairs. The value can be accessed by a unique key in the dictionary. (
                
Python | Prompt for Password at Runtime and Termination with Error Message
                
Say our Script requires a password, but since the script is meant for interactive use, it is likely to prompt the user for a password rather than hardcode it into the script. Python’s getpass module precisely does what it is needed. It will allow the user to very easily prompt for a password without having the keyed-in password displayed on the use
                
Python | Assertion Error
                
Assertion Error Assertion is a programming concept used while writing a code where the user declares a condition to be true using assert statement prior to running the module. If the condition is True, the control simply moves to the next line of code. In case if it is False the program stops running and returns AssertionError Exception. The functi
                
Python IMDbPY  - Error Handling
                
In this article we will see how we can handle errors related to IMDb module of Python, error like invalid search or data base error network issues that are related to IMDbPY can be caught by checking for the imdb.IMDbErrorexceptionIn order to handle error we have to import the following from imdb import IMDbError Syntax : try : # code except IMDbEr
          
Company
About Us
Legal
In Media
Contact Us
Advertise with us
GFG Corporate Solution
Placement Training Program
GeeksforGeeks Community
Languages
Python
Java
C++
PHP
GoLang
SQL
R Language
Android Tutorial
Tutorials Archive
DSA
Data Structures
Algorithms
DSA for Beginners
Basic DSA Problems
DSA Roadmap
Top 100 DSA Interview Problems
DSA Roadmap by Sandeep Jain
All Cheat Sheets
Data Science & ML
Data Science With Python
Data Science For Beginner
Machine Learning
ML Maths
Data Visualisation
Pandas
NumPy
NLP
Deep Learning
Web Technologies
HTML
CSS
JavaScript
TypeScript
ReactJS
NextJS
Bootstrap
Web Design
Python Tutorial
Python Programming Examples
Python Projects
Python Tkinter
Web Scraping
OpenCV Tutorial
Python Interview Question
Django
Computer Science
Operating Systems
Computer Network
Database Management System
Software Engineering
Digital Logic Design
Engineering Maths
Software Development
Software Testing
DevOps
Git
Linux
AWS
Docker
Kubernetes
Azure
GCP
DevOps Roadmap
System Design
High Level Design
Low Level Design
UML Diagrams
Interview Guide
Design Patterns
OOAD
System Design Bootcamp
Interview Questions
Inteview Preparation
Competitive Programming
Top DS or Algo for CP
Company-Wise Recruitment Process
Company-Wise Preparation
Aptitude Preparation
Puzzles
School Subjects
Mathematics
Physics
Chemistry
Biology
Social Science
English Grammar
Commerce
World GK
GeeksforGeeks Videos
DSA
Python
Java
C++
Web Development
Data Science
CS Subjects
         
        We use cookies to ensure you have the best browsing experience on our website. By using our site, you
        acknowledge that you have read and understood our
        Cookie Policy &
        Privacy Policy
        Got It !
                    
Please go through our recently updated Improvement Guidelines before submitting any improvements.
                    
This improvement is locked by another user right now. You can suggest the changes for now and it will be under 'My Suggestions' Tab on Write.
                    
You will be notified via email once the article is available for improvement.
                        Thank you for your valuable feedback!
                        Suggest changes
                  
Please go through our recently updated Improvement Guidelines before submitting any improvements.
                      
Suggest Changes
                      
Help us improve. Share your suggestions to enhance the article. Contribute your expertise and make a difference in the GeeksforGeeks portal.