frontend_widget.py
382 lines
| 14.3 KiB
| text/x-python
|
PythonLexer
epatters
|
r2687 | # Standard library imports | ||
import signal | ||||
epatters
|
r2714 | import sys | ||
epatters
|
r2687 | |||
epatters
|
r2602 | # System library imports | ||
from pygments.lexers import PythonLexer | ||||
from PyQt4 import QtCore, QtGui | ||||
import zmq | ||||
# Local imports | ||||
epatters
|
r2685 | from IPython.core.inputsplitter import InputSplitter | ||
epatters
|
r2602 | from call_tip_widget import CallTipWidget | ||
from completion_lexer import CompletionLexer | ||||
from console_widget import HistoryConsoleWidget | ||||
epatters
|
r2603 | from pygments_highlighter import PygmentsHighlighter | ||
epatters
|
r2602 | |||
class FrontendHighlighter(PygmentsHighlighter): | ||||
epatters
|
r2715 | """ A PygmentsHighlighter that can be turned on and off and that ignores | ||
prompts. | ||||
epatters
|
r2602 | """ | ||
def __init__(self, frontend): | ||||
epatters
|
r2715 | super(FrontendHighlighter, self).__init__(frontend.document()) | ||
epatters
|
r2602 | self._current_offset = 0 | ||
self._frontend = frontend | ||||
self.highlighting_on = False | ||||
def highlightBlock(self, qstring): | ||||
""" Highlight a block of text. Reimplemented to highlight selectively. | ||||
""" | ||||
epatters
|
r2715 | if not self.highlighting_on: | ||
return | ||||
# The input to this function is unicode string that may contain | ||||
# paragraph break characters, non-breaking spaces, etc. Here we acquire | ||||
# the string as plain text so we can compare it. | ||||
current_block = self.currentBlock() | ||||
string = self._frontend._get_block_plain_text(current_block) | ||||
# Decide whether to check for the regular or continuation prompt. | ||||
if current_block.contains(self._frontend._prompt_pos): | ||||
prompt = self._frontend._prompt | ||||
else: | ||||
prompt = self._frontend._continuation_prompt | ||||
# Don't highlight the part of the string that contains the prompt. | ||||
if string.startswith(prompt): | ||||
self._current_offset = len(prompt) | ||||
qstring.remove(0, len(prompt)) | ||||
else: | ||||
self._current_offset = 0 | ||||
PygmentsHighlighter.highlightBlock(self, qstring) | ||||
epatters
|
r2602 | |||
def setFormat(self, start, count, format): | ||||
epatters
|
r2715 | """ Reimplemented to highlight selectively. | ||
epatters
|
r2602 | """ | ||
start += self._current_offset | ||||
PygmentsHighlighter.setFormat(self, start, count, format) | ||||
class FrontendWidget(HistoryConsoleWidget): | ||||
epatters
|
r2627 | """ A Qt frontend for a generic Python kernel. | ||
epatters
|
r2602 | """ | ||
epatters
|
r2723 | |||
epatters
|
r2602 | # Emitted when an 'execute_reply' is received from the kernel. | ||
epatters
|
r2611 | executed = QtCore.pyqtSignal(object) | ||
epatters
|
r2602 | |||
#--------------------------------------------------------------------------- | ||||
epatters
|
r2669 | # 'QObject' interface | ||
epatters
|
r2602 | #--------------------------------------------------------------------------- | ||
epatters
|
r2643 | def __init__(self, parent=None): | ||
epatters
|
r2602 | super(FrontendWidget, self).__init__(parent) | ||
epatters
|
r2643 | # FrontendWidget protected variables. | ||
epatters
|
r2602 | self._call_tip_widget = CallTipWidget(self) | ||
self._completion_lexer = CompletionLexer(PythonLexer()) | ||||
epatters
|
r2627 | self._hidden = True | ||
epatters
|
r2602 | self._highlighter = FrontendHighlighter(self) | ||
epatters
|
r2685 | self._input_splitter = InputSplitter(input_mode='replace') | ||
epatters
|
r2611 | self._kernel_manager = None | ||
epatters
|
r2602 | |||
epatters
|
r2715 | # Configure the ConsoleWidget. | ||
epatters
|
r2723 | self.tab_width = 4 | ||
epatters
|
r2715 | self._set_continuation_prompt('... ') | ||
epatters
|
r2612 | self.document().contentsChange.connect(self._document_contents_change) | ||
epatters
|
r2669 | #--------------------------------------------------------------------------- | ||
# 'QWidget' interface | ||||
#--------------------------------------------------------------------------- | ||||
epatters
|
r2602 | def focusOutEvent(self, event): | ||
""" Reimplemented to hide calltips. | ||||
""" | ||||
self._call_tip_widget.hide() | ||||
epatters
|
r2687 | super(FrontendWidget, self).focusOutEvent(event) | ||
epatters
|
r2602 | |||
def keyPressEvent(self, event): | ||||
epatters
|
r2687 | """ Reimplemented to allow calltips to process events and to send | ||
signals to the kernel. | ||||
epatters
|
r2602 | """ | ||
epatters
|
r2687 | if self._executing and event.key() == QtCore.Qt.Key_C and \ | ||
self._control_down(event.modifiers()): | ||||
self._interrupt_kernel() | ||||
else: | ||||
epatters
|
r2688 | if self._call_tip_widget.isVisible(): | ||
self._call_tip_widget.keyPressEvent(event) | ||||
epatters
|
r2687 | super(FrontendWidget, self).keyPressEvent(event) | ||
epatters
|
r2602 | |||
#--------------------------------------------------------------------------- | ||||
# 'ConsoleWidget' abstract interface | ||||
#--------------------------------------------------------------------------- | ||||
epatters
|
r2688 | def _is_complete(self, source, interactive): | ||
""" Returns whether 'source' can be completely processed and a new | ||||
prompt created. When triggered by an Enter/Return key press, | ||||
'interactive' is True; otherwise, it is False. | ||||
epatters
|
r2602 | """ | ||
epatters
|
r2723 | complete = self._input_splitter.push(source.expandtabs(4)) | ||
epatters
|
r2688 | if interactive: | ||
complete = not self._input_splitter.push_accepts_more() | ||||
return complete | ||||
def _execute(self, source, hidden): | ||||
""" Execute 'source'. If 'hidden', do not show any output. | ||||
""" | ||||
self.kernel_manager.xreq_channel.execute(source) | ||||
self._hidden = hidden | ||||
epatters
|
r2602 | |||
def _prompt_started_hook(self): | ||||
""" Called immediately after a new prompt is displayed. | ||||
""" | ||||
epatters
|
r2709 | if not self._reading: | ||
self._highlighter.highlighting_on = True | ||||
epatters
|
r2602 | |||
epatters
|
r2709 | # Auto-indent if this is a continuation prompt. | ||
if self._get_prompt_cursor().blockNumber() != \ | ||||
self._get_end_cursor().blockNumber(): | ||||
epatters
|
r2716 | spaces = self._input_splitter.indent_spaces | ||
epatters
|
r2721 | self.appendPlainText('\t' * (spaces / self.tab_width)) | ||
self.appendPlainText(' ' * (spaces % self.tab_width)) | ||||
epatters
|
r2688 | |||
epatters
|
r2602 | 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. | ||||
""" | ||||
epatters
|
r2709 | if not self._reading: | ||
self._highlighter.highlighting_on = False | ||||
epatters
|
r2602 | |||
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() | ||||
epatters
|
r2716 | return not self._complete() | ||
epatters
|
r2602 | |||
#--------------------------------------------------------------------------- | ||||
# 'FrontendWidget' interface | ||||
#--------------------------------------------------------------------------- | ||||
def execute_file(self, path, hidden=False): | ||||
""" Attempts to execute file with 'path'. If 'hidden', no output is | ||||
shown. | ||||
""" | ||||
epatters
|
r2688 | self.execute('execfile("%s")' % path, hidden=hidden) | ||
epatters
|
r2602 | |||
epatters
|
r2609 | def _get_kernel_manager(self): | ||
""" Returns the current kernel manager. | ||||
""" | ||||
return self._kernel_manager | ||||
def _set_kernel_manager(self, kernel_manager): | ||||
epatters
|
r2643 | """ Disconnect from the current kernel manager (if any) and set a new | ||
kernel manager. | ||||
epatters
|
r2609 | """ | ||
epatters
|
r2643 | # Disconnect the old kernel manager, if necessary. | ||
epatters
|
r2611 | if self._kernel_manager is not None: | ||
epatters
|
r2701 | self._kernel_manager.started_channels.disconnect( | ||
self._started_channels) | ||||
self._kernel_manager.stopped_channels.disconnect( | ||||
self._stopped_channels) | ||||
epatters
|
r2643 | |||
# Disconnect the old kernel manager's channels. | ||||
epatters
|
r2611 | sub = self._kernel_manager.sub_channel | ||
xreq = self._kernel_manager.xreq_channel | ||||
epatters
|
r2707 | rep = self._kernel_manager.rep_channel | ||
epatters
|
r2611 | 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) | ||||
epatters
|
r2730 | rep.input_requested.disconnect(self._handle_req) | ||
epatters
|
r2611 | |||
epatters
|
r2702 | # Handle the case where the old kernel manager is still listening. | ||
Brian Granger
|
r2699 | if self._kernel_manager.channels_running: | ||
epatters
|
r2701 | self._stopped_channels() | ||
epatters
|
r2687 | |||
epatters
|
r2643 | # Set the new kernel manager. | ||
epatters
|
r2609 | self._kernel_manager = kernel_manager | ||
epatters
|
r2643 | if kernel_manager is None: | ||
return | ||||
# Connect the new kernel manager. | ||||
epatters
|
r2701 | kernel_manager.started_channels.connect(self._started_channels) | ||
kernel_manager.stopped_channels.connect(self._stopped_channels) | ||||
epatters
|
r2643 | |||
# Connect the new kernel manager's channels. | ||||
epatters
|
r2611 | sub = kernel_manager.sub_channel | ||
xreq = kernel_manager.xreq_channel | ||||
epatters
|
r2707 | rep = kernel_manager.rep_channel | ||
epatters
|
r2611 | sub.message_received.connect(self._handle_sub) | ||
xreq.execute_reply.connect(self._handle_execute_reply) | ||||
epatters
|
r2612 | xreq.complete_reply.connect(self._handle_complete_reply) | ||
xreq.object_info_reply.connect(self._handle_object_info_reply) | ||||
epatters
|
r2730 | rep.input_requested.connect(self._handle_req) | ||
epatters
|
r2611 | |||
epatters
|
r2701 | # Handle the case where the kernel manager started channels before | ||
epatters
|
r2643 | # we connected. | ||
Brian Granger
|
r2699 | if kernel_manager.channels_running: | ||
epatters
|
r2701 | self._started_channels() | ||
epatters
|
r2609 | |||
kernel_manager = property(_get_kernel_manager, _set_kernel_manager) | ||||
epatters
|
r2602 | #--------------------------------------------------------------------------- | ||
# '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 | ||||
epatters
|
r2612 | name = '.'.join(context) | ||
self._calltip_id = self.kernel_manager.xreq_channel.object_info(name) | ||||
self._calltip_pos = self.textCursor().position() | ||||
epatters
|
r2602 | 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) | ||||
epatters
|
r2612 | self._complete_id = self.kernel_manager.xreq_channel.complete( | ||
text, self.input_buffer_cursor_line, self.input_buffer) | ||||
self._complete_pos = self.textCursor().position() | ||||
epatters
|
r2602 | return True | ||
epatters
|
r2714 | def _get_banner(self): | ||
""" Gets a banner to display at the beginning of a session. | ||||
""" | ||||
banner = 'Python %s on %s\nType "help", "copyright", "credits" or ' \ | ||||
'"license" for more information.' | ||||
return banner % (sys.version, sys.platform) | ||||
epatters
|
r2602 | 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) | ||||
epatters
|
r2720 | text = str(cursor.selection().toPlainText()) | ||
epatters
|
r2602 | return self._completion_lexer.get_context(text) | ||
epatters
|
r2687 | def _interrupt_kernel(self): | ||
""" Attempts to the interrupt the kernel. | ||||
""" | ||||
if self.kernel_manager.has_kernel: | ||||
self.kernel_manager.signal_kernel(signal.SIGINT) | ||||
else: | ||||
self.appendPlainText('Kernel process is either remote or ' | ||||
'unspecified. Cannot interrupt.\n') | ||||
epatters
|
r2715 | def _show_interpreter_prompt(self): | ||
""" Shows a prompt for the interpreter. | ||||
""" | ||||
self._show_prompt('>>> ') | ||||
epatters
|
r2602 | #------ Signal handlers ---------------------------------------------------- | ||
epatters
|
r2705 | def _started_channels(self): | ||
""" Called when the kernel manager has started listening. | ||||
""" | ||||
epatters
|
r2715 | self._reset() | ||
epatters
|
r2714 | self.appendPlainText(self._get_banner()) | ||
epatters
|
r2715 | self._show_interpreter_prompt() | ||
epatters
|
r2705 | |||
def _stopped_channels(self): | ||||
""" Called when the kernel manager has stopped listening. | ||||
""" | ||||
epatters
|
r2715 | # FIXME: Print a message here? | ||
epatters
|
r2705 | pass | ||
epatters
|
r2602 | 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() | ||||
epatters
|
r2707 | def _handle_req(self, req): | ||
epatters
|
r2708 | # Make sure that all output from the SUB channel has been processed | ||
# before entering readline mode. | ||||
self.kernel_manager.sub_channel.flush() | ||||
epatters
|
r2706 | def callback(line): | ||
epatters
|
r2730 | self.kernel_manager.rep_channel.input(line) | ||
self._readline(req['content']['prompt'], callback=callback) | ||||
epatters
|
r2705 | |||
epatters
|
r2611 | def _handle_sub(self, omsg): | ||
epatters
|
r2688 | if self._hidden: | ||
return | ||||
handler = getattr(self, '_handle_%s' % omsg['msg_type'], None) | ||||
if handler is not None: | ||||
handler(omsg) | ||||
epatters
|
r2602 | |||
def _handle_pyout(self, omsg): | ||||
epatters
|
r2715 | self.appendPlainText(omsg['content']['data'] + '\n') | ||
epatters
|
r2602 | |||
def _handle_stream(self, omsg): | ||||
epatters
|
r2611 | self.appendPlainText(omsg['content']['data']) | ||
epatters
|
r2688 | self.moveCursor(QtGui.QTextCursor.End) | ||
epatters
|
r2602 | |||
epatters
|
r2716 | def _handle_execute_reply(self, reply): | ||
epatters
|
r2688 | if self._hidden: | ||
return | ||||
epatters
|
r2614 | # Make sure that all output from the SUB channel has been processed | ||
# before writing a new prompt. | ||||
self.kernel_manager.sub_channel.flush() | ||||
epatters
|
r2716 | status = reply['content']['status'] | ||
epatters
|
r2611 | if status == 'error': | ||
epatters
|
r2716 | self._handle_execute_error(reply) | ||
epatters
|
r2611 | elif status == 'aborted': | ||
text = "ERROR: ABORTED\n" | ||||
self.appendPlainText(text) | ||||
epatters
|
r2627 | self._hidden = True | ||
epatters
|
r2715 | self._show_interpreter_prompt() | ||
epatters
|
r2716 | self.executed.emit(reply) | ||
def _handle_execute_error(self, reply): | ||||
content = reply['content'] | ||||
traceback = ''.join(content['traceback']) | ||||
self.appendPlainText(traceback) | ||||
epatters
|
r2602 | |||
epatters
|
r2612 | 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']) | ||||
epatters
|
r2602 | |||
epatters
|
r2612 | 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: | ||||
epatters
|
r2666 | self._call_tip_widget.show_docstring(doc) | ||