Code action to add/delete imports

pyls/_utils.py

@@ -6,6 +6,7 @@
 import os
 import sys
 import threading
+import re
 
 import jedi
 
@@ -198,3 +199,7 @@ def is_process_alive(pid):
             return e.errno == errno.EPERM
         else:
             return True
+
+
+def camel_to_underscore(camelcase):
+    return re.sub('([A-Z]+)', r'_\1', camelcase).lower()

pyls/plugins/importmagic_lint.py

@@ -0,0 +1,264 @@
+# Copyright 2017 Palantir Technologies, Inc.
+import logging
+import re
+import sys
+import importmagic
+from pyls import hookimpl, lsp, _utils
+
+
+log = logging.getLogger(__name__)
+
+SOURCE = 'importmagic'
+ADD_IMPORT_COMMAND = 'importmagic.addimport'
+REMOVE_IMPORT_COMMAND = 'importmagic.removeimport'
+MAX_COMMANDS = 4
+UNRES_RE = re.compile(r"Unresolved import '(?P<unresolved>[\w.]+)'")
+UNREF_RE = re.compile(r"Unreferenced import '(?P<unreferenced>[\w.]+)'")
+
+_index_cache = {}
+
+
+def _get_index(sys_path):
+    """Build index of symbols from python modules.
+    Cache the index so we don't build it multiple times unnecessarily.
+    """
+    key = tuple(sys_path)
+    if key not in _index_cache:
+        log.info("Started building importmagic index")
+        index = importmagic.SymbolIndex()
+        # The build tend to be noisy
+        index.build_index(paths=sys_path)
+        _index_cache[key] = index
+        log.info("Finished building importmagic index")
+    return _index_cache[key]
+
+
+def _get_imports_list(source, index=None):
+    """Get modules, functions and variables that are imported.
+    """
+    if index is None:
+        index = importmagic.SymbolIndex()
+    imports = importmagic.Imports(index, source)
+    imported = [i.name for i in list(imports._imports)]
+    # Go over from imports
+    for from_import in list(imports._imports_from.values()):
+        imported.extend([i.name for i in list(from_import)])
+    return imported
+
+
+@hookimpl
+def pyls_commands():
+    return [ADD_IMPORT_COMMAND, REMOVE_IMPORT_COMMAND]
+
+
+@hookimpl
+def pyls_lint(document):
+    """Build a diagnostics of unresolved and unreferenced symbols.
+    Every entry follows this format:
+        {
+            'source': 'importmagic',
+            'range': {
+                'start': {
+                    'line': start_line,
+                    'character': start_column,
+                },
+                'end': {
+                    'line': end_line,
+                    'character': end_column,
+                },
+            },
+            'message': message_to_be_displayed,
+            'severity': sevirity_level,
+        }
+
+    Args:
+        document: The document to be linted.
+    Returns:
+        A list of dictionaries.
+    """
+    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:
+        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.Hint,
+            })
+
+    for unref in unreferenced:
+        for line_no, line in enumerate(document.lines):
+            pos = line.find(unref)
+            if pos < 0:
+                continue
+
+            # Find out if the unref is an import or a variable/func
+            imports = _get_imports_list(document.source)
+            if unref in imports:
+                message = "Unreferenced import '%s'" % unref
+            else:
+                message = "Unreferenced variable/function '%s'" % unref
+
+            diagnostics.append({
+                'source': SOURCE,
+                'range': {
+                    'start': {'line': line_no, 'character': pos},
+                    'end': {'line': line_no, 'character': pos + len(unref)}
+                },
+                'message': message,
+                'severity': lsp.DiagnosticSeverity.Warning,
+            })
+
+    return diagnostics
+
+
+@hookimpl
+def pyls_code_actions(config, document, context):
+    """Build a list of actions to be suggested to the user. Each action follow this format:
+        {
+            'title': 'importmagic',
+            'command': command,
+            'arguments':
+                {
+                    'uri': document.uri,
+                    'version': document.version,
+                    'startLine': start_line,
+                    'endLine': end_line,
+                    'newText': text,
+                }
+        }
+    """
+    # Update the style configuration
+    conf = config.plugin_settings('importmagic_lint')
+    min_score = conf.get('minScore', 1)
+    log.debug("Got importmagic settings: %s", conf)
+    importmagic.Imports.set_style(**{_utils.camel_to_underscore(k): v for k, v in conf.items()})
+
+    # Might be slow but is cached once built
+    # TODO (youben): add project path for indexing
+    index = _get_index(sys.path)
+    actions = []
+    diagnostics = context.get('diagnostics', [])
+    for diagnostic in diagnostics:
+        if diagnostic.get('source') != SOURCE:
+            continue
+        message = diagnostic.get('message', '')
+        if message.startswith('Unreferenced'):
+            m = UNREF_RE.match(message)
+            if not m:
+                continue
+            unref = m.group('unreferenced')
+            actions.append(_generate_remove_action(document, index, unref))
+        elif message.startswith('Unresolved'):
+            m = UNRES_RE.match(message)
+            if not m:
+                continue
+            unres = m.group('unresolved')
+            actions.extend(_get_actions_for_unres(document, index, min_score, unres))
+
+    return actions
+
+
+def _get_actions_for_unres(document, index, min_score, unres):
+    """Get the list of possible actions to be applied to solve an unresolved symbol.
+    Get a maximun of MAX_COMMANDS actions with the highest score, also filter low score actions
+    using the min_score value.
+    """
+    actions = []
+    for score, module, variable in sorted(index.symbol_scores(unres)[:MAX_COMMANDS], reverse=True):
+        if score < min_score:
+            # Skip low score results
+            continue
+        actions.append(_generate_add_action(document, index, module, variable))
+
+    return actions
+
+
+def _generate_add_action(document, index, module, variable):
+    """Generate the patch we would need to apply to import a module.
+    """
+    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()
+
+    action = {
+        'title': _add_command_title(variable, module),
+        'command': ADD_IMPORT_COMMAND,
+        'arguments': [{
+            'uri': document.uri,
+            'version': document.version,
+            'startLine': start_line,
+            'endLine': end_line,
+            'newText': text
+        }]
+    }
+    return action
+
+
+def _generate_remove_action(document, index, unref):
+    """Generate the patch we would need to apply to remove an import.
+    """
+    imports = importmagic.Imports(index, document.source)
+    imports.remove(unref)
+    start_line, end_line, text = imports.get_update()
+
+    action = {
+        'title': _remove_command_title(unref),
+        'command': REMOVE_IMPORT_COMMAND,
+        'arguments': [{
+            'uri': document.uri,
+            'version': document.version,
+            'startLine': start_line,
+            'endLine': end_line,
+            'newText': text
+        }]
+    }
+    return action
+
+
+@hookimpl
+def pyls_execute_command(workspace, command, arguments):
+    if command not in [ADD_IMPORT_COMMAND, REMOVE_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 _add_command_title(variable, module):
+    if not variable:
+        return 'Import "%s"' % module
+    return 'Import "%s" from "%s"' % (variable, module)
+
+
+def _remove_command_title(import_name):
+    return 'Remove import of "%s"' % import_name

setup.py

@@ -48,6 +48,7 @@
         'all': [
             'autopep8',
             'flake8',
+            'importmagic',
             'mccabe',
             'pycodestyle',
             'pydocstyle>=2.0.0',
@@ -58,6 +59,7 @@
         ],
         'autopep8': ['autopep8'],
         'flake8': ['flake8'],
+        'importmagic': ['importmagic'],
         'mccabe': ['mccabe'],
         'pycodestyle': ['pycodestyle'],
         'pydocstyle': ['pydocstyle>=2.0.0'],
@@ -80,6 +82,7 @@
             'autopep8 = pyls.plugins.autopep8_format',
             'folding = pyls.plugins.folding',
             'flake8 = pyls.plugins.flake8_lint',
+            'importmagic = pyls.plugins.importmagic_lint',
             'jedi_completion = pyls.plugins.jedi_completion',
             'jedi_definition = pyls.plugins.definition',
             'jedi_hover = pyls.plugins.hover',

test/plugins/test_importmagic_lint.py

@@ -0,0 +1,68 @@
+# Copyright 2019 Palantir Technologies, Inc.
+import tempfile
+import os
+from pyls import lsp, uris
+from pyls.plugins import importmagic_lint
+from pyls.workspace import Document
+
+DOC_URI = uris.from_fs_path(__file__)
+DOC = """
+time.sleep(10)
+print("test")
+"""
+
+
+def temp_document(doc_text):
+    temp_file = tempfile.NamedTemporaryFile(mode='w', delete=False)
+    name = temp_file.name
+    temp_file.write(doc_text)
+    temp_file.close()
+    doc = Document(uris.from_fs_path(name))
+
+    return name, doc
+
+
+def test_importmagic_lint():
+    try:
+        name, doc = temp_document(DOC)
+        diags = importmagic_lint.pyls_lint(doc)
+        unres_symbol = [d for d in diags if d['source'] == 'importmagic'][0]
+
+        assert unres_symbol['message'] == "Unresolved import 'time.sleep'"
+        assert unres_symbol['range']['start'] == {'line': 1, 'character': 0}
+        assert unres_symbol['range']['end'] == {'line': 1, 'character': 10}
+        assert unres_symbol['severity'] == lsp.DiagnosticSeverity.Hint
+
+    finally:
+        os.remove(name)
+
+
+def test_importmagic_actions(config):
+    context = {
+        'diagnostics': [
+            {
+                'range':
+                {
+                    'start': {'line': 1, 'character': 0},
+                    'end': {'line': 1, 'character': 10}
+                },
+                'message': "Unresolved import 'time.sleep'",
+                'severity': lsp.DiagnosticSeverity.Hint,
+                'source': importmagic_lint.SOURCE
+            }
+        ]
+    }
+
+    try:
+        name, doc = temp_document(DOC)
+        actions = importmagic_lint.pyls_code_actions(config, doc, context)
+        action = [a for a in actions if a['title'] == 'Import "time"'][0]
+        arguments = action['arguments'][0]
+
+        assert action['command'] == importmagic_lint.ADD_IMPORT_COMMAND
+        assert arguments['startLine'] == 1
+        assert arguments['endLine'] == 1
+        assert arguments['newText'] == 'import time\n\n\n'
+
+    finally:
+        os.remove(name)

test/test_utils.py

@@ -87,3 +87,9 @@ def test_clip_column():
     assert _utils.clip_column(2, ['123\n', '123'], 0) == 2
     assert _utils.clip_column(3, ['123\n', '123'], 0) == 3
     assert _utils.clip_column(4, ['123\n', '123'], 1) == 3
+
+
+def test_camel_to_underscore():
+    assert _utils.camel_to_underscore('camelCase') == 'camel_case'
+    assert _utils.camel_to_underscore('hangClosing') == 'hang_closing'
+    assert _utils.camel_to_underscore('ignore') == 'ignore'

vscode-client/package.json

@@ -35,6 +35,11 @@
                     },
                     "uniqueItems": true
                 },
+                "pyls.plugins.importmagic_lint.minScore": {
+                    "type": "number",
+                    "default": 1,
+                    "description": "The minimum score used to filter module import suggestions."
+                },
                 "pyls.plugins.jedi_completion.enabled": {
                     "type": "boolean",
                     "default": true,