* Adding object_info_request support to prototype kernel.

* Completion and calltips work again in FrontendWidget

IPython/frontend/qt/console/frontend_widget.py

@@ -1,330 +1,316 b''
 # Standard library imports
 from codeop import CommandCompiler
 from threading import Thread
 import time
 import types
 
 # System library imports
 from pygments.lexers import PythonLexer
 from PyQt4 import QtCore, QtGui
 import zmq
 
 # Local imports
 from call_tip_widget import CallTipWidget
 from completion_lexer import CompletionLexer
 from console_widget import HistoryConsoleWidget
 from pygments_highlighter import PygmentsHighlighter
 
 
 class FrontendHighlighter(PygmentsHighlighter):
     """ A Python PygmentsHighlighter that can be turned on and off and which 
         knows about continuation prompts.
     """
 
     def __init__(self, frontend):
         PygmentsHighlighter.__init__(self, frontend.document(), PythonLexer())
         self._current_offset = 0
         self._frontend = frontend
         self.highlighting_on = False
 
     def highlightBlock(self, qstring):
         """ Highlight a block of text. Reimplemented to highlight selectively.
         """
         if self.highlighting_on:
             for prompt in (self._frontend._prompt, 
                            self._frontend.continuation_prompt):
                 if qstring.startsWith(prompt):
                     qstring.remove(0, len(prompt))
                     self._current_offset = len(prompt)
                     break
             PygmentsHighlighter.highlightBlock(self, qstring)
 
     def setFormat(self, start, count, format):
         """ Reimplemented to avoid highlighting continuation prompts.
         """
         start += self._current_offset
         PygmentsHighlighter.setFormat(self, start, count, format)
 
 
 class FrontendWidget(HistoryConsoleWidget):
     """ A Qt frontend for an IPython kernel.
     """
 
     # Emitted when an 'execute_reply' is received from the kernel.
     executed = QtCore.pyqtSignal(object)
 
     #---------------------------------------------------------------------------
     # 'QWidget' interface
     #---------------------------------------------------------------------------
     
     def __init__(self, kernel_manager, parent=None):
         super(FrontendWidget, self).__init__(parent)
 
         self._call_tip_widget = CallTipWidget(self)
         self._compile = CommandCompiler()
         self._completion_lexer = CompletionLexer(PythonLexer())
         self._highlighter = FrontendHighlighter(self)
         self._kernel_manager = None
 
-        self.document().contentsChange.connect(self._document_contents_change)
-
         self.continuation_prompt = '... '
         self.kernel_manager = kernel_manager
 
+        self.document().contentsChange.connect(self._document_contents_change)
+
     def focusOutEvent(self, event):
         """ Reimplemented to hide calltips.
         """
         self._call_tip_widget.hide()
         return super(FrontendWidget, self).focusOutEvent(event)
 
     def keyPressEvent(self, event):
         """ Reimplemented to hide calltips.
         """
         if event.key() == QtCore.Qt.Key_Escape:
             self._call_tip_widget.hide()
         return super(FrontendWidget, self).keyPressEvent(event)
 
     #---------------------------------------------------------------------------
     # 'ConsoleWidget' abstract interface
     #---------------------------------------------------------------------------
 
     def _execute(self, interactive):
         """ Called to execute the input buffer. When triggered by an the enter
             key press, 'interactive' is True; otherwise, it is False. Returns
             whether the input buffer was completely processed and a new prompt
             created.
         """
         return self.execute_source(self.input_buffer, interactive=interactive)
         
     def _prompt_started_hook(self):
         """ Called immediately after a new prompt is displayed.
         """
         self._highlighter.highlighting_on = True
 
     def _prompt_finished_hook(self):
         """ Called immediately after a prompt is finished, i.e. when some input
             will be processed and a new prompt displayed.
         """
         self._highlighter.highlighting_on = False
 
     def _tab_pressed(self):
         """ Called when the tab key is pressed. Returns whether to continue
             processing the event.
         """
         self._keep_cursor_in_buffer()
         cursor = self.textCursor()
         if not self._complete():
             cursor.insertText('    ')
         return False
 
     #---------------------------------------------------------------------------
     # 'FrontendWidget' interface
     #---------------------------------------------------------------------------
 
     def execute_source(self, source, hidden=False, interactive=False):
         """ Execute a string containing Python code. If 'hidden', no output is
             shown. Returns whether the source executed (i.e., returns True only
             if no more input is necessary).
         """
         try:
             code = self._compile(source, symbol='single')
         except (OverflowError, SyntaxError, ValueError):
             # Just let IPython deal with the syntax error.
             code = Exception
             
         # Only execute interactive multiline input if it ends with a blank line
         lines = source.splitlines()
         if interactive and len(lines) > 1 and lines[-1].strip() != '':
             code = None
             
         executed = code is not None
         if executed:
             self.kernel_manager.xreq_channel.execute(source)
         else:
             space = 0
             for char in lines[-1]:
                 if char == '\t':
                     space += 4
                 elif char == ' ':
                     space += 1
                 else:
                     break
             if source.endswith(':') or source.endswith(':\n'):
                 space += 4
             self._show_continuation_prompt()
             self.appendPlainText(' ' * space)
 
         return executed
 
     def execute_file(self, path, hidden=False):
         """ Attempts to execute file with 'path'. If 'hidden', no output is
             shown.
         """
         self.execute_source('run %s' % path, hidden=hidden)
 
     def _get_kernel_manager(self):
         """ Returns the current kernel manager.
         """
         return self._kernel_manager
 
     def _set_kernel_manager(self, kernel_manager):
         """ Sets a new kernel manager, configuring its channels as necessary.
         """
         # Disconnect the old kernel manager.
         if self._kernel_manager is not None:
             sub = self._kernel_manager.sub_channel
             xreq = self._kernel_manager.xreq_channel
             sub.message_received.disconnect(self._handle_sub)
             xreq.execute_reply.disconnect(self._handle_execute_reply)
             xreq.complete_reply.disconnect(self._handle_complete_reply)
             xreq.object_info_reply.disconnect(self._handle_object_info_reply)
 
         # Connect the new kernel manager.
         self._kernel_manager = kernel_manager
         sub = kernel_manager.sub_channel
         xreq = kernel_manager.xreq_channel
         sub.message_received.connect(self._handle_sub)
         xreq.execute_reply.connect(self._handle_execute_reply)
-        #xreq.complete_reply.connect(self._handle_complete_reply)
-        #xreq.object_info_repy.connect(self._handle_object_info_reply)
+        xreq.complete_reply.connect(self._handle_complete_reply)
+        xreq.object_info_reply.connect(self._handle_object_info_reply)
         
         self._show_prompt('>>> ')
 
     kernel_manager = property(_get_kernel_manager, _set_kernel_manager)
 
     #---------------------------------------------------------------------------
     # 'FrontendWidget' protected interface
     #---------------------------------------------------------------------------
 
     def _call_tip(self):
         """ Shows a call tip, if appropriate, at the current cursor location.
         """
         # Decide if it makes sense to show a call tip
         cursor = self.textCursor()
         cursor.movePosition(QtGui.QTextCursor.Left)
         document = self.document()
         if document.characterAt(cursor.position()).toAscii() != '(':
             return False
         context = self._get_context(cursor)
         if not context:
             return False
 
         # Send the metadata request to the kernel
-        text = '.'.join(context)
-        msg = self.session.send(self.request_socket, 'metadata_request',
-                                dict(context=text))
-        
-        # Give the kernel some time to respond
-        rep = self._recv_reply_now('metadata_reply')
-        doc = rep.content.docstring if rep else ''
-
-        # Show the call tip
-        if doc:
-            self._call_tip_widget.show_tip(doc)
+        name = '.'.join(context)
+        self._calltip_id = self.kernel_manager.xreq_channel.object_info(name)
+        self._calltip_pos = self.textCursor().position()
         return True
 
     def _complete(self):
         """ Performs completion at the current cursor location.
         """
         # Decide if it makes sense to do completion
         context = self._get_context()
         if not context:
             return False
 
         # Send the completion request to the kernel
         text = '.'.join(context)
-        line = self.input_buffer_cursor_line
-        msg = self.session.send(self.request_socket, 'complete_request',
-                                dict(text=text, line=line))
-        
-        # Give the kernel some time to respond
-        rep = self._recv_reply_now('complete_reply')
-        matches = rep.content.matches if rep else []
-
-        # Show the completion at the correct location
-        cursor = self.textCursor()
-        cursor.movePosition(QtGui.QTextCursor.Left, n=len(text))
-        self._complete_with_items(cursor, matches)
+        self._complete_id = self.kernel_manager.xreq_channel.complete(
+            text, self.input_buffer_cursor_line, self.input_buffer)
+        self._complete_pos = self.textCursor().position()
         return True
 
     def _get_context(self, cursor=None):
         """ Gets the context at the current cursor location.
         """
         if cursor is None:
             cursor = self.textCursor()
         cursor.movePosition(QtGui.QTextCursor.StartOfLine, 
                             QtGui.QTextCursor.KeepAnchor)
         text = unicode(cursor.selectedText())
         return self._completion_lexer.get_context(text)
 
     #------ Signal handlers ----------------------------------------------------
 
     def _document_contents_change(self, position, removed, added):
         """ Called whenever the document's content changes. Display a calltip
             if appropriate.
         """
         # Calculate where the cursor should be *after* the change:
         position += added
 
         document = self.document()
         if position == self.textCursor().position():
             self._call_tip()
 
     def _handle_sub(self, omsg):
         handler = getattr(self, '_handle_%s' % omsg['msg_type'], None)
         if handler is not None:
             handler(omsg)
 
     def _handle_pyout(self, omsg):
         session = omsg['parent_header']['session']
         if session == self.kernel_manager.session.session:
             self.appendPlainText(omsg['content']['data'] + '\n')
 
     def _handle_stream(self, omsg):
         self.appendPlainText(omsg['content']['data'])
         
     def _handle_execute_reply(self, rep):
         content = rep['content']
         status = content['status']
         if status == 'error':
             self.appendPlainText(content['traceback'][-1])
         elif status == 'aborted':
             text = "ERROR: ABORTED\n"
             self.appendPlainText(text)
         self._show_prompt('>>> ')
         self.executed.emit(rep)
 
-    #------ Communication methods ----------------------------------------------
-
-    def _recv_reply(self):
-        return self.session.recv(self.request_socket)
+    def _handle_complete_reply(self, rep):
+        cursor = self.textCursor()
+        if rep['parent_header']['msg_id'] == self._complete_id and \
+                cursor.position() == self._complete_pos:
+            text = '.'.join(self._get_context())
+            cursor.movePosition(QtGui.QTextCursor.Left, n=len(text))
+            self._complete_with_items(cursor, rep['content']['matches'])
 
-    def _recv_reply_now(self, msg_type):
-        for i in xrange(5):
-            rep = self._recv_reply()
-            if rep is not None and rep.msg_type == msg_type:
-                return rep
-            time.sleep(0.1)
-        return None
+    def _handle_object_info_reply(self, rep):
+        cursor = self.textCursor()
+        if rep['parent_header']['msg_id'] == self._calltip_id and \
+                cursor.position() == self._calltip_pos:
+            doc = rep['content']['docstring']
+            if doc:
+                self._call_tip_widget.show_tip(doc)
 
 
 if __name__ == '__main__':
     import sys
     from IPython.frontend.qt.kernelmanager import QtKernelManager
 
     # Create KernelManager
     xreq_addr = ('127.0.0.1', 5575)
     sub_addr = ('127.0.0.1', 5576)
     rep_addr = ('127.0.0.1', 5577)
     kernel_manager = QtKernelManager(xreq_addr, sub_addr, rep_addr)
     kernel_manager.sub_channel.start()
     kernel_manager.xreq_channel.start()
 
     # Launch application
     app = QtGui.QApplication(sys.argv)
     widget = FrontendWidget(kernel_manager)
     widget.setWindowTitle('Python')
     widget.resize(640, 480)
     widget.show()
     sys.exit(app.exec_())
     

IPython/zmq/kernel.py

@@ -1,272 +1,311 b''
 #!/usr/bin/env python
 """A simple interactive kernel that talks to a frontend over 0MQ.
 
 Things to do:
 
 * Finish implementing `raw_input`.
 * Implement `set_parent` logic. Right before doing exec, the Kernel should
   call set_parent on all the PUB objects with the message about to be executed.
 * Implement random port and security key logic.
 * Implement control messages.
 * Implement event loop and poll version.
 """
 
 import __builtin__
 import sys
 import time
 import traceback
 
 from code import CommandCompiler
 
 import zmq
 
 from session import Session, Message, extract_header
 from completer import KernelCompleter
 
 class OutStream(object):
     """A file like object that publishes the stream to a 0MQ PUB socket."""
 
     def __init__(self, session, pub_socket, name, max_buffer=200):
         self.session = session
         self.pub_socket = pub_socket
         self.name = name
         self._buffer = []
         self._buffer_len = 0
         self.max_buffer = max_buffer
         self.parent_header = {}
 
     def set_parent(self, parent):
         self.parent_header = extract_header(parent)
 
     def close(self):
         self.pub_socket = None
 
     def flush(self):
         if self.pub_socket is None:
             raise ValueError(u'I/O operation on closed file')
         else:
             if self._buffer:
                 data = ''.join(self._buffer)
                 content = {u'name':self.name, u'data':data}
                 msg = self.session.msg(u'stream', content=content,
                                        parent=self.parent_header)
                 print>>sys.__stdout__, Message(msg)
                 self.pub_socket.send_json(msg)
                 self._buffer_len = 0
                 self._buffer = []
 
     def isattr(self):
         return False
 
     def next(self):
         raise IOError('Read not supported on a write only stream.')
 
     def read(self, size=None):
         raise IOError('Read not supported on a write only stream.')
 
     readline=read
 
     def write(self, s):
         if self.pub_socket is None:
             raise ValueError('I/O operation on closed file')
         else:
             self._buffer.append(s)
             self._buffer_len += len(s)
             self._maybe_send()
 
     def _maybe_send(self):
         if '\n' in self._buffer[-1]:
             self.flush()
         if self._buffer_len > self.max_buffer:
             self.flush()
 
     def writelines(self, sequence):
         if self.pub_socket is None:
             raise ValueError('I/O operation on closed file')
         else:
             for s in sequence:
                 self.write(s)
 
 
 class DisplayHook(object):
 
     def __init__(self, session, pub_socket):
         self.session = session
         self.pub_socket = pub_socket
         self.parent_header = {}
 
     def __call__(self, obj):
         if obj is None:
             return
 
         __builtin__._ = obj
         msg = self.session.msg(u'pyout', {u'data':repr(obj)},
                                parent=self.parent_header)
         self.pub_socket.send_json(msg)
 
     def set_parent(self, parent):
         self.parent_header = extract_header(parent)
 
 
 class RawInput(object):
 
     def __init__(self, session, socket):
         self.session = session
         self.socket = socket
 
     def __call__(self, prompt=None):
         msg = self.session.msg(u'raw_input')
         self.socket.send_json(msg)
         while True:
             try:
                 reply = self.socket.recv_json(zmq.NOBLOCK)
             except zmq.ZMQError, e:
                 if e.errno == zmq.EAGAIN:
                     pass
                 else:
                     raise
             else:
                 break
         return reply[u'content'][u'data']
 
 
 class Kernel(object):
 
     def __init__(self, session, reply_socket, pub_socket):
         self.session = session
         self.reply_socket = reply_socket
         self.pub_socket = pub_socket
         self.user_ns = {}
         self.history = []
         self.compiler = CommandCompiler()
         self.completer = KernelCompleter(self.user_ns)
         
         # Build dict of handlers for message types
+        msg_types = [ 'execute_request', 'complete_request', 
+                      'object_info_request' ]
         self.handlers = {}
-        for msg_type in ['execute_request', 'complete_request']:
+        for msg_type in msg_types:
             self.handlers[msg_type] = getattr(self, msg_type)
 
     def abort_queue(self):
         while True:
             try:
                 ident = self.reply_socket.recv(zmq.NOBLOCK)
             except zmq.ZMQError, e:
                 if e.errno == zmq.EAGAIN:
                     break
             else:
                 assert self.reply_socket.rcvmore(), "Unexpected missing message part."
                 msg = self.reply_socket.recv_json()
             print>>sys.__stdout__, "Aborting:"
             print>>sys.__stdout__, Message(msg)
             msg_type = msg['msg_type']
             reply_type = msg_type.split('_')[0] + '_reply'
             reply_msg = self.session.msg(reply_type, {'status' : 'aborted'}, msg)
             print>>sys.__stdout__, Message(reply_msg)
             self.reply_socket.send(ident,zmq.SNDMORE)
             self.reply_socket.send_json(reply_msg)
             # We need to wait a bit for requests to come in. This can probably
             # be set shorter for true asynchronous clients.
             time.sleep(0.1)
 
     def execute_request(self, ident, parent):
         try:
             code = parent[u'content'][u'code']
         except:
             print>>sys.__stderr__, "Got bad msg: "
             print>>sys.__stderr__, Message(parent)
             return
         pyin_msg = self.session.msg(u'pyin',{u'code':code}, parent=parent)
         self.pub_socket.send_json(pyin_msg)
         try:
             comp_code = self.compiler(code, '<zmq-kernel>')
             sys.displayhook.set_parent(parent)
             exec comp_code in self.user_ns, self.user_ns
         except:
             result = u'error'
             etype, evalue, tb = sys.exc_info()
             tb = traceback.format_exception(etype, evalue, tb)
             exc_content = {
                 u'status' : u'error',
                 u'traceback' : tb,
                 u'etype' : unicode(etype),
                 u'evalue' : unicode(evalue)
             }
             exc_msg = self.session.msg(u'pyerr', exc_content, parent)
             self.pub_socket.send_json(exc_msg)
             reply_content = exc_content
         else:
             reply_content = {'status' : 'ok'}
         reply_msg = self.session.msg(u'execute_reply', reply_content, parent)
         print>>sys.__stdout__, Message(reply_msg)
         self.reply_socket.send(ident, zmq.SNDMORE)
         self.reply_socket.send_json(reply_msg)
         if reply_msg['content']['status'] == u'error':
             self.abort_queue()
 
     def complete_request(self, ident, parent):
         matches = {'matches' : self.complete(parent),
                    'status' : 'ok'}
         completion_msg = self.session.send(self.reply_socket, 'complete_reply',
                                            matches, parent, ident)
         print >> sys.__stdout__, completion_msg
 
     def complete(self, msg):
         return self.completer.complete(msg.content.line, msg.content.text)
 
+    def object_info_request(self, ident, parent):
+        context = parent['content']['oname'].split('.')
+        object_info = self.object_info(context)
+        msg = self.session.send(self.reply_socket, 'object_info_reply',
+                                object_info, parent, ident)
+        print >> sys.__stdout__, msg
+
+    def object_info(self, context):
+        symbol, leftover = self.symbol_from_context(context)
+        if symbol is not None and not leftover:
+            doc = getattr(symbol, '__doc__', '')
+        else:
+            doc = ''
+        object_info = dict(docstring = doc)
+        return object_info
+
+    def symbol_from_context(self, context):
+        if not context:
+            return None, context
+
+        base_symbol_string = context[0]
+        symbol = self.user_ns.get(base_symbol_string, None)
+        if symbol is None:
+            symbol = __builtin__.__dict__.get(base_symbol_string, None)
+        if symbol is None:
+            return None, context
+
+        context = context[1:]
+        for i, name in enumerate(context):
+            new_symbol = getattr(symbol, name, None)
+            if new_symbol is None:
+                return symbol, context[i:]
+            else:
+                symbol = new_symbol
+
+        return symbol, []
+
     def start(self):
         while True:
             ident = self.reply_socket.recv()
             assert self.reply_socket.rcvmore(), "Unexpected missing message part."
             msg = self.reply_socket.recv_json()
             omsg = Message(msg)
             print>>sys.__stdout__
             print>>sys.__stdout__, omsg
             handler = self.handlers.get(omsg.msg_type, None)
             if handler is None:
                 print >> sys.__stderr__, "UNKNOWN MESSAGE TYPE:", omsg
             else:
                 handler(ident, omsg)
 
 
 def main():
     c = zmq.Context()
 
     ip = '127.0.0.1'
     port_base = 5575
     connection = ('tcp://%s' % ip) + ':%i'
     rep_conn = connection % port_base
     pub_conn = connection % (port_base+1)
 
     print >>sys.__stdout__, "Starting the kernel..."
     print >>sys.__stdout__, "XREP Channel:", rep_conn
     print >>sys.__stdout__, "PUB Channel:", pub_conn
 
     session = Session(username=u'kernel')
 
     reply_socket = c.socket(zmq.XREP)
     reply_socket.bind(rep_conn)
 
     pub_socket = c.socket(zmq.PUB)
     pub_socket.bind(pub_conn)
 
     stdout = OutStream(session, pub_socket, u'stdout')
     stderr = OutStream(session, pub_socket, u'stderr')
     sys.stdout = stdout
     sys.stderr = stderr
 
     display_hook = DisplayHook(session, pub_socket)
     sys.displayhook = display_hook
 
     kernel = Kernel(session, reply_socket, pub_socket)
 
     # For debugging convenience, put sleep and a string in the namespace, so we
     # have them every time we start.
     kernel.user_ns['sleep'] = time.sleep
     kernel.user_ns['s'] = 'Test string'
     
     print >>sys.__stdout__, "Use Ctrl-\\ (NOT Ctrl-C!) to terminate."
     kernel.start()
 
 
 if __name__ == '__main__':
     main()