Unable to import modules from root folder if python.autoComplete.extraPaths is set

[DumDumin]

Environment data

• VS Code version: 1.37.1
• Extension version (available under the Extensions sidebar): 2019.8.30787
• OS and version: Windows 10, version 1903
• Python version (& distribution if applicable, e.g. Anaconda): 3.6.8
• Type of virtual environment used (N/A | venv | virtualenv | conda | ...): N/A
• Relevant/affected Python packages and their versions: XXX
• Jedi or Language Server? Language Server

Expected behaviour

I have the following folder structur:

• projectFolder
  • src
    • _ init_.py
    • main.py
    • subfolder
      • _ init_.py
      • xyz.py
  • tests
    • _ init_.py
    • some_test.py

I added
"python.autoComplete.extraPaths": [ "./src" ],
to my settings.json to get autocompletion in main.py for
from subfolder import xyz

In my test folder I still need to import modules from root with
from src.subfolder import xyz
to let them run correctly.

I would expect to get autocompletion in both cases.

Actual behaviour

But I won't get any autocompletion anymore in my test files, only unresolved reference.
unresolved import 'src.subfolder'Python(unresolved-import)

from subfolder import xyz
gives me autocompletion, but the tests cannot run due to real unresolved imports

I also tried
"python.autoComplete.extraPaths": [ ".", "./src" ],
without any luck.

[jakebailey]

Does it work if the __init__.py is removed from src? I'm not entirely certain the __init__.py files are required in either src or tests, as they imply that they're intended to be imported themselves.

[DumDumin]

I need both init files.

What I do now is to add the src path in the test init.py

import os 
import sys 
cwd = os.getcwd() 
sys.path.append(cwd + './src') 

this allows me to use the the autocompletion in the test files and ensures correct importing when pytest runs the tests

[jakebailey]

Setting PYTHONPATH might be another option, rather than an at-runtime sys.path modification.

Either way, I'd still appreciate it if you could test the behavior when those files are removed. Autocompletion should be fine in the test files so long as you've used extraPaths (as you've previously stated).

[CTrando]

I tried this out as well, but shouldn't putting an extra path of "." work? On user paths I didn't see "." get resolved to the workspace root. Is this intended on our part?

[jakebailey]

. is filtered. That's already the workspace root, which is added implicitly.

[CTrando]

If the workspace root is added implicitly then shouldn't src.subfolder work fine?

[jakebailey]

I guess I misread the issue. Importing src.subfolder is really strange and shouldn't be done. All projects I have seen with src use that folder as the main import root, then use PYTHONPATH or some other mechanism to change things, and still have pytest working. Otherwise, it's not well constructed and may want to be rewritten to not do import src.subfolder. An example is: https://github.com/fsfe/reuse-tool

Our import root carving behavior means that if subfolder is marked as an import root, it is no longer importable as src.subfolder. This isn't correct, and is tracked in a few other issues being worked on.

[CTrando]

I see, so what should be done is setting PYTHONPATH such that from the test folder it can do import subfolder succesfully.