Improve completion descriptions

sadovnychyi · sadovnychyi · commit 3c6b3bd47e13 · 2015-04-29T20:32:28.000+08:00
diff --git a/README.md b/README.md
@@ -1,9 +1,20 @@
 # Python Autocomplete Package
 
-CPython variables, methods, functions and modules autocompletions in Atom. Install
+Python variables, methods, functions and modules autocompletions in Atom. Install
 [autocomplete-plus](https://github.com/atom-community/autocomplete-plus) before
 installing this package.
 
 This is powered by [Jedi](https://github.com/davidhalter/jedi).
 
 ![Demo](https://cloud.githubusercontent.com/assets/193864/7388957/36019954-ee9c-11e4-8373-7bf551ed613f.gif)
+
+
+# Features
+
+* Highlights UPPERCASE_VARIABLES as constants according to PEP8.
+* Highlights builtin functions and variables with special style.
+* Prints first 50 characters of statement value while completing variables.
+* Additional caching so the same request will not be handled twice.
+
+
+Inspired by [autocomplete-plus-python-jedi](https://github.com/tinloaf/autocomplete-plus-python-jedi).
diff --git a/lib/completion.py b/lib/completion.py
@@ -6,7 +6,7 @@
 
 
 class JediCompletion(object):
-  types = {
+  basic_types = {
     'module': 'import',
     'class': 'class',
     'instance': 'variable',
@@ -20,6 +20,33 @@ def __init__(self):
       if path not in sys.path:
         sys.path.insert(0, path)
 
+  def _get_completion_type(self, completion):
+    is_built_in = completion.in_builtin_module
+    if completion.type not in ['import', 'keyword'] and is_built_in():
+      return 'builtin'
+    if completion.type in ['statement'] and completion.name.isupper():
+      return 'constant'
+    if completion.type in self.basic_types:
+      return self.basic_types.get(completion.type)
+
+  def _description(self, completion):
+    """Provide a description of the completion object."""
+    if completion._definition is None:
+      return ''
+    t = completion.type
+    if t == 'statement':
+      desc = ''.join(
+        c.get_code() for c in completion._definition.children
+        if type(c).__name__ in ['InstanceElement', 'String']).replace('\n', '')
+    elif t == 'keyword':
+      desc = ''
+    elif t == 'import':
+      desc = completion._definition.get_code()
+    else:
+      desc = '.'.join(unicode(p) for p in completion._path())
+    line = '' if completion.in_builtin_module else '@%s' % completion.line
+    return ('%s: %s%s' % (t, desc, line))[:50]
+
   @classmethod
   def _get_top_level_module(cls, path):
     """Recursively walk through directories looking for top level module.
@@ -57,10 +84,10 @@ def _serialize(self, completions, identifier):
         'snippet': self._generate_snippet(completion),
         'displayText': completion.name,
         # 'replacementPrefix': completion.name[:completion._like_name_length],
-        'type': self.types.get(completion.type),
+        'type': self._get_completion_type(completion),
         # TODO: try to understand return value
         # 'leftLabel': '',
-        'rightLabel': completion.description,
+        'rightLabel': self._description(completion),
         'description': completion.docstring(),
         # 'descriptionMoreURL': completion.module_name
       })
diff --git a/lib/main.coffee b/lib/main.coffee
@@ -20,7 +20,7 @@ module.exports =
 
   getProvider: ->
     return @provider if @provider?
-    PythonProvider = require('./pythonprovider')
+    PythonProvider = require('./python-provider')
     @provider = new PythonProvider()
     return @provider
 
diff --git a/lib/python-provider.coffee b/lib/python-provider.coffee
@@ -1,7 +1,7 @@
 module.exports =
 class PythonProvider
   selector: '.source.python'
-  disableForSelector: '.source.python .comment, .source.python .string'
+  disableForSelector: '.source.python.comment, .source.python.string'
   inclusionPriority: 1
   excludeLowerPriority: true
 
