autoimport.md

Autoimport for pylsp

Requirements:

1. install python-lsp-server[rope]
2. set pylsp.plugins.rope_autoimport.enabled to true
3. This enables both completions and code actions. You can switch them off by setting pylsp.plugins.rope_autoimport.completions.enabled and/or pylsp.plugins.rope_autoimport.code_actions.enabled to false

Startup

Autoimport will generate an autoimport sqllite3 database in .ropefolder/autoimport.db on startup.
This will take a few seconds but should be much quicker on future runs.

Usage

Autoimport will provide suggestions to import names from everything in sys.path. You can change this by changing where pylsp is running or by setting rope's 'python_path' option. It will suggest modules, submodules, keywords, functions, and classes.

Since autoimport inserts everything towards the end of the import group, its recommended you use the isort plugin.

Credits

• Most of the code was written by me, @bagel897
• lyz-code for inspiration and some ideas
• rope, especially @lieryan
• pyright for details on language server implementation