Add a plugin to provide autoimport functionality

CONFIGURATION.md

@@ -59,7 +59,7 @@ This server can be configured using `workspace/didChangeConfiguration` method. E
 | `pylsp.plugins.pylint.args` | `array`  of non-unique `string` items | Arguments to pass to pylint. | `null` |
 | `pylsp.plugins.pylint.executable` | `string` | Executable to run pylint with. Enabling this will run pylint on unsaved files via stdin. Can slow down workflow. Only works with python3. | `null` |
 | `pylsp.plugins.rope_completion.enabled` | `boolean` | Enable or disable the plugin. | `false` |
-| `pylsp.plugins.rope_autoimport.enabled` | `boolean` | Enable or disable the plugin. | `true` |
+| `pylsp.plugins.rope_autoimport.enabled` | `boolean` | Enable or disable the plugin. | `false` |
 | `pylsp.plugins.rope_completion.eager` | `boolean` | Resolve documentation and detail eagerly. | `false` |
 | `pylsp.plugins.yapf.enabled` | `boolean` | Enable or disable the plugin. | `true` |
 | `pylsp.rope.extensionModules` | `string` | Builtin and c-extension modules that are allowed to be imported and inspected by rope. | `null` |

README.md

@@ -95,6 +95,7 @@ As an example, to change the list of errors that pycodestyle will ignore, assumi
 ## LSP Server Features
 
 * Auto Completion
+* [Autoimport](docs/autoimport.md)
 * Code Linting
 * Signature Help
 * Go to definition

docs/autoimport.md

@@ -1,17 +1,18 @@
 # Autoimport for pylsp
 Requirements:
-1. rope
-2. ``pylsp.plugins.rope_autoimport.enabled`` is enabled
+1. install ``python-lsp-server[rope]``
+2. set ``pylsp.plugins.rope_autoimport.enabled`` to ``true`` 
 ## 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``. It will suggest modules, submodules, keywords, functions, and classes.  
+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](https://github.com/paradoxxxzero/pyls-isort).
 
 ## Credits
  - Most of the code was written by me, @bageljrkhanofemus
  - [lyz-code](https://github.com/lyz-code/autoimport) for inspiration and some ideas
- - [rope](https://github.com/python-rope/rope)
+ - [rope](https://github.com/python-rope/rope), especially @lieryan
  - [pyright](https://github.com/Microsoft/pyright) for details on language server implementation

pylsp/config/schema.json

@@ -337,7 +337,7 @@
       "description": "Enable or disable the plugin."
     },"pylsp.plugins.rope_autoimport.enabled": {
       "type": "boolean",
-      "default": true,
+      "default": false,
       "description": "Enable or disable the plugin."
     },
     "pylsp.plugins.rope_completion.eager": {

pylsp/plugins/rope_autoimport.py

@@ -1,7 +1,6 @@
 import logging
-from collections import OrderedDict
 from functools import lru_cache
-from typing import Generator, List, Set
+from typing import Any, Dict, Generator, List, Set
 
 import parso
 from parso.python import tree
@@ -21,17 +20,12 @@
 
 
 @hookimpl
-def pylsp_settings():
+def pylsp_settings() -> Dict[str, Dict[str, Dict[str, Any]]]:
     # Default rope_completion to disabled
-    return {"plugins": {"rope_autoimport": {"enabled": True}}}
+    return {"plugins": {"rope_autoimport": {"enabled": False}}}
 
 
-def deduplicate(input_list):
-    """Remove duplicates from list."""
-    return list(OrderedDict.fromkeys(input_list))
-
-
-def should_insert(expr: tree.BaseNode, word_node: tree.Leaf) -> bool:
+def _should_insert(expr: tree.BaseNode, word_node: tree.Leaf) -> bool:
     """
     Check if we should insert the word_node on the given expr.
 
@@ -52,11 +46,11 @@ def should_insert(expr: tree.BaseNode, word_node: tree.Leaf) -> bool:
     if isinstance(first_child, (tree.PythonErrorNode, tree.PythonNode)):
         # The tree will often include error nodes like this to indicate errors
         # we want to ignore errors since the code is being written
-        return should_insert(first_child, word_node)
-    return handle_first_child(first_child, expr, word_node)
+        return _should_insert(first_child, word_node)
+    return _handle_first_child(first_child, expr, word_node)
 
 
-def handle_first_child(
+def _handle_first_child(
     first_child: NodeOrLeaf, expr: tree.BaseNode, word_node: tree.Leaf
 ) -> bool:
     """Check if we suggest imports given the following first child."""
@@ -117,7 +111,7 @@ def _process_statements(
     word: str,
     autoimport: AutoImport,
     document: Document,
-) -> Generator:
+) -> Generator[Dict[str, Any], None, None]:
     for import_statement, name, source, itemkind in suggestions:
         insert_line = autoimport.find_insertion_line(document.source) - 1
         start = {"line": insert_line, "character": 0}
@@ -173,7 +167,7 @@ def pylsp_completions(
     line = document.lines[position["line"]]
     expr = parso.parse(line)
     word_node = expr.get_leaf_for_position((1, position["character"]))
-    if not should_insert(expr, word_node):
+    if not _should_insert(expr, word_node):
         return []
     word = word_node.value
     rope_config = config.settings(document_path=document.path).get("rope", {})
@@ -236,5 +230,5 @@ def pylsp_document_did_save(config: Config, workspace: Workspace, document: Docu
     autoimport = AutoImport(rope_project, memory=False)
     autoimport.generate_cache(resources=[rope_doucment])
     # Might as well using saving the document as an indicator to regenerate the module cache
-    autoimport.generate_modules_cache() 
+    autoimport.generate_modules_cache()
     autoimport.close()

pyproject.toml

@@ -33,7 +33,7 @@ all = [
     "pydocstyle>=2.0.0",
     "pyflakes>=2.4.0,<2.5.0",
     "pylint>=2.5.0",
-    "rope>=1.1.0",
+    "rope>=1.1.1",
     "yapf",
 ]
 autopep8 = ["autopep8>=1.6.0,<1.7.0"]
@@ -43,7 +43,7 @@ pycodestyle = ["pycodestyle>=2.8.0,<2.9.0"]
 pydocstyle = ["pydocstyle>=2.0.0"]
 pyflakes = ["pyflakes>=2.4.0,<2.5.0"]
 pylint = ["pylint>=2.5.0"]
-rope = ["rope>0.10.5"]
+rope = ["rope>1.1.1"]
 yapf = ["yapf"]
 test = [
     "pylint>=2.5.0",