vscode import error for python module

Question

I am trying to do an import in python from one directory level up.

import sys

sys.path.append('..')
from cn_modules import exception

I get an Error from VSCode when I try to do Run Build Task as:

ImportError: No module named cn_modules

The same code works without any error from terminal (python).
I face the problem when I try to run it from VSCode Run Build task.
Any clue on what is wrong here?

Have spent quiet some time but not able to resolve this, Any help is appreciated.

NOTE: this works when i do debug using vscode too. Below are my config for launch.json and tasks.json

launch.json

 {
        "version": "0.2.0",
        "configurations": [
            {
                "name": "Python Console App",
                "type": "python",
                "request": "launch",
                "stopOnEntry": true,
                "program": "${file}",
                "externalConsole": true,
                "debugOptions": [
                    "WaitOnAbnormalExit",
                    "WaitOnNormalExit"
                ],
                "env": {},
                "envFile": "${workspaceRoot}/.env",
                "console":"integratedTerminal",
                "pythonPath": "${config:python.pythonPath}"
            }
        ]
    }

tasks.json

{
        "version": "0.1.0",
        "command": "/usr/bin/python",
        "isShellCommand": true,
        "args": ["${file}"],
        "showOutput": "always",
        "env": {},
        "envFile": "${workspaceRoot}/.env",
        "pythonPath": "${config:python.pythonPath}"
 }

"one directory level up"... from where? Are you aware of the current working directory? If you want to go up a directory from the location of your script, then you need to find the path of your script first. — Aran-Fey
– Aran-Fey, Commented Oct 2, 2017 at 7:38
Possible duplicate of How to properly determine current script directory in Python? — Aran-Fey
– Aran-Fey, Commented Oct 2, 2017 at 7:40
I do not have any problem running the code in python, it works. I am facing the problem when trying to run the same from vscode build task. — Chandan Nayak
– Chandan Nayak, Commented Oct 2, 2017 at 8:02
Where does the build task set the CWD (Current Working Directory) to be? — ifconfig
– ifconfig, Commented Oct 2, 2017 at 19:58
This is a known issue with VSCode and setting the cwd and similar does NOT work. — gented
– gented, Commented Dec 4, 2018 at 13:56

ChenHao Wu · Accepted Answer · 2019-01-06 15:05:08Z

76

I tried to add this in my launch.json, then it works!

"env": {"PYTHONPATH": "${workspaceRoot}"}

below is my launch.json

        "name": "Python: Current File (Integrated Terminal)",
        "type": "python",
        "request": "launch",
        "program": "${file}",
        "cwd": "${workspaceRoot}",
        "env": {"PYTHONPATH": "${workspaceRoot}"},
        "console": "integratedTerminal"

wish it can help u! :)

edited Jan 6, 2019 at 15:05

answered Dec 5, 2018 at 2:08

ChenHao Wu

8696 silver badges6 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

karu Over a year ago

I also needed to restart VS Code afterwards.

James Huang Over a year ago

Where can I find launch.json?

bwdm Over a year ago

@JamesHuang Configurations are defined in a launch.json file that's stored in a .vscode folder in your workspace. If it doesn't exist, it can be initialized via the debug menu from the sidebar.

John Jiang Over a year ago

launch.json is no longer found in latest vscode.

Raid Over a year ago

@JohnJiang If there's no .vscode directory you can just make one (in the project directory). Then you can create launch.json in there.

|

Daniel · Accepted Answer · 2020-04-14 23:50:00Z

20

In your launch.json file, change env:{} to:

"env": {"PYTHONPATH": "${workspaceRoot}"}

edited Apr 14, 2020 at 23:50

Daniel

9,6396 gold badges69 silver badges94 bronze badges

answered Apr 3, 2018 at 13:58

G4th

2312 silver badges3 bronze badges

3 Comments

Antonio Sesto Over a year ago

where is launch.json located?

Juan Over a year ago

That did it for me too, thanks. It started failing out of the blue after the weekend. I guess a VS update

jbchurchill Over a year ago

Would it be safe to put this directly in settings.json?

Mubashar Javed · Accepted Answer · 2021-02-04 13:49:19Z

16

The solution is given below just worked for me.

Press Ctrl+Shift+P
Type: Configure Language Specific Setting
Then select Python
settings.json will open. Check in this JSON file if there is a line like this:

{"python.jediEnabled": false}

(Press Ctrl+F and then paste the above line to find it quickly)

If yes, then delete or comment this line, save the file and reload VScode.
DONE!

edited Feb 4, 2021 at 13:49

answered Sep 28, 2019 at 13:58

Mubashar Javed

1,4071 gold badge11 silver badges19 bronze badges

1 Comment

Timo Over a year ago

If your hurt is like mine - What is python.jedi doing? See this

dcarl661 · Accepted Answer · 2019-04-03 20:34:47Z

10

Thanks Honza Kalfus jankalfus

I have noticed that if I use File -> Close folder and then File -> Open Folder... and open the project folder again, the errors are gone. If I just restart VS Code instead, I keep getting the errors. I presume that some internal cache gets cleared?

Found here https://github.com/Microsoft/vscode/issues/10391

answered Apr 3, 2019 at 20:34

dcarl661

3224 silver badges12 bronze badges

1 Comment

Chris Zuidema Over a year ago

For me this was the correct answer.

Dylan Wang · Accepted Answer · 2020-05-14 00:11:51Z

9

In my case, it's nothing to do with

"env": {"PYTHONPATH": "${workspaceRoot}"}

Here is my folder/module structure:

/Dev/csproj/deploy/test.py 
/Dev/csproj/util/utils.py

and in test.py, it imports the utils function

import sys
sys.path.append('../')
from util.utils import get_keyvault_secret

It has no issue if I run test.py in terminal folder /Dev/csproj/deploy/.
But if I want to debug test.py in VSCode (under workspaceRoot), I got the exception of "ModuleNotFoundError"
To fix it, I add this to my debug configuration launch.json

"cwd": "${workspaceRoot}\\Dev\\csproj\\deploy",

edited May 14, 2020 at 0:11

answered Mar 18, 2019 at 23:00

Dylan Wang

1311 silver badge5 bronze badges

Comments

Paulus · Accepted Answer · 2020-04-16 12:49:47Z

I have had the same problem, in my case it was caused by the current directory of the vscode debug process being different to the directory the script was in. It is helpful to do a

print('cwd is %s' %(os.getcwd()))

Just before your sys.path.append and your imports. What happened with me is that the running environment cwd seems to default to the workspace directory, which seems to be the directory containing the vs code project file, and if this is not where your script is located, then your relative include paths are broken.

A solution to this is to insure that your script changes its current directory to the directory where the script is located, and also to append your syspath to the directory where the script is located:

scriptdir = os.path.dirname(os.path.realpath(__file__))
print('dir containing script is %s' % (scriptdir))

# append our extra module directory (in this case Autogen) onto the script directory

sys.path.append(os.path.join(scriptdir, 'Autogen'))

# also change cwd to where the script is located (helps for finding relative files)
print('============\ncwd is %s' %(os.getcwd()))

os.chdir(scriptdir)
print('============\ncwd after change to script dir is %s' %(os.getcwd()))

All the above steps will help to make your script run well, but they will not help for intellisense or code completion. To have the code completion run well, you must create a .env file (usually in the same directory as your .vscode directory) and in your .env file you add the directories where you want vscode to look for extra python modules

Contents of .env file

PYTHONPATH="someDirRelativeTowhereYourVSCodeProjectLives\\Autogen"

Out of interest, why the downvote? I tried to answer correctly and point out things that could cause the problem?

W.Perrin · Accepted Answer · 2020-08-16 04:53:40Z

4

There are two ways. Directly put it in launch.json or use a .env file.

All in launch.json

launch.json

"env": {"PYTHONPATH": "${workspaceRoot};${workspaceRoot}/modules;${workspaceRoot}/modules/somePrj/modules"}

Use a .env file

launch.json

"envFile": "${workspaceRoot}/.env"

.env

PYTHONPATH=".;modules;/modules/somePrj/modules"

The .env file way is recommended for we can choose prod.env or test.env.

answered Aug 16, 2020 at 4:53

W.Perrin

4,78536 silver badges31 bronze badges

Comments

Anna Madsen · Accepted Answer · 2022-11-14 13:03:12Z

3

For me, the issue had to do with a mismatch in the selected Python interpreter in VSCode, versus the overall used version of Python on my computer.

The selected Python interpreter in VSCode was Pyhon 3.8.10 64-bit (microsoft store) (which was the recommended version):

Whereas the current global version of Python on my laptop was Python 3.10.4

After changing the interpreter to Python 3.10.4 64-bit, all the import errors disappeared

edited Nov 14, 2022 at 13:03

answered Sep 2, 2022 at 13:31

Anna Madsen

5101 gold badge6 silver badges19 bronze badges

Comments

LongToeBoy · Accepted Answer · 2020-04-12 01:05:53Z

2

i did nothing but to add header in the beginning

#!/usr/bin/env python

that fixed my problem... maybe it will help somebody who is new just like me

answered Apr 12, 2020 at 1:05

LongToeBoy

1951 silver badge10 bronze badges

1 Comment

hsh_Ar Jan 13 at 8:34

this one did it for me, thanx

Alfa Bravo · Accepted Answer · 2020-08-06 07:51:35Z

Since this is a VScode question I could add what my answer was.

We are running many Python Django backends in a backends folder like so:

+projectBackends
    -oneService
    -twoService
    -threeService

And so in my project folder in VScode I just opened the projectBackends folder, because this would then give me all the services underneath it all at once. Seemed clear and simple. But then all the linting gets done from the root folder which is projectBackends, and not from the root folder of each service:

from oneService.module1 import view

gave and import error, where if I put

from projectBackends.oneService.module1 import view

I got no error, but then the microservice would not work.

So in the end I just added a folder for every microservice in my workspace like:

+oneService
+twoService
+threeService

Which solved all the import errors for the independant microservices

Ethan · Accepted Answer · 2022-06-06 12:13:46Z

1

Until MSFT figures out how to really resolve this issue create a symlink between the file you are wanting to import to the folder where the Python environment you are using is installed and that resolved the problem for me.

Adding path to Win10 did not work xtraPath.json change did not work (how to specifically fill in what goes between the paren is a mystery)

Wasted three days on this. Hope the VSCode people read this. You are wasting thousands of hours not fixing this problem EASILY. It takes infinitely more time to set up your IDE than to get some project working. Stop wasting people's time!.

edited Jun 6, 2022 at 12:13

Ethan

1,0288 gold badges18 silver badges30 bronze badges

answered Jun 5, 2022 at 22:13

user3814004

1591 silver badge11 bronze badges

Comments

windyvation · Accepted Answer · 2023-12-22 22:30:32Z

0

Similar to @anna madsen, I changed my python interpreter.

Then, when I tried to run a python file that imported a .py file from a different folder, that didn’t work when I tried via the vscode terminal.

However, when I opened the .py file and ran it from the menu Run > Run Without Debugging, then this worked.

And now, when I run the file from the vscode terminal, that works too. There may have been some initialization by running the file from the run menu that fixed whatever my setup gap was.

answered Dec 22, 2023 at 22:30

windyvation

5813 silver badges16 bronze badges

Collectives™ on Stack Overflow

vscode import error for python module

12 Answers 12

6 Comments

3 Comments

1 Comment

1 Comment

Comments

1 Comment

Comments

Comments

1 Comment

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

12 Answers 12

6 Comments

3 Comments

1 Comment

1 Comment

Comments

1 Comment

Comments

Comments

1 Comment

Comments

Comments

Comments

Linked

Related