[ty] Add inlay hints for call arguments by MatthewMckee4 · Pull Request #19269 · astral-sh/ruff

MatthewMckee4 · 2025-07-10T18:04:33Z

Summary

Add function argument inlay hints.

Note that the inlay hints here have the structure {name}= instead of {name}: for rust. I think this makes more sense for python.

As you can see I have made lots of visibility modifiers public. I don't want to do this, but I have for an initial showcase of this feature.

If anyone can advise on a better solution (maybe some function inside the ty_python_semantic crate) that would be greatly appreciated.

Test Plan

Add tests to ty_ide/src/inlay_hints.rs.

MatthewMckee4 · 2025-07-10T18:05:01Z

Will mark this as ready for review for some initial feedback

github-actions · 2025-07-10T18:08:15Z

`mypy_primer` results

No ecosystem changes detected ✅
No memory usage changes detected ✅

crates/ty_ide/src/inlay_hints.rs

MichaReiser · 2025-07-11T07:23:37Z

crates/ty_ide/src/inlay_hints.rs

+                let call_ty = call.func.inferred_type(&self.model).into_callable(self.db);
+                if let Some(Type::Callable(callable)) = call_ty {
+                    let first_signature = callable.signatures(self.db).into_iter().next().cloned();
+                    if let Some(signature) = first_signature {


I think we need to match the signature here to resolve the best matching overload or it will show incorrect results for overloads

Yeah that makes sense, I just took the first one for initial demonstration. I'll look into to how to do that

It could make sense to take a look at the signature_help implementation which does something very similar.

Okay thank you

This works well, but it also provides inlay hints for positional only, variadic and keyword_variadic, which i don't think we want

Fixed that now

MichaReiser · 2025-07-11T07:24:11Z

crates/ty_python_semantic/src/types.rs

-            }
+            Type::ClassLiteral(class_literal) => ClassType::NonGeneric(class_literal)
+                .into_callable(db)
+                .into_callable(db),


Huh, why do we need to call into_callable twice. This looks fairly odd

ClassLiteral.into_callable can return bound methods, I agree it looks weird, maybe I should change the class literal function instead to convert them

I have added more into_callable calls in ClassLiteral.into_callable

MatthewMckee4 · 2025-07-11T20:05:53Z

This doesn't seem to work well with overloads. Seems to be because of one of the internal functions from bindings maybe

MatthewMckee4 · 2025-07-24T23:24:13Z

@MichaReiser what are you're thoughts on this PR, what more would you like to see?

Also, is this something we really want?

dhruvmanila · 2025-08-07T14:14:15Z

We can now also gate this behind an option similar to what @dhruvmanila did in #19780

For reference, this is what Python extension provides:

  // Enable/disable inlay hints for call argument names:
  // ```python
  // datetime('year='2019, 'month='10, 'day='27)
  // ```
  // 
  //  - off: Disable inlay hints for call argument names.
  //  - partial: Enable inlay hints for positional-or-keyword arguments while ignoring positional-only and keyword-only.
  //  - all: Enable inlay hints for positional-or-keyword and positional-only arguments while ignoring keyword-only.
  "python.analysis.inlayHints.callArgumentNames": "off",

For now, we can just start with a boolean true / false but the "partial" does seem interesting although not sure about usage metrics.

MatthewMckee4 · 2025-08-07T17:47:15Z

Cool, thanks. To be honest I didn't know the python extension provided this

MatthewMckee4 · 2025-08-07T17:53:48Z

Should we start with Boolean for all inlay hints or for both call arguments and assignments

MichaReiser · 2025-08-08T07:49:29Z

Should we start with Boolean for all inlay hints or for both call arguments and assignments

I suggest following pylance's approach with a separate boolean option for each (we can change it to a non boolean option in the future)

Have you looked into what other Python language servers (e.g. pylance) do here?

Were you able to find out how pylance handle call argument names (e.g. how they're formatted?)

MatthewMckee4 · 2025-08-08T08:17:08Z

They do it like it is done in this PR.

They also have some guard that prevents argument names prefixed with "_" being displayed, that seems beneficial to add here

MichaReiser · 2025-08-11T14:24:59Z

Just checking in (no pressure). Is this waiting on any input from my end?

MatthewMckee4 · 2025-08-11T20:44:13Z

Sorry, no not really, I just haven't got to doing what I said was beneficial.

I'll get that done, then I think I'm happy with this.

MichaReiser · 2025-08-12T06:39:35Z

Okay, no worries. I just wanted to make sure it isn't blocked on me.

MatthewMckee4 · 2025-08-12T13:46:16Z

Okay, that's all the changes I think i need to make

MichaReiser · 2025-08-12T14:21:00Z

Again, this is great. Thank you. I'm not yet sure how many inlay hints we want to enable in the playground but that's something we can easily tune

* main: Don't cache files with diagnostics (#19869) [ty] support recursive type aliases (#19805) [ty] Remove unsafe `salsa::Update` implementations in `tuple.rs` (#19880) [ty] Function argument inlay hints (#19269) [ty] Remove Salsa interning for `TypedDictType` (#19879) Fix `lint.future-annotations` link (#19876) [ty] Reduce memory usage of `TupleSpec` and `TupleType` (#19872) [ty] Track heap usage of salsa structs (#19790) Update salsa to pull in tracked struct changes (#19843) [ty] simplify CycleDetector::visit signature (#19873) [ty] use interior mutability in type visitors (#19871) [ty] Fix tool name is None when no ty path is given in ty_benchmark (#19870) [ty] Remove `Type::Tuple` (#19669) [ty] Short circuit `ReachabilityConstraints::analyze_single` for dynamic types (#19867)

…aints * dcreager/inferrable: (65 commits) this was right after all mark typevars inferrable as we go fix tests fix inference of constrained typevars [ty] Add precise inference for indexing, slicing and unpacking `NamedTuple` instances (#19560) Add rule code to GitLab description (#19896) [ty] render docstrings in hover (#19882) [ty] simplify return type of place_from_declarations (#19884) [ty] Various minor cleanups to tuple internals (#19891) [ty] Improve `sys.version_info` special casing (#19894) Don't cache files with diagnostics (#19869) [ty] support recursive type aliases (#19805) [ty] Remove unsafe `salsa::Update` implementations in `tuple.rs` (#19880) [ty] Function argument inlay hints (#19269) [ty] Remove Salsa interning for `TypedDictType` (#19879) Fix `lint.future-annotations` link (#19876) [ty] Reduce memory usage of `TupleSpec` and `TupleType` (#19872) [ty] Track heap usage of salsa structs (#19790) Update salsa to pull in tracked struct changes (#19843) [ty] simplify CycleDetector::visit signature (#19873) ...

## Summary Related to astral-sh/ruff#19269, this PR defines the `ty.inlayHints.callArgumentNames` setting in the VS Code extension.

Start on function argument inlay hints

d86ed68

MatthewMckee4 marked this pull request as ready for review July 10, 2025 18:05

MatthewMckee4 requested review from AlexWaygood, MichaReiser, carljm, dcreager and sharkdp as code owners July 10, 2025 18:05

AlexWaygood added server Related to the LSP server ty Multi-file analysis & type inference labels Jul 10, 2025

Add more tests

a7888bc

AlexWaygood removed their request for review July 10, 2025 19:39

MichaReiser reviewed Jul 11, 2025

View reviewed changes

MatthewMckee4 added 9 commits July 11, 2025 19:32

Merge branch 'main' into function-argument-inlay-hints

85c8edc

Refactor

e085a26

remove package lock

8c2b0bb

Add back package lock

2fceb71

Add back package lock

b48bccd

Rename functions

c84a058

Rename functions

281a33b

Fix modifier

8a6348e

Add range test

00c0a12

MichaReiser marked this pull request as draft July 14, 2025 07:51

MatthewMckee4 added 2 commits July 25, 2025 00:19

Merge branch 'main' into function-argument-inlay-hints

cbbc682

Fix

6e76b93

MatthewMckee4 added 2 commits July 25, 2025 00:26

Fix clippy

39b5971

Merge branch 'main' into function-argument-inlay-hints

c98db8a

MatthewMckee4 added 3 commits August 7, 2025 20:32

Dont sort arguments

708ada9

merge main

6153293

Update settings

4e07927

MatthewMckee4 requested a review from MichaReiser August 7, 2025 19:42

MatthewMckee4 added 2 commits August 7, 2025 21:26

Remove useless matches

7bd45cc

Fix clippy

b112938

MatthewMckee4 added 3 commits August 11, 2025 21:47

Don't include argument names that are prefixed with _

02f7d9a

Merge branch 'main' into function-argument-inlay-hints

64970f3

Fix test

6d34023

MatthewMckee4 added 2 commits August 12, 2025 14:43

Update tests

397d8ae

Update argument names

1ac9599

Merge branch 'main' into function-argument-inlay-hints

ac7cca1

MichaReiser enabled auto-merge (squash) August 12, 2025 13:55

MichaReiser merged commit ad28b80 into astral-sh:main Aug 12, 2025
37 checks passed

MatthewMckee4 deleted the function-argument-inlay-hints branch August 12, 2025 13:57

dhruvmanila mentioned this pull request Aug 14, 2025

Add ty.inlayHints.callArgumentNames config option astral-sh/ty-vscode#119

Merged

dhruvmanila changed the title ~~[ty] Function argument inlay hints~~ [ty] Add inlay hints for call arguments Aug 14, 2025

dhruvmanila added a commit to astral-sh/ty-vscode that referenced this pull request Aug 14, 2025

Add ty.inlayHints.callArgumentNames config option (#119)

4c1cf36

## Summary Related to astral-sh/ruff#19269, this PR defines the `ty.inlayHints.callArgumentNames` setting in the VS Code extension.

Comments

Conversation

MatthewMckee4 commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Uh oh!

MatthewMckee4 commented Jul 10, 2025

Uh oh!

github-actions bot commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

mypy_primer results

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MatthewMckee4 commented Jul 11, 2025

Uh oh!

MatthewMckee4 commented Jul 24, 2025

Uh oh!

dhruvmanila commented Aug 7, 2025

Uh oh!

MatthewMckee4 commented Aug 7, 2025

Uh oh!

MatthewMckee4 commented Aug 7, 2025

Uh oh!

MichaReiser commented Aug 8, 2025

Uh oh!

MatthewMckee4 commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MichaReiser commented Aug 11, 2025

Uh oh!

MatthewMckee4 commented Aug 11, 2025

Uh oh!

MichaReiser commented Aug 12, 2025

Uh oh!

MatthewMckee4 commented Aug 12, 2025

Uh oh!

Uh oh!

MichaReiser commented Aug 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MatthewMckee4 commented Jul 10, 2025 •

edited

Loading

github-actions bot commented Jul 10, 2025 •

edited

Loading

`mypy_primer` results

MatthewMckee4 commented Aug 8, 2025 •

edited

Loading