'Go to definition' prefers root of repo, even if outside of project folder

[sebastian-b]

Environment data

• VS Code version: 1.27.2
• Extension version (available under the Extensions sidebar): 2018.8.0
• OS and version: Mac OS 10.13.6
• Python version (& distribution if applicable, e.g. Anaconda): XXX
• Type of virtual environment used (N/A | venv | virtualenv | conda | ...): conda
• Relevant/affected Python packages and their versions: Python 3.6

Actual behavior

"Go to definition" looks in the wrong path in the root of the repository, when its name matches the file in the currently opened folder.

This only happens, when the project is a subfolder of a repository. If the .git folder is removed, it works as expected.

Maybe this is related to issue 2555? Using the language server with "python.jediEnabled": false also avoids this problem.

Expected behavior

Ignore files in the root of the repository, if outside of project (or reduce priority).

Steps to reproduce:

Given the following folders:

.git
project/
    .vscode/
        settings.json
    main.py
    utils.py
utils.py

1. Open the folder project/ in vscode
2. Open the file main.py
3. Use "Go to definition" on import utils

vscode jumps to /utils.py instead of project/utils.py, even though it is outside the project.

If the /.git folder is removed, it works as expected. Running python main.py works as expected in any case.

Logs

Output for Python in the Output panel (View→Output, change the drop-down the upper-right of the Output panel to Python)

##########Linting Output - pylint##########

--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

Output from Console under the Developer Tools panel (toggle Developer Tools on under Help)

(no output)

[d3r3kk]

Thanks for the report @sebastian-b, and the details you've provided.

Using the language server with "python.jediEnabled": false also avoids this problem.

Is this workaround not a viable solution for you? Could you tell us why, if that is the case?

Otherwise, I believe this is more an issue with jedi than with the extension itself, but we should repro just in case we're doing something wonky here!

[sebastian-b]

Is this workaround not a viable solution for you?

It is! I only saw the workaround after creating the ticket and since this setting was described as experimental, I left the ticket open.

[d3r3kk]

Understood, thanks for letting us know.

[d3r3kk]

I have verified that this does indeed happen when Jedi is enabled.

If I run the script I've created, it runs as expected (picks up the local utils version, not the one located at the workspace root).

Here's my layout:

${workspaceFolder}\utils.py:

def base_util():
    print("base")


def common():
    print("base-common")

${workspaceFolder}/project/utils.py:

def project_utils():
    pass


def common():
    print("project-common")

${workspaceFolder}/project/main.py:

import utils

utils.common()

From the terminal, if I run this I see:

dekeeler@dek-laptop-lnx:~/dev/github/d3r3kk/test/2585_jedi_navigation_oddity$ python3 project/main.py
project-common

But if I use Go to definition inside of main.py on the call to utils.common (line 3), I get taken to the ${workspaceFolder}/utils.py version of the function.

[d3r3kk]

Files that we potentially need to diagnose:
pythonFiles/completion.py
src/client/providers/jediProxy.ts

Hypothesis: We are finding the definitions for both (all) functions/libs but are only using the first one found to jump to.

[lig]

@d3r3kk I've found that currently, it is worse than that. Not sure if it should be reported as a separate issue.

If I have flask or tensorflow installed in the project's virtualenv which both have logging module inside their namespaces "Go to definition" on import logging will open flask/logging.py or tensorflow/logging.py instead of logging from the stdlib.