Last updated: Apr 10, 2024
Reading timeยท12 min
The Python "ModuleNotFoundError: No module named 'corsheaders'" occurs when we
forget to install the corsheaders
module before importing it or install it in
an incorrect environment.
To solve the error, install the module by running the
pip install django-cors-headers
command.
Open your terminal in your project's root directory and install the
django-cors-headers
module.
# ๐๏ธ In a virtual environment or using Python 2 pip install django-cors-headers # ๐๏ธ For Python 3 (could also be pip3.10 depending on your version) pip3 install django-cors-headers # ๐๏ธ If you get a permissions error sudo pip3 install django-cors-headers pip install django-cors-headers --user # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install django-cors-headers # ๐๏ธ For Python 3 (could also be pip3.10 depending on your version) python3 -m pip install django-cors-headers # ๐๏ธ Using py alias (Windows) py -m pip install django-cors-headers # ๐๏ธ For Anaconda conda install -c conda-forge django-cors-headers # ๐๏ธ For Jupyter Notebook !pip install django-cors-headers
Once you have the django-cors-headers module installed, add it to your installed apps:
INSTALLED_APPS = [ # ..., "corsheaders", # ..., ]
Make sure to add a trailing comma as omitting it causes a ModuleNotFoundError
.
You also have to add a middleware class to listen in on responses.
MIDDLEWARE = [ # ..., "corsheaders.middleware.CorsMiddleware", "django.middleware.common.CommonMiddleware", # ..., ]
CorsMiddleware
should be placed as high as possible, before any middleware that can generate responses, such as CommonMiddleware
and WhiteNoiseMiddleware
.If you use CORS_REPLACE_HTTPS_REFERER
, place CorsMiddleware
before Django's
CsrfViewMiddleware
.
If you get the error ModuleNotFoundError: No module named 'django', click on the link and follow the instructions.
The error occurs for multiple reasons:
django-cors-headers
package installed by running
pip install django-cors-headers
.corsheaders.py
which would shadow the official module.corsheaders
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
django-cors-headers
package with pip3.10 install django-cors-headers
.
pip3.10 install django-cors-headers # ๐๏ธ If you get a permissions error use pip3 (NOT pip3.X) sudo pip3 install django-cors-headers
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 django-cors-headers
If the "No module named 'corsheaders'" error persists, try restarting your IDE and development server/script.
You can
check if you have the django-cors-headers
package installed
by running the pip show django-cors-headers
command.
# ๐๏ธ Check if you have django-cors-headers installed pip show django-cors-headers # ๐๏ธ If you don't have pip set up in PATH python -m pip show django-cors-headers
The pip show django-cors-headers
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.
django-cors-headers
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 get the error ModuleNotFoundError: No module named 'django', click on the link and follow the instructions.
If you are using a virtual environment, make sure you are installing
django-cors-headers
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 django-cors-headers in your virtual environment pip install django-cors-headers
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.
corsheaders.py
because that would shadow the original django-cors-headers
module.You also shouldn't be declaring a variable named corsheaders
as that would
also shadow the original module.
If the error is not resolved, try to uninstall the django-cors-headers
package
and then install it.
# ๐๏ธ Check if you have django-cors-headers installed pip show django-cors-headers # ๐๏ธ If you don't have pip set up in PATH python -m pip show django-cors-headers # ๐๏ธ Uninstall django-cors-headers pip uninstall django-cors-headers # ๐๏ธ If you don't have pip set up in PATH python -m pip uninstall django-cors-headers # ๐๏ธ Install django-cors-headers pip install django-cors-headers # ๐๏ธ If you don't have pip set up in PATH python -m pip install django-cors-headers
Try restarting your IDE and development server/script.
You can also try to upgrade the version of the django-cors-headers
package.
pip install django-cors-headers --upgrade # ๐๏ธ If you don't have pip set up in PATH python -m pip install django-cors-headers --upgrade
django-cors-headers
.To install the django-cors-headers
module on Windows:
pip install django-cors-headers
and press Enter.pip install django-cors-headers # ๐๏ธ For Python 3 pip3 install django-cors-headers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install django-cors-headers # ๐๏ธ For Python 3 python3 -m pip install django-cors-headers # ๐๏ธ Using py alias py -m pip install django-cors-headers # ๐๏ธ If you get a permissions error pip install django-cors-headers --user # ๐๏ธ For Anaconda conda install -c conda-forge django-cors-headers
Once you have the django-cors-headers module installed, add it to your installed apps:
INSTALLED_APPS = [ # ..., "corsheaders", # ..., ]
Make sure to add a trailing comma as omitting it causes a ModuleNotFoundError
.
You also have to add a middleware class to listen in on responses.
MIDDLEWARE = [ # ..., "corsheaders.middleware.CorsMiddleware", "django.middleware.common.CommonMiddleware", # ..., ]
CorsMiddleware
should be placed as high as possible, before any middleware that can generate responses, such as CommonMiddleware
and WhiteNoiseMiddleware
.If you use CORS_REPLACE_HTTPS_REFERER
, place CorsMiddleware
before Django's
CsrfViewMiddleware
.
If the installation 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 django-cors-headers
.
python -m pip install django-cors-headers python3 -m pip install django-cors-headers py -m pip install django-cors-headers
Alternatively, you can install the django-cors-headers
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 `django-cors-headers` in your virtual environment pip install django-cors-headers
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
django-cors-headers
module is installed by using the pip show django-cors-headers
command.pip show django-cors-headers pip3 show django-cors-headers python -m pip show django-cors-headers python3 -m pip show django-cors-headers
The pip show django-cors-headers
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 django-cors-headers on macOS or Linux:
pip install django-cors-headers
and press Enter.pip install django-cors-headers # ๐๏ธ For Python 3 pip3 install django-cors-headers # ๐๏ธ If you get a permissions error sudo pip3 install django-cors-headers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install django-cors-headers # ๐๏ธ For Python 3 python3 -m pip install django-cors-headers # ๐๏ธ Alternative if you get a permissions error pip install django-cors-headers --user # ๐๏ธ For Anaconda conda install -c conda-forge django-cors-headers
Once you have the django-cors-headers module installed, add it to your installed apps:
INSTALLED_APPS = [ # ..., "corsheaders", # ..., ]
Make sure to add a trailing comma as omitting it causes a ModuleNotFoundError
.
You also have to add a middleware class to listen in on responses.
MIDDLEWARE = [ # ..., "corsheaders.middleware.CorsMiddleware", "django.middleware.common.CommonMiddleware", # ..., ]
CorsMiddleware
should be placed as high as possible, before any middleware that can generate responses, such as CommonMiddleware
and WhiteNoiseMiddleware
.If you use CORS_REPLACE_HTTPS_REFERER
, place CorsMiddleware
before Django's
CsrfViewMiddleware
.
If you get an error that pip
isn't found, use the python -m
command.
python -m pip install django-cors-headers python3 -m pip install django-cors-headers
If you get a permissions error, prefix the command with sudo
.
sudo pip install django-cors-headers sudo pip3 install django-cors-headers
Alternatively, you can install the django-cors-headers
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 django-cors-headers in your virtual environment pip install django-cors-headers
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 django-cors-headers
has been
installed successfully.
pip show django-cors-headers pip3 show django-cors-headers python -m pip show django-cors-headers python3 -m pip show django-cors-headers
The pip show django-cors-headers
command will either state that the package is
not installed or show a bunch of information about the package.
To install django-cors-headers in Visual Studio Code:
pip install django-cors-headers
command to install the
django-cors-headers
module.pip install django-cors-headers # ๐๏ธ For Python 3 pip3 install django-cors-headers # ๐๏ธ If you get a permissions error sudo pip3 install django-cors-headers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install django-cors-headers # ๐๏ธ For Python 3 python3 -m pip install django-cors-headers # ๐๏ธ Using py alias py -m pip install django-cors-headers # ๐๏ธ Alternative if you get a permissions error pip install django-cors-headers --user
CTRL+Shift+P
and then type "View: Toggle Terminal".Once you have the django-cors-headers module installed, add it to your installed apps:
INSTALLED_APPS = [ # ..., "corsheaders", # ..., ]
Make sure to add a trailing comma as omitting it causes a ModuleNotFoundError
.
You also have to add a middleware class to listen in on responses.
MIDDLEWARE = [ # ..., "corsheaders.middleware.CorsMiddleware", "django.middleware.common.CommonMiddleware", # ..., ]
CorsMiddleware
should be placed as high as possible, before any middleware that can generate responses, such as CommonMiddleware
and WhiteNoiseMiddleware
.If you use CORS_REPLACE_HTTPS_REFERER
, place CorsMiddleware
before Django's
CsrfViewMiddleware
.
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 django-cors-headers in your virtual environment pip install django-cors-headers
Your virtual environment will use the version of Python that was used to create it.
To install django-cors-headers in PyCharm:
Alt+F12
on your keyboard to open the terminal.pip install django-cors-headers
command to install the
django-cors-headers
module.pip install django-cors-headers # ๐๏ธ For Python 3 pip3 install django-cors-headers # ๐๏ธ If you get a permissions error sudo pip3 install django-cors-headers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install django-cors-headers # ๐๏ธ For Python 3 python3 -m pip install django-cors-headers # ๐๏ธ Using py alias py -m pip install django-cors-headers # ๐๏ธ Alternative if you get a permissions error pip install django-cors-headers --user
Once you have the django-cors-headers module installed, add it to your installed apps:
INSTALLED_APPS = [ # ..., "corsheaders", # ..., ]
Make sure to add a trailing comma as omitting it causes a ModuleNotFoundError
.
You also have to add a middleware class to listen in on responses.
MIDDLEWARE = [ # ..., "corsheaders.middleware.CorsMiddleware", "django.middleware.common.CommonMiddleware", # ..., ]
CorsMiddleware
should be placed as high as possible, before any middleware that can generate responses, such as CommonMiddleware
and WhiteNoiseMiddleware
.If you use CORS_REPLACE_HTTPS_REFERER
, place CorsMiddleware
before Django's
CsrfViewMiddleware
.
Alternatively, you can use the IDE itself to install the module.
+
icon and type django-cors-headers
.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
You can install the django-cors-headers
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 django-cors-headers
package.
# ๐๏ธ Using conda conda install -c conda-forge django-cors-headers # ๐๏ธ Alternatively use `pip` pip install django-cors-headers # ๐๏ธ For Python 3 pip3 install django-cors-headers # ๐๏ธ If you get a permissions error sudo pip3 install django-cors-headers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install django-cors-headers # ๐๏ธ For Python 3 python3 -m pip install django-cors-headers # ๐๏ธ Using py alias py -m pip install django-cors-headers # ๐๏ธ Alternative if you get a permissions error pip install django-cors-headers --user
Click on the following article if you need to install a specific version of the package using Anaconda.
To install django-cors-headers in Jupyter Notebook:
pip install django-cors-headers
and press Enter.# ๐๏ธ Using pip pip install django-cors-headers # ๐๏ธ For Python 3 pip3 install django-cors-headers # ๐๏ธ If you get a permissions error sudo pip3 install django-cors-headers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install django-cors-headers # ๐๏ธ For Python 3 python3 -m pip install django-cors-headers # ๐๏ธ Using py alias py -m pip install django-cors-headers # ๐๏ธ Using conda conda install -c conda-forge django-cors-headers # ๐๏ธ Alternative if you get a permissions error pip install django-cors-headers --user
Once you have the django-cors-headers module installed, add it to your installed apps:
INSTALLED_APPS = [ # ..., "corsheaders", # ..., ]
Make sure to add a trailing comma as omitting it causes a ModuleNotFoundError
.
You also have to add a middleware class to listen in on responses.
MIDDLEWARE = [ # ..., "corsheaders.middleware.CorsMiddleware", "django.middleware.common.CommonMiddleware", # ..., ]
CorsMiddleware
should be placed as high as possible, before any middleware that can generate responses, such as CommonMiddleware
and WhiteNoiseMiddleware
.If you use CORS_REPLACE_HTTPS_REFERER
, place CorsMiddleware
before Django's
CsrfViewMiddleware
.
Alternatively, you can use the Python ipykernel
.
Click on "New" and then click on "Python 3 (ipykernel)".
Type !pip install django-cors-headers
and click on "Run".
Note that the pip install
command must be prefixed with an exclamation mark if
you use this approach.
!pip install django-cors-headers
Once you type the command, click "Run" to install the django-cors-headers
module.
If you get a permissions error, e.g. "[WinError: 5] Access is denied", add the
--user
option to the installation command.
!pip install django-cors-headers --user
If the error persists, try to restart the Jupyter Kernel and rerun the command.