Hierarchical symbols (palantir#176)

gatesn · web-flow · commit 9a3545df98e9 · 2017-10-28T21:38:04.000+01:00
* Correctly structure outline view

* Improve smybol spec to better show the behavior

* Symbol hierarchies

* Symbol hierarchies

* Symbol hierarchies

* Fixes

* Fixes
diff --git a/pyls/plugins/symbols.py b/pyls/plugins/symbols.py
@@ -12,15 +12,45 @@ def pyls_document_symbols(config, document):
     definitions = document.jedi_names(all_scopes=all_scopes)
     return [{
         'name': d.name,
+        'containerName': _container(d),
+        'location': {
+            'uri': document.uri,
+            'range': _range(d),
+        },
         'kind': _kind(d),
-        'location': {'uri': document.uri, 'range': _range(d)}
-    } for d in definitions]
+    } for d in definitions if _include_def(d)]
 
 
-def _range(d):
+def _include_def(definition):
+    return (
+        # Don't tend to include parameters as symbols
+        definition.type != 'param' and
+        # Unused vars should also be skipped
+        definition.name != '_' and
+        _kind(definition) is not None
+    )
+
+
+def _container(definition):
+    try:
+        # Jedi sometimes fails here.
+        parent = definition.parent()
+        # Here we check that a grand-parent exists to avoid declaring symbols
+        # as children of the module.
+        if parent.parent():
+            return parent.name
+    except:
+        pass
+
+
+def _range(definition):
+    # This gets us more accurate end position
+    definition = definition._name.tree_name.get_definition()
+    (start_line, start_column) = definition.start_pos
+    (end_line, end_column) = definition.end_pos
     return {
-        'start': {'line': d.line - 1, 'character': d.column},
-        'end': {'line': d.line - 1, 'character': d.column + len(d.name)}
+        'start': {'line': start_line - 1, 'character': start_column},
+        'end': {'line': end_line - 1, 'character': end_column}
     }
 
 
diff --git a/test/plugins/test_symbols.py b/test/plugins/test_symbols.py
@@ -10,11 +10,14 @@
 a = 'hello'
 
 class B:
-    def __init__():
-        pass
+    def __init__(self):
+        x = 2
+        self.y = x
+
+def main(x):
+    y = 2 * x
+    return y
 
-def main():
-    pass
 """
 
 
@@ -23,14 +26,13 @@ def test_symbols(config):
     config.update({'plugins': {'jedi_symbols': {'all_scopes': False}}})
     symbols = pyls_document_symbols(config, doc)
 
-    # All four symbols (import sys, a, B, main)
-    assert len(symbols) == 4
+    # All four symbols (import sys, a, B, main, y)
+    assert len(symbols) == 5
 
     def sym(name):
         return [s for s in symbols if s['name'] == name][0]
 
     # Check we have some sane mappings to VSCode constants
-    assert sym('sys')['kind'] == SymbolKind.Module
     assert sym('a')['kind'] == SymbolKind.Variable
     assert sym('B')['kind'] == SymbolKind.Class
     assert sym('main')['kind'] == SymbolKind.Function
@@ -39,18 +41,17 @@ def sym(name):
     assert sym('a')['location']['range']['start'] == {'line': 2, 'character': 0}
 
 
-def test_symbols_alls_scopes(config):
+def test_symbols_all_scopes(config):
     doc = Document(DOC_URI, DOC)
     symbols = pyls_document_symbols(config, doc)
 
-    # All five symbols (import sys, a, B, __init__, main)
-    assert len(symbols) == 5
+    # All eight symbols (import sys, a, B, __init__, x, y, main, y)
+    assert len(symbols) == 8
 
     def sym(name):
         return [s for s in symbols if s['name'] == name][0]
 
     # Check we have some sane mappings to VSCode constants
-    assert sym('sys')['kind'] == SymbolKind.Module
     assert sym('a')['kind'] == SymbolKind.Variable
     assert sym('B')['kind'] == SymbolKind.Class
     assert sym('__init__')['kind'] == SymbolKind.Function
