I am using the following setup
- macOS v10.14 (Mojave)
- Python 3.7.1
- Visual Studio Code 1.30
- Pylint 2.2.2
- Django 2.1.4
I want to use linting to make my life a bit easier in Visual Studio Code. However, for every import I have states “unresolved import”. Even on default Django imports (i.e. from django.db import models).
I presume it is because it is not seeing the virtual environment Python files.
Everything works just fine, but it’s starting to get annoying.
The interpreter choices I have are all system versions of Python. It does not seem to see my virtual environment Python at all (it is not in the same directory as my workspace, so that part makes sense).
If I set up the python.PythonPath in the settings.json file, it just ignores it and does not list my virtual environment path as an option. I also tried setting it up in my global Python settings, but it also does not show up.
Is there a quick fix to get it working?
5
41 Answers
The accepted answer won’t fix the error when importing own modules.
Use the following setting in your workspace settings .vscode/settings.json
:
"python.autoComplete.extraPaths": ["./path-to-your-code"],
Reference: Troubleshooting, Unresolved import warnings
14
I have a mixed workspace, all python code is in a sub folder. Adding a .vscode in the sub folder will not work, this is the only working solution.
– daisybest answer for vscode settings.json. (if using workspace.xml the accepted answer might be the way to go, but can’t say for sure. i’m also using a mixed workspace) many thanks for solution.
– NoneThis should be the answer.
This worked for me! The reference link explains perfectly. TL;DR; For user created local scripts in subdirectories, the above setting helps the python interpreter to recognize the subdirectory as its own workspace. Subsequently, recognizing scripts in the workspace and resolving imports when whole modules or individual methods are imported.
Hello everyone! I’ve found that [“./path-to-your-code”] can be [“./**”] in any case where a double star means any sub-folder under the root directory! This is a simpler solution.
In your workspace settings, you can set your Python path like this:
{
"python.defaultInterpreterPath": "/path/to/your/venv/bin/python",
}
12
This sort of works. For the Python specific imports it resolves those now but not my own models (i.e. “from users.models import User” still says it cannot resolve it). Thoughts on that?
–Not sure. Please try reloading the window of the vs code ( from shell,
code <project_directory> -r
) or just restart the vscode.– ruddraI am not sure, sometimes it may occur if the workspace directory is not set properly. Please make sure
manage.py
is in root ofworkspace
. Also please make sure the pylint is configured properly– ruddrayou genius! It was because my workspace was not starting at the root level of the project. Once i adjusted that it started work. Thanks so much!
–Thanks so much! Helped me get past an ages-old problem!
– user10925323
Alternative way: use the command interface!
Cmd/Ctrl + Shift + P → Python: Select Interpreter → choose the one with the packages you look for:
7
in my case this did not work but hopefully it helps others with this issue.
–yeah that’s the spirit, it’s not a complicated solution, it’s what happened for me 🙂
– tedThis worked for me. Incase anyone was still wondering in 2019.
– Safder@Safder not for me. using virtualenv
this worked for me. Because I have a directory structure where each python project I have a new
venv
, with this i point it to that specific Python in thevenv
directory for that project– cryanbhu
This issue has already been opened on GitHub:
Python unresolved import issue #3840
There are two very useful answers, by MagnuesBrzenk and SpenHouet.
The best solution for now is to create a .env file in your project root folder. Then add a PYTHONPATH to it like this:
PYTHONPATH=YOUR/MODULES/PATH
And in your settings.json add:
"python.envFile": ".env"
5
There was a common issue with editable installs when using the Microsoft Python Language Server. However it looks like currently after the new fix described here: github.com/microsoft/python-language-server/issues/… the issue has been fixed and any import can be added with ExtraPaths. Look at this TroubleShooting for more help: github.com/microsoft/python-language-server/blob/master/…
Thanks @TomaszChudzik – Setting: “python.autoComplete.extraPaths”: [“./src”] worked like a charm!
– RobertAnother solution is to add your codebase modules in your virtualenv (using
add2virtualenv YOUR/MODULES/PATH
for example), and select this virtualenv as your python interpreter.– AntwanProject root folder in vscode means where the workspace.code-workspace is and all the repos as subdirs? Module path is the path to
site-packages
?– Timo
When I do > reload window
that fixes it.
Reference: Python unresolved import issue #3840, dkavraal‘s comment
2
It just hides the warning if I click on the file, again it shows up!
Is “>” literal or part of a prompt?
If you have this code in your settings.json
file, delete it:
{
"python.jediEnabled": false
}
4
It’s better to add a bit of explanation.
– TiwEditing this line is a big change in your project. Line: “python.jediEnabled”: false disables the old language server and enables the new Microsoft Python Language Server. Look here: github.com/Microsoft/vscode-python/issues/2177 I think it’s much simpler to just add necessary dependencies to our envFile. It’s described in another answer. With the new Microsoft Python Language Server intellisense works much better for me.
For me its the other way around, enabling jedi in settings.json works for me. See more here, stackoverflow.com/a/57269144/2877493
– nairb@Tiw especially since an other answer suggest the very opposite.
None of the solutions worked except this one. Replacing “Pylance” or “Microsoft” in the settings.json solved mine.
"python.languageServer": "Jedi"
1
Agreed. I also tried all the options provided but this worked!
– Wick 12c
If you are more visual like myself, you can use the Visual Studio Code configurations in menu File → Preferences → Settings (Ctrl + ,). Go to Extensions → Python.
In the section Analysis: Disabled, add the suppression of the following message: unresolved-import
:
2
The unresolved-import for relative imports is clearly incorrect, this gets rid of it.
This only fixes the warning, not the knock on issues. If I use the python path method then the import warning disappears, and also “drill in” (“goto definition”) and “parameter hints” work.
I was able to resolved this by enabling jedi in .vscodesettings.json
"python.jediEnabled": true
Reference from https://github.com/Microsoft/vscode-python/issues/3840#issuecomment-456017675
2
You need to select the interpreter associated with the virtual environment.
Click here (at the bottom status bar):
And just select the virtual environment you are working with. Done.
Sometimes, even with the interpreter selected, it won’t work. Just repeat the process again and it should solve it.
2
This was exactly my problem (on mac) and selecting the proper interpreter solved it. Thanks!
– Mahm00dThis was my problem. Julia apparently installed its own Python interpreter to
~.juliaconda3python.exe
.
I wonder how many solutions this problem have (or have not), I tried most of the above, nothing worked, the only solution that worked is to set the python language server to Jedi, instead of Microsoft in the settings.json file:
"python.languageServer": "Jedi"
None of the previous answers worked for me. Adding both of the lines below to my settings.json file did, however.
"python.analysis.disabled": [
"unresolved-import"
],
"python.linting.pylintArgs": ["--load-plugin","pylint_protobuf"]
The first line really just hides the linting error. Certainly not a permanent solution, but de-clutters the screen.
This answer gave me the second line: VS Code PyLint Error E0602 (undefined variable) with ProtoBuf compiled Python Structure
Maybe someone who understands Python more than me can explain that one more.
1
Glad people are finding this useful, however is there anyone that can explain that second key-value pair?
My solution
This solution is only for the current project.
In the project root, create folder
.vscode
Then create the file
.vscode/settings.json
In the file
setting.json
, add the line (this is for Python 3){ "python.pythonPath": "/usr/local/bin/python3", }
This is the example for Python 2
{ "python.pythonPath": "/usr/local/bin/python", }
If you don’t know where your Python installation is located, just run the command
which python
orwhich python3
on the terminal. It will print the Python location.This example works for dockerized Python – Django.
0
The solution from Shinebayar G worked, but this other one is a little bit more elegant:
Copied from Python unresolved import issue #3840:
Given the following example project structure:
- workspaceRootFolder
- .vscode
- … other folders
- codeFolder
What I did to resolve this issue:
- Go into the workspace folder (here workspaceRootFolder) and create a .env file
- In this empty .env file, add the line PYTHONPATH=codeFolder (replace codeFolder with your folder name)
- Add “python.envFile”: “${workspaceFolder}/.env” to the settings.json
- Restart Visual Studio Code
0
To me the problem was related with the project that I was working on. It took me a while to figure it out, so I hope this helps:
Original folder structure:
root/
__init__.py # Empty
folder/
__init__.py # Empty
sub_folder_b/
my_code.py
sub_folder_c/
another_code.py
In another_code.py:
from folder.sub_folder_b import my_code.py
This didn’t trigger the intellisense in Visual Studio Code, but it did execute OK.
On the other hand, adding “root” on the import path, did make the intellisense work, but raised ModuleNotFoundError when executing:
from root.folder.sub_folder_b import my_code.py
The solution was to remove the _init_.py file inside the “folder” directory, leaving only the _init_.py located at /root
.
Okay, so 2 years down the line I have ran into this annoying problem. All I can seen here are some really complicated workarounds. Here are easy to follow steps for anyone else who might just run into this later on:
- at the bottom of VS Code where you see the Python version listed, just click there
- Select Interpreter windows is going to appear
- click on the first option that says “Select Interpreter Path” and navigate to the folder path which has your Virtual Environment
That’s all you need to do and avoid tempering with those settings in VS Code which might get very complicated of not handled with caution.
4
Thanks Surveyor Jr. This actually did not work for me back in the day. So maybe there have been improvements. Thanks for adding this workaround to the thread!
–This doesn’t work for me either
@JamieMarshall I guess it now depends on OS. I am a Windows user. #Assumption. But hopefully you found an answer by now.
@SurveyorJr – I’m windows as well. It turned out for me, I had to uninstall and re-install pylint.
This works for me:
Open the command palette (Ctrl + Shift + P) and choose “Python: Select Interpreter”.
Doing this, you set the Python interpreter in Visual Studio Code.
2
I was facing the same problem while importing the project-related(non standard) modules.
Detailed explanation of the problem
Directory structure:
Project_dir:
.vscode/settings.json
dir_1
> a
> b
> c
dir_2
> x
> y
> z
What we want:
Project_dir
dir_3
import a
import y
Here “import a” and “import y” fails with following error:
Import "dir_1.a" could not be resolvedPylancereportMissingImports
Import "dir_2.y" could not be resolvedPylancereportMissingImports
What worked for me:
Appending the top directory which contains the modules to be imported.
In above example add the follwoing “Code to append” in “.vscode/settings.json”
Filename:
.vscode/settings.json
Code to append:
"python.analysis.extraPaths": [dir_1, dir_2]
2
This is what ended up working for me. I had my project with code in a
package_name
folder nested in an outerpackage_name
folder. Adding justpackage_name
to “extraPaths” (not the absolute path) did the trick.Worked for me but I had to put the directory name in quotations.
– yem
None of the answers here solved this error for me. Code would run, but I could not jump directly to function definitions. It was only for certain local packages. For one thing, python.jediEnabled
is no longer a valid option. I did two things, but I am not sure the first was necessary:
- Download Pylance extension, change
python.languageServer
to “Pylance” - Add
"python.analysis.extraPaths": [ "path_to/src_file" ]
Apparently the root and src
will be checked for local packages, but others must be added here.
2
Installing the Pylance extension immediately fixed it for me
I have pylance installed and I’m still facing this issue for some projects. And is extraPaths suppose to point to a path? What is “src_file” ?
That happens because Visual Studio Code considers your current folder as the main folder, instead of considering the actual main folder.
The quick way to fix is it provide the interpreter path to the main folder.
Press Command + Shift + P (or Ctrl + Shift + P on most other systems).
Type Python interpreter
Select the path where you installed Python in from the options available.
Changing
Python:Language Server
to ‘Jedi’ worked for me.
It was ‘Windows’ initially.
For me, it worked, if I setup the paths for python, pylint and autopep8 to the local environment paths.
For your workspace add/change this:
"python.pythonPath": "...\your_path\.venv\Scripts\python.exe",
"python.linting.pylintPath": "...\your_path\.venv\Scripts\pylint.exe",
"python.formatting.autopep8Path": "...\your_path\.venv\Scripts\autopep8.exe",
Save and restart VS Code with workspace.
Done!
1
This worked for me as well, more specifically setting the “python.linting.pylintPath” is what fixed the issue. I never had this issue until I upgraded to Python 3.9. My guess is there is a default pylint path they are using.
I am using the following setup: (in Apr 2021)
- macos big sur
- vscode
- Anaconda 3 (for environment)
And I faced this error during starting of the Django.
So, I follow these steps and this error is resolved.
Steps are given in these screenshots:
Open settings (workspace)
Now, click
Edit in settings.json
Make path like given in this screenshot
/opt/anaconda3/bin/python
5. Now, save this settings.json file.
6. Restart the vscode
Also, intellisense might not work for some time hold on wait for some time and then restart again then vscode reads file for new path.
I have a different solution: my Visual Studio Code instance had picked up the virtualenv stored in .venv
, but it was using the wrong Python binary. It was using .venv/bin/python3.7
; using the switcher in the blue status bar.
I changed it to use .venv/bin/python
and all of my imports were resolved correctly.
I don’t know what Visual Studio Code is doing behind the scenes when I do this, nor do I understand why this was causing my problem, but for me this was a slightly simpler solution than editing my workspace settings.
In case of a Pylint error, install the following
pipenv install pylint-django
Then create a file, .pylintrc, in the root folder and write the following
load-plugins=pylint-django
I have faced this problem in three ways. Although for each of them a solution is available in the answers to this question, I just thought to put it all together.
First I got an “Unresolved Import” while importing some modules and I noticed that my installations were happening in global pip instead of the virtual environment.
This issue was because of the Python interpreter. You need to select the interpreter in Visual Studio Code using Shift + Ctrl + P and then type
Select Python Interpreter
. Select your venv interpreter here.The second issue was: The above change did not resolve my issue completely. This time it was because of file settings.json. If you don’t have the settings.json file in your project directory, create one and add the following line in that:
{ "python.pythonPath": "apis/bin/python" }
This will basically tell Visual Studio Code to use the Python interpreter that is in your venv.
The third issue was while importing a custom Python module or file in another program. For this you need to understand the folder structure. As Python in venv is inside bin, you’ll need to specify the folder of your module (most of the time the application folder). In my case it was
app
,from app.models import setup_db
Verbally, import setup_db from models.py resides in the app folder.
If you are using pipenv
then you need to specify the path to your virtual environment.in settings.json
file.
For example :
{
"python.pythonPath":
"/Users/username/.local/share/virtualenvs/Your-Virual-Env/bin/python"
}
This can help.
If someone happens to be as moronic as me, the following worked.
Old folder structure:
awesome_code.py
__init__.py
src/
__init__.py
stuff1.py
stuff2.py
New structure:
awesome_code.py
src/
__init__.py
stuff1.py
stuff2.py
How to avoid warning
Please note that this is just skipping the warning not resolving it.
First of all open visual studio code settings in json and add following arguments after "[python]":{}
"python.linting.pylintArgs": ["--rep[![enter image description here][1]][1]orts", "12", "--disable", "I0011"], "python.linting.flake8Args": ["--ignore=E24,W504", "--verbose"] "python.linting.pydocstyleArgs": ["--ignore=D400", "--ignore=D4"]
This has helped me to avoid pylint warnings in VSCode.
2
Ignoring the warning is not a good practice, instead you should suggest the solution to fix the root cause.
– riteshIn that case, I have to change the title of my answer to “How to avoid python pylint warning”?
I have resolved import error by Ctrl + Shift + P.
Type “Preferences settings” and select the option Preferences Open Settings (JSON)
And add the line "python.pythonPath": "/usr/bin/"
So the JSON content should look like:
{
"python.pythonPath": "/usr/bin/"
}
Keep other configuration lines if they are present.
This should import all modules that you have installed using PIP for autocomplete.
pip install pylint-django
, then in vs code settings add this:"python.linting.pylintArgs": [ "--load-plugins=pylint_django", ],
@VaibhavVishal unfortunately, i still get the same results (added it to my settings.json file)
Its actually a VScode problem that detects import package very late , after restarting it is fixed automatically.
@VaibhavVishal this is the only solution that worked for me in the entire thread. Thanks.
My pythonPath was already set correctly to the venv python. If this helps anyone, I actually had to install pylint in my venv:
python -m pip install pylint
, and then update my pylintPath in VS Code to the venv pylint.