Skip to content

Fix: LSP import completions with trailing spaces and builtin filtering (#1704) #1712

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+354 −42
Open

Fix: LSP import completions with trailing spaces and builtin filtering (#1704) #1712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a76d9f0
Fix wrong import suggestions from builtins (#1704)
vinismarques Nov 28, 2025
8390af0
Fix LSP completion for import statements with trailing whitespace
vinismarques Nov 29, 2025
f803932
Refactor: Address clippy warnings in lsp.rs
vinismarques Nov 29, 2025
8b8e907
Docs: Fix typo in CONTRIBUTING.md
vinismarques Nov 29, 2025
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ reproduction.
Once you have a minimal reproducible example of the bug, create a failing test
for it, so you can easily run it and verify that the bug still exists while you
work on tracking down the root cause and fix the issue. See the section above on
testing and place yout reproducible examples in the appropriate test file or
testing and place your reproducible examples in the appropriate test file or
create a new one.

### Print debugging
Expand Down
190 changes: 149 additions & 41 deletions pyrefly/lib/state/lsp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2629,6 +2629,60 @@ impl<'a> Transaction<'a> {
}
}

fn add_module_exports_completions(
&self,
handle: &Handle,
module_name: ModuleName,
completions: &mut Vec<CompletionItem>,
) {
if let Some(handle) = self.import_handle(handle, module_name, None).finding() {
let exports = self.get_exports(&handle);
for (name, export) in exports.iter() {
// Filter out implicitly re-exported builtins
if let ExportLocation::OtherModule(module, _) = &export
&& (*module == ModuleName::builtins()
|| *module == ModuleName::extra_builtins())
{
continue;
}
let is_deprecated = match export {
ExportLocation::ThisModule(export) => export.deprecation.is_some(),
ExportLocation::OtherModule(_, _) => false,
};
completions.push(CompletionItem {
label: name.to_string(),
// todo(kylei): completion kind for exports
kind: Some(CompletionItemKind::VARIABLE),
tags: if is_deprecated {
Some(vec![CompletionItemTag::DEPRECATED])
} else {
None
},
..Default::default()
})
}
}
}

fn add_all_modules_completions(&self, handle: &Handle, completions: &mut Vec<CompletionItem>) {
let mut seen_root_modules = std::collections::HashSet::new();
for module_name in self.modules() {
if module_name == handle.module() {
continue;
}
let root_module_name = module_name.first_component();
let root_module_str = root_module_name.as_str();

if seen_root_modules.insert(root_module_str.to_owned()) {
completions.push(CompletionItem {
label: root_module_str.to_owned(),
kind: Some(CompletionItemKind::MODULE),
..Default::default()
});
}
}
}

// Kept for backwards compatibility - used by external callers (lsp/server.rs, playground.rs)
// who don't need the is_incomplete flag
pub fn completion(
Expand Down Expand Up @@ -2711,35 +2765,16 @@ impl<'a> Transaction<'a> {
identifier,
context: IdentifierContext::ImportedName { module_name, .. },
}) => {
if let Some(handle) = self.import_handle(handle, module_name, None).finding() {
// Because of parser error recovery, `from x impo...` looks like `from x import impo...`
// If the user might be typing the `import` keyword, add that as an autocomplete option.
if "import".starts_with(identifier.as_str()) {
result.push(CompletionItem {
label: "import".to_owned(),
kind: Some(CompletionItemKind::KEYWORD),
..Default::default()
})
}
let exports = self.get_exports(&handle);
for (name, export) in exports.iter() {
let is_deprecated = match export {
ExportLocation::ThisModule(export) => export.deprecation.is_some(),
ExportLocation::OtherModule(_, _) => false,
};
result.push(CompletionItem {
label: name.to_string(),
// todo(kylei): completion kind for exports
kind: Some(CompletionItemKind::VARIABLE),
tags: if is_deprecated {
Some(vec![CompletionItemTag::DEPRECATED])
} else {
None
},
..Default::default()
})
}
// Because of parser error recovery, `from x impo...` looks like `from x import impo...`
// If the user might be typing the `import` keyword, add that as an autocomplete option.
if "import".starts_with(identifier.as_str()) {
result.push(CompletionItem {
label: "import".to_owned(),
kind: Some(CompletionItemKind::KEYWORD),
..Default::default()
})
}
self.add_module_exports_completions(handle, module_name, &mut result);
}
// TODO: Handle relative import (via ModuleName::new_maybe_relative)
Some(IdentifierWithContext {
Expand Down Expand Up @@ -2838,24 +2873,97 @@ impl<'a> Transaction<'a> {
// todo(kylei): optimization, avoid duplicate ast walks
if let Some(mod_module) = self.get_ast(handle) {
let nodes = Ast::locate_node(&mod_module, position);

// If no node covers the current position, try to find a preceding import statement
let mut processed_as_import_statement = false;
if nodes.is_empty() {
for stmt in mod_module.body.iter().rev() {
let stmt_end = stmt.range().end();
if stmt_end <= position {
let text_after_stmt =
if let Some(module_info) = self.get_module_info(handle) {
module_info
.code_at(TextRange::new(stmt_end, position))
.to_owned()
} else {
"".to_owned()
};

if text_after_stmt.trim().is_empty()
&& !text_after_stmt.contains('\n')
{
match stmt {
ruff_python_ast::Stmt::ImportFrom(import_from) => {
// `from ... import <cursor>`
if let Some(module) = &import_from.module
&& position >= module.range().end()
{
self.add_module_exports_completions(
handle,
ModuleName::from_str(module.as_str()),
&mut result,
);
processed_as_import_statement = true;
}
}
ruff_python_ast::Stmt::Import(_) => {
// `import <cursor>`
self.add_all_modules_completions(handle, &mut result);
processed_as_import_statement = true;
}
_ => {}
}
}
break; // Found the most relevant preceding statement
}
}
}

if !processed_as_import_statement && nodes.is_empty() {
self.add_keyword_completions(handle, &mut result);
self.add_local_variable_completions(handle, None, position, &mut result);
self.add_builtins_autoimport_completions(handle, None, &mut result);
}
self.add_literal_completions(handle, position, &mut result);
self.add_dict_key_completions(
handle,
mod_module.as_ref(),
position,
&mut result,
);
// in foo(x=<>, y=2<>), the first containing node is AnyNodeRef::Arguments(_)
// in foo(<>), the first containing node is AnyNodeRef::ExprCall
if let Some(first) = nodes.first()
&& matches!(first, AnyNodeRef::ExprCall(_) | AnyNodeRef::Arguments(_))
{
self.add_kwargs_completions(handle, position, &mut result);

// Original logic for when nodes are found, or after fallback if not processed as import
if let Some(first) = nodes.first() {
match first {
AnyNodeRef::StmtImportFrom(import_from) => {
// `from ... import <cursor>`
if let Some(module) = &import_from.module
&& position >= module.range().end()
{
self.add_module_exports_completions(
handle,
ModuleName::from_str(module.as_str()),
&mut result,
);
}
}
AnyNodeRef::StmtImport(_) => {
// `import <cursor>`
self.add_all_modules_completions(handle, &mut result);
}
_ => {}
}
}

// Remaining general completions if no specific import context was found or handled
if !processed_as_import_statement || !nodes.is_empty() {
self.add_literal_completions(handle, position, &mut result);
self.add_dict_key_completions(
handle,
mod_module.as_ref(),
position,
&mut result,
);
// in foo(x=<>, y=2<>), the first containing node is AnyNodeRef::Arguments(_)
// in foo(<>), the first containing node is AnyNodeRef::ExprCall
if let Some(first) = nodes.first()
&& matches!(first, AnyNodeRef::ExprCall(_) | AnyNodeRef::Arguments(_))
{
self.add_kwargs_completions(handle, position, &mut result);
}
}
}
}
Expand Down
Loading