Use dicts for completion metadata instead of strs

Author: wilywampa

ftplugin/python/ipy.vim

@@ -254,7 +254,8 @@ def process_matches(matches, metadata, result):
         completions = matches
     else:
         completions = [s.encode(vim_encoding) for s in matches]
-        metadata = [s.encode(vim_encoding) for s in metadata]
+        for i, m in enumerate(metadata):
+            metadata[i] = {k: v.encode(vim_encoding) for k, v in m.items()}
     if vim.vars['ipython_dictionary_completion'] and not vim.vars['ipython_greedy_matching']:
         for char in '\'"':
             if any(c.endswith(char + ']') for c in completions):
@@ -266,16 +267,18 @@ def process_matches(matches, metadata, result):
     except ValueError:
         pass
     for c, m in zip(completions, metadata):
-        m = m.replace('\0', '^@')  # vim can't handle null bytes in Python strings
+        # vim can't handle null bytes in Python strings
+        m = {k: v.replace('\0', '^@') for k, v in m.items()}
         result.c, result.m = c, m
-        if 'CALLSIG' in m:
-            result.split = m.partition('CALLSIG')
-            vim.command('call add(res, {"word": IPythonPyeval("r.c"), '
-                                       '"menu": IPythonPyeval("r.split[0]"), '
-                                       '"info": IPythonPyeval("r.split[-1]")})')
+        if 'info' in m:
+            r.text, r.info = m['text'], m['info']
+            vim.command('call add(res, {"word": IPythonPyeval("r.c"),    '
+                                       '"menu": IPythonPyeval("r.text"), '
+                                       '"info": IPythonPyeval("r.info")})')
         else:
-            vim.command('call add(res, {"word": IPythonPyeval("r.c"), '
-                                       '"menu": IPythonPyeval("r.m")})')
+            r.text = m.get('text', '')
+            vim.command('call add(res, {"word": IPythonPyeval("r.c"),    '
+                                       '"menu": IPythonPyeval("r.text")})')
 endpython
 
 fun! CompleteIPython(findstart, base)

ftplugin/python/vim_ipython.py

@@ -18,6 +18,7 @@ def __getattribute__(self, key):
     vim = NoOp()
     print("uh oh, not running inside vim")
 
+import ast
 import os
 import sys
 import time
@@ -345,7 +346,6 @@ def get_doc_msg(msg_id):
     elif 'user_expressions' in content:
         doc = content['user_expressions']['_doc']
     if doc:
-        import ast
         content = ast.literal_eval(doc['data']['text/plain'])
 
     if not content['found']:
@@ -446,20 +446,36 @@ def ipy_complete(base, current_line, pos):
         msg_id = complete(code=current_line, cursor_pos=pos)
     try:
         m = get_child_msg(msg_id, timeout=vim_vars.get('ipython_completion_timeout', 2))
-        matches = m['content']['matches']
-        metadata = m['content'].get('metadata', None)
-        if not metadata:
-            metadata = ['' for _ in matches]
-        # we need to be careful with unicode, because we can have unicode
-        # completions for filenames (for the %run magic, for example). So the next
-        # line will fail on those:
-        #completions= [str(u) for u in matches]
-        # because str() won't work for non-ascii characters
-        # and we also have problems with unicode in vim, hence the following:
-        return matches, metadata
+        try:
+            return get_completion_metadata()
+        except KeyError:  # completion_metadata function not available
+            matches = m['content']['matches']
+            metadata = [{} for _ in matches]
+            return matches, metadata
+    except Empty:
+        echo("no reply from IPython kernel")
+        raise IOError
+
+def get_completion_metadata():
+    """Generate and fetch completion metadata."""
+    request = '_completions = completion_metadata(get_ipython())'
+    try:
+        msg_id = send(request, silent=True, user_variables=['_completions'])
+    except TypeError: # change in IPython 3.0+
+        msg_id = send(request, silent=True, user_expressions={'_completions':'_completions'})
+    try:
+        m = get_child_msg(msg_id, timeout=vim_vars.get('ipython_completion_timeout', 2))
     except Empty:
         echo("no reply from IPython kernel")
         raise IOError
+    content = m['content']
+    if 'user_variables' in content:
+        metadata = content['user_variables']['_completions']
+    else:
+        metadata = content['user_expressions']['_completions']
+    metadata = ast.literal_eval(metadata['data']['text/plain'])
+    matches = [c['match'] for c in metadata]
+    return matches, metadata
 
 def vim_ipython_is_open():
     """