Show More
@@ -1,330 +1,330 b'' | |||||
1 | # Standard library imports |
|
1 | # Standard library imports | |
2 | import signal |
|
2 | import signal | |
3 |
|
3 | |||
4 | # System library imports |
|
4 | # System library imports | |
5 | from pygments.lexers import PythonLexer |
|
5 | from pygments.lexers import PythonLexer | |
6 | from PyQt4 import QtCore, QtGui |
|
6 | from PyQt4 import QtCore, QtGui | |
7 | import zmq |
|
7 | import zmq | |
8 |
|
8 | |||
9 | # Local imports |
|
9 | # Local imports | |
10 | from IPython.core.inputsplitter import InputSplitter |
|
10 | from IPython.core.inputsplitter import InputSplitter | |
11 | from call_tip_widget import CallTipWidget |
|
11 | from call_tip_widget import CallTipWidget | |
12 | from completion_lexer import CompletionLexer |
|
12 | from completion_lexer import CompletionLexer | |
13 | from console_widget import HistoryConsoleWidget |
|
13 | from console_widget import HistoryConsoleWidget | |
14 | from pygments_highlighter import PygmentsHighlighter |
|
14 | from pygments_highlighter import PygmentsHighlighter | |
15 |
|
15 | |||
16 |
|
16 | |||
17 | class FrontendHighlighter(PygmentsHighlighter): |
|
17 | class FrontendHighlighter(PygmentsHighlighter): | |
18 | """ A Python PygmentsHighlighter that can be turned on and off and which |
|
18 | """ A Python PygmentsHighlighter that can be turned on and off and which | |
19 | knows about continuation prompts. |
|
19 | knows about continuation prompts. | |
20 | """ |
|
20 | """ | |
21 |
|
21 | |||
22 | def __init__(self, frontend): |
|
22 | def __init__(self, frontend): | |
23 | PygmentsHighlighter.__init__(self, frontend.document(), PythonLexer()) |
|
23 | PygmentsHighlighter.__init__(self, frontend.document(), PythonLexer()) | |
24 | self._current_offset = 0 |
|
24 | self._current_offset = 0 | |
25 | self._frontend = frontend |
|
25 | self._frontend = frontend | |
26 | self.highlighting_on = False |
|
26 | self.highlighting_on = False | |
27 |
|
27 | |||
28 | def highlightBlock(self, qstring): |
|
28 | def highlightBlock(self, qstring): | |
29 | """ Highlight a block of text. Reimplemented to highlight selectively. |
|
29 | """ Highlight a block of text. Reimplemented to highlight selectively. | |
30 | """ |
|
30 | """ | |
31 | if self.highlighting_on: |
|
31 | if self.highlighting_on: | |
32 | for prompt in (self._frontend._continuation_prompt, |
|
32 | for prompt in (self._frontend._continuation_prompt, | |
33 | self._frontend._prompt): |
|
33 | self._frontend._prompt): | |
34 | if qstring.startsWith(prompt): |
|
34 | if qstring.startsWith(prompt): | |
35 | qstring.remove(0, len(prompt)) |
|
35 | qstring.remove(0, len(prompt)) | |
36 | self._current_offset = len(prompt) |
|
36 | self._current_offset = len(prompt) | |
37 | break |
|
37 | break | |
38 | PygmentsHighlighter.highlightBlock(self, qstring) |
|
38 | PygmentsHighlighter.highlightBlock(self, qstring) | |
39 |
|
39 | |||
40 | def setFormat(self, start, count, format): |
|
40 | def setFormat(self, start, count, format): | |
41 | """ Reimplemented to avoid highlighting continuation prompts. |
|
41 | """ Reimplemented to avoid highlighting continuation prompts. | |
42 | """ |
|
42 | """ | |
43 | start += self._current_offset |
|
43 | start += self._current_offset | |
44 | PygmentsHighlighter.setFormat(self, start, count, format) |
|
44 | PygmentsHighlighter.setFormat(self, start, count, format) | |
45 |
|
45 | |||
46 |
|
46 | |||
47 | class FrontendWidget(HistoryConsoleWidget): |
|
47 | class FrontendWidget(HistoryConsoleWidget): | |
48 | """ A Qt frontend for a generic Python kernel. |
|
48 | """ A Qt frontend for a generic Python kernel. | |
49 | """ |
|
49 | """ | |
50 |
|
50 | |||
51 | # Emitted when an 'execute_reply' is received from the kernel. |
|
51 | # Emitted when an 'execute_reply' is received from the kernel. | |
52 | executed = QtCore.pyqtSignal(object) |
|
52 | executed = QtCore.pyqtSignal(object) | |
53 |
|
53 | |||
54 | #--------------------------------------------------------------------------- |
|
54 | #--------------------------------------------------------------------------- | |
55 | # 'QObject' interface |
|
55 | # 'QObject' interface | |
56 | #--------------------------------------------------------------------------- |
|
56 | #--------------------------------------------------------------------------- | |
57 |
|
57 | |||
58 | def __init__(self, parent=None): |
|
58 | def __init__(self, parent=None): | |
59 | super(FrontendWidget, self).__init__(parent) |
|
59 | super(FrontendWidget, self).__init__(parent) | |
60 |
|
60 | |||
61 | # ConsoleWidget protected variables. |
|
61 | # ConsoleWidget protected variables. | |
62 | self._continuation_prompt = '... ' |
|
62 | self._continuation_prompt = '... ' | |
63 | self._prompt = '>>> ' |
|
63 | self._prompt = '>>> ' | |
64 |
|
64 | |||
65 | # FrontendWidget protected variables. |
|
65 | # FrontendWidget protected variables. | |
66 | self._call_tip_widget = CallTipWidget(self) |
|
66 | self._call_tip_widget = CallTipWidget(self) | |
67 | self._completion_lexer = CompletionLexer(PythonLexer()) |
|
67 | self._completion_lexer = CompletionLexer(PythonLexer()) | |
68 | self._hidden = True |
|
68 | self._hidden = True | |
69 | self._highlighter = FrontendHighlighter(self) |
|
69 | self._highlighter = FrontendHighlighter(self) | |
70 | self._input_splitter = InputSplitter(input_mode='replace') |
|
70 | self._input_splitter = InputSplitter(input_mode='replace') | |
71 | self._kernel_manager = None |
|
71 | self._kernel_manager = None | |
72 |
|
72 | |||
73 | self.document().contentsChange.connect(self._document_contents_change) |
|
73 | self.document().contentsChange.connect(self._document_contents_change) | |
74 |
|
74 | |||
75 | #--------------------------------------------------------------------------- |
|
75 | #--------------------------------------------------------------------------- | |
76 | # 'QWidget' interface |
|
76 | # 'QWidget' interface | |
77 | #--------------------------------------------------------------------------- |
|
77 | #--------------------------------------------------------------------------- | |
78 |
|
78 | |||
79 | def focusOutEvent(self, event): |
|
79 | def focusOutEvent(self, event): | |
80 | """ Reimplemented to hide calltips. |
|
80 | """ Reimplemented to hide calltips. | |
81 | """ |
|
81 | """ | |
82 | self._call_tip_widget.hide() |
|
82 | self._call_tip_widget.hide() | |
83 | super(FrontendWidget, self).focusOutEvent(event) |
|
83 | super(FrontendWidget, self).focusOutEvent(event) | |
84 |
|
84 | |||
85 | def keyPressEvent(self, event): |
|
85 | def keyPressEvent(self, event): | |
86 | """ Reimplemented to allow calltips to process events and to send |
|
86 | """ Reimplemented to allow calltips to process events and to send | |
87 | signals to the kernel. |
|
87 | signals to the kernel. | |
88 | """ |
|
88 | """ | |
89 | if self._executing and event.key() == QtCore.Qt.Key_C and \ |
|
89 | if self._executing and event.key() == QtCore.Qt.Key_C and \ | |
90 | self._control_down(event.modifiers()): |
|
90 | self._control_down(event.modifiers()): | |
91 | self._interrupt_kernel() |
|
91 | self._interrupt_kernel() | |
92 | else: |
|
92 | else: | |
93 | if self._call_tip_widget.isVisible(): |
|
93 | if self._call_tip_widget.isVisible(): | |
94 | self._call_tip_widget.keyPressEvent(event) |
|
94 | self._call_tip_widget.keyPressEvent(event) | |
95 | super(FrontendWidget, self).keyPressEvent(event) |
|
95 | super(FrontendWidget, self).keyPressEvent(event) | |
96 |
|
96 | |||
97 | #--------------------------------------------------------------------------- |
|
97 | #--------------------------------------------------------------------------- | |
98 | # 'ConsoleWidget' abstract interface |
|
98 | # 'ConsoleWidget' abstract interface | |
99 | #--------------------------------------------------------------------------- |
|
99 | #--------------------------------------------------------------------------- | |
100 |
|
100 | |||
101 | def _is_complete(self, source, interactive): |
|
101 | def _is_complete(self, source, interactive): | |
102 | """ Returns whether 'source' can be completely processed and a new |
|
102 | """ Returns whether 'source' can be completely processed and a new | |
103 | prompt created. When triggered by an Enter/Return key press, |
|
103 | prompt created. When triggered by an Enter/Return key press, | |
104 | 'interactive' is True; otherwise, it is False. |
|
104 | 'interactive' is True; otherwise, it is False. | |
105 | """ |
|
105 | """ | |
106 | complete = self._input_splitter.push(source) |
|
106 | complete = self._input_splitter.push(source) | |
107 | if interactive: |
|
107 | if interactive: | |
108 | complete = not self._input_splitter.push_accepts_more() |
|
108 | complete = not self._input_splitter.push_accepts_more() | |
109 | return complete |
|
109 | return complete | |
110 |
|
110 | |||
111 | def _execute(self, source, hidden): |
|
111 | def _execute(self, source, hidden): | |
112 | """ Execute 'source'. If 'hidden', do not show any output. |
|
112 | """ Execute 'source'. If 'hidden', do not show any output. | |
113 | """ |
|
113 | """ | |
114 | self.kernel_manager.xreq_channel.execute(source) |
|
114 | self.kernel_manager.xreq_channel.execute(source) | |
115 | self._hidden = hidden |
|
115 | self._hidden = hidden | |
116 |
|
116 | |||
117 | def _prompt_started_hook(self): |
|
117 | def _prompt_started_hook(self): | |
118 | """ Called immediately after a new prompt is displayed. |
|
118 | """ Called immediately after a new prompt is displayed. | |
119 | """ |
|
119 | """ | |
120 | self._highlighter.highlighting_on = True |
|
120 | self._highlighter.highlighting_on = True | |
121 |
|
121 | |||
122 | # Auto-indent if this is a continuation prompt. |
|
122 | # Auto-indent if this is a continuation prompt. | |
123 | if self._get_prompt_cursor().blockNumber() != \ |
|
123 | if self._get_prompt_cursor().blockNumber() != \ | |
124 | self._get_end_cursor().blockNumber(): |
|
124 | self._get_end_cursor().blockNumber(): | |
125 | self.appendPlainText(' ' * self._input_splitter.indent_spaces) |
|
125 | self.appendPlainText(' ' * self._input_splitter.indent_spaces) | |
126 |
|
126 | |||
127 | def _prompt_finished_hook(self): |
|
127 | def _prompt_finished_hook(self): | |
128 | """ Called immediately after a prompt is finished, i.e. when some input |
|
128 | """ Called immediately after a prompt is finished, i.e. when some input | |
129 | will be processed and a new prompt displayed. |
|
129 | will be processed and a new prompt displayed. | |
130 | """ |
|
130 | """ | |
131 | self._highlighter.highlighting_on = False |
|
131 | self._highlighter.highlighting_on = False | |
132 |
|
132 | |||
133 | def _tab_pressed(self): |
|
133 | def _tab_pressed(self): | |
134 | """ Called when the tab key is pressed. Returns whether to continue |
|
134 | """ Called when the tab key is pressed. Returns whether to continue | |
135 | processing the event. |
|
135 | processing the event. | |
136 | """ |
|
136 | """ | |
137 | self._keep_cursor_in_buffer() |
|
137 | self._keep_cursor_in_buffer() | |
138 | cursor = self.textCursor() |
|
138 | cursor = self.textCursor() | |
139 | if not self._complete(): |
|
139 | if not self._complete(): | |
140 | cursor.insertText(' ') |
|
140 | cursor.insertText(' ') | |
141 | return False |
|
141 | return False | |
142 |
|
142 | |||
143 | #--------------------------------------------------------------------------- |
|
143 | #--------------------------------------------------------------------------- | |
144 | # 'FrontendWidget' interface |
|
144 | # 'FrontendWidget' interface | |
145 | #--------------------------------------------------------------------------- |
|
145 | #--------------------------------------------------------------------------- | |
146 |
|
146 | |||
147 | def execute_file(self, path, hidden=False): |
|
147 | def execute_file(self, path, hidden=False): | |
148 | """ Attempts to execute file with 'path'. If 'hidden', no output is |
|
148 | """ Attempts to execute file with 'path'. If 'hidden', no output is | |
149 | shown. |
|
149 | shown. | |
150 | """ |
|
150 | """ | |
151 | self.execute('execfile("%s")' % path, hidden=hidden) |
|
151 | self.execute('execfile("%s")' % path, hidden=hidden) | |
152 |
|
152 | |||
153 | def _get_kernel_manager(self): |
|
153 | def _get_kernel_manager(self): | |
154 | """ Returns the current kernel manager. |
|
154 | """ Returns the current kernel manager. | |
155 | """ |
|
155 | """ | |
156 | return self._kernel_manager |
|
156 | return self._kernel_manager | |
157 |
|
157 | |||
158 | def _set_kernel_manager(self, kernel_manager): |
|
158 | def _set_kernel_manager(self, kernel_manager): | |
159 | """ Disconnect from the current kernel manager (if any) and set a new |
|
159 | """ Disconnect from the current kernel manager (if any) and set a new | |
160 | kernel manager. |
|
160 | kernel manager. | |
161 | """ |
|
161 | """ | |
162 | # Disconnect the old kernel manager, if necessary. |
|
162 | # Disconnect the old kernel manager, if necessary. | |
163 | if self._kernel_manager is not None: |
|
163 | if self._kernel_manager is not None: | |
164 |
self._kernel_manager.started_l |
|
164 | self._kernel_manager.started_channels.disconnect( | |
165 |
self._started_l |
|
165 | self._started_channels) | |
166 |
self._kernel_manager.stopped_l |
|
166 | self._kernel_manager.stopped_channels.disconnect( | |
167 |
self._stopped_l |
|
167 | self._stopped_channels) | |
168 |
|
168 | |||
169 | # Disconnect the old kernel manager's channels. |
|
169 | # Disconnect the old kernel manager's channels. | |
170 | sub = self._kernel_manager.sub_channel |
|
170 | sub = self._kernel_manager.sub_channel | |
171 | xreq = self._kernel_manager.xreq_channel |
|
171 | xreq = self._kernel_manager.xreq_channel | |
172 | sub.message_received.disconnect(self._handle_sub) |
|
172 | sub.message_received.disconnect(self._handle_sub) | |
173 | xreq.execute_reply.disconnect(self._handle_execute_reply) |
|
173 | xreq.execute_reply.disconnect(self._handle_execute_reply) | |
174 | xreq.complete_reply.disconnect(self._handle_complete_reply) |
|
174 | xreq.complete_reply.disconnect(self._handle_complete_reply) | |
175 | xreq.object_info_reply.disconnect(self._handle_object_info_reply) |
|
175 | xreq.object_info_reply.disconnect(self._handle_object_info_reply) | |
176 |
|
176 | |||
177 |
# Handle the case where the old kernel manager is still l |
|
177 | # Handle the case where the old kernel manager is still channels. | |
178 |
if self._kernel_manager. |
|
178 | if self._kernel_manager.channels_running: | |
179 |
self._stopped_l |
|
179 | self._stopped_channels() | |
180 |
|
180 | |||
181 | # Set the new kernel manager. |
|
181 | # Set the new kernel manager. | |
182 | self._kernel_manager = kernel_manager |
|
182 | self._kernel_manager = kernel_manager | |
183 | if kernel_manager is None: |
|
183 | if kernel_manager is None: | |
184 | return |
|
184 | return | |
185 |
|
185 | |||
186 | # Connect the new kernel manager. |
|
186 | # Connect the new kernel manager. | |
187 |
kernel_manager.started_l |
|
187 | kernel_manager.started_channels.connect(self._started_channels) | |
188 |
kernel_manager.stopped_l |
|
188 | kernel_manager.stopped_channels.connect(self._stopped_channels) | |
189 |
|
189 | |||
190 | # Connect the new kernel manager's channels. |
|
190 | # Connect the new kernel manager's channels. | |
191 | sub = kernel_manager.sub_channel |
|
191 | sub = kernel_manager.sub_channel | |
192 | xreq = kernel_manager.xreq_channel |
|
192 | xreq = kernel_manager.xreq_channel | |
193 | sub.message_received.connect(self._handle_sub) |
|
193 | sub.message_received.connect(self._handle_sub) | |
194 | xreq.execute_reply.connect(self._handle_execute_reply) |
|
194 | xreq.execute_reply.connect(self._handle_execute_reply) | |
195 | xreq.complete_reply.connect(self._handle_complete_reply) |
|
195 | xreq.complete_reply.connect(self._handle_complete_reply) | |
196 | xreq.object_info_reply.connect(self._handle_object_info_reply) |
|
196 | xreq.object_info_reply.connect(self._handle_object_info_reply) | |
197 |
|
197 | |||
198 |
# Handle the case where the kernel manager started l |
|
198 | # Handle the case where the kernel manager started channels before | |
199 | # we connected. |
|
199 | # we connected. | |
200 |
if kernel_manager. |
|
200 | if kernel_manager.channels_running: | |
201 |
self._started_l |
|
201 | self._started_channels() | |
202 |
|
202 | |||
203 | kernel_manager = property(_get_kernel_manager, _set_kernel_manager) |
|
203 | kernel_manager = property(_get_kernel_manager, _set_kernel_manager) | |
204 |
|
204 | |||
205 | #--------------------------------------------------------------------------- |
|
205 | #--------------------------------------------------------------------------- | |
206 | # 'FrontendWidget' protected interface |
|
206 | # 'FrontendWidget' protected interface | |
207 | #--------------------------------------------------------------------------- |
|
207 | #--------------------------------------------------------------------------- | |
208 |
|
208 | |||
209 | def _call_tip(self): |
|
209 | def _call_tip(self): | |
210 | """ Shows a call tip, if appropriate, at the current cursor location. |
|
210 | """ Shows a call tip, if appropriate, at the current cursor location. | |
211 | """ |
|
211 | """ | |
212 | # Decide if it makes sense to show a call tip |
|
212 | # Decide if it makes sense to show a call tip | |
213 | cursor = self.textCursor() |
|
213 | cursor = self.textCursor() | |
214 | cursor.movePosition(QtGui.QTextCursor.Left) |
|
214 | cursor.movePosition(QtGui.QTextCursor.Left) | |
215 | document = self.document() |
|
215 | document = self.document() | |
216 | if document.characterAt(cursor.position()).toAscii() != '(': |
|
216 | if document.characterAt(cursor.position()).toAscii() != '(': | |
217 | return False |
|
217 | return False | |
218 | context = self._get_context(cursor) |
|
218 | context = self._get_context(cursor) | |
219 | if not context: |
|
219 | if not context: | |
220 | return False |
|
220 | return False | |
221 |
|
221 | |||
222 | # Send the metadata request to the kernel |
|
222 | # Send the metadata request to the kernel | |
223 | name = '.'.join(context) |
|
223 | name = '.'.join(context) | |
224 | self._calltip_id = self.kernel_manager.xreq_channel.object_info(name) |
|
224 | self._calltip_id = self.kernel_manager.xreq_channel.object_info(name) | |
225 | self._calltip_pos = self.textCursor().position() |
|
225 | self._calltip_pos = self.textCursor().position() | |
226 | return True |
|
226 | return True | |
227 |
|
227 | |||
228 | def _complete(self): |
|
228 | def _complete(self): | |
229 | """ Performs completion at the current cursor location. |
|
229 | """ Performs completion at the current cursor location. | |
230 | """ |
|
230 | """ | |
231 | # Decide if it makes sense to do completion |
|
231 | # Decide if it makes sense to do completion | |
232 | context = self._get_context() |
|
232 | context = self._get_context() | |
233 | if not context: |
|
233 | if not context: | |
234 | return False |
|
234 | return False | |
235 |
|
235 | |||
236 | # Send the completion request to the kernel |
|
236 | # Send the completion request to the kernel | |
237 | text = '.'.join(context) |
|
237 | text = '.'.join(context) | |
238 | self._complete_id = self.kernel_manager.xreq_channel.complete( |
|
238 | self._complete_id = self.kernel_manager.xreq_channel.complete( | |
239 | text, self.input_buffer_cursor_line, self.input_buffer) |
|
239 | text, self.input_buffer_cursor_line, self.input_buffer) | |
240 | self._complete_pos = self.textCursor().position() |
|
240 | self._complete_pos = self.textCursor().position() | |
241 | return True |
|
241 | return True | |
242 |
|
242 | |||
243 | def _get_context(self, cursor=None): |
|
243 | def _get_context(self, cursor=None): | |
244 | """ Gets the context at the current cursor location. |
|
244 | """ Gets the context at the current cursor location. | |
245 | """ |
|
245 | """ | |
246 | if cursor is None: |
|
246 | if cursor is None: | |
247 | cursor = self.textCursor() |
|
247 | cursor = self.textCursor() | |
248 | cursor.movePosition(QtGui.QTextCursor.StartOfLine, |
|
248 | cursor.movePosition(QtGui.QTextCursor.StartOfLine, | |
249 | QtGui.QTextCursor.KeepAnchor) |
|
249 | QtGui.QTextCursor.KeepAnchor) | |
250 | text = unicode(cursor.selectedText()) |
|
250 | text = unicode(cursor.selectedText()) | |
251 | return self._completion_lexer.get_context(text) |
|
251 | return self._completion_lexer.get_context(text) | |
252 |
|
252 | |||
253 | def _interrupt_kernel(self): |
|
253 | def _interrupt_kernel(self): | |
254 | """ Attempts to the interrupt the kernel. |
|
254 | """ Attempts to the interrupt the kernel. | |
255 | """ |
|
255 | """ | |
256 | if self.kernel_manager.has_kernel: |
|
256 | if self.kernel_manager.has_kernel: | |
257 | self.kernel_manager.signal_kernel(signal.SIGINT) |
|
257 | self.kernel_manager.signal_kernel(signal.SIGINT) | |
258 | else: |
|
258 | else: | |
259 | self.appendPlainText('Kernel process is either remote or ' |
|
259 | self.appendPlainText('Kernel process is either remote or ' | |
260 | 'unspecified. Cannot interrupt.\n') |
|
260 | 'unspecified. Cannot interrupt.\n') | |
261 |
|
261 | |||
262 | #------ Signal handlers ---------------------------------------------------- |
|
262 | #------ Signal handlers ---------------------------------------------------- | |
263 |
|
263 | |||
264 | def _document_contents_change(self, position, removed, added): |
|
264 | def _document_contents_change(self, position, removed, added): | |
265 | """ Called whenever the document's content changes. Display a calltip |
|
265 | """ Called whenever the document's content changes. Display a calltip | |
266 | if appropriate. |
|
266 | if appropriate. | |
267 | """ |
|
267 | """ | |
268 | # Calculate where the cursor should be *after* the change: |
|
268 | # Calculate where the cursor should be *after* the change: | |
269 | position += added |
|
269 | position += added | |
270 |
|
270 | |||
271 | document = self.document() |
|
271 | document = self.document() | |
272 | if position == self.textCursor().position(): |
|
272 | if position == self.textCursor().position(): | |
273 | self._call_tip() |
|
273 | self._call_tip() | |
274 |
|
274 | |||
275 | def _handle_sub(self, omsg): |
|
275 | def _handle_sub(self, omsg): | |
276 | if self._hidden: |
|
276 | if self._hidden: | |
277 | return |
|
277 | return | |
278 | handler = getattr(self, '_handle_%s' % omsg['msg_type'], None) |
|
278 | handler = getattr(self, '_handle_%s' % omsg['msg_type'], None) | |
279 | if handler is not None: |
|
279 | if handler is not None: | |
280 | handler(omsg) |
|
280 | handler(omsg) | |
281 |
|
281 | |||
282 | def _handle_pyout(self, omsg): |
|
282 | def _handle_pyout(self, omsg): | |
283 | session = omsg['parent_header']['session'] |
|
283 | session = omsg['parent_header']['session'] | |
284 | if session == self.kernel_manager.session.session: |
|
284 | if session == self.kernel_manager.session.session: | |
285 | self.appendPlainText(omsg['content']['data'] + '\n') |
|
285 | self.appendPlainText(omsg['content']['data'] + '\n') | |
286 |
|
286 | |||
287 | def _handle_stream(self, omsg): |
|
287 | def _handle_stream(self, omsg): | |
288 | self.appendPlainText(omsg['content']['data']) |
|
288 | self.appendPlainText(omsg['content']['data']) | |
289 | self.moveCursor(QtGui.QTextCursor.End) |
|
289 | self.moveCursor(QtGui.QTextCursor.End) | |
290 |
|
290 | |||
291 | def _handle_execute_reply(self, rep): |
|
291 | def _handle_execute_reply(self, rep): | |
292 | if self._hidden: |
|
292 | if self._hidden: | |
293 | return |
|
293 | return | |
294 |
|
294 | |||
295 | # Make sure that all output from the SUB channel has been processed |
|
295 | # Make sure that all output from the SUB channel has been processed | |
296 | # before writing a new prompt. |
|
296 | # before writing a new prompt. | |
297 | self.kernel_manager.sub_channel.flush() |
|
297 | self.kernel_manager.sub_channel.flush() | |
298 |
|
298 | |||
299 | content = rep['content'] |
|
299 | content = rep['content'] | |
300 | status = content['status'] |
|
300 | status = content['status'] | |
301 | if status == 'error': |
|
301 | if status == 'error': | |
302 | self.appendPlainText(content['traceback'][-1]) |
|
302 | self.appendPlainText(content['traceback'][-1]) | |
303 | elif status == 'aborted': |
|
303 | elif status == 'aborted': | |
304 | text = "ERROR: ABORTED\n" |
|
304 | text = "ERROR: ABORTED\n" | |
305 | self.appendPlainText(text) |
|
305 | self.appendPlainText(text) | |
306 | self._hidden = True |
|
306 | self._hidden = True | |
307 | self._show_prompt() |
|
307 | self._show_prompt() | |
308 | self.executed.emit(rep) |
|
308 | self.executed.emit(rep) | |
309 |
|
309 | |||
310 | def _handle_complete_reply(self, rep): |
|
310 | def _handle_complete_reply(self, rep): | |
311 | cursor = self.textCursor() |
|
311 | cursor = self.textCursor() | |
312 | if rep['parent_header']['msg_id'] == self._complete_id and \ |
|
312 | if rep['parent_header']['msg_id'] == self._complete_id and \ | |
313 | cursor.position() == self._complete_pos: |
|
313 | cursor.position() == self._complete_pos: | |
314 | text = '.'.join(self._get_context()) |
|
314 | text = '.'.join(self._get_context()) | |
315 | cursor.movePosition(QtGui.QTextCursor.Left, n=len(text)) |
|
315 | cursor.movePosition(QtGui.QTextCursor.Left, n=len(text)) | |
316 | self._complete_with_items(cursor, rep['content']['matches']) |
|
316 | self._complete_with_items(cursor, rep['content']['matches']) | |
317 |
|
317 | |||
318 | def _handle_object_info_reply(self, rep): |
|
318 | def _handle_object_info_reply(self, rep): | |
319 | cursor = self.textCursor() |
|
319 | cursor = self.textCursor() | |
320 | if rep['parent_header']['msg_id'] == self._calltip_id and \ |
|
320 | if rep['parent_header']['msg_id'] == self._calltip_id and \ | |
321 | cursor.position() == self._calltip_pos: |
|
321 | cursor.position() == self._calltip_pos: | |
322 | doc = rep['content']['docstring'] |
|
322 | doc = rep['content']['docstring'] | |
323 | if doc: |
|
323 | if doc: | |
324 | self._call_tip_widget.show_docstring(doc) |
|
324 | self._call_tip_widget.show_docstring(doc) | |
325 |
|
325 | |||
326 |
def _started_l |
|
326 | def _started_channels(self): | |
327 | self.clear() |
|
327 | self.clear() | |
328 |
|
328 | |||
329 |
def _stopped_l |
|
329 | def _stopped_channels(self): | |
330 | pass |
|
330 | pass |
@@ -1,94 +1,94 b'' | |||||
1 | # System library imports |
|
1 | # System library imports | |
2 | from PyQt4 import QtCore, QtGui |
|
2 | from PyQt4 import QtCore, QtGui | |
3 |
|
3 | |||
4 | # Local imports |
|
4 | # Local imports | |
5 | from frontend_widget import FrontendWidget |
|
5 | from frontend_widget import FrontendWidget | |
6 |
|
6 | |||
7 |
|
7 | |||
8 | class IPythonWidget(FrontendWidget): |
|
8 | class IPythonWidget(FrontendWidget): | |
9 | """ A FrontendWidget for an IPython kernel. |
|
9 | """ A FrontendWidget for an IPython kernel. | |
10 | """ |
|
10 | """ | |
11 |
|
11 | |||
12 | #--------------------------------------------------------------------------- |
|
12 | #--------------------------------------------------------------------------- | |
13 | # 'QObject' interface |
|
13 | # 'QObject' interface | |
14 | #--------------------------------------------------------------------------- |
|
14 | #--------------------------------------------------------------------------- | |
15 |
|
15 | |||
16 | def __init__(self, parent=None): |
|
16 | def __init__(self, parent=None): | |
17 | super(IPythonWidget, self).__init__(parent) |
|
17 | super(IPythonWidget, self).__init__(parent) | |
18 |
|
18 | |||
19 | self._magic_overrides = {} |
|
19 | self._magic_overrides = {} | |
20 |
|
20 | |||
21 | #--------------------------------------------------------------------------- |
|
21 | #--------------------------------------------------------------------------- | |
22 | # 'ConsoleWidget' abstract interface |
|
22 | # 'ConsoleWidget' abstract interface | |
23 | #--------------------------------------------------------------------------- |
|
23 | #--------------------------------------------------------------------------- | |
24 |
|
24 | |||
25 | def _execute(self, source, hidden): |
|
25 | def _execute(self, source, hidden): | |
26 | """ Reimplemented to override magic commands. |
|
26 | """ Reimplemented to override magic commands. | |
27 | """ |
|
27 | """ | |
28 | magic_source = source.strip() |
|
28 | magic_source = source.strip() | |
29 | if magic_source.startswith('%'): |
|
29 | if magic_source.startswith('%'): | |
30 | magic_source = magic_source[1:] |
|
30 | magic_source = magic_source[1:] | |
31 | magic, sep, arguments = magic_source.partition(' ') |
|
31 | magic, sep, arguments = magic_source.partition(' ') | |
32 | if not magic: |
|
32 | if not magic: | |
33 | magic = magic_source |
|
33 | magic = magic_source | |
34 |
|
34 | |||
35 | callback = self._magic_overrides.get(magic) |
|
35 | callback = self._magic_overrides.get(magic) | |
36 | if callback: |
|
36 | if callback: | |
37 | output = callback(arguments) |
|
37 | output = callback(arguments) | |
38 | if output: |
|
38 | if output: | |
39 | self.appendPlainText(output) |
|
39 | self.appendPlainText(output) | |
40 | self._show_prompt() |
|
40 | self._show_prompt() | |
41 | else: |
|
41 | else: | |
42 | super(IPythonWidget, self)._execute(source, hidden) |
|
42 | super(IPythonWidget, self)._execute(source, hidden) | |
43 |
|
43 | |||
44 | #--------------------------------------------------------------------------- |
|
44 | #--------------------------------------------------------------------------- | |
45 | # 'FrontendWidget' interface |
|
45 | # 'FrontendWidget' interface | |
46 | #--------------------------------------------------------------------------- |
|
46 | #--------------------------------------------------------------------------- | |
47 |
|
47 | |||
48 | def execute_file(self, path, hidden=False): |
|
48 | def execute_file(self, path, hidden=False): | |
49 | """ Reimplemented to use the 'run' magic. |
|
49 | """ Reimplemented to use the 'run' magic. | |
50 | """ |
|
50 | """ | |
51 | self.execute('run %s' % path, hidden=hidden) |
|
51 | self.execute('run %s' % path, hidden=hidden) | |
52 |
|
52 | |||
53 | #--------------------------------------------------------------------------- |
|
53 | #--------------------------------------------------------------------------- | |
54 | # 'IPythonWidget' interface |
|
54 | # 'IPythonWidget' interface | |
55 | #--------------------------------------------------------------------------- |
|
55 | #--------------------------------------------------------------------------- | |
56 |
|
56 | |||
57 | def set_magic_override(self, magic, callback): |
|
57 | def set_magic_override(self, magic, callback): | |
58 | """ Overrides an IPython magic command. This magic will be intercepted |
|
58 | """ Overrides an IPython magic command. This magic will be intercepted | |
59 | by the frontend rather than passed on to the kernel and 'callback' |
|
59 | by the frontend rather than passed on to the kernel and 'callback' | |
60 | will be called with a single argument: a string of argument(s) for |
|
60 | will be called with a single argument: a string of argument(s) for | |
61 | the magic. The callback can (optionally) return text to print to the |
|
61 | the magic. The callback can (optionally) return text to print to the | |
62 | console. |
|
62 | console. | |
63 | """ |
|
63 | """ | |
64 | self._magic_overrides[magic] = callback |
|
64 | self._magic_overrides[magic] = callback | |
65 |
|
65 | |||
66 | def remove_magic_override(self, magic): |
|
66 | def remove_magic_override(self, magic): | |
67 | """ Removes the override for the specified magic, if there is one. |
|
67 | """ Removes the override for the specified magic, if there is one. | |
68 | """ |
|
68 | """ | |
69 | try: |
|
69 | try: | |
70 | del self._magic_overrides[magic] |
|
70 | del self._magic_overrides[magic] | |
71 | except KeyError: |
|
71 | except KeyError: | |
72 | pass |
|
72 | pass | |
73 |
|
73 | |||
74 |
|
74 | |||
75 | if __name__ == '__main__': |
|
75 | if __name__ == '__main__': | |
76 | from IPython.frontend.qt.kernelmanager import QtKernelManager |
|
76 | from IPython.frontend.qt.kernelmanager import QtKernelManager | |
77 |
|
77 | |||
78 | # Don't let Qt or ZMQ swallow KeyboardInterupts. |
|
78 | # Don't let Qt or ZMQ swallow KeyboardInterupts. | |
79 | import signal |
|
79 | import signal | |
80 | signal.signal(signal.SIGINT, signal.SIG_DFL) |
|
80 | signal.signal(signal.SIGINT, signal.SIG_DFL) | |
81 |
|
81 | |||
82 | # Create a KernelManager. |
|
82 | # Create a KernelManager. | |
83 | kernel_manager = QtKernelManager() |
|
83 | kernel_manager = QtKernelManager() | |
84 | kernel_manager.start_kernel() |
|
84 | kernel_manager.start_kernel() | |
85 |
kernel_manager.start_l |
|
85 | kernel_manager.start_channels() | |
86 |
|
86 | |||
87 | # Launch the application. |
|
87 | # Launch the application. | |
88 | app = QtGui.QApplication([]) |
|
88 | app = QtGui.QApplication([]) | |
89 | widget = IPythonWidget() |
|
89 | widget = IPythonWidget() | |
90 | widget.kernel_manager = kernel_manager |
|
90 | widget.kernel_manager = kernel_manager | |
91 | widget.setWindowTitle('Python') |
|
91 | widget.setWindowTitle('Python') | |
92 | widget.resize(640, 480) |
|
92 | widget.resize(640, 480) | |
93 | widget.show() |
|
93 | widget.show() | |
94 | app.exec_() |
|
94 | app.exec_() |
@@ -1,147 +1,151 b'' | |||||
1 | """ Defines a KernelManager that provides signals and slots. |
|
1 | """ Defines a KernelManager that provides signals and slots. | |
2 | """ |
|
2 | """ | |
3 |
|
3 | |||
4 | # System library imports. |
|
4 | # System library imports. | |
5 | from PyQt4 import QtCore |
|
5 | from PyQt4 import QtCore | |
6 | import zmq |
|
6 | import zmq | |
7 |
|
7 | |||
8 | # IPython imports. |
|
8 | # IPython imports. | |
9 | from IPython.zmq.kernelmanager import KernelManager, SubSocketChannel, \ |
|
9 | from IPython.zmq.kernelmanager import KernelManager, SubSocketChannel, \ | |
10 | XReqSocketChannel, RepSocketChannel |
|
10 | XReqSocketChannel, RepSocketChannel | |
11 | from util import MetaQObjectHasTraits |
|
11 | from util import MetaQObjectHasTraits | |
12 |
|
12 | |||
13 |
|
13 | |||
14 |
|
14 | |||
15 | class QtSubSocketChannel(SubSocketChannel, QtCore.QObject): |
|
15 | class QtSubSocketChannel(SubSocketChannel, QtCore.QObject): | |
16 |
|
16 | |||
17 | # Emitted when any message is received. |
|
17 | # Emitted when any message is received. | |
18 | message_received = QtCore.pyqtSignal(object) |
|
18 | message_received = QtCore.pyqtSignal(object) | |
19 |
|
19 | |||
20 | # Emitted when a message of type 'pyout' or 'stdout' is received. |
|
20 | # Emitted when a message of type 'pyout' or 'stdout' is received. | |
21 | output_received = QtCore.pyqtSignal(object) |
|
21 | output_received = QtCore.pyqtSignal(object) | |
22 |
|
22 | |||
23 | # Emitted when a message of type 'pyerr' or 'stderr' is received. |
|
23 | # Emitted when a message of type 'pyerr' or 'stderr' is received. | |
24 | error_received = QtCore.pyqtSignal(object) |
|
24 | error_received = QtCore.pyqtSignal(object) | |
25 |
|
25 | |||
26 | #--------------------------------------------------------------------------- |
|
26 | #--------------------------------------------------------------------------- | |
27 | # 'object' interface |
|
27 | # 'object' interface | |
28 | #--------------------------------------------------------------------------- |
|
28 | #--------------------------------------------------------------------------- | |
29 |
|
29 | |||
30 | def __init__(self, *args, **kw): |
|
30 | def __init__(self, *args, **kw): | |
31 | """ Reimplemented to ensure that QtCore.QObject is initialized first. |
|
31 | """ Reimplemented to ensure that QtCore.QObject is initialized first. | |
32 | """ |
|
32 | """ | |
33 | QtCore.QObject.__init__(self) |
|
33 | QtCore.QObject.__init__(self) | |
34 | SubSocketChannel.__init__(self, *args, **kw) |
|
34 | SubSocketChannel.__init__(self, *args, **kw) | |
35 |
|
35 | |||
36 | #--------------------------------------------------------------------------- |
|
36 | #--------------------------------------------------------------------------- | |
37 | # 'SubSocketChannel' interface |
|
37 | # 'SubSocketChannel' interface | |
38 | #--------------------------------------------------------------------------- |
|
38 | #--------------------------------------------------------------------------- | |
39 |
|
39 | |||
40 | def call_handlers(self, msg): |
|
40 | def call_handlers(self, msg): | |
41 | """ Reimplemented to emit signals instead of making callbacks. |
|
41 | """ Reimplemented to emit signals instead of making callbacks. | |
42 | """ |
|
42 | """ | |
43 | # Emit the generic signal. |
|
43 | # Emit the generic signal. | |
44 | self.message_received.emit(msg) |
|
44 | self.message_received.emit(msg) | |
45 |
|
45 | |||
46 | # Emit signals for specialized message types. |
|
46 | # Emit signals for specialized message types. | |
47 | msg_type = msg['msg_type'] |
|
47 | msg_type = msg['msg_type'] | |
48 | if msg_type in ('pyout', 'stdout'): |
|
48 | if msg_type in ('pyout', 'stdout'): | |
49 | self.output_received.emit(msg) |
|
49 | self.output_received.emit(msg) | |
50 | elif msg_type in ('pyerr', 'stderr'): |
|
50 | elif msg_type in ('pyerr', 'stderr'): | |
51 | self.error_received.emit(msg) |
|
51 | self.error_received.emit(msg) | |
52 |
|
52 | |||
53 | def flush(self): |
|
53 | def flush(self): | |
54 | """ Reimplemented to ensure that signals are dispatched immediately. |
|
54 | """ Reimplemented to ensure that signals are dispatched immediately. | |
55 | """ |
|
55 | """ | |
56 | super(QtSubSocketChannel, self).flush() |
|
56 | super(QtSubSocketChannel, self).flush() | |
57 | QtCore.QCoreApplication.instance().processEvents() |
|
57 | QtCore.QCoreApplication.instance().processEvents() | |
58 |
|
58 | |||
59 |
|
59 | |||
60 | class QtXReqSocketChannel(XReqSocketChannel, QtCore.QObject): |
|
60 | class QtXReqSocketChannel(XReqSocketChannel, QtCore.QObject): | |
61 |
|
61 | |||
62 | # Emitted when any message is received. |
|
62 | # Emitted when any message is received. | |
63 | message_received = QtCore.pyqtSignal(object) |
|
63 | message_received = QtCore.pyqtSignal(object) | |
64 |
|
64 | |||
65 | # Emitted when a reply has been received for the corresponding request type. |
|
65 | # Emitted when a reply has been received for the corresponding request type. | |
66 | execute_reply = QtCore.pyqtSignal(object) |
|
66 | execute_reply = QtCore.pyqtSignal(object) | |
67 | complete_reply = QtCore.pyqtSignal(object) |
|
67 | complete_reply = QtCore.pyqtSignal(object) | |
68 | object_info_reply = QtCore.pyqtSignal(object) |
|
68 | object_info_reply = QtCore.pyqtSignal(object) | |
69 |
|
69 | |||
70 | #--------------------------------------------------------------------------- |
|
70 | #--------------------------------------------------------------------------- | |
71 | # 'object' interface |
|
71 | # 'object' interface | |
72 | #--------------------------------------------------------------------------- |
|
72 | #--------------------------------------------------------------------------- | |
73 |
|
73 | |||
74 | def __init__(self, *args, **kw): |
|
74 | def __init__(self, *args, **kw): | |
75 | """ Reimplemented to ensure that QtCore.QObject is initialized first. |
|
75 | """ Reimplemented to ensure that QtCore.QObject is initialized first. | |
76 | """ |
|
76 | """ | |
77 | QtCore.QObject.__init__(self) |
|
77 | QtCore.QObject.__init__(self) | |
78 | XReqSocketChannel.__init__(self, *args, **kw) |
|
78 | XReqSocketChannel.__init__(self, *args, **kw) | |
79 |
|
79 | |||
80 | #--------------------------------------------------------------------------- |
|
80 | #--------------------------------------------------------------------------- | |
81 | # 'XReqSocketChannel' interface |
|
81 | # 'XReqSocketChannel' interface | |
82 | #--------------------------------------------------------------------------- |
|
82 | #--------------------------------------------------------------------------- | |
83 |
|
83 | |||
84 | def call_handlers(self, msg): |
|
84 | def call_handlers(self, msg): | |
85 | """ Reimplemented to emit signals instead of making callbacks. |
|
85 | """ Reimplemented to emit signals instead of making callbacks. | |
86 | """ |
|
86 | """ | |
87 | # Emit the generic signal. |
|
87 | # Emit the generic signal. | |
88 | self.message_received.emit(msg) |
|
88 | self.message_received.emit(msg) | |
89 |
|
89 | |||
90 | # Emit signals for specialized message types. |
|
90 | # Emit signals for specialized message types. | |
91 | msg_type = msg['msg_type'] |
|
91 | msg_type = msg['msg_type'] | |
92 | signal = getattr(self, msg_type, None) |
|
92 | signal = getattr(self, msg_type, None) | |
93 | if signal: |
|
93 | if signal: | |
94 | signal.emit(msg) |
|
94 | signal.emit(msg) | |
95 |
|
95 | |||
96 | def _queue_request(self, msg, callback): |
|
|||
97 | """ Reimplemented to skip callback handling. |
|
|||
98 | """ |
|
|||
99 | self.command_queue.put(msg) |
|
|||
100 | self.add_io_state(zmq.POLLOUT) |
|
|||
101 |
|
||||
102 |
|
96 | |||
103 | class QtRepSocketChannel(RepSocketChannel, QtCore.QObject): |
|
97 | class QtRepSocketChannel(RepSocketChannel, QtCore.QObject): | |
104 |
|
98 | |||
105 | #--------------------------------------------------------------------------- |
|
99 | #--------------------------------------------------------------------------- | |
106 | # 'object' interface |
|
100 | # 'object' interface | |
107 | #--------------------------------------------------------------------------- |
|
101 | #--------------------------------------------------------------------------- | |
108 |
|
102 | |||
109 | def __init__(self, *args, **kw): |
|
103 | def __init__(self, *args, **kw): | |
110 | """ Reimplemented to ensure that QtCore.QObject is initialized first. |
|
104 | """ Reimplemented to ensure that QtCore.QObject is initialized first. | |
111 | """ |
|
105 | """ | |
112 | QtCore.QObject.__init__(self) |
|
106 | QtCore.QObject.__init__(self) | |
113 | RepSocketChannel.__init__(self, *args, **kw) |
|
107 | RepSocketChannel.__init__(self, *args, **kw) | |
114 |
|
108 | |||
115 |
|
109 | |||
116 | class QtKernelManager(KernelManager, QtCore.QObject): |
|
110 | class QtKernelManager(KernelManager, QtCore.QObject): | |
117 | """ A KernelManager that provides signals and slots. |
|
111 | """ A KernelManager that provides signals and slots. | |
118 | """ |
|
112 | """ | |
119 |
|
113 | |||
120 | __metaclass__ = MetaQObjectHasTraits |
|
114 | __metaclass__ = MetaQObjectHasTraits | |
121 |
|
115 | |||
122 | # Emitted when the kernel manager has started listening. |
|
116 | # Emitted when the kernel manager has started listening. | |
123 |
started_l |
|
117 | started_channels = QtCore.pyqtSignal() | |
124 |
|
118 | |||
125 | # Emitted when the kernel manager has stopped listening. |
|
119 | # Emitted when the kernel manager has stopped listening. | |
126 |
stopped_l |
|
120 | stopped_channels = QtCore.pyqtSignal() | |
127 |
|
121 | |||
128 | # Use Qt-specific channel classes that emit signals. |
|
122 | # Use Qt-specific channel classes that emit signals. | |
129 | sub_channel_class = QtSubSocketChannel |
|
123 | sub_channel_class = QtSubSocketChannel | |
130 | xreq_channel_class = QtXReqSocketChannel |
|
124 | xreq_channel_class = QtXReqSocketChannel | |
131 | rep_channel_class = QtRepSocketChannel |
|
125 | rep_channel_class = QtRepSocketChannel | |
132 |
|
126 | |||
133 | #--------------------------------------------------------------------------- |
|
127 | #--------------------------------------------------------------------------- | |
|
128 | # 'object' interface | |||
|
129 | #--------------------------------------------------------------------------- | |||
|
130 | ||||
|
131 | def __init__(self, *args, **kw): | |||
|
132 | """ Reimplemented to ensure that QtCore.QObject is initialized first. | |||
|
133 | """ | |||
|
134 | QtCore.QObject.__init__(self) | |||
|
135 | KernelManager.__init__(self, *args, **kw) | |||
|
136 | ||||
|
137 | #--------------------------------------------------------------------------- | |||
134 | # 'KernelManager' interface |
|
138 | # 'KernelManager' interface | |
135 | #--------------------------------------------------------------------------- |
|
139 | #--------------------------------------------------------------------------- | |
136 |
|
140 | |||
137 |
def start_l |
|
141 | def start_channels(self): | |
138 | """ Reimplemented to emit signal. |
|
142 | """ Reimplemented to emit signal. | |
139 | """ |
|
143 | """ | |
140 |
super(QtKernelManager, self).start_l |
|
144 | super(QtKernelManager, self).start_channels() | |
141 |
self.started_l |
|
145 | self.started_channels.emit() | |
142 |
|
146 | |||
143 |
def stop_l |
|
147 | def stop_channels(self): | |
144 | """ Reimplemented to emit signal. |
|
148 | """ Reimplemented to emit signal. | |
145 | """ |
|
149 | """ | |
146 |
super(QtKernelManager, self).stop_l |
|
150 | super(QtKernelManager, self).stop_channels() | |
147 |
self.stopped_l |
|
151 | self.stopped_channels.emit() |
This diff has been collapsed as it changes many lines, (527 lines changed) Show them Hide them | |||||
@@ -1,497 +1,536 b'' | |||||
1 | """Kernel frontend classes. |
|
1 | """Classes to manage the interaction with a running kernel. | |
2 |
|
2 | |||
3 | TODO: Create logger to handle debugging and console messages. |
|
3 | Todo | |
|
4 | ==== | |||
4 |
|
5 | |||
|
6 | * Create logger to handle debugging and console messages. | |||
5 | """ |
|
7 | """ | |
6 |
|
8 | |||
|
9 | #----------------------------------------------------------------------------- | |||
|
10 | # Copyright (C) 2008-2010 The IPython Development Team | |||
|
11 | # | |||
|
12 | # Distributed under the terms of the BSD License. The full license is in | |||
|
13 | # the file COPYING, distributed as part of this software. | |||
|
14 | #----------------------------------------------------------------------------- | |||
|
15 | ||||
|
16 | #----------------------------------------------------------------------------- | |||
|
17 | # Imports | |||
|
18 | #----------------------------------------------------------------------------- | |||
|
19 | ||||
7 | # Standard library imports. |
|
20 | # Standard library imports. | |
8 | from Queue import Queue, Empty |
|
21 | from Queue import Queue, Empty | |
9 | from subprocess import Popen |
|
22 | from subprocess import Popen | |
10 | from threading import Thread |
|
23 | from threading import Thread | |
11 | import time |
|
24 | import time | |
12 | import traceback |
|
|||
13 |
|
25 | |||
14 | # System library imports. |
|
26 | # System library imports. | |
15 | import zmq |
|
27 | import zmq | |
16 | from zmq import POLLIN, POLLOUT, POLLERR |
|
28 | from zmq import POLLIN, POLLOUT, POLLERR | |
17 | from zmq.eventloop import ioloop |
|
29 | from zmq.eventloop import ioloop | |
18 |
|
30 | |||
19 | # Local imports. |
|
31 | # Local imports. | |
20 |
from IPython.utils.traitlets import HasTraits, Any, |
|
32 | from IPython.utils.traitlets import HasTraits, Any, Instance, Type | |
21 | Type |
|
|||
22 | from kernel import launch_kernel |
|
33 | from kernel import launch_kernel | |
23 | from session import Session |
|
34 | from session import Session | |
24 |
|
35 | |||
25 | # Constants. |
|
36 | #----------------------------------------------------------------------------- | |
26 | LOCALHOST = '127.0.0.1' |
|
37 | # Constants and exceptions | |
|
38 | #----------------------------------------------------------------------------- | |||
27 |
|
39 | |||
|
40 | LOCALHOST = '127.0.0.1' | |||
28 |
|
41 | |||
29 |
class |
|
42 | class InvalidPortNumber(Exception): | |
30 | pass |
|
43 | pass | |
31 |
|
44 | |||
|
45 | #----------------------------------------------------------------------------- | |||
|
46 | # ZMQ Socket Channel classes | |||
|
47 | #----------------------------------------------------------------------------- | |||
32 |
|
48 | |||
33 | class ZmqSocketChannel(Thread): |
|
49 | class ZmqSocketChannel(Thread): | |
34 |
""" |
|
50 | """The base class for the channels that use ZMQ sockets. | |
35 | """ |
|
51 | """ | |
36 |
|
||||
37 | context = None |
|
52 | context = None | |
38 | session = None |
|
53 | session = None | |
39 | socket = None |
|
54 | socket = None | |
40 | ioloop = None |
|
55 | ioloop = None | |
41 | iostate = None |
|
56 | iostate = None | |
|
57 | _address = None | |||
|
58 | ||||
|
59 | def __init__(self, context, session, address): | |||
|
60 | """Create a channel | |||
42 |
|
|
61 | ||
43 | def __init__(self, context, session, address=None): |
|
62 | Parameters | |
|
63 | ---------- | |||
|
64 | context : zmq.Context | |||
|
65 | The ZMQ context to use. | |||
|
66 | session : session.Session | |||
|
67 | The session to use. | |||
|
68 | address : tuple | |||
|
69 | Standard (ip, port) tuple that the kernel is listening on. | |||
|
70 | """ | |||
44 | super(ZmqSocketChannel, self).__init__() |
|
71 | super(ZmqSocketChannel, self).__init__() | |
45 | self.daemon = True |
|
72 | self.daemon = True | |
46 |
|
73 | |||
47 | self.context = context |
|
74 | self.context = context | |
48 | self.session = session |
|
75 | self.session = session | |
49 | self.address = address |
|
76 | if address[1] == 0: | |
|
77 | raise InvalidPortNumber('The port number for a channel cannot be 0.') | |||
|
78 | self._address = address | |||
50 |
|
79 | |||
51 | def stop(self): |
|
80 | def stop(self): | |
52 |
"""Stop the |
|
81 | """Stop the channel's activity. | |
53 |
|
82 | |||
54 | The thread will raise :class:`RuntimeError` if :method:`self.start` |
|
83 | This calls :method:`Thread.join` and returns when the thread | |
55 | is called again. |
|
84 | terminates. :class:`RuntimeError` will be raised if | |
|
85 | :method:`self.start` is called again. | |||
56 | """ |
|
86 | """ | |
57 | self.join() |
|
87 | self.join() | |
58 |
|
88 | |||
|
89 | @property | |||
|
90 | def address(self): | |||
|
91 | """Get the channel's address as an (ip, port) tuple. | |||
59 |
|
92 | |||
60 | def get_address(self): |
|
93 | By the default, the address is (localhost, 0), where 0 means a random | |
61 | """ Get the channel's address. By the default, a channel is on |
|
94 | port. | |
62 | localhost with no port specified (a negative port number). |
|
|||
63 | """ |
|
95 | """ | |
64 | return self._address |
|
96 | return self._address | |
65 |
|
97 | |||
66 | def set_adresss(self, address): |
|
|||
67 | """ Set the channel's address. Should be a tuple of form: |
|
|||
68 | (ip address [str], port [int]). |
|
|||
69 | or None, in which case the address is reset to its default value. |
|
|||
70 | """ |
|
|||
71 | # FIXME: Validate address. |
|
|||
72 | if self.is_alive(): # This is Thread.is_alive |
|
|||
73 | raise RuntimeError("Cannot set address on a running channel!") |
|
|||
74 | else: |
|
|||
75 | if address is None: |
|
|||
76 | address = (LOCALHOST, 0) |
|
|||
77 | self._address = address |
|
|||
78 |
|
||||
79 | address = property(get_address, set_adresss) |
|
|||
80 |
|
||||
81 | def add_io_state(self, state): |
|
98 | def add_io_state(self, state): | |
82 | """Add IO state to the eventloop. |
|
99 | """Add IO state to the eventloop. | |
83 |
|
100 | |||
|
101 | Parameters | |||
|
102 | ---------- | |||
|
103 | state : zmq.POLLIN|zmq.POLLOUT|zmq.POLLERR | |||
|
104 | The IO state flag to set. | |||
|
105 | ||||
84 | This is thread safe as it uses the thread safe IOLoop.add_callback. |
|
106 | This is thread safe as it uses the thread safe IOLoop.add_callback. | |
85 | """ |
|
107 | """ | |
86 | def add_io_state_callback(): |
|
108 | def add_io_state_callback(): | |
87 | if not self.iostate & state: |
|
109 | if not self.iostate & state: | |
88 | self.iostate = self.iostate | state |
|
110 | self.iostate = self.iostate | state | |
89 | self.ioloop.update_handler(self.socket, self.iostate) |
|
111 | self.ioloop.update_handler(self.socket, self.iostate) | |
90 | self.ioloop.add_callback(add_io_state_callback) |
|
112 | self.ioloop.add_callback(add_io_state_callback) | |
91 |
|
113 | |||
92 | def drop_io_state(self, state): |
|
114 | def drop_io_state(self, state): | |
93 | """Drop IO state from the eventloop. |
|
115 | """Drop IO state from the eventloop. | |
94 |
|
116 | |||
|
117 | Parameters | |||
|
118 | ---------- | |||
|
119 | state : zmq.POLLIN|zmq.POLLOUT|zmq.POLLERR | |||
|
120 | The IO state flag to set. | |||
|
121 | ||||
95 | This is thread safe as it uses the thread safe IOLoop.add_callback. |
|
122 | This is thread safe as it uses the thread safe IOLoop.add_callback. | |
96 | """ |
|
123 | """ | |
97 | def drop_io_state_callback(): |
|
124 | def drop_io_state_callback(): | |
98 | if self.iostate & state: |
|
125 | if self.iostate & state: | |
99 | self.iostate = self.iostate & (~state) |
|
126 | self.iostate = self.iostate & (~state) | |
100 | self.ioloop.update_handler(self.socket, self.iostate) |
|
127 | self.ioloop.update_handler(self.socket, self.iostate) | |
101 | self.ioloop.add_callback(drop_io_state_callback) |
|
128 | self.ioloop.add_callback(drop_io_state_callback) | |
102 |
|
129 | |||
103 |
|
130 | |||
104 |
class |
|
131 | class XReqSocketChannel(ZmqSocketChannel): | |
|
132 | """The XREQ channel for issues request/replies to the kernel. | |||
|
133 | """ | |||
105 |
|
134 | |||
106 | def __init__(self, context, session, address=None): |
|
135 | command_queue = None | |
107 | super(SubSocketChannel, self).__init__(context, session, address) |
|
136 | ||
|
137 | def __init__(self, context, session, address): | |||
|
138 | self.command_queue = Queue() | |||
|
139 | super(XReqSocketChannel, self).__init__(context, session, address) | |||
108 |
|
140 | |||
109 | def run(self): |
|
141 | def run(self): | |
110 | self.socket = self.context.socket(zmq.SUB) |
|
142 | """The thread's main activity. Call start() instead.""" | |
111 |
self.socket. |
|
143 | self.socket = self.context.socket(zmq.XREQ) | |
112 | self.socket.setsockopt(zmq.IDENTITY, self.session.session) |
|
144 | self.socket.setsockopt(zmq.IDENTITY, self.session.session) | |
113 | self.socket.connect('tcp://%s:%i' % self.address) |
|
145 | self.socket.connect('tcp://%s:%i' % self.address) | |
114 | self.ioloop = ioloop.IOLoop() |
|
146 | self.ioloop = ioloop.IOLoop() | |
115 |
self.iostate = POLLIN |
|
147 | self.iostate = POLLERR|POLLIN | |
116 | self.ioloop.add_handler(self.socket, self._handle_events, |
|
148 | self.ioloop.add_handler(self.socket, self._handle_events, | |
117 | self.iostate) |
|
149 | self.iostate) | |
118 | self.ioloop.start() |
|
150 | self.ioloop.start() | |
119 |
|
151 | |||
120 | def stop(self): |
|
152 | def stop(self): | |
121 | self.ioloop.stop() |
|
153 | self.ioloop.stop() | |
122 |
super( |
|
154 | super(XReqSocketChannel, self).stop() | |
123 |
|
||||
124 | def _handle_events(self, socket, events): |
|
|||
125 | # Turn on and off POLLOUT depending on if we have made a request |
|
|||
126 | if events & POLLERR: |
|
|||
127 | self._handle_err() |
|
|||
128 | if events & POLLIN: |
|
|||
129 | self._handle_recv() |
|
|||
130 |
|
||||
131 | def _handle_err(self): |
|
|||
132 | # We don't want to let this go silently, so eventually we should log. |
|
|||
133 | raise zmq.ZMQError() |
|
|||
134 |
|
||||
135 | def _handle_recv(self): |
|
|||
136 | # Get all of the messages we can |
|
|||
137 | while True: |
|
|||
138 | try: |
|
|||
139 | msg = self.socket.recv_json(zmq.NOBLOCK) |
|
|||
140 | except zmq.ZMQError: |
|
|||
141 | # Check the errno? |
|
|||
142 | # Will this tigger POLLERR? |
|
|||
143 | break |
|
|||
144 | else: |
|
|||
145 | self.call_handlers(msg) |
|
|||
146 |
|
155 | |||
147 | def call_handlers(self, msg): |
|
156 | def call_handlers(self, msg): | |
148 | """This method is called in the ioloop thread when a message arrives. |
|
157 | """This method is called in the ioloop thread when a message arrives. | |
149 |
|
158 | |||
150 | Subclasses should override this method to handle incoming messages. |
|
159 | Subclasses should override this method to handle incoming messages. | |
151 | It is important to remember that this method is called in the thread |
|
160 | It is important to remember that this method is called in the thread | |
152 | so that some logic must be done to ensure that the application leve |
|
161 | so that some logic must be done to ensure that the application leve | |
153 | handlers are called in the application thread. |
|
162 | handlers are called in the application thread. | |
154 | """ |
|
163 | """ | |
155 | raise NotImplementedError('call_handlers must be defined in a subclass.') |
|
164 | raise NotImplementedError('call_handlers must be defined in a subclass.') | |
156 |
|
165 | |||
157 |
def |
|
166 | def execute(self, code): | |
158 | """Immediately processes all pending messages on the SUB channel. |
|
167 | """Execute code in the kernel. | |
159 |
|
||||
160 | This method is thread safe. |
|
|||
161 |
|
168 | |||
162 | Parameters |
|
169 | Parameters | |
163 | ---------- |
|
170 | ---------- | |
164 | timeout : float, optional |
|
171 | code : str | |
165 | The maximum amount of time to spend flushing, in seconds. The |
|
172 | A string of Python code. | |
166 | default is one second. |
|
|||
167 | """ |
|
|||
168 | # We do the IOLoop callback process twice to ensure that the IOLoop |
|
|||
169 | # gets to perform at least one full poll. |
|
|||
170 | stop_time = time.time() + timeout |
|
|||
171 | for i in xrange(2): |
|
|||
172 | self._flushed = False |
|
|||
173 | self.ioloop.add_callback(self._flush) |
|
|||
174 | while not self._flushed and time.time() < stop_time: |
|
|||
175 | time.sleep(0.01) |
|
|||
176 |
|
173 | |||
177 | def _flush(self): |
|
174 | Returns | |
178 | """Called in this thread by the IOLoop to indicate that all events have |
|
175 | ------- | |
179 | been processed. |
|
176 | The msg_id of the message sent. | |
180 | """ |
|
177 | """ | |
181 | self._flushed = True |
|
178 | # Create class for content/msg creation. Related to, but possibly | |
|
179 | # not in Session. | |||
|
180 | content = dict(code=code) | |||
|
181 | msg = self.session.msg('execute_request', content) | |||
|
182 | self._queue_request(msg) | |||
|
183 | return msg['header']['msg_id'] | |||
182 |
|
184 | |||
|
185 | def complete(self, text, line, block=None): | |||
|
186 | """Tab complete text, line, block in the kernel's namespace. | |||
183 |
|
|
187 | ||
184 | class XReqSocketChannel(ZmqSocketChannel): |
|
188 | Parameters | |
|
189 | ---------- | |||
|
190 | text : str | |||
|
191 | The text to complete. | |||
|
192 | line : str | |||
|
193 | The full line of text that is the surrounding context for the | |||
|
194 | text to complete. | |||
|
195 | block : str | |||
|
196 | The full block of code in which the completion is being requested. | |||
|
197 | ||||
|
198 | Returns | |||
|
199 | ------- | |||
|
200 | The msg_id of the message sent. | |||
185 |
|
|
201 | ||
186 | handler_queue = None |
|
202 | """ | |
187 | command_queue = None |
|
203 | content = dict(text=text, line=line) | |
188 | handlers = None |
|
204 | msg = self.session.msg('complete_request', content) | |
189 | _overriden_call_handler = None |
|
205 | self._queue_request(msg) | |
|
206 | return msg['header']['msg_id'] | |||
190 |
|
207 | |||
191 | def __init__(self, context, session, address=None): |
|
208 | def object_info(self, oname): | |
192 | self.handlers = {} |
|
209 | """Get metadata information about an object. | |
193 | self.handler_queue = Queue() |
|
|||
194 | self.command_queue = Queue() |
|
|||
195 | super(XReqSocketChannel, self).__init__(context, session, address) |
|
|||
196 |
|
|
210 | ||
197 | def run(self): |
|
211 | Parameters | |
198 | self.socket = self.context.socket(zmq.XREQ) |
|
212 | ---------- | |
199 | self.socket.setsockopt(zmq.IDENTITY, self.session.session) |
|
213 | oname : str | |
200 | self.socket.connect('tcp://%s:%i' % self.address) |
|
214 | A string specifying the object name. | |
201 | self.ioloop = ioloop.IOLoop() |
|
|||
202 | self.iostate = POLLERR|POLLIN |
|
|||
203 | self.ioloop.add_handler(self.socket, self._handle_events, |
|
|||
204 | self.iostate) |
|
|||
205 | self.ioloop.start() |
|
|||
206 |
|
215 | |||
207 | def stop(self): |
|
216 | Returns | |
208 | self.ioloop.stop() |
|
217 | ------- | |
209 | super(XReqSocketChannel, self).stop() |
|
218 | The msg_id of the message sent. | |
|
219 | """ | |||
|
220 | print oname | |||
|
221 | content = dict(oname=oname) | |||
|
222 | msg = self.session.msg('object_info_request', content) | |||
|
223 | self._queue_request(msg) | |||
|
224 | return msg['header']['msg_id'] | |||
210 |
|
225 | |||
211 | def _handle_events(self, socket, events): |
|
226 | def _handle_events(self, socket, events): | |
212 | if events & POLLERR: |
|
227 | if events & POLLERR: | |
213 | self._handle_err() |
|
228 | self._handle_err() | |
214 | if events & POLLOUT: |
|
229 | if events & POLLOUT: | |
215 | self._handle_send() |
|
230 | self._handle_send() | |
216 | if events & POLLIN: |
|
231 | if events & POLLIN: | |
217 | self._handle_recv() |
|
232 | self._handle_recv() | |
218 |
|
233 | |||
219 | def _handle_recv(self): |
|
234 | def _handle_recv(self): | |
220 | msg = self.socket.recv_json() |
|
235 | msg = self.socket.recv_json() | |
221 | self.call_handlers(msg) |
|
236 | self.call_handlers(msg) | |
222 |
|
237 | |||
223 | def _handle_send(self): |
|
238 | def _handle_send(self): | |
224 | try: |
|
239 | try: | |
225 | msg = self.command_queue.get(False) |
|
240 | msg = self.command_queue.get(False) | |
226 | except Empty: |
|
241 | except Empty: | |
227 | pass |
|
242 | pass | |
228 | else: |
|
243 | else: | |
229 | self.socket.send_json(msg) |
|
244 | self.socket.send_json(msg) | |
230 | if self.command_queue.empty(): |
|
245 | if self.command_queue.empty(): | |
231 | self.drop_io_state(POLLOUT) |
|
246 | self.drop_io_state(POLLOUT) | |
232 |
|
247 | |||
233 | def _handle_err(self): |
|
248 | def _handle_err(self): | |
234 | # We don't want to let this go silently, so eventually we should log. |
|
249 | # We don't want to let this go silently, so eventually we should log. | |
235 | raise zmq.ZMQError() |
|
250 | raise zmq.ZMQError() | |
236 |
|
251 | |||
237 |
def _queue_request(self, msg |
|
252 | def _queue_request(self, msg): | |
238 | handler = self._find_handler(msg['msg_type'], callback) |
|
|||
239 | self.handler_queue.put(handler) |
|
|||
240 | self.command_queue.put(msg) |
|
253 | self.command_queue.put(msg) | |
241 | self.add_io_state(POLLOUT) |
|
254 | self.add_io_state(POLLOUT) | |
242 |
|
255 | |||
243 | def execute(self, code, callback=None): |
|
|||
244 | # Create class for content/msg creation. Related to, but possibly |
|
|||
245 | # not in Session. |
|
|||
246 | content = dict(code=code) |
|
|||
247 | msg = self.session.msg('execute_request', content) |
|
|||
248 | self._queue_request(msg, callback) |
|
|||
249 | return msg['header']['msg_id'] |
|
|||
250 |
|
256 | |||
251 | def complete(self, text, line, block=None, callback=None): |
|
257 | class SubSocketChannel(ZmqSocketChannel): | |
252 | content = dict(text=text, line=line) |
|
258 | """The SUB channel which listens for messages that the kernel publishes. | |
253 | msg = self.session.msg('complete_request', content) |
|
259 | """ | |
254 | self._queue_request(msg, callback) |
|
|||
255 | return msg['header']['msg_id'] |
|
|||
256 |
|
260 | |||
257 | def object_info(self, oname, callback=None): |
|
261 | def __init__(self, context, session, address): | |
258 | content = dict(oname=oname) |
|
262 | super(SubSocketChannel, self).__init__(context, session, address) | |
259 | msg = self.session.msg('object_info_request', content) |
|
|||
260 | self._queue_request(msg, callback) |
|
|||
261 | return msg['header']['msg_id'] |
|
|||
262 |
|
263 | |||
263 | def _find_handler(self, name, callback): |
|
264 | def run(self): | |
264 | if callback is not None: |
|
265 | """The thread's main activity. Call start() instead.""" | |
265 | return callback |
|
266 | self.socket = self.context.socket(zmq.SUB) | |
266 | handler = self.handlers.get(name) |
|
267 | self.socket.setsockopt(zmq.SUBSCRIBE,'') | |
267 | if handler is None: |
|
268 | self.socket.setsockopt(zmq.IDENTITY, self.session.session) | |
268 | raise MissingHandlerError( |
|
269 | self.socket.connect('tcp://%s:%i' % self.address) | |
269 | 'No handler defined for method: %s' % name) |
|
270 | self.ioloop = ioloop.IOLoop() | |
270 | return handler |
|
271 | self.iostate = POLLIN|POLLERR | |
|
272 | self.ioloop.add_handler(self.socket, self._handle_events, | |||
|
273 | self.iostate) | |||
|
274 | self.ioloop.start() | |||
271 |
|
275 | |||
272 | def override_call_handler(self, func): |
|
276 | def stop(self): | |
273 | """Permanently override the call_handler. |
|
277 | self.ioloop.stop() | |
|
278 | super(SubSocketChannel, self).stop() | |||
274 |
|
279 | |||
275 | The function func will be called as:: |
|
280 | def call_handlers(self, msg): | |
|
281 | """This method is called in the ioloop thread when a message arrives. | |||
276 |
|
282 | |||
277 | func(handler, msg) |
|
283 | Subclasses should override this method to handle incoming messages. | |
|
284 | It is important to remember that this method is called in the thread | |||
|
285 | so that some logic must be done to ensure that the application leve | |||
|
286 | handlers are called in the application thread. | |||
|
287 | """ | |||
|
288 | raise NotImplementedError('call_handlers must be defined in a subclass.') | |||
278 |
|
289 | |||
279 | And must call:: |
|
290 | def flush(self, timeout=1.0): | |
|
291 | """Immediately processes all pending messages on the SUB channel. | |||
280 |
|
292 | |||
281 | handler(msg) |
|
293 | This method is thread safe. | |
282 |
|
294 | |||
283 | in the main thread. |
|
295 | Parameters | |
|
296 | ---------- | |||
|
297 | timeout : float, optional | |||
|
298 | The maximum amount of time to spend flushing, in seconds. The | |||
|
299 | default is one second. | |||
284 | """ |
|
300 | """ | |
285 | assert callable(func), "not a callable: %r" % func |
|
301 | # We do the IOLoop callback process twice to ensure that the IOLoop | |
286 | self._overriden_call_handler = func |
|
302 | # gets to perform at least one full poll. | |
|
303 | stop_time = time.time() + timeout | |||
|
304 | for i in xrange(2): | |||
|
305 | self._flushed = False | |||
|
306 | self.ioloop.add_callback(self._flush) | |||
|
307 | while not self._flushed and time.time() < stop_time: | |||
|
308 | time.sleep(0.01) | |||
287 |
|
309 | |||
288 |
def |
|
310 | def _handle_events(self, socket, events): | |
|
311 | # Turn on and off POLLOUT depending on if we have made a request | |||
|
312 | if events & POLLERR: | |||
|
313 | self._handle_err() | |||
|
314 | if events & POLLIN: | |||
|
315 | self._handle_recv() | |||
|
316 | ||||
|
317 | def _handle_err(self): | |||
|
318 | # We don't want to let this go silently, so eventually we should log. | |||
|
319 | raise zmq.ZMQError() | |||
|
320 | ||||
|
321 | def _handle_recv(self): | |||
|
322 | # Get all of the messages we can | |||
|
323 | while True: | |||
289 | try: |
|
324 | try: | |
290 | handler = self.handler_queue.get(False) |
|
325 | msg = self.socket.recv_json(zmq.NOBLOCK) | |
291 |
except |
|
326 | except zmq.ZMQError: | |
292 | print "Message received with no handler!!!" |
|
327 | # Check the errno? | |
293 | print msg |
|
328 | # Will this tigger POLLERR? | |
294 | else: |
|
329 | break | |
295 | self.call_handler(handler, msg) |
|
|||
296 |
|
||||
297 | def call_handler(self, handler, msg): |
|
|||
298 | if self._overriden_call_handler is not None: |
|
|||
299 | self._overriden_call_handler(handler, msg) |
|
|||
300 | elif hasattr(self, '_call_handler'): |
|
|||
301 | call_handler = getattr(self, '_call_handler') |
|
|||
302 | call_handler(handler, msg) |
|
|||
303 | else: |
|
330 | else: | |
304 | raise RuntimeError('no handler!') |
|
331 | self.call_handlers(msg) | |
|
332 | ||||
|
333 | def _flush(self): | |||
|
334 | """Callback for :method:`self.flush`.""" | |||
|
335 | self._flushed = True | |||
305 |
|
336 | |||
306 |
|
337 | |||
307 | class RepSocketChannel(ZmqSocketChannel): |
|
338 | class RepSocketChannel(ZmqSocketChannel): | |
|
339 | """A reply channel to handle raw_input requests that the kernel makes.""" | |||
|
340 | ||||
|
341 | def run(self): | |||
|
342 | """The thread's main activity. Call start() instead.""" | |||
|
343 | self.ioloop = ioloop.IOLoop() | |||
|
344 | self.ioloop.start() | |||
|
345 | ||||
|
346 | def stop(self): | |||
|
347 | self.ioloop.stop() | |||
|
348 | super(SubSocketChannel, self).stop() | |||
308 |
|
349 | |||
309 | def on_raw_input(self): |
|
350 | def on_raw_input(self): | |
310 | pass |
|
351 | pass | |
311 |
|
352 | |||
312 |
|
353 | |||
|
354 | #----------------------------------------------------------------------------- | |||
|
355 | # Main kernel manager class | |||
|
356 | #----------------------------------------------------------------------------- | |||
|
357 | ||||
|
358 | ||||
313 | class KernelManager(HasTraits): |
|
359 | class KernelManager(HasTraits): | |
314 | """ Manages a kernel for a frontend. |
|
360 | """ Manages a kernel for a frontend. | |
315 |
|
361 | |||
316 | The SUB channel is for the frontend to receive messages published by the |
|
362 | The SUB channel is for the frontend to receive messages published by the | |
317 | kernel. |
|
363 | kernel. | |
318 |
|
364 | |||
319 | The REQ channel is for the frontend to make requests of the kernel. |
|
365 | The REQ channel is for the frontend to make requests of the kernel. | |
320 |
|
366 | |||
321 | The REP channel is for the kernel to request stdin (raw_input) from the |
|
367 | The REP channel is for the kernel to request stdin (raw_input) from the | |
322 | frontend. |
|
368 | frontend. | |
323 | """ |
|
369 | """ | |
324 |
|
||||
325 | # Whether the kernel manager is currently listening on its channels. |
|
|||
326 | is_listening = Bool(False) |
|
|||
327 |
|
||||
328 | # The PyZMQ Context to use for communication with the kernel. |
|
370 | # The PyZMQ Context to use for communication with the kernel. | |
329 |
context = Instance(zmq.Context |
|
371 | context = Instance(zmq.Context) | |
330 |
|
372 | |||
331 | # The Session to use for communication with the kernel. |
|
373 | # The Session to use for communication with the kernel. | |
332 |
session = Instance(Session |
|
374 | session = Instance(Session) | |
333 |
|
375 | |||
334 | # The classes to use for the various channels. |
|
376 | # The classes to use for the various channels. | |
335 | sub_channel_class = Type(SubSocketChannel) |
|
|||
336 | xreq_channel_class = Type(XReqSocketChannel) |
|
377 | xreq_channel_class = Type(XReqSocketChannel) | |
|
378 | sub_channel_class = Type(SubSocketChannel) | |||
337 | rep_channel_class = Type(RepSocketChannel) |
|
379 | rep_channel_class = Type(RepSocketChannel) | |
338 |
|
380 | |||
339 | # Protected traits. |
|
381 | # Protected traits. | |
340 | _kernel = Instance(Popen) |
|
382 | _kernel = Instance(Popen) | |
341 | _sub_channel = Any |
|
383 | _xreq_address = Any | |
|
384 | _sub_address = Any | |||
|
385 | _rep_address = Any | |||
342 | _xreq_channel = Any |
|
386 | _xreq_channel = Any | |
|
387 | _sub_channel = Any | |||
343 | _rep_channel = Any |
|
388 | _rep_channel = Any | |
344 |
|
389 | |||
|
390 | def __init__(self, xreq_address=None, sub_address=None, rep_address=None, | |||
|
391 | context=None, session=None): | |||
|
392 | self._xreq_address = (LOCALHOST, 0) if xreq_address is None else xreq_address | |||
|
393 | self._sub_address = (LOCALHOST, 0) if sub_address is None else sub_address | |||
|
394 | self._rep_address = (LOCALHOST, 0) if rep_address is None else rep_address | |||
|
395 | self.context = zmq.Context() if context is None else context | |||
|
396 | self.session = Session() if session is None else session | |||
|
397 | ||||
345 | #-------------------------------------------------------------------------- |
|
398 | #-------------------------------------------------------------------------- | |
346 | # Channel management methods: |
|
399 | # Channel management methods: | |
347 | #-------------------------------------------------------------------------- |
|
400 | #-------------------------------------------------------------------------- | |
348 |
|
401 | |||
349 |
def start_l |
|
402 | def start_channels(self): | |
350 | """Starts listening on the specified ports. If already listening, raises |
|
403 | """Starts the channels for this kernel. | |
351 | a RuntimeError. |
|
404 | ||
|
405 | This will create the channels if they do not exist and then start | |||
|
406 | them. If port numbers of 0 are being used (random ports) then you | |||
|
407 | must first call :method:`start_kernel`. If the channels have been | |||
|
408 | stopped and you call this, :class:`RuntimeError` will be raised. | |||
352 | """ |
|
409 | """ | |
353 | if self.is_listening: |
|
|||
354 | raise RuntimeError("Cannot start listening. Already listening!") |
|
|||
355 | else: |
|
|||
356 | self.is_listening = True |
|
|||
357 | self.sub_channel.start() |
|
|||
358 |
|
|
410 | self.xreq_channel.start() | |
|
411 | self.sub_channel.start() | |||
359 |
|
|
412 | self.rep_channel.start() | |
360 |
|
413 | |||
361 | @property |
|
414 | def stop_channels(self): | |
362 | def is_alive(self): |
|
415 | """Stops the channels for this kernel. | |
363 | """ Returns whether the kernel is alive. """ |
|
|||
364 | if self.is_listening: |
|
|||
365 | # TODO: check if alive. |
|
|||
366 | return True |
|
|||
367 | else: |
|
|||
368 | return False |
|
|||
369 |
|
|
416 | ||
370 | def stop_listening(self): |
|
417 | This stops the channels by joining their threads. If the channels | |
371 | """Stops listening. If not listening, does nothing. """ |
|
418 | were not started, :class:`RuntimeError` will be raised. | |
372 | if self.is_listening: |
|
419 | """ | |
373 | self.is_listening = False |
|
|||
374 | self.sub_channel.stop() |
|
|||
375 |
|
|
420 | self.xreq_channel.stop() | |
|
421 | self.sub_channel.stop() | |||
376 |
|
|
422 | self.rep_channel.stop() | |
377 |
|
423 | |||
|
424 | @property | |||
|
425 | def channels_running(self): | |||
|
426 | """Are all of the channels created and running?""" | |||
|
427 | return self.xreq_channel.is_alive() \ | |||
|
428 | and self.sub_channel.is_alive() \ | |||
|
429 | and self.rep_channel.is_alive() | |||
|
430 | ||||
378 | #-------------------------------------------------------------------------- |
|
431 | #-------------------------------------------------------------------------- | |
379 | # Kernel process management methods: |
|
432 | # Kernel process management methods: | |
380 | #-------------------------------------------------------------------------- |
|
433 | #-------------------------------------------------------------------------- | |
381 |
|
434 | |||
382 | def start_kernel(self): |
|
435 | def start_kernel(self): | |
383 | """Starts a kernel process and configures the manager to use it. |
|
436 | """Starts a kernel process and configures the manager to use it. | |
384 |
|
437 | |||
385 | If ports have been specified via the address attributes, they are used. |
|
438 | If random ports (port=0) are being used, this method must be called | |
386 | Otherwise, open ports are chosen by the OS and the channel port |
|
439 | before the channels are created. | |
387 | attributes are configured as appropriate. |
|
|||
388 | """ |
|
440 | """ | |
389 | xreq, sub = self.xreq_address, self.sub_address |
|
441 | xreq, sub = self.xreq_address, self.sub_address | |
390 | if xreq[0] != LOCALHOST or sub[0] != LOCALHOST: |
|
442 | if xreq[0] != LOCALHOST or sub[0] != LOCALHOST: | |
391 | raise RuntimeError("Can only launch a kernel on localhost." |
|
443 | raise RuntimeError("Can only launch a kernel on localhost." | |
392 | "Make sure that the '*_address' attributes are " |
|
444 | "Make sure that the '*_address' attributes are " | |
393 | "configured properly.") |
|
445 | "configured properly.") | |
394 |
|
446 | |||
395 | kernel, xrep, pub = launch_kernel(xrep_port=xreq[1], pub_port=sub[1]) |
|
447 | kernel, xrep, pub = launch_kernel(xrep_port=xreq[1], pub_port=sub[1]) | |
396 | self.set_kernel(kernel) |
|
|||
397 | self.xreq_address = (LOCALHOST, xrep) |
|
|||
398 | self.sub_address = (LOCALHOST, pub) |
|
|||
399 |
|
||||
400 | def set_kernel(self, kernel): |
|
|||
401 | """Sets the kernel manager's kernel to an existing kernel process. |
|
|||
402 |
|
||||
403 | It is *not* necessary to a set a kernel to communicate with it via the |
|
|||
404 | channels, and those objects must be configured separately. It |
|
|||
405 | *is* necessary to set a kernel if you want to use the manager (or |
|
|||
406 | frontends that use the manager) to signal and/or kill the kernel. |
|
|||
407 |
|
||||
408 | Parameters: |
|
|||
409 | ----------- |
|
|||
410 | kernel : Popen |
|
|||
411 | An existing kernel process. |
|
|||
412 | """ |
|
|||
413 | self._kernel = kernel |
|
448 | self._kernel = kernel | |
|
449 | self._xreq_address = (LOCALHOST, xrep) | |||
|
450 | self._sub_address = (LOCALHOST, pub) | |||
|
451 | # The rep channel is not fully working yet, but its base class makes | |||
|
452 | # sure the port is not 0. We set to -1 for now until the rep channel | |||
|
453 | # is fully working. | |||
|
454 | self._rep_address = (LOCALHOST, -1) | |||
414 |
|
455 | |||
415 | @property |
|
456 | @property | |
416 | def has_kernel(self): |
|
457 | def has_kernel(self): | |
417 | """Returns whether a kernel process has been specified for the kernel |
|
458 | """Returns whether a kernel process has been specified for the kernel | |
418 | manager. |
|
459 | manager. | |
419 |
|
460 | |||
420 | A kernel process can be set via 'start_kernel' or 'set_kernel'. |
|
461 | A kernel process can be set via 'start_kernel' or 'set_kernel'. | |
421 | """ |
|
462 | """ | |
422 | return self._kernel is not None |
|
463 | return self._kernel is not None | |
423 |
|
464 | |||
424 | def kill_kernel(self): |
|
465 | def kill_kernel(self): | |
425 | """ Kill the running kernel. """ |
|
466 | """ Kill the running kernel. """ | |
426 | if self._kernel: |
|
467 | if self._kernel is not None: | |
427 | self._kernel.kill() |
|
468 | self._kernel.kill() | |
428 | self._kernel = None |
|
469 | self._kernel = None | |
429 | else: |
|
470 | else: | |
430 | raise RuntimeError("Cannot kill kernel. No kernel is running!") |
|
471 | raise RuntimeError("Cannot kill kernel. No kernel is running!") | |
431 |
|
472 | |||
432 | def signal_kernel(self, signum): |
|
473 | def signal_kernel(self, signum): | |
433 | """ Sends a signal to the kernel. """ |
|
474 | """ Sends a signal to the kernel. """ | |
434 | if self._kernel: |
|
475 | if self._kernel is not None: | |
435 | self._kernel.send_signal(signum) |
|
476 | self._kernel.send_signal(signum) | |
436 | else: |
|
477 | else: | |
437 | raise RuntimeError("Cannot signal kernel. No kernel is running!") |
|
478 | raise RuntimeError("Cannot signal kernel. No kernel is running!") | |
438 |
|
479 | |||
|
480 | @property | |||
|
481 | def is_alive(self): | |||
|
482 | """Is the kernel process still running?""" | |||
|
483 | if self._kernel is not None: | |||
|
484 | if self._kernel.poll() is None: | |||
|
485 | return True | |||
|
486 | else: | |||
|
487 | return False | |||
|
488 | else: | |||
|
489 | # We didn't start the kernel with this KernelManager so we don't | |||
|
490 | # know if it is running. We should use a heartbeat for this case. | |||
|
491 | return True | |||
|
492 | ||||
439 | #-------------------------------------------------------------------------- |
|
493 | #-------------------------------------------------------------------------- | |
440 | # Channels used for communication with the kernel: |
|
494 | # Channels used for communication with the kernel: | |
441 | #-------------------------------------------------------------------------- |
|
495 | #-------------------------------------------------------------------------- | |
442 |
|
496 | |||
443 | @property |
|
497 | @property | |
444 | def sub_channel(self): |
|
|||
445 | """Get the SUB socket channel object.""" |
|
|||
446 | if self._sub_channel is None: |
|
|||
447 | self._sub_channel = self.sub_channel_class(self.context, |
|
|||
448 | self.session) |
|
|||
449 | return self._sub_channel |
|
|||
450 |
|
||||
451 | @property |
|
|||
452 | def xreq_channel(self): |
|
498 | def xreq_channel(self): | |
453 | """Get the REQ socket channel object to make requests of the kernel.""" |
|
499 | """Get the REQ socket channel object to make requests of the kernel.""" | |
454 | if self._xreq_channel is None: |
|
500 | if self._xreq_channel is None: | |
455 | self._xreq_channel = self.xreq_channel_class(self.context, |
|
501 | self._xreq_channel = self.xreq_channel_class(self.context, | |
456 |
self.session |
|
502 | self.session, | |
|
503 | self.xreq_address) | |||
457 | return self._xreq_channel |
|
504 | return self._xreq_channel | |
458 |
|
505 | |||
459 | @property |
|
506 | @property | |
|
507 | def sub_channel(self): | |||
|
508 | """Get the SUB socket channel object.""" | |||
|
509 | if self._sub_channel is None: | |||
|
510 | self._sub_channel = self.sub_channel_class(self.context, | |||
|
511 | self.session, | |||
|
512 | self.sub_address) | |||
|
513 | return self._sub_channel | |||
|
514 | ||||
|
515 | @property | |||
460 | def rep_channel(self): |
|
516 | def rep_channel(self): | |
461 | """Get the REP socket channel object to handle stdin (raw_input).""" |
|
517 | """Get the REP socket channel object to handle stdin (raw_input).""" | |
462 | if self._rep_channel is None: |
|
518 | if self._rep_channel is None: | |
463 | self._rep_channel = self.rep_channel_class(self.context, |
|
519 | self._rep_channel = self.rep_channel_class(self.context, | |
464 |
self.session |
|
520 | self.session, | |
|
521 | self.rep_address) | |||
465 | return self._rep_channel |
|
522 | return self._rep_channel | |
466 |
|
523 | |||
467 | #-------------------------------------------------------------------------- |
|
524 | @property | |
468 | # Delegates for the Channel address attributes: |
|
525 | def xreq_address(self): | |
469 | #-------------------------------------------------------------------------- |
|
526 | return self._xreq_address | |
470 |
|
||||
471 | def get_sub_address(self): |
|
|||
472 | return self.sub_channel.address |
|
|||
473 |
|
||||
474 | def set_sub_address(self, address): |
|
|||
475 | self.sub_channel.address = address |
|
|||
476 |
|
||||
477 | sub_address = property(get_sub_address, set_sub_address, |
|
|||
478 | doc="The address used by SUB socket channel.") |
|
|||
479 |
|
||||
480 | def get_xreq_address(self): |
|
|||
481 | return self.xreq_channel.address |
|
|||
482 |
|
||||
483 | def set_xreq_address(self, address): |
|
|||
484 | self.xreq_channel.address = address |
|
|||
485 |
|
||||
486 | xreq_address = property(get_xreq_address, set_xreq_address, |
|
|||
487 | doc="The address used by XREQ socket channel.") |
|
|||
488 |
|
527 | |||
489 | def get_rep_address(self): |
|
528 | @property | |
490 | return self.rep_channel.address |
|
529 | def sub_address(self): | |
|
530 | return self._sub_address | |||
491 |
|
531 | |||
492 | def set_rep_address(self, address): |
|
532 | @property | |
493 | self.rep_channel.address = address |
|
533 | def rep_address(self): | |
|
534 | return self._rep_address | |||
494 |
|
535 | |||
495 | rep_address = property(get_rep_address, set_rep_address, |
|
|||
496 | doc="The address used by REP socket channel.") |
|
|||
497 |
|
536 |
General Comments 0
You need to be logged in to leave comments.
Login now