Use import magic for auto-imports

pyls/plugins/__init__.py

@@ -1 +1 @@
-# Copyright 2017 Palantir Technologies, Inc.
+# Copyright 2017 Palantir Technologies, Inc.

pyls/plugins/importmagic_lint.py

@@ -0,0 +1,135 @@
+# Copyright 2017 Palantir Technologies, Inc.
+import logging
+import re
+
+import importmagic
+
+from pyls import hookimpl, lsp, _utils
+
+
+log = logging.getLogger(__name__)
+
+SOURCE = 'importmagic'
+ADD_IMPORT_COMMAND = 'importmagic.addimport'
+MAX_COMMANDS = 4
+UNRES_RE = re.compile(r"Unresolved import '(?P<unresolved>[\w.]+)'")
+
+_index_cache = {}
+
+
+def _get_index(sys_path):
+    key = tuple(sys_path)
+    if key not in _index_cache:
+        index = importmagic.SymbolIndex()
+        index.build_index(paths=sys_path)
+        _index_cache[key] = index
+    return _index_cache[key]
+
+
+@hookimpl
+def pyls_commands():
+    return [ADD_IMPORT_COMMAND]
+
+
+@hookimpl
+def pyls_lint(document):
+    scope = importmagic.Scope.from_source(document.source)
+    unresolved, _unreferenced = scope.find_unresolved_and_unreferenced_symbols()
+
+    diagnostics = []
+
+    # Annoyingly, we only get the text of an unresolved import, so we'll look for it ourselves
+    for unres in unresolved:
+        if unres not in document.source:
+            continue
+
+        for line_no, line in enumerate(document.lines):
+            pos = line.find(unres)
+            if pos < 0:
+                continue
+
+            diagnostics.append({
+                'source': SOURCE,
+                'range': {
+                    'start': {'line': line_no, 'character': pos},
+                    'end': {'line': line_no, 'character': pos + len(unres)}
+                },
+                'message': "Unresolved import '%s'" % unres,
+                'severity': lsp.DiagnosticSeverity.Error,
+            })
+
+    return diagnostics
+
+
+@hookimpl
+def pyls_code_actions(config, workspace, document, context):
+    # Update the style configuration
+    conf = config.plugin_settings('importmagic_lint')
+    importmagic.Imports.set_style(**{_utils.camel_to_underscore(k): v for k, v in conf.items()})
+
+    actions = []
+    diagnostics = context.get('diagnostics', [])
+    for diagnostic in diagnostics:
+        if diagnostic.get('source') != SOURCE:
+            continue
+        m = UNRES_RE.match(diagnostic['message'])
+        if not m:
+            continue
+
+        unres = m.group('unresolved')
+        index = _get_index(workspace.syspath_for_path(document.path))
+
+        for score, module, variable in sorted(index.symbol_scores(unres)[:MAX_COMMANDS], reverse=True):
+            if score < 1:
+                # These tend to be terrible
+                continue
+
+            # Generate the patch we would need to apply
+            imports = importmagic.Imports(index, document.source)
+            if variable:
+                imports.add_import_from(module, variable)
+            else:
+                imports.add_import(module)
+            start_line, end_line, text = imports.get_update()
+
+            actions.append({
+                'title': _command_title(variable, module),
+                'command': ADD_IMPORT_COMMAND,
+                'arguments': [{
+                    'uri': document.uri,
+                    'version': document.version,
+                    'startLine': start_line,
+                    'endLine': end_line,
+                    'newText': text
+                }]
+            })
+    return actions
+
+
+@hookimpl
+def pyls_execute_command(workspace, command, arguments):
+    if command != ADD_IMPORT_COMMAND:
+        return
+
+    args = arguments[0]
+
+    edit = {'documentChanges': [{
+        'textDocument': {
+            'uri': args['uri'],
+            'version': args['version']
+        },
+        'edits': [{
+            'range': {
+                'start': {'line': args['startLine'], 'character': 0},
+                'end': {'line': args['endLine'], 'character': 0},
+            },
+            'newText': args['newText']
+        }]
+    }]}
+    workspace.apply_edit(edit)
+
+
+def _command_title(variable, module):
+    if not variable:
+        return 'Import "%s"' % module
+    return 'Import "%s" from "%s"' % (variable, module)

pyls/plugins/pycodestyle_lint.py

@@ -1,7 +1,10 @@
 # Copyright 2017 Palantir Technologies, Inc.
 import logging
+
 import pycodestyle
-from pyls import config as pyls_config, hookimpl, lsp, _utils
+
+from pyls import _utils, config as pyls_config, hookimpl, lsp
+
 
 log = logging.getLogger(__name__)
 

pyls/plugins/signature.py

@@ -1,7 +1,9 @@
 # Copyright 2017 Palantir Technologies, Inc.
 import logging
+
 from pyls import hookimpl
 
+
 log = logging.getLogger(__name__)
 
 

setup.py

@@ -34,6 +34,7 @@
     install_requires=[
         'configparser',
         'future',
+        'importmagic',
         'jedi>=0.10',
         'json-rpc',
         'mccabe',
@@ -60,6 +61,7 @@
             'pyls = pyls.__main__:main',
         ],
         'pyls': [
+            'importmagic = pyls.plugins.importmagic_lint',
             'jedi_completion = pyls.plugins.completion',
             'jedi_definition = pyls.plugins.definition',
             'jedi_hover = pyls.plugins.hover',

vscode-client/package.json

@@ -20,6 +20,22 @@
             "title": "Python Language Server Configuration",
             "type": "object",
             "properties": {
+                "pyls.plugins.importmagic_lint.enabled": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Enable or disable the plugin."
+                },
+                "pyls.plugins.importmagic_lint.maxColumns": {
+                    "type": "number",
+                    "default": null,
+                    "description": "The maximum number of columns for generated import statements"
+                },
+                "pyls.plugins.importmagic_lint.multiline": {
+                    "type": "string",
+                    "default": "parentheses",
+                    "enum": ["parentheses", "backslash"],
+                    "description": "The style to use for multiline import statements"
+                },
                 "pyls.plugins.jedi_completion.enabled": {
                     "type": "boolean",
                     "default": true,