How to setup working directory in VS Code for pylint?

Question

I have a project with that structure:

├── .git
├── .gitignore
├── README.md
├── requirements.txt
└── src

Pylint by default running from project root and I have error on all my imports, because source root in src directory. I try to setup the linter path in settings.json, but then linter don't work

"python.linting.pylintPath": "cd src && pylint"

Question is: how to change the source root for pylint in VS Code? I use this extension https://github.com/DonJayamanne/pythonVSCode

score 9 · Accepted Answer · edited Nov 08 '17 at 13:16

9

You can solve this by creating a .env file in the project root with content:

PYTHONPATH=./src

edited Nov 08 '17 at 13:16

mjr104

193
1
4

answered Nov 07 '17 at 14:00

Arr

749
3
6
15

4

This clearly doesn't work *unless* you `export PYTHONPATH=./src` in the terminal. – gented Sep 12 '18 at 14:10
@gented not even when you set pyenv path in workspace settings? – jave.web Feb 25 '20 at 20:14
2

With the current VS Code Python extension, you *do not* need to run `export PYTHONPATH=./src` if you have a `.env` file with the above contents in your workspace folder. The extension will automatically use any environment variables set in the `.env` file. [See the docs for more info.](https://code.visualstudio.com/docs/python/environments#_environment-variable-definitions-file) – Cameron Bieganek Sep 30 '20 at 18:25
This works for me but not when I run a file in VScode. Any hints there? – Roelant Nov 24 '20 at 12:26

score 8 · Answer 2 · answered Sep 27 '19 at 13:32

8

Add this line in your settings.json file (in the .vscode directory).

"python.autoComplete.extraPaths": ["./src"],

answered Sep 27 '19 at 13:32

Marco Lavagnino

1,140
12
31

In case you want to find this through GUI => go to Settings => Extensions => Python => "Auto Complete: Extra Paths" => Edit in settings.json (hopefuly in future this will change to GUI dynamic list of input fields :) ) – jave.web Feb 25 '20 at 20:13

score 0 · Answer 3 · answered Jun 10 '20 at 12:47

The PYTHONPATH is the path to python, not the working directory .

The better way is to customize Settings.json and launch.json, do like this:

// vi .vscode/Settings.json
{
    "python.pythonPath": "venv/bin/python",
    "python.linting.pylintEnabled": true,
    "python.linting.enabled": true,
    "python.formatting.provider": "autopep8"
}

// vi .vscode/launch.json
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: your project name",
            "type": "python",
            "request": "launch",
            "cwd": "${workspaceRoot}/src",
        }
    ]
}

refer: https://code.visualstudio.com/docs/editor/debugging#_launch-versus-attach-configurations

No, `PYTHONPATH` is the list of directories where Python looks for modules. [See the docs.](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH) — Cameron Bieganek, Sep 30 '20 at 18:27

score 0 · Answer 4 · answered Feb 17 '23 at 15:51

0

With the newer separate Pylint VSCode extension, the only thing that worked for me was adding "pylint.args": ["--rcfile=PATH_TO/pylintrc"] to my VSCode settings.json.

answered Feb 17 '23 at 15:51

Akh

632
1
6
15

score -1 · Answer 5 · answered Jun 22 '22 at 09:41

-1

In vs-code: File - Preferences - Settings Search for: Pylint "Pylint: Path" - Add item

It work for me!

answered Jun 22 '22 at 09:41

dipbox

1

1

"Pylint: Path" is the path of the Pylint executable. It doesn't answer the question. :) – Quentin Brosse Dec 06 '22 at 16:27

How to setup working directory in VS Code for pylint?

5 Answers5