##// END OF EJS Templates
Standardise some module docstring first lines
Standardise some module docstring first lines

File last commit:

r13888:74d7ea88
r13888:74d7ea88
Show More
completer.py
57 lines | 1.8 KiB | text/x-python | PythonLexer
"""Adapt readline completer interface to make ZMQ request.
"""
# -*- coding: utf-8 -*-
import readline
try:
from queue import Empty # Py 3
except ImportError:
from Queue import Empty # Py 2
from IPython.config import Configurable
from IPython.utils.traitlets import Float
class ZMQCompleter(Configurable):
"""Client-side completion machinery.
How it works: self.complete will be called multiple times, with
state=0,1,2,... When state=0 it should compute ALL the completion matches,
and then return them for each value of state."""
timeout = Float(5.0, config=True, help='timeout before completion abort')
def __init__(self, shell, client, config=None):
super(ZMQCompleter,self).__init__(config=config)
self.shell = shell
self.client = client
self.matches = []
def complete_request(self,text):
line = readline.get_line_buffer()
cursor_pos = readline.get_endidx()
# send completion request to kernel
# Give the kernel up to 0.5s to respond
msg_id = self.client.shell_channel.complete(text=text, line=line,
cursor_pos=cursor_pos)
msg = self.client.shell_channel.get_msg(timeout=self.timeout)
if msg['parent_header']['msg_id'] == msg_id:
return msg["content"]["matches"]
return []
def rlcomplete(self, text, state):
if state == 0:
try:
self.matches = self.complete_request(text)
except Empty:
#print('WARNING: Kernel timeout on tab completion.')
pass
try:
return self.matches[state]
except IndexError:
return None
def complete(self, text, line, cursor_pos=None):
return self.rlcomplete(text, 0)