Pylint unresolved import error in Visual Studio Code

Question

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  quot unresolved import quot   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

User · Answer

In my case I already had a Conda environment activated, but I still wanted local Python modules to be available for autocomplete, peeking definition, etc.

I tried many solutions such as adding a list of Python paths etc., but what finally solved it for me was to create a symbolic link from Conda's lib/python{your version}/site-packages to my local module.

User · Answer

None of the previous answers worked for me  Adding both of the lines below to my settings json file did  however   quot python analysis disabled quot          quot unresolved-import quot      quot python linting pylintArgs quot     quot --load-plugin quot   quot pylint protobuf quot    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

User · Answer

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

User · Answer

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

User · Answer

My solution was to open Visual Studio Code in a previous directory

User · Answer

If you have this code in your settings json file  delete it         quot python jediEnabled quot   false

User · Answer

This works for me  Open the command palette  Ctrl   Shift   P  and choose  quot Python  Select Interpreter quot   Doing this  you set the Python interpreter in Visual Studio Code

User · Answer

Conda environment  pylint error   quot Unable to import  django X  quot   After activating the desired Python interpreter in your conda environment  VS Code will sometimes continue to use pylint from the default conda environment  For example    home  lt username gt  anaconda3 bin pylint  1  Install pylint in your target conda environment   conda activate  lt target environment gt    conda install pylint  2  Update VS Code Settings  In VS Code Settings  search for  quot pylint path quot  Click the Workspace tab  instead of the default User  Under  quot Extensions      quot   click  quot Python     quot  Scroll down to Python  gt  Linting  Pylint Path Enter the pylint path pointing to the copy of pylint that was just installed  for example     home  lt username gt  anaconda3 envs  lt target environment gt  bin pylint  Replace  lt username gt  and  lt target environment gt  according to your system configuration  Now pylint will find the installed libraries  including Django  presuming that Django has been installed in  lt target environment gt   3  Install the Django pylint plugin   conda install pylint-django  Update the VS Code Settings to use the plugin   Search VS Code settings for  quot pylint args quot  Under Python  gt  Linting  Pylint Args  click  quot Add Item quot  Enter  --load-plugins pylint django Click  quot OK quot  Click  quot Add Item quot  Enter  --django-settings-module  lt PROJECT FOLDER gt  settings  Replace  lt PROJECT FOLDER gt  with the folder containing the  quot settings py quot  Django configuration file    Click  quot OK quot  Restart VS Code

User · Answer

Alternative way  use the command interface  Cmd Ctrl   Shift   P   Python  Select Interpreter   choose the one with the packages you look for

User · Answer

First make sure that you ve installed the plugin  but it s likely that the workspace directory isn t properly set  Just check Pylint and edit the underlying settings json file         quot python pythonPath quot    quot  usr local bin python3 quot        quot git ignoreLimitWarning quot   true

User · Answer

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

User · Answer

The accepted answer won t fix the error when importing own modules  Use the following setting in your workspace settings  vscode settings json   quot python autoComplete extraPaths quot     quot   path-to-your-code quot     Reference  Troubleshooting  Unresolved import warnings

User · Answer

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   quot python pythonPath quot    quot      your path   venv  Scripts  python exe quot    quot python linting pylintPath quot    quot      your path   venv  Scripts  pylint exe quot    quot python formatting autopep8Path quot    quot      your path   venv  Scripts  autopep8 exe quot    Save and restart VS Code with workspace  Done

User · Answer

I solved the problem with command-line python  I installed modules with vs code terminal in project path  but when import the module on windows command line python  that throws an error as this module not defined so I install these modules from the command line and my problem solved

User · Answer

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

User · Answer

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   quot python envFile quot    quot  env quot

User · Answer

None of the solutions worked except this one  Replacing  quot Pylance quot  or  quot Microsoft quot  in the settings json solved mine   quot python languageServer quot    quot Jedi quot

User · Answer

I was able to resolved this by enabling jedi in  vscode settings json   python jediEnabled   true   Reference from https   github com Microsoft vscode-python issues 3840 issuecomment-456017675

User · Answer

If you are using pipenv then you need to specify the path to your virtual environment in settings json file  For example          quot python pythonPath quot                quot  Users username  local share virtualenvs Your-Virual-Env bin python quot     This can help

User · Answer

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  quot Pylance quot  Add  quot python analysis extraPaths quot      quot path to src file quot     Apparently the root and src will be checked for local packages  but others must be added here

User · Answer

In your workspace settings  you can set your Python path like this         quot python pythonPath quot    quot  path to your venv bin python quot

User · Answer

I have one library which errs out when trying to include it using the Jedi language service and works fine without it  i e  the C  one   The library is jsonslicer and it does depend on an external C library I installed into  usr local lib  Could that have something to do with it  I installed the Jedi service and the library in my Conda environment and used that environment within Visual  Studio  It works fine at runtime and in my terminal  but not when checking for problems in my source files and it shows up as an error

User · Answer

Install code-runner and add the code below in the settings json folder       quot code-runner executorMap quot              quot python quot    quot python3 -u quot           quot python quot    quot  the Python executable with modules or its path  -u quot

User · Answer

When I do  gt  reload window that fixes it  Reference  Python unresolved import issue  3840  dkavraal s comment

User · Answer

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  quot Unresolved Import quot  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                 quot python pythonPath quot    quot apis bin python quot         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

User · Answer

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   quot python languageServer quot    quot Jedi quot

User · Answer

I have the same problem with python 3 8 5 using venv vscode 1 48 2 I found my solution  In  env folder  lib site-packages does not contains the packages  I use this setting   vscode settings json                quot python autoComplete extraPaths quot                  quot      quot                       quot python pythonPath quot    quot env  Scripts  python exe quot            quot python languageServer quot    quot Microsoft quot

User · Answer

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  quot python envFile quot    quot   workspaceFolder   env quot  to the settings json Restart Visual Studio Code

User · Answer

Resolved First of all open visual studio code settings in json and add following arguments after  quot  python  quot      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 solved my issue with pylint

User · Answer

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          gt  a          gt  b          gt  c     dir 2          gt  x          gt  y          gt  z  What we want  Project dir     dir 3         import a         import y  Here  quot import a quot  and  quot import y quot  fails with following error  Import  quot dir 1 a quot  could not be resolvedPylancereportMissingImports Import  quot dir 2 y quot  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  quot Code to append quot  in  quot  vscode settings json quot  Filename   vscode settings json  Code to append   quot python analysis extraPaths quot    dir 1  dir 2

User · Answer

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

User · Answer

Changing Python Language Server to  Jedi  worked for me  It was  Windows  initially

User · Answer

I have resolved import error by Ctrl   Shift   P  Type  quot Preferences settings quot  and select the option Preferences Open Settings  JSON  And add the line  quot python pythonPath quot    quot  usr bin  quot  So the JSON content should look like         quot python pythonPath quot    quot  usr bin  quot     Keep other configuration lines if they are present  This should import all modules that you have installed using PIP for autocomplete

User · Answer

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         quot python pythonPath quot    quot  usr local bin python3 quot       This is the example for Python  2        quot python pythonPath quot    quot  usr local bin python quot       If you don t know where your Python installation is located  just run the command which python or which python3 on the terminal  It will print the Python location   This example works for dockerized Python - Django

User · Answer

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  quot root quot  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  quot folder quot  directory  leaving only the  init  py located at  root

User · Answer

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

[python] Pylint "unresolved import" error in Visual Studio Code

Examples related to python

Examples related to django

Examples related to visual-studio-code

Examples related to pylint