ModuleNotFoundError: No module named ‘cx_Oracle’

In Python, ModuleNotFoundError: No module named ‘cx_Oracle’ error occurs if we try to import the ‘cx_Oracle‘ module without installing the package or if you have not installed it in the correct environment.

In this tutorial, let’s look at installing the cx_Oracle module correctly in different operating systems and solve ModuleNotFoundError: No module named ‘cx_Oracle’ error.  

What is ModuleNotFoundError: No module named ‘cx_Oracle’?

There are various reasons why we get the ModuleNotFoundError: No module named ‘cx_Oracle’ error

  • Trying to use the module- without installing the cx_Oracle package.
  • If the IDE is set to the incorrect version of the Python/Python interpreter.
  • You are using the virtual environment and the cx_Oracle module is not installed inside a virtual environment
  • Installing the cx_Oracle package in a different version of Python than the one which is used currently.
  • Declaring a variable name as the module name(cx_Oracle)

If you are getting an error installing pip, checkout pip: command not found to resolve the issue.

How to fix ModuleNotFoundError: No module named ‘cx_Oracle’?

cx_Oracle is not a built-in module (it doesn’t come with the default python installation) in Python; you need to install it explicitly using the pip installer and then use it.  

cx_Oracle is a Python extension module that enables access to Oracle Database. It conforms to the Python database API 2.0 specification with a considerable number of additions and a couple of exclusions. See the homepage for a feature list.

We can fix the error by installing the ‘cx_Oracle‘ module by running the pip install cx_Oracle command in your terminal/shell.

We can verify if the package is installed correctly by running the following command in the terminal/shell.

This will provide the details of the package installed, including the version number, license, and the path it is installed. If the module is not installed, you will get a warning message in the terminal stating WARNING: Package(s) not found: cx_Oracle.

pip show cx_Oracle

Output

Name: cx-Oracle
Version: 8.3.0
Summary: Python interface to Oracle
Home-page: https://oracle.github.io/python-cx_Oracle
Author: "Anthony Tuininga",
Author-email: "anthony.tuininga@gmail.com",
License: BSD License
Location: c:\personal\ijs\python_samples\venv\lib\site-packages
Requires:

Solution 1 – Installing and using the cx_Oracle module in a proper way

Based on the Python version and the operating system you are running, run the relevant command to install the cx_Oracle module.

# If you are using Python 2 (Windows)
pip install cx_Oracle

# if you are using Python 3 (Windows)
pip3 install cx_Oracle

# If the pip is not set as environment varibale PATH
python -m pip install cx_Oracle

# If you are using Python 2 (Linux)
sudo pip install cx_Oracle

# if you are using Python 3 (Linux)
sudo pip3 install cx_Oracle

# In case if you have to easy_install
sudo easy_install -U cx_Oracle

# On Centos
yum install cx_Oracle

# On Ubuntu
sudo apt-get install cx_Oracle

# If you are installing it in Anaconda 
conda install -c conda-forge cx_Oracle

Once you have installed the cx_Oracle module, we can now import it inside our code and use it as shown below.

# query.py

import cx_Oracle

# Establish the database connection
connection = cx_Oracle.connect(user="admin", password=Python12356,
                               dsn="dbhost.itsmycode.com/orclpdb1")

# Obtain a cursor
cursor = connection.cursor()

# Data for binding
manager_id = 145
first_name = "Peter"

# Execute the query
sql = """SELECT first_name, last_name
         FROM employees
         WHERE manager_id = :mid AND first_name = :fn"""
cursor.execute(sql, mid=manager_id, fn=first_name)

# Loop over the result set
for row in cursor:
    print(row)

Output

Peter James
Peter Cullen

Solution 2 – Verify if the IDE is set to use the correct Python version

If you are still getting the same error even after installing the package, you can verify if the IDE you are using is configured with the correct version of the Python interpreter.

For Eg:- In the case of Visual Studio Code, we can set the Python version by pressing CTRL + Shift + Por ( + Shift + P on Mac) to open the command palette.

Once the command palette opens, select the Python interpreter and select the correct version of Python and also the virtual environment(if configured) as shown below.

Image 1

Python Interpreter

Solution 3 – Installing cx_Oracle inside the virtual environment

Many different IDEs like Jupyter Notebook, Spyder, Anaconda, or PyCharm often install their own virtual environment of Python to keep things clean and separated from your global Python.

If you are using VS Code, then you can also create a virtual environment, as shown below.

In the case of virtual environments, you need to ensure that the cx_Oracle module needs to be installed inside the virtual environment and not globally.

Step 1: Create a Virtual Environment. If you have already created a virtual environment, then proceed to step 2.

Step 2: Activate the Virtual Environment

Step 3: Install the required module using the pip install command

# Create a virtual Environment
py -3 -m venv venv

# Activate the virtual environment (windows command)
venv\Scripts\activate.bat

# Activate the virtual environment (windows powershell)
venv\Scripts\Activate.ps1

# Activate the virtual environment (Linux)
source venv/bin/activate

# Install cx_Oracle inside the virtual environment
pip install cx_Oracle

Solution 4 – Ensure that a module name is not declared name a variable name.

Last but not least, you may need to cross-check and ensure that you haven’t declared a variable with the same name as the module name.

You should check if you haven’t named any files as cx_Oracle.py as it may shadow the original cx_Oracle module.

If the issue is still not solved, you can try removing the package and installing it once again, restart the IDE, and check the paths to ensure that packages are installed in the correct environment path and Python version.

Conclusion

The ModuleNotFoundError: No module named ‘cx_Oracle’ error occurs when we try to import the ‘cx_Oracle‘ module without installing the package or if you have not installed it in the correct environment.

We can resolve the issue by installing the cx_Oracle module by running the pip install cx_Oracle command. Also, ensure that the module is installed in the proper environment in case you use any virtual environments, and the Python version is appropriately set in the IDE that you are running the code.

Leave a Reply

Your email address will not be published.

Sign Up for Our Newsletters

Subscribe to get notified of the latest articles. We will never spam you. Be a part of our ever-growing community.

You May Also Like
Python String Rfind()

Python String rfind()

Table of Contents Hide rfind() Syntaxrfind() Parametersrfind() Return ValueDifference between rfind() method and rindex() methodExample 1: rfind() without any argumentsExample 2: rfind() with start and end Arguments The Python String…
View Post
Python Enumerate()

Python enumerate()

Table of Contents Hide enumerate() Syntax enumerate() Parametersenumerate() Return ValueExample 1: How enumerate() method works in Python?Example 2: Using Enumerate object in loops The enumerate() in Python is a built-in function that adds…
View Post