ModuleNotFoundError: No module named ‘pymysql’

In Python, ModuleNotFoundError: No module named ‘pymysql’ error occurs if we try to import the ‘PyMySQL‘ 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 PyMySQL module correctly in different operating systems and solve ModuleNotFoundError: No module named ‘pymysql’ error.  

What is ModuleNotFoundError: No module named ‘pymysql’?

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

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

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

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

PyMySQL 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.  

PyMySQL is an interface for connecting to a MySQL database server from Python. It implements the Python Database API v2. 0 and contains a pure-Python MySQL client library. The goal of PyMySQL is to be a drop-in replacement for MySQLdb.

We can fix the error by installing the ‘PyMySQL‘ module by running the pip install PyMySQL 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: PyMySQL.

pip show PyMySQL

Output

Name: PyMySQL
Version: 1.0.2
Summary: Pure Python MySQL Driver
Home-page: https://github.com/PyMySQL/PyMySQL/
Author: yutaka.matsubara
Author-email: yutaka.matsubara@gmail.com
License: "MIT"
Location: c:\personal\ijs\python_samples\venv\lib\site-packages

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

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

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

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

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

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

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

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

# On Centos
yum install PyMySQL

# On Ubuntu
sudo apt-get install PyMySQL

# If you are installing it in Anaconda 
conda install -c anaconda pymysql

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

import pymysql.cursors

# Connect to the database
connection = pymysql.connect(host='localhost',
                             user='user',
                             password='passwd',
                             database='db',
                             charset='utf8mb4',
                             cursorclass=pymysql.cursors.DictCursor)

with connection:
    with connection.cursor() as cursor:
        # Create a new record
        sql = "INSERT INTO `users` (`email`, `password`) VALUES (%s, %s)"
        cursor.execute(sql, ('webmaster@python.org', 'very-secret'))

    # connection is not autocommit by default. So you must commit to save
    # your changes.
    connection.commit()

    with connection.cursor() as cursor:
        # Read a single record
        sql = "SELECT `id`, `password` FROM `users` WHERE `email`=%s"
        cursor.execute(sql, ('webmaster@python.org',))
        result = cursor.fetchone()
        print(result)

Output

{'id': 1, 'password': 'very-secret'}

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).

Solution 3 – Installing PyMySQL 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 PyMySQL 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 PyMySQL inside the virtual environment
pip install PyMySQL

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 pymysql.py as it may shadow the original PyMySQL 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 ‘pymysql’ error occurs when we try to import the ‘PyMySQL‘ module without installing the package or if you have not installed it in the correct environment.

We can resolve the issue by installing the PyMySQL module by running the pip install PyMySQL 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.