Python ModuleNotFound issue in VSCode

Question

I have an issue with importing modules from a subfolder in my projects main folder.

The project structure is:

project_folder/
|-- main.py
|
|-- tools/
    |-- script.py
|
|-- utils/
    |--__init__.py
    |--misc.py

When I try to import a function from the utils.misc module, I get a ModuleNotFoundError (using VSCode), but I can run the code with no issue when I use Spyder.

The statement I use in script.py to import is:

from utils.misc import my_function

How can I resolve this issue?

Please see a snapshot of the error below:

I have also added ${workpsaceFolder} to cwd configuration, and added the project root folder to the PYTHONPATH in the launch.json file (see below). However the project_folder still fails to show up when I print sys.path.

UPDATE: See the screenshot of the project structure and the error below

Answer 1

Have you changed the cwd(official docs) configuration in the launch.json file? It defaults to ${workspaceFolder}. Then the import you take should work.

Update:

{
      "name": "Python: Current File",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
      "env": {
        "PYTHONPATH": "${workspaceFolder}"
      },
      "cwd": "${workspaceFolder}",
}

Add the env configuration.

Update

  "env": {
    "PYTHONPATH": "${workspaceFolder}"
  },

will not work when you use Code Runner.

Update: You need to run the code with terminal(F5) instead of Code Runner. Or like this:

And make sure save the file before you run the code.

UPDATE: See the screenshot of the project structure and the error below

Answer 2

Just add .env file in the root of your working directory (real_root_dir in my case)

• Opened in VSCode folder is real_root_dir

• Project tree is

real_root_dir
├── .env
├── other_project
│   └── c.py
└── project_root
    ├── a.py
    ├── b
    │   ├── __init__.py
    │   └── b.py
    └── run.py

• content of .env file is

PYTHONPATH=project_root:other_project

• run.py code

from a import A
from b.b import B
from c import C

print(A)
print(B)
print(C)

With this configuration VSCode will find even C and allow to jump into it, but python still don't know about C, so running output will be:

Traceback (most recent call last):
  File "/Users/sergei/temp/real_root_dir/project_root/run.py", line 3, in <module>
    from c import C
ModuleNotFoundError: No module named 'c'

Of course, importing of outside C module is not normal in usual cases.
But A and B will work properly with python interpreter and VSCode both.