Use a python package in the same project folder in visual studio code

Question

I created my customized package called 'dto' in my project folder. But It does not recognize this package and module.

How can I make my visual studio code to find it?

In Pycharm, if I create new package, it automatically detects that.

I executed my simulator.py script in my simulation package.

Jojin · Answer 1 · 2018-12-14T13:12:18.693

2

From what I can see from the directory tree, you need to use a relative import(python >= 2.5):

from ..dto import price

Here the .. is used to specify that the import should be made from two folders up the current location of the script that is being invoked.

In your case, relative imports cannot be used as the files are in different packages. Please find the relevant post here beyond top level package error in relative import

edited Dec 14 '18 at 13:12

answered Dec 14 '18 at 12:24

Jojin

124
1
8

Thank you for helping me. This error occurred. Exception has occurred: ValueError attempted relative import beyond top-level package File "C:\Users\lich_\Documents\aits\simulation\simulator.py", line 4, in from ..dto import PriceInfo – Antonio SEO Dec 14 '18 at 12:38
Can you check this again?? – Antonio SEO Dec 14 '18 at 12:39
Oops, I might have jumped the gun there. Relative imports cannot be used beyond the current package. I have added the relevant answers to your question in my post. – Jojin Dec 14 '18 at 13:11

Yossarian42 · Accepted Answer · 2019-05-28T09:50:31.697

I have encountered the same problem. It seems visual studio code cannot automatically detect new python package. It has something to do with $PYTHONPATH configuration. I found an official reference from visual studio code documentation. Please have a look at this doc.

adding a dev.env file inside your project

PYTHONPATH=${workspaceFolder}:${PYTHONPATH}

adding the following in your workspace settings.json config file

"python.envFile": "${workspaceFolder}/dev.env"

This works for me. The debugger can find modules in the new package. Hopefully, this will help you.

Timothy C. Quinn · Answer 3 · 2022-04-13T19:33:38.730

@Yossarian42's answer will work if you have a folder with your package name in the root of your project. However if your project follows the structure mentioned in Py-Pkgs and uses a src dir like:

mypkg
├── CHANGELOG.md               ┐
...
├── pyproject.toml             ┐ 
├── src                        │
│   └── mypkg                  │ Package source code, metadata,
│       ├── __init__.py        │ and build instructions 
│       └── mypkg.py           ┘
└── tests                      ┐
    └── ...                    ┘ Package tests
└── examples                   ┐
    ├── mypkg_examples.py      │
    └── ...                    ┘ Package examples

In this case, you use the following for dev.env in your workspaceFolder (root):

PYTHONPATH=./src:${PYTHONPATH}

Create or edit {workspaceFolder}/.vscode/settings.json with:

"python.envFile": "${workspaceFolder}/.env"

Full settings.json example:

{
    "python.envFile": "${workspaceFolder}/dev.env"
}

For debugging the python.envFile setting, you can print out the Python path with the following code:

import sys; print(f"sys.path: {sys.path}")

Use a python package in the same project folder in visual studio code

3 Answers3

Linked