Last updated: Apr 8, 2024
Reading timeยท10 min
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.
# ๐๏ธ 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 a 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.
import yaml print(yaml.load(""" - Hesperiidae - Papilionidae - Apatelodidae - Epiplemidae """, Loader=yaml.Loader) )
The error occurs for multiple reasons:
pyyaml
package installed by running pip install pyyaml
.yaml.py
which would shadow the official module.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.
python --version
For example, my Python version is 3.10.4
, so I would install the pyyaml
package with pip3.10 install pyyaml
.
pip3.10 install pyyaml # ๐๏ธ If you get a 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
:
# ๐๏ธ 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.
You can
check if you have the pyyaml
package installed
by running the pip show pyyaml
command.
# ๐๏ธ 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.
If the package is not installed, make sure your IDE is using the correct version of Python.
pyyaml
package using the incorrect version or your IDE might be set up to use a different version.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.
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.
# ๐๏ธ Use the 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 your 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.
yaml.py
because that would shadow the original pyyaml
module.You also shouldn't be declaring a variable named yaml
as that would also
shadow the original module.
If the error is not resolved, try to uninstall the pyyaml
package and then
reinstall it.
# ๐๏ธ 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.
pip install pyyaml --upgrade # ๐๏ธ If you don't have pip set up in PATH python -m pip install pyyaml --upgrade
PyYAML
.To install the PyYAML
module on Windows:
pip install pyyaml
and press Enter.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 a 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
.
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:
Shift
and right-click in Explorer.# ๐๏ธ 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 your 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.
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
PyYAML
module is installed by using the pip show pyyaml
command.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.
To install PyYAML on macOS or Linux:
pip install pyyaml
and press Enter.pip install pyyaml # ๐๏ธ For Python 3 pip3 install pyyaml # ๐๏ธ If you get a 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 a 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.
python -m pip install pyyaml python3 -m pip install pyyaml
If you get a permissions error, prefix the command with sudo
.
sudo pip install pyyaml sudo pip3 install pyyaml
Alternatively, you can install the pyyaml
package in a virtual environment:
# ๐๏ธ 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 your virtual environment pip install pyyaml
Your virtual environment will use the version of Python that was used to create it.
python3 -m venv venv
command doesn't work, use python -m venv venv
instead.You can use the pip show
command to verify
pyyaml
has been installed
successfully.
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.
To install PyYAML in Visual Studio Code:
pip install pyyaml
command to install the pyyaml
module.pip install pyyaml # ๐๏ธ For Python 3 pip3 install pyyaml # ๐๏ธ If you get a 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 a permissions error pip install pyyaml --user
CTRL+Shift+P
and then type "View: Toggle Terminal".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.
python --version python3 --version
You can also try creating a virtual environment if you don't already have one.
# ๐๏ธ 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 your virtual environment pip install pyyaml
Your virtual environment will use the version of Python that was used to create it.
To install PyYAML in PyCharm:
Alt+F12
on your keyboard to open the terminal.pip install pyyaml
command to install the pyyaml
module.pip install pyyaml # ๐๏ธ For Python 3 pip3 install pyyaml # ๐๏ธ If you get a 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 a permissions error pip install pyyaml --user
Alternatively, you can use the IDE itself to install the module.
+
icon and type PyYAML
.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.
python --version python3 --version
To install PyYAML in Anaconda:
pyyaml
in the search bar to the right.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.
# ๐๏ธ Using conda conda install -c conda-forge pyyaml # ๐๏ธ Alternatively use `pip` pip install pyyaml # ๐๏ธ For Python 3 pip3 install pyyaml # ๐๏ธ If you get a 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 a permissions error pip install pyyaml --user
Click on the following article if you need to install a specific version of the package using Anaconda.
To install PyYAML in Jupyter Notebook:
pip install pyyaml
and press Enter.# ๐๏ธ Using pip pip install pyyaml # ๐๏ธ For Python 3 pip3 install pyyaml # ๐๏ธ If you get a 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 a permissions error pip install pyyaml --user
Alternatively, you can use the Python ipykernel.
Click on "New" and then click on "Python 3 (ipykernel)".
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.
!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.
!pip install pyyaml --user
If the error persists, try to restart the Jupyter Kernel and rerun the command.