[ty] Double click to insert inlay hint by MatthewMckee4 · Pull Request #21600 · astral-sh/ruff

MatthewMckee4 · 2025-11-24T00:14:32Z

Summary

Resolves astral-sh/ty#317 (comment).

I can't get the auto import working great.

I haven't added many places where we specify that the type display is invalid syntax.

Test Plan

Nothing yet

astral-sh-bot · 2025-11-24T00:16:49Z

Diagnostic diff on typing conformance tests

No changes detected when running ty on typing conformance tests ✅

astral-sh-bot · 2025-11-24T00:18:13Z

`mypy_primer` results

No ecosystem changes detected ✅

No memory usage changes detected ✅

MatthewMckee4 · 2025-11-24T00:20:24Z

crates/ty_ide/src/inlay_hints.rs

+                        let Some(definition_name) = definition.name(db) else {
+                            continue;
+                        };


This causes issues for some definition kinds, like Unknown.

Gankra · 2025-11-24T14:43:35Z

The parts that aren't the auto-import stuff look reasonable to me (just not as familiar with auto-import stuff).

Might make sense to have the auto-import stuff be a follow-up?

MatthewMckee4 · 2025-11-24T15:25:38Z

Yes, I agree. Perhaps @BurntSushi would be able to advise or help with the auto import?

I can remove the auto import for now.

Perhaps we can put this behind a experimental flag for now also?

I will also try to add more invalid syntax places.

I also think it would be useful if we had alternative display for types that emit invalid synatx, like I'd still like to add a function signature with Callable notation.
This also seems like something we can just iterate on.

Gankra · 2025-11-24T15:28:13Z

Perhaps we can put this behind a experimental flag for now also?

I'm on the fence about it because you can just... not double-click (and undo if you do). I think we can land the minimal implementation and then disable/flag it if it's a problem for some reason.

This also seems like something we can just iterate on.

Yeah agreed.

Gankra · 2025-11-24T15:29:27Z

I don't think it's strictly a blocker to not catch all the invalid syntax. It's something we'll probably burn down really fast in followups and the only stakes is a user getting mad that a feature they manually invoked did something useless.

Gankra · 2025-11-24T15:30:33Z

Actually ok I think it's slightly higher stakes -- "user gets very confused" is probably more likely. But still, followups.

MatthewMckee4 · 2025-11-24T15:31:27Z

I'm on the fence about it because you can just... not double-click

true, but at least for now if you double click on some type with a todo type, its looks horribly and not an amazing experience.

Though, we may not get the user feedback about missing invalid syntax types if we hid it.

Happy to keep it open now, and let the issues trickle in.

BurntSushi · 2025-11-24T15:31:34Z

crates/ty_ide/src/inlay_hints.rs

+                                    new_text: (*content).to_string(),
+                                });
+                            }
+                        }


What you have here looks reasonable to me. What's going wrong?

I will review more tonight. But off the top of my head.

T[: typing.TypeVar] = TypeVar("T")

the definition name is TypeVar so we from typing import TypeVar for example, but this doesnt help us. as we now have the annotation : typing.TypeVar.

Obviously not a great example because we should not type hint TypeVar (also a good place to not allow insert option`.

But for other types this would cause problems.

So its mostly an issue with the names.

Oh I see. You might need to use ImportAction::symbol_text, since the import might need to be fully qualified for correctness in some cases.

With that said, I think the specific issue you're hitting is that you're always requesting a from import statement via ImportRequest::import_from. If you want to respect an existing qualified import, then you'll want ImportRequest::import. So you'll probably need to detect which one you have and then use the right request. (Note though that it is only a request. So you still need to use ImportAction::symbol_text.)

I built the importer API with completions in mind. It might make sense to change ImportAction::symbol_text to return an Edit instead of a &str for your use case.

Okay, thanks. I'll leave this out for this PR i think, and have a go at it separately.

One thing i am thinking is that I don't know how many different formats of types we have like this. If it were just TypeVar and typing.TypeVar I could easily distinguish between them, but I don't know other ways this could show.

FWIW, T: TypeVar = TypeVar("T") is an invalid TypeVar declaration that ty will complain about, so we maybe shouldn't be offering a code action to add that to the user's code 😅

Gankra · 2025-11-24T15:40:29Z

A rough heuristic for invalid syntax that will let you find most things: i believe (, ), <, >, ' are all invalid in type syntax (idk if ' is stricly invalid but anywhere we explicitly emit it we're doing type crimes).

MatthewMckee4 · 2025-11-24T15:44:48Z

Nice okay, do you think its worth it for us to scan over the label after getting the TypeDetails to check for invalid characters? Or should i just search for them in the display.rs file and manually set them to all be invalid

Gankra · 2025-11-24T15:47:34Z

It's really tempting to just do the contains but I think it's probably best to mark up our code in display.rs yeah.

MatthewMckee4 · 2025-11-24T16:35:09Z

Is it ridiculous to try to make some property tests for this?

testing that after the edits have been accepted, that we have valid python syntax? And possibly no diagnostics on the file?

Gankra · 2025-11-24T16:37:18Z

More tests is more better, I would have been lazy and just snapshot-tested like the rest of the IDE stuff 😅

MatthewMckee4 · 2025-11-24T16:38:21Z

I will try it then, see how it goes.

Gankra · 2025-11-24T16:44:05Z

I will say we have a release tomorrow and I'd love to get some version of this PR in for that release (not a huge deal if not but I think this will really solidify inlay hints as Useful).

crates/ty_ide/src/inlay_hints.rs

Gankra

Rad! Just a few nits.

Gankra · 2025-11-24T19:01:41Z

crates/ty_ide/src/inlay_hints.rs

+fn dont_allow_edits(stmt_assign: &ruff_python_ast::StmtAssign) -> bool {
+    if stmt_assign.targets.len() > 1 {
+        return true;
+    }


Oh great call on this -- I might also call this is_valid_syntax, since that's ultimately the crux?

I guess its "if we add an annotation is it valid syntax".

But I'm not sure how to name that, "is_valid_syntax" doesn't seem exactly correct.

annotations_are_valid_syntax?

Gankra · 2025-11-24T19:04:27Z

crates/ty_ide/src/inlay_hints.rs

+        class F:
+            @property
+            def whatever(self): ...
+
+        ab: property = F.whatever


(can be a followup) i have a sneaking suspicion this is a fake type

yeah this didnt look great

Gankra · 2025-11-24T19:08:39Z

crates/ty_python_semantic/src/types/definition.rs

+impl<'db> TypeDefinition<'db> {
+    pub fn definition<'a>(&'a self) -> Option<&'a Definition<'db>> {
+        match self {
+            Self::Module(_) => None,
+            Self::Class(definition)
+            | Self::Function(definition)
+            | Self::TypeVar(definition)
+            | Self::TypeAlias(definition)
+            | Self::SpecialForm(definition)
+            | Self::NewType(definition) => Some(definition),
+        }
+    }
+}


Is this code from the auto-import stuff?

yeah, will remove, thanks

Gankra · 2025-11-24T20:01:13Z

Hell yes hell yeah let's kick this things tires

…d-typevar * origin/main: (30 commits) [ty] Double click to insert inlay hint (#21600) [ty] Switch the error code from `unresolved-attribute` to `possibly-missing-attribute` for submodules that may not be available (#21618) [ty] Substitute for `typing.Self` when checking protocol members (#21569) [ty] Don't suggest things that aren't subclasses of `BaseException` after `raise` [ty] Add hint about resolved Python version when a user attempts to import a member added on a newer version (#21615) Use release commit for actions/checkout (#21610) [ty] Add failing mdtest for known `Protocol` panic (#21594) [`parser`] Fix panic when parsing IPython escape command expressions (#21480) Fix cargo shear in CI (#21609) Update actions/checkout digest to c2d88d3 (#21601) Update dependency ruff to v0.14.6 (#21603) Update astral-sh/setup-uv action to v7.1.4 (#21602) Update Rust crate clap to v4.5.53 (#21604) Update taiki-e/install-action action to v2.62.56 (#21608) Update Rust crate hashbrown to v0.16.1 (#21605) Update Rust crate indexmap to v2.12.1 (#21606) Update Rust crate syn to v2.0.111 (#21607) [ty] Check method definitions on subclasses for Liskov violations (#21436) [ty] Fix panic for unclosed string literal in type annotation position (#21592) [ty] Fix rendering of unused suppression diagnostic (#21580) ...

* main: [ty] Extend Liskov checks to also cover classmethods and staticmethods (astral-sh#21598) Dogfood ty on the `scripts` directory (astral-sh#21617) [ty] support generic aliases in `type[...]`, like `type[C[int]]` (astral-sh#21552) [ty] Retain the function-like-ness of `Callable` types when binding `self` (astral-sh#21614) [ty] Distinguish "unconstrained" from "constrained to any type" (astral-sh#21539) Disable ty workspace diagnostics for VSCode users (astral-sh#21620) [ty] Double click to insert inlay hint (astral-sh#21600) [ty] Switch the error code from `unresolved-attribute` to `possibly-missing-attribute` for submodules that may not be available (astral-sh#21618) [ty] Substitute for `typing.Self` when checking protocol members (astral-sh#21569) [ty] Don't suggest things that aren't subclasses of `BaseException` after `raise` [ty] Add hint about resolved Python version when a user attempts to import a member added on a newer version (astral-sh#21615)

MatthewMckee4 added 2 commits November 24, 2025 00:12

Double click to insert inlay hint

8f63139

Update ty server tests

ff49108

MatthewMckee4 commented Nov 24, 2025

View reviewed changes

AlexWaygood changed the title ~~Double click to insert inlay hint~~ [ty] Double click to insert inlay hint Nov 24, 2025

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

BurntSushi reviewed Nov 24, 2025

View reviewed changes

Add tests for file after edits

e280e75

MatthewMckee4 commented Nov 24, 2025

View reviewed changes

crates/ty_ide/src/inlay_hints.rs Outdated Show resolved Hide resolved

MatthewMckee4 added 6 commits November 24, 2025 17:54

Dont allow edits for some assignments

5625e6f

Add test for function inlay hint

f621d94

Add more invalid syntax locations

1537bdb

Add more invalid syntax locations

38f77cc

Remove uv lock

4be8d37

Dont edit generic parameters

4810a5d

MatthewMckee4 marked this pull request as ready for review November 24, 2025 18:22

MatthewMckee4 requested review from AlexWaygood, MichaReiser, carljm, dcreager and sharkdp as code owners November 24, 2025 18:22

Gankra approved these changes Nov 24, 2025

View reviewed changes

Address review

7fa4a55

Gankra enabled auto-merge (squash) November 24, 2025 19:44

Gankra merged commit 6f9265d into astral-sh:main Nov 24, 2025
40 checks passed

MatthewMckee4 deleted the bake-inlay-hints branch December 27, 2025 00:21

Conversation

MatthewMckee4 commented Nov 24, 2025

Summary

Test Plan

Uh oh!

astral-sh-bot bot commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Diagnostic diff on typing conformance tests

Uh oh!

astral-sh-bot bot commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

mypy_primer results

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Gankra commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MatthewMckee4 commented Nov 24, 2025

Uh oh!

Gankra commented Nov 24, 2025

Uh oh!

Gankra commented Nov 24, 2025

Uh oh!

Gankra commented Nov 24, 2025

Uh oh!

MatthewMckee4 commented Nov 24, 2025

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!

Gankra commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MatthewMckee4 commented Nov 24, 2025

Uh oh!

Gankra commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MatthewMckee4 commented Nov 24, 2025

Uh oh!

Gankra commented Nov 24, 2025

Uh oh!

MatthewMckee4 commented Nov 24, 2025

Uh oh!

Gankra commented Nov 24, 2025

Uh oh!

Uh oh!

Gankra left a comment

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!

Uh oh!

Gankra commented Nov 24, 2025

Uh oh!

Reviewers

Assignees

Labels

astral-sh-bot bot commented Nov 24, 2025 •

edited

Loading

astral-sh-bot bot commented Nov 24, 2025 •

edited

Loading

`mypy_primer` results

Gankra commented Nov 24, 2025 •

edited

Loading

Gankra commented Nov 24, 2025 •

edited

Loading

Gankra commented Nov 24, 2025 •

edited

Loading