Pylint "unresolved import" error in Visual Studio Code

python

import-error

vscode-settings

python-configuration

byNikita Barsukov·Oct 8, 2024

To quickly eliminate the "unresolved import" error, align Pylint with your project's Python environment. Activate the needed environment and guide Visual Studio Code to the correct interpreter: Ctrl+Shift+P -> Python: Select Interpreter. If this error persists, make modifications to .vscode/settings.json:

{
    "python.linting.pylintArgs": [
        "--init-hook",
        "import sys; sys.path.append('/path_to_your_module')"
    ]
}

In the above, replace '/path_to_your_module' with the valid path where Python can locate your elusive module. Boom! sys.path is now fine-tuned for Pylint to recognize your imports.

Get ExtraPath-savvy

To fix this error, extra paths customizations are a surefire solution. In your .vscode/settings.json, add these settings:

{
    "python.autoComplete.extraPaths": ["path_to_your_package_A", "path_to_your_package_B"],
    "python.analysis.extraPaths": ["path_to_your_package_A", "path_to_your_package_B"]
}

Be sure to update these paths according to your project - those package paths aren't going to find themselves!

Setting up the .env squad

Set up a .env file with PYTHONPATH to direct VS Code to your module locations:

PYTHONPATH=path_to_your_module_A:path_to_your_module_B

And signal "python.envFile": "${workspaceFolder}/.env" in your settings for a streamlined setup. With these settings, your import issues will be saying, "Env-ious setup! Let's run this code!"

Check Python Interpreter and Reload VS Code

Check that your Python interpreter (Ctrl+Shift+P -> Python: Select Interpreter) and your project root are best buddies, pairing them wrong can lead to troubled imports. If they're already besties but the error persists, refreshing the settings in VS Code might help. You know what they say, "A quick reload clears the cache's abode".

Deep Troubleshooting

Taming the LSP Pylance

Got a stubborn unresolved import problem? Maybe LSP Pylance can help. Set this configuration in .vscode/settings.json:

{
    "python.defaultInterpreterPath": "path_to_your_virtual_env_python_bin"
}

Where the path is your project's virtual environment. Who knew magic wands were just virtual paths all along?

Is it the Packages?

If certain imports keep playing hide and seek, check they're installed in the selected interpreter. Sometimes it's not you, it's them (the packages).

Workspace Gymnastics

Doing multi-root workspaces? Ensure each folder's settings.json points to the right Python interpreter. Keep your configurations as flexible as a gymnast, and your code will be doing backflips.

Take a GitHub Walk

Strolling through GitHub issue discussions like #3840 offers community insights and solutions. Remember, all programmers learn from falling (and forum threads).

explain-codes / Python / Pylint "unresolved import" error in Visual Studio Code

Linked

How to fix "Attempted relative import in non-package" even with __init__.py



Python 3: ImportError "No Module named Setuptools"



Where does pip install its packages?



Importing files from different folder



Importing modules from parent folder

