Implement rope autoimport.

klen · klen · commit bda0b92388aa · 2013-11-29T01:23:00.000+07:00
diff --git a/autoload/pymode/rope.vim b/autoload/pymode/rope.vim
@@ -145,3 +145,10 @@ fun! pymode#rope#module_to_package() "{{{
     endif
     PymodePython rope.ModuleToPackageRefactoring().run()
 endfunction "}}}
+
+fun! pymode#rope#autoimport(word) "{{{
+    if !pymode#save()
+        return 0
+    endif
+    PymodePython rope.autoimport()
+endfunction "}}}
diff --git a/ftplugin/python/pymode.vim b/ftplugin/python/pymode.vim
@@ -50,6 +50,7 @@ if g:pymode_options
     setlocal nowrap
     setlocal textwidth=79
     setlocal commentstring=#%s
+    setlocal define=^\s*\\(def\\\\|class\\)
 endif
 
 if g:pymode_lint
@@ -155,4 +156,8 @@ if g:pymode_rope
     command! -buffer PymodeRopeRenameModule call pymode#rope#rename_module()
     command! -buffer PymodeRopeModuleToPackage call pymode#rope#module_to_package()
 
+    if g:pymode_rope_autoimport
+        command! -buffer PymodeRopeAutoImport call pymode#rope#autoimport(expand('<cword>'))
+    end
+
 end
diff --git a/pymode/rope.py b/pymode/rope.py
@@ -10,7 +10,7 @@
 import json
 import multiprocessing
 from .utils import (
-    message, PY2, error, pymode_input, pymode_inputlist, pymode_y_n)
+    pymode_message, PY2, pymode_error, pymode_input, pymode_inputlist, pymode_y_n)
 
 if PY2:
     sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'libs'))
@@ -19,7 +19,7 @@
 
 from rope.base import project, libutils, exceptions, change # noqa
 from rope.base.fscommands import FileSystemCommands # noqa
-from rope.contrib import autoimport, codeassist, findit # noqa
+from rope.contrib import autoimport as rope_autoimport, codeassist, findit # noqa
 from rope.refactor import ModuleToPackage, ImportOrganizer, rename, extract, inline, usefunction, move # noqa
 from rope.base.taskhandle import TaskHandle # noqa
 
@@ -193,7 +193,7 @@ def show_doc():
                 raise exceptions.BadIdentifierError
             vim.command('let l:output = %s' % json.dumps(doc.split('\n')))
         except exceptions.BadIdentifierError:
-            error("No documentation found.")
+            pymode_error("No documentation found.")
 
 
 def find_it():
@@ -259,7 +259,7 @@ def new():
     root = vim.eval('input("Enter project root: ", getcwd())')
     prj = project.Project(projectroot=root)
     prj.close()
-    message("Project is opened: %s" % root)
+    pymode_message("Project is opened: %s" % root)
 
 
 def undo():
@@ -272,7 +272,7 @@ def undo():
     with RopeContext() as ctx:
         changes = ctx.project.history.tobe_undone
         if changes is None:
-            error('Nothing to undo!')
+            pymode_error('Nothing to undo!')
             return False
 
         if pymode_y_n(yes=False, msg='Undo [%s]?' % str(changes)):
@@ -291,7 +291,7 @@ def redo():
     with RopeContext() as ctx:
         changes = ctx.project.history.tobe_redone
         if changes is None:
-            error('Nothing to redo!')
+            pymode_error('Nothing to redo!')
             return False
 
         if pymode_y_n(yes=False, msg='Redo [%s]?' % str(changes)):
@@ -318,6 +318,41 @@ def get_ctx(*args, **kwargs):
     return get_ctx
 
 
+def autoimport():
+    """ Autoimport modules.
+
+    :return bool:
+
+    """
+    word = vim.eval('a:word')
+    if not word:
+        pymode_error("Should be word under cursor.")
+        return False
+
+    def insert_import(name, module, ctx, source):
+        linenum = int(ctx.importer.find_insertion_line(source))
+        line = 'from %s insert %s' % (module, name)
+        vim.current.buffer[linenum - 1:linenum - 1] = [line]
+
+    with RopeContext() as ctx:
+        if not ctx.importer.names:
+            ctx.generate_autoimport_cache()
+        modules = ctx.importer.get_modules(word)
+        if not modules:
+            pymode_message('Global name %s not found.' % word)
+            return False
+
+        source, _ = get_assist_params()
+        if len(modules) == 1:
+            insert_import(word, modules[0], ctx, source)
+
+        else:
+            module = pymode_inputlist('Wich module to import:', modules)
+            insert_import(word, module, ctx, source)
+
+        return True
+
+
 @cache_project
 class RopeContext(object):
 
@@ -331,8 +366,8 @@ def __init__(self, path, project_path):
         self.project = project.Project(
             project_path, fscommands=FileSystemCommands())
 
-        self.importer = autoimport.AutoImport(project=self.project,
-                                              observe=False)
+        self.importer = rope_autoimport.AutoImport(
+            project=self.project, observe=False)
 
         update_python_path(self.project.prefs.get('python_path', []))
 
@@ -388,7 +423,7 @@ def __init__(self, msg):
     def __call__(self):
         """ Show current progress. """
         percent_done = self.handle.current_jobset().get_percent_done()
-        message('%s - done %s%%' % (self.message, percent_done))
+        pymode_message('%s - done %s%%' % (self.message, percent_done))
 
 
 _scope_weight = {
@@ -413,7 +448,7 @@ def run(self):
 
         with RopeContext() as ctx:
             try:
-                message(self.__doc__)
+                pymode_message(self.__doc__)
                 refactor = self.get_refactor(ctx)
                 input_str = self.get_input_str(refactor, ctx)
                 if not input_str:
@@ -439,10 +474,10 @@ def run(self):
                 ctx.project.do(changes, task_handle=progress.handle)
                 reload_changes(changes)
             except exceptions.RefactoringError as e:
-                error(str(e))
+                pymode_error(str(e))
 
             except Exception as e:
-                error('Unhandled exception in Pymode: %s' % e)
+                pymode_error('Unhandled exception in Pymode: %s' % e)
 
     @staticmethod
     def get_refactor(ctx):
@@ -501,7 +536,7 @@ def get_input_str(self, refactor, ctx):
         newname = pymode_input(msg, oldname)
 
         if newname == oldname:
-            message("Nothing to do.")
+            pymode_message("Nothing to do.")
             return False
 
         return newname
diff --git a/pymode/run.py b/pymode/run.py
@@ -9,7 +9,7 @@
 import sys
 import vim # noqa
 
-from .utils import error
+from .utils import pymode_error
 
 
 VIM_INPUT = lambda s: vim.eval('input("%s")' % s)
@@ -37,7 +37,7 @@ def run_code():
             # A non-false code indicates abnormal termination.
             # A false code will be treated as a
             # successful run, and the error will be hidden from Vim
-            error("Script exited with code %s" % e.code)
+            pymode_error("Script exited with code %s" % e.code)
             vim.command('return')
 
     except Exception:
diff --git a/pymode/utils.py b/pymode/utils.py
@@ -20,7 +20,7 @@ def __wrapper():
     return __wrapper
 
 
-def message(content):
+def pymode_message(content):
     """ Show message. """
 
     vim.command('call pymode#wide_message("%s")' % str(content))
@@ -51,13 +51,13 @@ def pymode_inputlist(msg, opts):
         input_str = 0
 
     if not input_str:
-        message('Cancelled!')
+        pymode_message('Cancelled!')
         return False
 
     try:
         return opts[input_str - 1]
     except (IndexError, ValueError):
-        error('Invalid option: %s' % input_str)
+        pymode_error('Invalid option: %s' % input_str)
         return pymode_inputlist(msg, opts)
 
 
@@ -81,7 +81,7 @@ def pymode_input(umsg, udefault='', opts=None):
     return input_str or default
 
 
-def error(content):
+def pymode_error(content):
     """ Show error. """
 
     vim.command('call pymode#error("%s")' % str(content))
@@ -117,6 +117,6 @@ def wrapper(*args, **kwargs):
         try:
             return func(*args, **kwargs)
         except (Exception, vim.error): # noqa
-            error(traceback.format_exc())
+            pymode_error(traceback.format_exc())
             return None
     return wrapper
diff --git a/pymode/virtualenv.py b/pymode/virtualenv.py
@@ -3,7 +3,7 @@
 import os.path
 import vim # noqa
 
-from .utils import message
+from .utils import pymode_message
 
 
 def enable_virtualenv():
@@ -30,7 +30,7 @@ def enable_virtualenv():
         source = f.read()
         exec(compile(  # noqa
             source, activate_this, 'exec'), dict(__file__=activate_this))
-        message('Activate virtualenv: ' + path)
+        pymode_message('Activate virtualenv: ' + path)
         vim.command('let g:pymode_virtualenv_enabled = "%s"' % path)
         return True
     finally:
