Skip to content

PR: Include all symbols that Jedi reports as declared in a file when add_import_symbols is False #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 6, 2022
Merged

PR: Include all symbols that Jedi reports as declared in a file when add_import_symbols is False #261

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e2df82
Improve detection of symbols when add_import_symbols is False
ccordoba12 Sep 5, 2022
0d654c2
Skip relative imports from symbols when add_import_symbols is False
ccordoba12 Sep 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions pylsp/plugins/symbols.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ def pylsp_document_symbols(config, document):

# Skip imported symbols comparing module names.
sym_full_name = d.full_name
document_dot_path = document.dot_path
if sym_full_name is not None:
document_dot_path = document.dot_path

# We assume a symbol is imported from another module to start
# with.
imported_symbol = True
Expand All @@ -48,6 +49,8 @@ def pylsp_document_symbols(config, document):
# we need to discard it to do module comparisons below.
if '.' in sym_full_name:
sym_module_name = sym_full_name.rpartition('.')[0]
else:
sym_module_name = sym_full_name

# This is necessary to display symbols in init files (the checks
# below fail without it).
Expand All @@ -56,9 +59,9 @@ def pylsp_document_symbols(config, document):

# document_dot_path is the module where the symbol is imported,
# whereas sym_module_name is the one where it was declared.
if sym_module_name.startswith(document_dot_path):
# If sym_module_name starts with the same string as document_dot_path,
# we can safely assume it was declared in the document.
if document_dot_path in sym_module_name:
# If document_dot_path is in sym_module_name, we can safely assume
# that the symbol was declared in the document.
imported_symbol = False
elif sym_module_name.split('.')[0] in document_dot_path.split('.'):
# If the first module in sym_module_name is one of the modules in
Expand All @@ -74,10 +77,19 @@ def pylsp_document_symbols(config, document):
# When there's no __init__.py next to a file or in one of its
# parents, the checks above fail. However, Jedi has a nice way
# to tell if the symbol was declared in the same file: if
# full_name starts by __main__.
# sym_module_name starts by __main__.
if imported_symbol:
if not sym_module_name.startswith('__main__'):
continue
else:
# We need to skip symbols if their definition doesn't have `full_name` info, they
# are detected as a definition, but their description (e.g. `class Foo`) doesn't
# match the code where they're detected by Jedi. This happens for relative imports.
if _include_def(d):
if d.description not in d.get_line_code():
continue
else:
continue

try:
docismodule = os.path.samefile(document.path, d.module_path)
Expand Down