ModuleNotFoundError: No module named 'yaml' in Python

# ModuleNotFoundError: No module named 'yaml' in Python

The Python "ModuleNotFoundError: No module named 'yaml'" occurs when we forget to install the pyyaml module before importing it or install it in an incorrect environment.

To solve the error, install the module by running the pip install pyyaml command.

Open your terminal in your project's root directory and install the pyyaml module.

Copied!
# 👇️ in a virtual environment or using Python 2
pip install pyyaml

# 👇️ for python 3 (could also be pip3.10 depending on your version)
pip3 install pyyaml

# 👇️ if you get permissions error
sudo pip3 install pyyaml
pip install pyyaml --user

# 👇️ if you don't have pip in your PATH environment variable
python -m pip install pyyaml

# 👇️ for python 3 (could also be pip3.10 depending on your version)
python3 -m pip install pyyaml

# 👇️ using py alias (Windows)
py -m pip install pyyaml

# 👇️ for Anaconda
conda install -c conda-forge pyyaml

# 👇️ for Jupyter Notebook
!pip install pyyaml

After you install the pyyaml package, try importing it as follows.

Copied!
import yaml

print(yaml.load("""
 - Hesperiidae
 - Papilionidae
 - Apatelodidae
 - Epiplemidae
 """, Loader=yaml.Loader)
      )

# Common causes of the error

The error occurs for multiple reasons:

1. Not having the pyyaml package installed by running pip install pyyaml.
2. Installing the package in a different Python version than the one you're using.
3. Installing the package globally and not in your virtual environment.
4. Your IDE running an incorrect version of Python.
5. Naming your module yaml.py which would shadow the official module.
6. Declaring a variable named yaml which would shadow the imported variable.

If the error persists, get your Python version and make sure you are installing the package using the correct Python version.

Copied!
python --version

For example, my Python version is 3.10.4, so I would install the pyyaml package with pip3.10 install pyyaml.

Copied!
pip3.10 install pyyaml

# 👇️ if you get permissions error use pip3 (NOT pip3.X)
sudo pip3 install pyyaml

Notice that the version number corresponds to the version of pip I'm using.

If the PATH for pip is not set up on your machine, replace pip with python3 -m pip:

Copied!
# 👇️ make sure to use your version of Python, e.g. 3.10
python3 -m pip install pyyaml

If the error persists, try restarting your IDE and development server/script.

# Check if the package is installed

You can check if you have the pyyaml package installed by running the pip show pyyaml command.

Copied!
# 👇️ check if you have pyyaml installed
pip show pyyaml

# 👇️ if you don't have pip set up in PATH
python -m pip show pyyaml

The pip show pyyaml command will either state that the package is not installed or show a bunch of information about the package, including the location where the package is installed.

# Make sure your IDE is using the correct Python version

If the package is not installed, make sure your IDE is using the correct version of Python.

For example, In VSCode, you can press CTRL + Shift + P or (⌘ + Shift + P on Mac) to open the command palette.

Then type "Python select interpreter" in the field.

Then select the correct python version from the dropdown menu.

# Install the package in a Virtual Environment

If you are using a virtual environment, make sure you are installing pyyaml in your virtual environment and not globally.

You can try creating a virtual environment if you don't already have one.

Copied!
# 👇️ use correct version of Python when creating VENV
python3 -m venv venv

# 👇️ activate on Unix or MacOS
source venv/bin/activate

# 👇️ activate on Windows (cmd.exe)
venv\Scripts\activate.bat

# 👇️ activate on Windows (PowerShell)
venv\Scripts\Activate.ps1

# 👇️ install pyyaml in virtual environment
pip install pyyaml

If the python3 -m venv venv command doesn't work, try the following 2 commands:

• python -m venv venv
• py -m venv venv

Your virtual environment will use the version of Python that was used to create it.

You also shouldn't be declaring a variable named yaml as that would also shadow the original module.

# Try reinstalling the package

If the error is not resolved, try to uninstall the pyyaml package and then reinstall it.

Copied!
# 👇️ check if you have pyyaml installed
pip show pyyaml

# 👇️ if you don't have pip set up in PATH
python -m pip show pyyaml

# 👇️ uninstall pyyaml
pip uninstall pyyaml

# 👇️ if you don't have pip set up in PATH
python -m pip uninstall pyyaml

# 👇️ install pyyaml
pip install pyyaml

# 👇️ if you don't have pip set up in PATH
python -m pip install pyyaml

Try restarting your IDE and development server/script.

You can also try to upgrade the version of the pyyaml package.

Copied!
pip install pyyaml --upgrade

# 👇️ if you don't have pip set up in PATH
python -m pip install pyyaml --upgrade

# Table of Contents

1. Install PyYAML on Windows
2. Install PyYAML on macOS or Linux
3. Install PyYAML in Visual Studio Code
4. Install PyYAML in PyCharm
5. Install PyYAML in Anaconda
6. Install PyYAML in Jupyter Notebook

# Install PyYAML on Windows

To install the PyYAML module on Windows:

1. Type CMD in the search bar and open the Command Prompt application.
2. Type pip install pyyaml and press Enter.

Copied!
pip install pyyaml

# 👇️ for Python 3
pip3 install pyyaml

# 👇️ if you don't have pip in your PATH environment variable
python -m pip install pyyaml

# 👇️ for Python 3
python3 -m pip install pyyaml

# 👇️ using py alias
py -m pip install pyyaml

# 👇️ if you get permissions error
pip install pyyaml --user

# 👇️ for Anaconda
conda install -c conda-forge pyyaml

If the command doesn't succeed, try running CMD as an administrator.

If you get the error 'pip' is not recognized as an internal or external command, use the python -m command when installing PyYAML.

Copied!
python -m pip install pyyaml

python3 -m pip install pyyaml

py -m pip install pyyaml

Alternatively, you can install the PyYAML module in a virtual environment:

1. Open the root directory of your project.
2. Press Shift and right-click in Explorer.

3. Click on "Open PowerShell window here".
4. Run the following commands.

Copied!
# 👇️ might also be: "python3 -m venv venv"
python -m venv venv

# 👇️ activate on Windows (PowerShell)
venv\Scripts\Activate.ps1

# 👇️ activate on Windows (cmd.exe)
venv\Scripts\activate.bat

# 👇️ install pyyaml in virtual environment
pip install pyyaml

If the python -m venv venv command doesn't work, try the following 2 commands:

• python3 -m venv venv
• py -m venv venv.

If you see an error message that ps1 cannot be loaded because running scripts is disabled on this system, run the following command, type "yes" when prompted and rerun the activation command.

Copied!
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

Copied!
pip show pyyaml
pip3 show pyyaml

python -m pip show pyyaml
python3 -m pip show pyyaml

The pip show pyyaml command will either state that the package is not installed or show a bunch of information about the package, including the location where the package is installed.

# Install PyYAML on macOS or Linux

To install PyYAML on macOS or Linux:

1. Search for "terminal" and start the application.
2. Type pip install pyyaml and press Enter.

Copied!
pip install pyyaml

# 👇️ for Python 3
pip3 install pyyaml

# 👇️ if you get permissions error
sudo pip3 install pyyaml

# 👇️ if you don't have pip in your PATH environment variable
python -m pip install pyyaml

# 👇️ for python 3
python3 -m pip install pyyaml

# 👇️ alternative if you get permissions error
pip install pyyaml --user

# 👇️ for Anaconda
conda install -c conda-forge pyyaml

If you get an error that pip isn't found, use the python -m command.

Copied!
python -m pip install pyyaml

python3 -m pip install pyyaml

If you get a permissions error, prefix the command with sudo.

Copied!
sudo pip install pyyaml

sudo pip3 install pyyaml

Alternatively, you can install the pyyaml package in a virtual environment:

1. Open your terminal in the root directory of your project.
2. Run the following commands.

Copied!
# 👇️ could also be "python -m venv venv"
python3 -m venv venv

# 👇️ activate virtual env on macOS or Linux
source venv/bin/activate

# 👇️ install pyyaml in virtual environment
pip install pyyaml

Your virtual environment will use the version of Python that was used to create it.

You can use the pip show command to verify pyyaml has been installed successfully.

Copied!
pip show pyyaml
pip3 show pyyaml

python -m pip show pyyaml
python3 -m pip show pyyaml

The pip show pyyaml command will either state that the package is not installed or show a bunch of information about the package.

# Install PyYAML in Visual Studio Code

To install PyYAML in Visual Studio Code:

1. Press CTRL + ` (Backtick) on your keyboard to open the terminal.
2. Run the pip install pyyaml command to install the pyyaml module.

Copied!
pip install pyyaml

# 👇️ for Python 3
pip3 install pyyaml

# 👇️ if you get permissions error
sudo pip3 install pyyaml

# 👇️ if you don't have pip in your PATH environment variable
python -m pip install pyyaml

# 👇️ for python 3
python3 -m pip install pyyaml

# 👇️ using py alias
py -m pip install pyyaml

# 👇️ alternative if you get permissions error
pip install pyyaml --user

When installing Python modules in Visual Studio code, make sure that your IDE is configured to use the correct Python version.

Press CTRL+Shift+P or (⌘ + Shift + P on Mac) to open the command palette.

Then type "Python select interpreter" in the field.

Then select the correct Python version from the dropdown menu.

You can use the python --version command if you need to get your version of Python.

Copied!
python --version
python3 --version

You can also try creating a virtual environment if you don't already have one.

Copied!
# 👇️ could also be "python -m venv venv" or "py -m venv venv"
python3 -m venv venv

# 👇️ activate on Unix or MacOS
source venv/bin/activate

# 👇️ activate on Windows (cmd.exe)
venv\Scripts\activate.bat

# 👇️ activate on Windows (PowerShell)
venv\Scripts\Activate.ps1

# 👇️ install pyyaml in virtual environment
pip install pyyaml

Your virtual environment will use the version of Python that was used to create it.

# Install PyYAML in PyCharm

To install PyYAML in PyCharm:

1. Press Alt+F12 on your keyboard to open the terminal.
2. Run the pip install pyyaml command to install the pyyaml module.

Copied!
pip install pyyaml

# 👇️ for Python 3
pip3 install pyyaml

# 👇️ if you get permissions error
sudo pip3 install pyyaml

# 👇️ if you don't have pip in your PATH environment variable
python -m pip install pyyaml

# 👇️ for python 3
python3 -m pip install pyyaml

# 👇️ using py alias
py -m pip install pyyaml

# 👇️ alternative if you get permissions error
pip install pyyaml --user

Alternatively, you can use the IDE itself to install the module.

1. Click on "File" > "Settings" > "Project" > "Python Interpreter".
2. Click on the + icon and type PyYAML.
3. Click on "Install Package".

Click on "File" > "Settings" > "Project" > "Python Interpreter".

Then select the correct Python version from the dropdown menu.

You can use the python --version command if you need to get your version of Python.

Copied!
python --version
python3 --version

# Install PyYAML in Anaconda

To install PyYAML in Anaconda:

1. Open your Anaconda Navigator.
2. Click on "Environments" and select your project.
3. Type pyyaml in the search bar to the right.
4. Tick the pyyaml package and click on "Apply".

Alternatively, you can install the PyYAML package with a command.

If you are on Windows, search for "Anaconda Prompt" and open the application.

If you are on macOS or Linux, open your terminal.

Run the following command to install the PyYAML package.

Copied!
# 👇️ using conda
conda install -c conda-forge pyyaml

# 👇️ Alternatively use `pip`
pip install pyyaml

# 👇️ for Python 3
pip3 install pyyaml

# 👇️ if you get permissions error
sudo pip3 install pyyaml

# 👇️ if you don't have pip in your PATH environment variable
python -m pip install pyyaml

# 👇️ for python 3
python3 -m pip install pyyaml

# 👇️ using py alias
py -m pip install pyyaml

# 👇️ alternative if you get permissions error
pip install pyyaml --user

Click on the following article if you need to install a specific version of the package using Anaconda.

# Install PyYAML in Jupyter Notebook

To install PyYAML in Jupyter Notebook:

1. Open your terminal and type "jupyter notebook".

2. Click on "New" and then "Terminal" in the browser tab.

3. Type pip install pyyaml and press Enter.

Copied!
# 👇️ using pip
pip install pyyaml

# 👇️ for Python 3
pip3 install pyyaml

# 👇️ if you get permissions error
sudo pip3 install pyyaml

# 👇️ if you don't have pip in your PATH environment variable
python -m pip install pyyaml

# 👇️ for python 3
python3 -m pip install pyyaml

# 👇️ using py alias
py -m pip install pyyaml

# 👇️ using conda
conda install -c conda-forge pyyaml

# 👇️ alternative if you get permissions error
pip install pyyaml --user

Alternatively, you can use the Python ipykernel.

1. Open your terminal and type "jupyter notebook".

2. Click on "New" and then click on "Python 3 (ipykernel)".

3. Type !pip install pyyaml and click on "Run".

Note that the pip install command must be prefixed with an exclamation mark if you use this approach.

Copied!
!pip install pyyaml

Once you type the command, click "Run" to install the pyyaml module.

If you get a permissions error, e.g. "[WinError: 5] Access is denied", add the --user option to the installation command.

Copied!
!pip install pyyaml --user

If the error persists, try to restart the Jupyter Kernel and rerun the command.