Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
81 changes: 81 additions & 0 deletions pyrefly/lib/state/lsp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ use ruff_python_ast::ExprName;
use ruff_python_ast::Identifier;
use ruff_python_ast::Keyword;
use ruff_python_ast::ModModule;
use ruff_python_ast::Stmt;
use ruff_python_ast::StmtClassDef;
use ruff_python_ast::StmtImportFrom;
use ruff_python_ast::UnaryOp;
use ruff_python_ast::name::Name;
Expand All @@ -72,6 +74,7 @@ use crate::state::ide::import_regular_import_edit;
use crate::state::ide::insert_import_edit;
use crate::state::ide::key_to_intermediate_definition;
use crate::state::lsp_attributes::AttributeContext;
use crate::state::lsp_attributes::expr_matches_name;
use crate::state::require::Require;
use crate::state::state::CancellableTransaction;
use crate::state::state::Transaction;
Expand Down Expand Up @@ -751,6 +754,74 @@ impl<'a> Transaction<'a> {
}
}

fn refine_keyword_argument_definition_for_class(
&self,
class_def: &StmtClassDef,
param_name: &Identifier,
) -> Option<(TextRange, DefinitionMetadata)> {
let param_id = param_name.id();

// Prefer class field annotations/assignments when present.
for stmt in &class_def.body {
match stmt {
Stmt::AnnAssign(assign) if expr_matches_name(assign.target.as_ref(), param_id) => {
return Some((assign.target.range(), DefinitionMetadata::Attribute));
}
Stmt::Assign(assign) => {
if let Some(target) = assign
.targets
.iter()
.find(|target| expr_matches_name(target, param_id))
{
return Some((target.range(), DefinitionMetadata::Attribute));
}
}
_ => {}
}
}

// Fall back to __init__ parameters if no class field matches.
for stmt in &class_def.body {
if let Stmt::FunctionDef(function_def) = stmt
&& function_def.name.id == dunder::INIT
{
for regular_param in function_def.parameters.args.iter() {
if regular_param.name().id() == param_id {
return Some((
regular_param.name().range(),
DefinitionMetadata::Variable(Some(SymbolKind::Variable)),
));
}
}
for kwonly_param in function_def.parameters.kwonlyargs.iter() {
if kwonly_param.name().id() == param_id {
return Some((
kwonly_param.name().range(),
DefinitionMetadata::Variable(Some(SymbolKind::Variable)),
));
}
}
}
}

None
}

fn refine_keyword_argument_definition_for_callee(
&self,
ast: &ModModule,
callee_range: TextRange,
param_name: &Identifier,
) -> Option<(TextRange, DefinitionMetadata)> {
let covering_nodes = Ast::locate_node(ast, callee_range.start());
match (covering_nodes.first(), covering_nodes.get(1)) {
(Some(AnyNodeRef::Identifier(_)), Some(AnyNodeRef::StmtClassDef(class_def))) => {
self.refine_keyword_argument_definition_for_class(class_def, param_name)
}
_ => None,
}
}

fn definition_at(&self, handle: &Handle, position: TextSize) -> Option<Key> {
self.get_bindings(handle)?
.definition_at_position(position)
Expand Down Expand Up @@ -1554,6 +1625,16 @@ impl<'a> Transaction<'a> {
};

for range in ranges.into_iter() {
if let Some((definition_range, metadata)) = self
.refine_keyword_argument_definition_for_callee(ast.as_ref(), range, identifier)
{
results.push(FindDefinitionItem {
metadata,
definition_range,
module: module_info.dupe(),
});
continue;
}
let refined_param_range =
self.refine_param_location_for_callee(ast.as_ref(), range, identifier);
// TODO(grievejia): Should we filter out unrefinable ranges here?
Expand Down
25 changes: 25 additions & 0 deletions pyrefly/lib/test/lsp/definition.rs
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,31 @@ Definition Result:
);
}

#[test]
fn keyword_argument_test_class_field() {
let code = r#"
class Foo:
x: int

def test() -> None:
Foo(x=1)
# ^
"#;
let report = get_batched_lsp_operations_report_allow_error(&[("main", code)], get_test_report);
assert_eq!(
r#"
# main.py
6 | Foo(x=1)
^
Definition Result:
3 | x: int
^
"#
.trim(),
report.trim(),
);
}

#[test]
fn keyword_argument_test_multiple_methods() {
let code = r#"
Expand Down
Loading