Merge pull request #730 from MrBago/aliases

Match on module aliases for auto import suggestions

CHANGELOG.md

@@ -1,6 +1,6 @@
 # **Upcoming release**
 
-- ...
+- #730 Match on module aliases for autoimport suggestions
 
 # Release 1.12.0
 

docs/configuration.rst

@@ -14,6 +14,11 @@ Will be used if [tool.rope] is configured.
 
     [tool.rope]
     split_imports = true
+    autoimport.aliases = [
+        ['dt', 'datetime'],
+        ['mp', 'multiprocessing'],
+    ]
+
 
 config.py
 ---------
@@ -48,9 +53,9 @@ Additionally, you can run an executable function at startup of rope.
 pytool.toml
 -----------
 If neither a config.py or a pyproject.toml is present, rope will use a pytool.toml.
-It follows the exact same syntax of the pyproject.toml.
+It follows the exact same syntax as ``pyproject.toml``.
 
-- Mac OS X: ``~/Library/Application Support/pytool.toml.``
+- Mac OS X: ``~/Library/Application Support/pytool.toml``.
 - Unix: ``~/.config/pytool.toml``` or in $XDG_CONFIG_HOME, if defined
 - Windows: ``C:\Users\<username>\AppData\Local\pytool.toml``
 

rope/base/builtins.py

@@ -1,4 +1,5 @@
 """This module tries to support builtin types and functions."""
+
 import inspect
 import io
 

rope/base/fscommands.py

@@ -6,6 +6,7 @@
 `MercurialCommands` for example.
 
 """
+
 import os
 import re
 import shutil

rope/base/libutils.py

@@ -1,4 +1,5 @@
 """A few useful functions for using rope as a library"""
+
 import os.path
 
 import rope.base.project

rope/base/oi/soi.py

@@ -4,6 +4,7 @@
 package.
 
 """
+
 import rope.base.builtins  # Use full qualification for clarity.
 from rope.base import arguments, evaluate, pynames, pyobjects, utils
 from rope.base.oi.type_hinting.factory import get_type_hinting_factory

rope/base/oi/transform.py

@@ -1,4 +1,5 @@
 """Provides classes for persisting `PyObject`"""
+
 import os
 import re
 

rope/base/oi/type_hinting/providers/docstrings.py

@@ -21,6 +21,7 @@
     - https://groups.google.com/d/topic/rope-dev/LCFNN98vckI/discussion
 
 """
+
 import re
 
 from rope.base.oi.type_hinting import utils

rope/base/oi/type_hinting/providers/numpydocstrings.py

@@ -3,6 +3,7 @@
 https://github.com/davidhalter/jedi/blob/b489019f5bd5750051122b94cc767df47751ecb7/jedi/evaluate/docstrings.py
 Thanks to @davidhalter for this utils under MIT License.
 """
+
 import re
 
 from rope.base.ast import literal_eval

rope/base/prefs.py

@@ -12,6 +12,30 @@
 from rope.base.resources import Folder
 
 
+@dataclass
+class AutoimportPrefs:
+    # underlined: bool = field(
+    #     default=False, description="Cache underlined (private) modules")
+    # memory: bool = field(default=None, description="Cache in memory instead of disk")
+    # parallel: bool = field(default=True, description="Use multiple processes to parse")
+
+    aliases: List[Tuple[str, str]] = field(
+        default_factory=lambda : [
+            ("np", "numpy"),
+            ("pd", "pandas"),
+            ("plt", "matplotlib.pyplot"),
+            ("sns", "seaborn"),
+            ("tf", "tensorflow"),
+            ("sk", "sklearn"),
+            ("sm", "statsmodels"),
+        ],
+        description=dedent("""
+            Aliases for module names.  For example, `[('np', 'numpy')]` makes rope recommend
+            ``import numpy as np``.
+        """),
+    )
+
+
 @dataclass
 class Prefs:
     """Class to store rope preferences."""
@@ -139,7 +163,6 @@ class Prefs:
             appear in the importing namespace.
         """),
     )
-
     prefer_module_from_imports: bool = field(
         default=False,
         description=dedent("""
@@ -206,6 +229,8 @@ class Prefs:
             Can only be set in config.py.
         """),
     )
+    autoimport: AutoimportPrefs = field(
+        default_factory=AutoimportPrefs, description="Preferences for Autoimport")
 
     def set(self, key: str, value: Any):
         """Set the value of `key` preference to `value`."""

rope/base/simplify.py

@@ -2,6 +2,7 @@
 
 This module is here to help source code analysis.
 """
+
 import re
 
 from rope.base import codeanalyze, utils

rope/base/versioning.py

@@ -1,3 +1,4 @@
+import dataclasses
 import hashlib
 import importlib.util
 import json
@@ -31,7 +32,9 @@ def _get_prefs_data(project) -> str:
     del prefs_data["project_opened"]
     del prefs_data["callbacks"]
     del prefs_data["dependencies"]
-    return json.dumps(prefs_data, sort_keys=True, indent=2)
+    return json.dumps(
+        prefs_data, sort_keys=True, indent=2, default=lambda o: o.__dict__
+    )
 
 
 def _get_file_content(module_name: str) -> str:

rope/contrib/autoimport/__init__.py

@@ -1,4 +1,5 @@
 """AutoImport module for rope."""
+
 from .pickle import AutoImport as _PickleAutoImport
 from .sqlite import AutoImport as _SqliteAutoImport
 

rope/contrib/autoimport/defs.py

@@ -1,4 +1,5 @@
 """Definitions of types for the Autoimport program."""
+
 import pathlib
 from enum import Enum
 from typing import NamedTuple, Optional
@@ -92,6 +93,13 @@ class Package(NamedTuple):
     type: PackageType
 
 
+class Alias(NamedTuple):
+    """A module alias to be added to the database."""
+
+    alias: str
+    modname: str
+
+
 class Name(NamedTuple):
     """A Name to be added to the database."""
 

rope/contrib/autoimport/models.py

@@ -56,13 +56,11 @@ def delete_from(self) -> FinalQuery:
 class Model(ABC):
     @property
     @abstractmethod
-    def table_name(self) -> str:
-        ...
+    def table_name(self) -> str: ...
 
     @property
     @abstractmethod
-    def schema(self) -> Dict[str, str]:
-        ...
+    def schema(self) -> Dict[str, str]: ...
 
     @classmethod
     def create_table(cls, connection):
@@ -88,6 +86,29 @@ class Metadata(Model):
     objects = Query(table_name, columns)
 
 
+class Alias(Model):
+    table_name = "aliases"
+    schema = {
+        "alias": "TEXT",
+        "module": "TEXT",
+    }
+    columns = list(schema.keys())
+    objects = Query(table_name, columns)
+
+    @classmethod
+    def create_table(cls, connection):
+        super().create_table(connection)
+        connection.execute(
+            "CREATE INDEX IF NOT EXISTS aliases_alias_nocase ON aliases(alias COLLATE NOCASE)"
+        )
+
+    modules = Query(
+        "(SELECT DISTINCT aliases.*, package, source, type FROM aliases INNER JOIN names on aliases.module = names.module)",
+        columns + ["package", "source", "type"],
+    )
+    search_modules_with_alias = modules.where("alias LIKE (?)")
+
+
 class Name(Model):
     table_name = "names"
     schema = {

rope/contrib/autoimport/pickle.py

@@ -10,7 +10,6 @@
 sqlite-based storage backend (rope.contrib.autoimport.sqlite.AutoImport).
 """
 
-
 import contextlib
 import re
 

rope/contrib/autoimport/sqlite.py

@@ -22,6 +22,7 @@
 from rope.contrib.autoimport import models
 from rope.contrib.autoimport.defs import (
     ModuleFile,
+    Alias,
     Name,
     NameType,
     Package,
@@ -330,6 +331,13 @@ def _search_module(
             yield SearchResult(
                 f"import {module}", module, source, NameType.Module.value
             )
+        for alias, module, source in self._execute(
+            models.Alias.search_modules_with_alias.select("alias", "module", "source"),
+            (name,),
+        ):
+            yield SearchResult(
+                f"import {module} as {alias}", alias, source, NameType.Module.value
+            )
 
     def get_modules(self, name) -> List[str]:
         """Get the list of modules that have global `name`."""
@@ -471,11 +479,14 @@ def clear_cache(self):
         """
         with self.connection:
             self._execute(models.Name.objects.drop_table())
+            self._execute(models.Alias.objects.drop_table())
             self._execute(models.Package.objects.drop_table())
             self._execute(models.Metadata.objects.drop_table())
             models.Name.create_table(self.connection)
+            models.Alias.create_table(self.connection)
             models.Package.create_table(self.connection)
             models.Metadata.create_table(self.connection)
+            self.add_aliases(self.project.prefs.autoimport.aliases)
             data = (
                 versioning.calculate_version_hash(self.project),
                 json.dumps(versioning.get_version_hash_data(self.project)),
@@ -595,6 +606,10 @@ def _convert_name(name: Name) -> tuple:
             name.name_type.value,
         )
 
+    def add_aliases(self, aliases: Iterable[Alias]):
+        if aliases:
+            self._executemany(models.Alias.objects.insert_into(), aliases)
+
     def _add_names(self, names: Iterable[Name]):
         if names is not None:
             self._executemany(

rope/contrib/autoimport/utils.py

@@ -1,4 +1,5 @@
 """Utility functions for the autoimport code."""
+
 import pathlib
 import sys
 from collections import OrderedDict

rope/contrib/finderrors.py

@@ -23,6 +23,7 @@
 * ... ;-)
 
 """
+
 from rope.base import ast, evaluate, pyobjects
 
 

rope/contrib/fixmodnames.py

@@ -15,6 +15,7 @@
 argument.
 
 """
+
 from rope.base import taskhandle
 from rope.contrib import changestack
 from rope.refactor import rename

rope/refactor/__init__.py

@@ -45,6 +45,7 @@
 monitoring the progress of refactorings.
 
 """
+
 from rope.refactor.importutils import ImportOrganizer  # noqa
 from rope.refactor.topackage import ModuleToPackage  # noqa
 

rope/refactor/importutils/__init__.py

@@ -4,6 +4,7 @@
 refactorings or as a separate task.
 
 """
+
 import rope.base.codeanalyze
 import rope.base.evaluate
 from rope.base import libutils

rope/refactor/inline.py

@@ -406,9 +406,9 @@ def _get_definition_params(self):
                 "Cannot inline functions with list and keyword arguments."
             )
         if self.pyfunction.get_kind() == "classmethod":
-            paramdict[
-                definition_info.args_with_defaults[0][0]
-            ] = self.pyfunction.parent.get_name()
+            paramdict[definition_info.args_with_defaults[0][0]] = (
+                self.pyfunction.parent.get_name()
+            )
         return paramdict
 
     def get_function_name(self):

rope/refactor/move.py

@@ -4,6 +4,7 @@
 based on inputs.
 
 """
+
 from __future__ import annotations
 
 import typing

rope/refactor/occurrences.py

@@ -35,7 +35,6 @@
     arguments
 """
 
-
 import contextlib
 import re
 

rope/refactor/similarfinder.py

@@ -1,4 +1,5 @@
 """This module can be used for finding similar code"""
+
 import re
 
 import rope.base.builtins  # Use full qualification for clarity.

ropetest/contrib/autoimporttest.py

@@ -1,6 +1,7 @@
 import unittest
 
 from rope.contrib.autoimport import sqlite as autoimport
+from rope.contrib.autoimport.defs import Alias
 from ropetest import testutils
 
 
@@ -124,6 +125,30 @@ def test_search_module(self):
         self.assertIn(import_statement, self.importer.search("os"))
         self.assertIn(import_statement, self.importer.search("o"))
 
+    def test_search_alias(self):
+        self.mod2.write("myvar = None\n")
+        self.importer.update_resource(self.mod2)
+        self.importer.add_aliases([
+            ("noMatch", "does_not_exists_this"),
+            ("hasMatch", "pkg.mod2"),
+        ])
+
+        self.assertEqual([], self.importer.search("noMatch", exact_match=True))
+
+        import_statement = ("import pkg.mod2 as hasMatch", "hasMatch")
+        self.assertIn(import_statement, self.importer.search("hasMatch", exact_match=True))
+        self.assertIn(import_statement, self.importer.search("hasM"))
+        self.assertIn(import_statement, self.importer.search("h"))
+
+    def test_alias_updated_from_prefs(self):
+        self.mod2.write("myvar = None\n")
+        self.project.prefs.autoimport.aliases = [("mod2_alias", "pkg.mod2")]
+        self.importer.clear_cache()
+        self.importer.update_resource(self.mod2)
+        import_statement = ("import pkg.mod2 as mod2_alias", "mod2_alias")
+        self.assertIn(import_statement, self.importer.search("mod2_alias", exact_match=True))
+        self.assertIn(import_statement, self.importer.search("mod2", exact_match=False))
+
     def test_search(self):
         self.importer.update_module("typing")
         import_statement = ("from typing import Dict", "Dict")