Redo Autoimport

.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip pytest pytest-timeout
+        python -m pip -e .[dev] 
     - name: Test with pytest
       run: |
         pytest -v

CHANGELOG.md

@@ -1,8 +1,6 @@
 # **Upcoming release**
-
-## XXX
-
-- XXX
+## New feature
+- #464 Improve autoimport code to use a sqllite3 database, cache all available modules quickly, search for names and produce import statements, sort import statements.
 
 # Release 1.0.0
 

docs/library.rst

@@ -835,6 +835,23 @@ returns the list of modules with the given global name.
 ``AutoImport.import_assist()`` tries to find the modules that have a
 global name that starts with the given prefix.
 
+It uses an sqllite3 database, which can be made persistent by passing memory as false to the constructor.
+It must be closed when done with the ```AutoImport.close()``` method.
+
+AutoImport can search for a name from both modules and statements you can import from them.
+
+.. code-block:: python
+
+  from rope.base.project import Project
+  from rope.contrib.autoimport import AutoImport
+
+  project = Project("/path/to/project")
+  autoimport = AutoImport(project, memory=False)
+  autoimport.generate_resource_cache()  # Generates a cache of the local modules, from the project you're working on
+  autoimport.generate_modules_cache()  # Generates a cache of external modules
+  print(autoimport.search("Dict"))
+  autoimport.close()
+
 
 Cross-Project Refactorings
 --------------------------

rope/contrib/autoimport/__init__.py

@@ -0,0 +1,4 @@
+"""AutoImport module for rope."""
+from .autoimport import AutoImport
+
+__all__ = ["AutoImport"]