Visitar URL original
Assign lower completion ranking to deprecated names in auto import by Glyphack · Pull Request #23188 · astral-sh/ruff · GitHub
Skip to content

Assign lower completion ranking to deprecated names in auto import - #23188

Merged
BurntSushi merged 4 commits into
astral-sh:mainfrom
Glyphack:auto-import-cmp-deprecated
Feb 11, 2026
Merged

Assign lower completion ranking to deprecated names in auto import#23188
BurntSushi merged 4 commits into
astral-sh:mainfrom
Glyphack:auto-import-cmp-deprecated

Conversation

@Glyphack

@Glyphack Glyphack commented Feb 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

Follow up to #23089 this PR assigns lower completion ranking to deprecated names in auto import suggestions.
The implementation relies on finding a decorator named deprecated in the source code ton consider that name deprecated.

Fixes astral-sh/ty#2654 for real :)

Test Plan

Added another test case for this.

I could not find an

Here's how the behavior changed:

Before:

abstractc

AbstractAsyncContextManager (module: contextlib)
AbstractBasicAuthHandler (module: urllib.request)
AbstractChildWatcher (module: asyncio)
AbstractContextManager (module: contextlib)
AbstractEventLoopPolicy (module: asyncio)
abstractclassmethod (module: abc)
abstractstaticmethod (module: abc)

After:

AbstractAsyncContextManager (module: contextlib)
AbstractBasicAuthHandler (module: urllib.request)
AbstractContextManager (module: contextlib) (*, 3/7)
AbstractEventLoopPolicy (module: asyncio)
AbstractChildWatcher (module: asyncio)
abstractclassmethod (module: abc)
abstractstaticmethod (module: abc)

@AlexWaygood AlexWaygood added server Related to the Ruff or ty LSP server ty The ty type checker labels Feb 9, 2026
@Glyphack
Glyphack marked this pull request as ready for review February 10, 2026 16:39
BurntSushi
BurntSushi requested changes Feb 10, 2026
View reviewed changes

@BurntSushi BurntSushi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! That was easy. This LGTM with a unit test in crates/ty_ide/src/symbols.rs. You'll probably want to add a helper method PublicTest::exports that returns a &FlatSymbols (see PublicTest::exports_for). Then you can iterate over it and check whether the symbols it contains are deprecated.

@AlexWaygood
AlexWaygood removed their request for review February 10, 2026 19:35
@Glyphack
Used a test that better represents playground
78d1ede 
In playground this term abstractc is autocompleted to
AbstractContextManager but in the ty_completion_eval this is option 3.
Nevertheless I'm using that because I expect that to show up higher
and this case actually breaks the test case if we don't have the
deprecated functionality.
@Glyphack
Add unit test for deprecated detection
7c45068
@Glyphack

Glyphack commented Feb 10, 2026

Copy link
Copy Markdown
Contributor Author

The name PublicTest::exports was already taken (if I understand correctly that you wanted to create that function) it was returning the str of the exports. So I created a new function PublicTest::exported_symbols instead that returns the FlatSymbols.

BurntSushi
BurntSushi approved these changes Feb 11, 2026
View reviewed changes

@BurntSushi BurntSushi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yeah, perfect!

@BurntSushi
BurntSushi merged commit 9ba7c4a into astral-sh:main Feb 11, 2026
46 checks passed
@Glyphack
Glyphack deleted the auto-import-cmp-deprecated branch February 11, 2026 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BurntSushi BurntSushi BurntSushi approved these changes
@carljm carljm Awaiting requested review from carljm
@MichaReiser MichaReiser Awaiting requested review from MichaReiser
@sharkdp sharkdp Awaiting requested review from sharkdp
@dcreager dcreager Awaiting requested review from dcreager
@Gankra Gankra Awaiting requested review from Gankra

Assignees

No one assigned

Labels

server Related to the Ruff or ty LSP server ty The ty type checker

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[completions] Down-rank deprecated symbols

3 participants

@Glyphack @BurntSushi @AlexWaygood