Show More
The requested changes are too big and content was truncated. Show full diff
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
@@ -1,372 +1,372 b'' | |||
|
1 | 1 | """ |
|
2 | 2 | Base front end class for all line-oriented frontends, rather than |
|
3 | 3 | block-oriented. |
|
4 | 4 | |
|
5 | 5 | Currently this focuses on synchronous frontends. |
|
6 | 6 | """ |
|
7 | 7 | __docformat__ = "restructuredtext en" |
|
8 | 8 | |
|
9 | 9 | #------------------------------------------------------------------------------- |
|
10 | 10 | # Copyright (C) 2008 The IPython Development Team |
|
11 | 11 | # |
|
12 | 12 | # Distributed under the terms of the BSD License. The full license is in |
|
13 | 13 | # the file COPYING, distributed as part of this software. |
|
14 | 14 | #------------------------------------------------------------------------------- |
|
15 | 15 | |
|
16 | 16 | #------------------------------------------------------------------------------- |
|
17 | 17 | # Imports |
|
18 | 18 | #------------------------------------------------------------------------------- |
|
19 | 19 | import re |
|
20 | 20 | |
|
21 | 21 | import sys |
|
22 | 22 | import codeop |
|
23 | 23 | |
|
24 | 24 | from frontendbase import FrontEndBase |
|
25 | 25 | from IPython.kernel.core.interpreter import Interpreter |
|
26 | 26 | |
|
27 | 27 | def common_prefix(strings): |
|
28 | 28 | """ Given a list of strings, return the common prefix between all |
|
29 | 29 | these strings. |
|
30 | 30 | """ |
|
31 | 31 | ref = strings[0] |
|
32 | 32 | prefix = '' |
|
33 | 33 | for size in range(len(ref)): |
|
34 | 34 | test_prefix = ref[:size+1] |
|
35 | 35 | for string in strings[1:]: |
|
36 | 36 | if not string.startswith(test_prefix): |
|
37 | 37 | return prefix |
|
38 | 38 | prefix = test_prefix |
|
39 | 39 | |
|
40 | 40 | return prefix |
|
41 | 41 | |
|
42 | 42 | #------------------------------------------------------------------------------- |
|
43 | 43 | # Base class for the line-oriented front ends |
|
44 | 44 | #------------------------------------------------------------------------------- |
|
45 | 45 | class LineFrontEndBase(FrontEndBase): |
|
46 | 46 | """ Concrete implementation of the FrontEndBase class. This is meant |
|
47 | 47 | to be the base class behind all the frontend that are line-oriented, |
|
48 | 48 | rather than block-oriented. |
|
49 | 49 | """ |
|
50 | 50 | |
|
51 | 51 | # We need to keep the prompt number, to be able to increment |
|
52 | 52 | # it when there is an exception. |
|
53 | 53 | prompt_number = 1 |
|
54 | 54 | |
|
55 | 55 | # We keep a reference to the last result: it helps testing and |
|
56 | 56 | # programatic control of the frontend. |
|
57 | 57 | last_result = dict(number=0) |
|
58 | 58 | |
|
59 | 59 | # The last prompt displayed. Useful for continuation prompts. |
|
60 | 60 | last_prompt = '' |
|
61 | 61 | |
|
62 | 62 | # The input buffer being edited |
|
63 | 63 | input_buffer = '' |
|
64 | 64 | |
|
65 | 65 | # Set to true for debug output |
|
66 | 66 | debug = False |
|
67 | 67 | |
|
68 | 68 | # A banner to print at startup |
|
69 | 69 | banner = None |
|
70 | 70 | |
|
71 | 71 | #-------------------------------------------------------------------------- |
|
72 | 72 | # FrontEndBase interface |
|
73 | 73 | #-------------------------------------------------------------------------- |
|
74 | 74 | |
|
75 | 75 | def __init__(self, shell=None, history=None, banner=None, *args, **kwargs): |
|
76 | 76 | if shell is None: |
|
77 | 77 | shell = Interpreter() |
|
78 | 78 | FrontEndBase.__init__(self, shell=shell, history=history) |
|
79 | 79 | |
|
80 | 80 | if banner is not None: |
|
81 | 81 | self.banner = banner |
|
82 | 82 | |
|
83 | 83 | def start(self): |
|
84 | 84 | """ Put the frontend in a state where it is ready for user |
|
85 | 85 | interaction. |
|
86 | 86 | """ |
|
87 | 87 | if self.banner is not None: |
|
88 | 88 | self.write(self.banner, refresh=False) |
|
89 | 89 | |
|
90 | 90 | self.new_prompt(self.input_prompt_template.substitute(number=1)) |
|
91 | 91 | |
|
92 | 92 | |
|
93 | 93 | def complete(self, line): |
|
94 | 94 | """Complete line in engine's user_ns |
|
95 | 95 | |
|
96 | 96 | Parameters |
|
97 | 97 | ---------- |
|
98 | 98 | line : string |
|
99 | 99 | |
|
100 |
Res |
|
|
101 | ------ | |
|
100 | Returns | |
|
101 | ------- | |
|
102 | 102 | The replacement for the line and the list of possible completions. |
|
103 | 103 | """ |
|
104 | 104 | completions = self.shell.complete(line) |
|
105 | 105 | complete_sep = re.compile('[\s\{\}\[\]\(\)\=]') |
|
106 | 106 | if completions: |
|
107 | 107 | prefix = common_prefix(completions) |
|
108 | 108 | residual = complete_sep.split(line)[:-1] |
|
109 | 109 | line = line[:-len(residual)] + prefix |
|
110 | 110 | return line, completions |
|
111 | 111 | |
|
112 | 112 | |
|
113 | 113 | def render_result(self, result): |
|
114 | 114 | """ Frontend-specific rendering of the result of a calculation |
|
115 | 115 | that has been sent to an engine. |
|
116 | 116 | """ |
|
117 | 117 | if 'stdout' in result and result['stdout']: |
|
118 | 118 | self.write('\n' + result['stdout']) |
|
119 | 119 | if 'display' in result and result['display']: |
|
120 | 120 | self.write("%s%s\n" % ( |
|
121 | 121 | self.output_prompt_template.substitute( |
|
122 | 122 | number=result['number']), |
|
123 | 123 | result['display']['pprint'] |
|
124 | 124 | ) ) |
|
125 | 125 | |
|
126 | 126 | |
|
127 | 127 | def render_error(self, failure): |
|
128 | 128 | """ Frontend-specific rendering of error. |
|
129 | 129 | """ |
|
130 | 130 | self.write('\n\n'+str(failure)+'\n\n') |
|
131 | 131 | return failure |
|
132 | 132 | |
|
133 | 133 | |
|
134 | 134 | def is_complete(self, string): |
|
135 | 135 | """ Check if a string forms a complete, executable set of |
|
136 | 136 | commands. |
|
137 | 137 | |
|
138 | 138 | For the line-oriented frontend, multi-line code is not executed |
|
139 | 139 | as soon as it is complete: the users has to enter two line |
|
140 | 140 | returns. |
|
141 | 141 | """ |
|
142 | 142 | if string in ('', '\n'): |
|
143 | 143 | # Prefiltering, eg through ipython0, may return an empty |
|
144 | 144 | # string although some operations have been accomplished. We |
|
145 | 145 | # thus want to consider an empty string as a complete |
|
146 | 146 | # statement. |
|
147 | 147 | return True |
|
148 | 148 | elif ( len(self.input_buffer.split('\n'))>2 |
|
149 | 149 | and not re.findall(r"\n[\t ]*\n[\t ]*$", string)): |
|
150 | 150 | return False |
|
151 | 151 | else: |
|
152 | 152 | self.capture_output() |
|
153 | 153 | try: |
|
154 | 154 | # Add line returns here, to make sure that the statement is |
|
155 | 155 | # complete (except if '\' was used). |
|
156 | 156 | # This should probably be done in a different place (like |
|
157 | 157 | # maybe 'prefilter_input' method? For now, this works. |
|
158 | 158 | clean_string = string.rstrip('\n') |
|
159 | 159 | if not clean_string.endswith('\\'): clean_string +='\n\n' |
|
160 | 160 | is_complete = codeop.compile_command(clean_string, |
|
161 | 161 | "<string>", "exec") |
|
162 | 162 | self.release_output() |
|
163 | 163 | except Exception, e: |
|
164 | 164 | # XXX: Hack: return True so that the |
|
165 | 165 | # code gets executed and the error captured. |
|
166 | 166 | is_complete = True |
|
167 | 167 | return is_complete |
|
168 | 168 | |
|
169 | 169 | |
|
170 | 170 | def write(self, string, refresh=True): |
|
171 | 171 | """ Write some characters to the display. |
|
172 | 172 | |
|
173 | 173 | Subclass should overide this method. |
|
174 | 174 | |
|
175 | 175 | The refresh keyword argument is used in frontends with an |
|
176 | 176 | event loop, to choose whether the write should trigget an UI |
|
177 | 177 | refresh, and thus be syncrhonous, or not. |
|
178 | 178 | """ |
|
179 | 179 | print >>sys.__stderr__, string |
|
180 | 180 | |
|
181 | 181 | |
|
182 | 182 | def execute(self, python_string, raw_string=None): |
|
183 | 183 | """ Stores the raw_string in the history, and sends the |
|
184 | 184 | python string to the interpreter. |
|
185 | 185 | """ |
|
186 | 186 | if raw_string is None: |
|
187 | 187 | raw_string = python_string |
|
188 | 188 | # Create a false result, in case there is an exception |
|
189 | 189 | self.last_result = dict(number=self.prompt_number) |
|
190 | 190 | |
|
191 | 191 | try: |
|
192 | 192 | try: |
|
193 | 193 | self.history.input_cache[-1] = raw_string.rstrip() |
|
194 | 194 | result = self.shell.execute(python_string) |
|
195 | 195 | self.last_result = result |
|
196 | 196 | self.render_result(result) |
|
197 | 197 | except: |
|
198 | 198 | self.show_traceback() |
|
199 | 199 | finally: |
|
200 | 200 | self.after_execute() |
|
201 | 201 | |
|
202 | 202 | |
|
203 | 203 | #-------------------------------------------------------------------------- |
|
204 | 204 | # LineFrontEndBase interface |
|
205 | 205 | #-------------------------------------------------------------------------- |
|
206 | 206 | |
|
207 | 207 | def prefilter_input(self, string): |
|
208 | 208 | """ Prefilter the input to turn it in valid python. |
|
209 | 209 | """ |
|
210 | 210 | string = string.replace('\r\n', '\n') |
|
211 | 211 | string = string.replace('\t', 4*' ') |
|
212 | 212 | # Clean the trailing whitespace |
|
213 | 213 | string = '\n'.join(l.rstrip() for l in string.split('\n')) |
|
214 | 214 | return string |
|
215 | 215 | |
|
216 | 216 | |
|
217 | 217 | def after_execute(self): |
|
218 | 218 | """ All the operations required after an execution to put the |
|
219 | 219 | terminal back in a shape where it is usable. |
|
220 | 220 | """ |
|
221 | 221 | self.prompt_number += 1 |
|
222 | 222 | self.new_prompt(self.input_prompt_template.substitute( |
|
223 | 223 | number=(self.last_result['number'] + 1))) |
|
224 | 224 | # Start a new empty history entry |
|
225 | 225 | self._add_history(None, '') |
|
226 | 226 | self.history_cursor = len(self.history.input_cache) - 1 |
|
227 | 227 | |
|
228 | 228 | |
|
229 | 229 | def complete_current_input(self): |
|
230 | 230 | """ Do code completion on current line. |
|
231 | 231 | """ |
|
232 | 232 | if self.debug: |
|
233 | 233 | print >>sys.__stdout__, "complete_current_input", |
|
234 | 234 | line = self.input_buffer |
|
235 | 235 | new_line, completions = self.complete(line) |
|
236 | 236 | if len(completions)>1: |
|
237 | 237 | self.write_completion(completions, new_line=new_line) |
|
238 | 238 | elif not line == new_line: |
|
239 | 239 | self.input_buffer = new_line |
|
240 | 240 | if self.debug: |
|
241 | 241 | print >>sys.__stdout__, 'line', line |
|
242 | 242 | print >>sys.__stdout__, 'new_line', new_line |
|
243 | 243 | print >>sys.__stdout__, completions |
|
244 | 244 | |
|
245 | 245 | |
|
246 | 246 | def get_line_width(self): |
|
247 | 247 | """ Return the width of the line in characters. |
|
248 | 248 | """ |
|
249 | 249 | return 80 |
|
250 | 250 | |
|
251 | 251 | |
|
252 | 252 | def write_completion(self, possibilities, new_line=None): |
|
253 | 253 | """ Write the list of possible completions. |
|
254 | 254 | |
|
255 | 255 | new_line is the completed input line that should be displayed |
|
256 | 256 | after the completion are writen. If None, the input_buffer |
|
257 | 257 | before the completion is used. |
|
258 | 258 | """ |
|
259 | 259 | if new_line is None: |
|
260 | 260 | new_line = self.input_buffer |
|
261 | 261 | |
|
262 | 262 | self.write('\n') |
|
263 | 263 | max_len = len(max(possibilities, key=len)) + 1 |
|
264 | 264 | |
|
265 | 265 | # Now we check how much symbol we can put on a line... |
|
266 | 266 | chars_per_line = self.get_line_width() |
|
267 | 267 | symbols_per_line = max(1, chars_per_line/max_len) |
|
268 | 268 | |
|
269 | 269 | pos = 1 |
|
270 | 270 | completion_string = [] |
|
271 | 271 | for symbol in possibilities: |
|
272 | 272 | if pos < symbols_per_line: |
|
273 | 273 | completion_string.append(symbol.ljust(max_len)) |
|
274 | 274 | pos += 1 |
|
275 | 275 | else: |
|
276 | 276 | completion_string.append(symbol.rstrip() + '\n') |
|
277 | 277 | pos = 1 |
|
278 | 278 | self.write(''.join(completion_string)) |
|
279 | 279 | self.new_prompt(self.input_prompt_template.substitute( |
|
280 | 280 | number=self.last_result['number'] + 1)) |
|
281 | 281 | self.input_buffer = new_line |
|
282 | 282 | |
|
283 | 283 | |
|
284 | 284 | def new_prompt(self, prompt): |
|
285 | 285 | """ Prints a prompt and starts a new editing buffer. |
|
286 | 286 | |
|
287 | 287 | Subclasses should use this method to make sure that the |
|
288 | 288 | terminal is put in a state favorable for a new line |
|
289 | 289 | input. |
|
290 | 290 | """ |
|
291 | 291 | self.input_buffer = '' |
|
292 | 292 | self.write(prompt) |
|
293 | 293 | |
|
294 | 294 | |
|
295 | 295 | def continuation_prompt(self): |
|
296 | 296 | """Returns the current continuation prompt. |
|
297 | 297 | """ |
|
298 | 298 | return ("."*(len(self.last_prompt)-2) + ': ') |
|
299 | 299 | |
|
300 | 300 | |
|
301 | 301 | def execute_command(self, command, hidden=False): |
|
302 | 302 | """ Execute a command, not only in the model, but also in the |
|
303 | 303 | view, if any. |
|
304 | 304 | """ |
|
305 | 305 | return self.shell.execute(command) |
|
306 | 306 | |
|
307 | 307 | #-------------------------------------------------------------------------- |
|
308 | 308 | # Private API |
|
309 | 309 | #-------------------------------------------------------------------------- |
|
310 | 310 | |
|
311 | 311 | def _on_enter(self, new_line_pos=0): |
|
312 | 312 | """ Called when the return key is pressed in a line editing |
|
313 | 313 | buffer. |
|
314 | 314 | |
|
315 | 315 | Parameters |
|
316 | 316 | ---------- |
|
317 | 317 | new_line_pos : integer, optional |
|
318 | 318 | Position of the new line to add, starting from the |
|
319 | 319 | end (0 adds a new line after the last line, -1 before |
|
320 | 320 | the last line...) |
|
321 | 321 | |
|
322 | 322 | Returns |
|
323 | 323 | ------- |
|
324 | 324 | True if execution is triggered |
|
325 | 325 | """ |
|
326 | 326 | current_buffer = self.input_buffer |
|
327 | 327 | # XXX: This string replace is ugly, but there should be no way it |
|
328 | 328 | # fails. |
|
329 | 329 | prompt_less_buffer = re.sub('^' + self.continuation_prompt(), |
|
330 | 330 | '', current_buffer).replace('\n' + self.continuation_prompt(), |
|
331 | 331 | '\n') |
|
332 | 332 | cleaned_buffer = self.prefilter_input(prompt_less_buffer) |
|
333 | 333 | if self.is_complete(cleaned_buffer): |
|
334 | 334 | self.execute(cleaned_buffer, raw_string=current_buffer) |
|
335 | 335 | return True |
|
336 | 336 | else: |
|
337 | 337 | # Start a new line. |
|
338 | 338 | new_line_pos = -new_line_pos |
|
339 | 339 | lines = current_buffer.split('\n')[:-1] |
|
340 | 340 | prompt_less_lines = prompt_less_buffer.split('\n') |
|
341 | 341 | # Create the new line, with the continuation prompt, and the |
|
342 | 342 | # same amount of indent than the line above it. |
|
343 | 343 | new_line = self.continuation_prompt() + \ |
|
344 | 344 | self._get_indent_string('\n'.join( |
|
345 | 345 | prompt_less_lines[:new_line_pos-1])) |
|
346 | 346 | if len(lines) == 1: |
|
347 | 347 | # We are starting a first continuation line. Indent it. |
|
348 | 348 | new_line += '\t' |
|
349 | 349 | elif current_buffer[:-1].split('\n')[-1].rstrip().endswith(':'): |
|
350 | 350 | # The last line ends with ":", autoindent the new line. |
|
351 | 351 | new_line += '\t' |
|
352 | 352 | |
|
353 | 353 | if new_line_pos == 0: |
|
354 | 354 | lines.append(new_line) |
|
355 | 355 | else: |
|
356 | 356 | lines.insert(new_line_pos, new_line) |
|
357 | 357 | self.input_buffer = '\n'.join(lines) |
|
358 | 358 | |
|
359 | 359 | |
|
360 | 360 | def _get_indent_string(self, string): |
|
361 | 361 | """ Return the string of whitespace that prefixes a line. Used to |
|
362 | 362 | add the right amount of indendation when creating a new line. |
|
363 | 363 | """ |
|
364 | 364 | string = string.replace('\t', ' '*4) |
|
365 | 365 | string = string.split('\n')[-1] |
|
366 | 366 | indent_chars = len(string) - len(string.lstrip()) |
|
367 | 367 | indent_string = '\t'*(indent_chars // 4) + \ |
|
368 | 368 | ' '*(indent_chars % 4) |
|
369 | 369 | |
|
370 | 370 | return indent_string |
|
371 | 371 | |
|
372 | 372 |
@@ -1,285 +1,285 b'' | |||
|
1 | 1 | """ |
|
2 | 2 | Frontend class that uses IPython0 to prefilter the inputs. |
|
3 | 3 | |
|
4 | 4 | Using the IPython0 mechanism gives us access to the magics. |
|
5 | 5 | |
|
6 | 6 | This is a transitory class, used here to do the transition between |
|
7 | 7 | ipython0 and ipython1. This class is meant to be short-lived as more |
|
8 | 8 | functionnality is abstracted out of ipython0 in reusable functions and |
|
9 | 9 | is added on the interpreter. This class can be a used to guide this |
|
10 | 10 | refactoring. |
|
11 | 11 | """ |
|
12 | 12 | __docformat__ = "restructuredtext en" |
|
13 | 13 | |
|
14 | 14 | #------------------------------------------------------------------------------- |
|
15 | 15 | # Copyright (C) 2008 The IPython Development Team |
|
16 | 16 | # |
|
17 | 17 | # Distributed under the terms of the BSD License. The full license is in |
|
18 | 18 | # the file COPYING, distributed as part of this software. |
|
19 | 19 | #------------------------------------------------------------------------------- |
|
20 | 20 | |
|
21 | 21 | #------------------------------------------------------------------------------- |
|
22 | 22 | # Imports |
|
23 | 23 | #------------------------------------------------------------------------------- |
|
24 | 24 | import sys |
|
25 | 25 | import pydoc |
|
26 | 26 | import os |
|
27 | 27 | import re |
|
28 | 28 | import __builtin__ |
|
29 | 29 | |
|
30 | 30 | from IPython.ipmaker import make_IPython |
|
31 | 31 | from IPython.ipapi import IPApi |
|
32 | 32 | from IPython.kernel.core.redirector_output_trap import RedirectorOutputTrap |
|
33 | 33 | |
|
34 | 34 | from IPython.kernel.core.sync_traceback_trap import SyncTracebackTrap |
|
35 | 35 | |
|
36 | 36 | from IPython.genutils import Term |
|
37 | 37 | |
|
38 | 38 | from linefrontendbase import LineFrontEndBase, common_prefix |
|
39 | 39 | |
|
40 | 40 | |
|
41 | 41 | def mk_system_call(system_call_function, command): |
|
42 | 42 | """ given a os.system replacement, and a leading string command, |
|
43 | 43 | returns a function that will execute the command with the given |
|
44 | 44 | argument string. |
|
45 | 45 | """ |
|
46 | 46 | def my_system_call(args): |
|
47 | 47 | system_call_function("%s %s" % (command, args)) |
|
48 | 48 | |
|
49 | 49 | my_system_call.__doc__ = "Calls %s" % command |
|
50 | 50 | return my_system_call |
|
51 | 51 | |
|
52 | 52 | #------------------------------------------------------------------------------- |
|
53 | 53 | # Frontend class using ipython0 to do the prefiltering. |
|
54 | 54 | #------------------------------------------------------------------------------- |
|
55 | 55 | class PrefilterFrontEnd(LineFrontEndBase): |
|
56 | 56 | """ Class that uses ipython0 to do prefilter the input, do the |
|
57 | 57 | completion and the magics. |
|
58 | 58 | |
|
59 | 59 | The core trick is to use an ipython0 instance to prefilter the |
|
60 | 60 | input, and share the namespace between the interpreter instance used |
|
61 | 61 | to execute the statements and the ipython0 used for code |
|
62 | 62 | completion... |
|
63 | 63 | """ |
|
64 | 64 | |
|
65 | 65 | debug = False |
|
66 | 66 | |
|
67 | 67 | def __init__(self, ipython0=None, argv=None, *args, **kwargs): |
|
68 |
""" Parameters |
|
|
69 |
---------- |
|
|
68 | """ Parameters | |
|
69 | ---------- | |
|
70 | 70 | |
|
71 | 71 | ipython0: an optional ipython0 instance to use for command |
|
72 | 72 | prefiltering and completion. |
|
73 | 73 | |
|
74 | 74 | argv : list, optional |
|
75 | 75 | Used as the instance's argv value. If not given, [] is used. |
|
76 | 76 | """ |
|
77 | 77 | if argv is None: |
|
78 | 78 | argv = [] |
|
79 | 79 | # This is a hack to avoid the IPython exception hook to trigger |
|
80 | 80 | # on exceptions (https://bugs.launchpad.net/bugs/337105) |
|
81 | 81 | # XXX: This is horrible: module-leve monkey patching -> side |
|
82 | 82 | # effects. |
|
83 | 83 | from IPython import iplib |
|
84 | 84 | iplib.InteractiveShell.isthreaded = True |
|
85 | 85 | |
|
86 | 86 | LineFrontEndBase.__init__(self, *args, **kwargs) |
|
87 | 87 | self.shell.output_trap = RedirectorOutputTrap( |
|
88 | 88 | out_callback=self.write, |
|
89 | 89 | err_callback=self.write, |
|
90 | 90 | ) |
|
91 | 91 | self.shell.traceback_trap = SyncTracebackTrap( |
|
92 | 92 | formatters=self.shell.traceback_trap.formatters, |
|
93 | 93 | ) |
|
94 | 94 | |
|
95 | 95 | # Start the ipython0 instance: |
|
96 | 96 | self.save_output_hooks() |
|
97 | 97 | if ipython0 is None: |
|
98 | 98 | # Instanciate an IPython0 interpreter to be able to use the |
|
99 | 99 | # prefiltering. |
|
100 | 100 | # Suppress all key input, to avoid waiting |
|
101 | 101 | def my_rawinput(x=None): |
|
102 | 102 | return '\n' |
|
103 | 103 | old_rawinput = __builtin__.raw_input |
|
104 | 104 | __builtin__.raw_input = my_rawinput |
|
105 | 105 | # XXX: argv=[] is a bit bold. |
|
106 | 106 | ipython0 = make_IPython(argv=argv, |
|
107 | 107 | user_ns=self.shell.user_ns, |
|
108 | 108 | user_global_ns=self.shell.user_global_ns) |
|
109 | 109 | __builtin__.raw_input = old_rawinput |
|
110 | 110 | self.ipython0 = ipython0 |
|
111 | 111 | # Set the pager: |
|
112 | 112 | self.ipython0.set_hook('show_in_pager', |
|
113 | 113 | lambda s, string: self.write("\n" + string)) |
|
114 | 114 | self.ipython0.write = self.write |
|
115 | 115 | self._ip = _ip = IPApi(self.ipython0) |
|
116 | 116 | # Make sure the raw system call doesn't get called, as we don't |
|
117 | 117 | # have a stdin accessible. |
|
118 | 118 | self._ip.system = self.system_call |
|
119 | 119 | # XXX: Muck around with magics so that they work better |
|
120 | 120 | # in our environment |
|
121 | 121 | if not sys.platform.startswith('win'): |
|
122 | 122 | self.ipython0.magic_ls = mk_system_call(self.system_call, |
|
123 | 123 | 'ls -CF') |
|
124 | 124 | # And now clean up the mess created by ipython0 |
|
125 | 125 | self.release_output() |
|
126 | 126 | |
|
127 | 127 | |
|
128 | 128 | if not 'banner' in kwargs and self.banner is None: |
|
129 | 129 | self.banner = self.ipython0.BANNER |
|
130 | 130 | |
|
131 | 131 | # FIXME: __init__ and start should be two different steps |
|
132 | 132 | self.start() |
|
133 | 133 | |
|
134 | 134 | #-------------------------------------------------------------------------- |
|
135 | 135 | # FrontEndBase interface |
|
136 | 136 | #-------------------------------------------------------------------------- |
|
137 | 137 | |
|
138 | 138 | def show_traceback(self): |
|
139 | 139 | """ Use ipython0 to capture the last traceback and display it. |
|
140 | 140 | """ |
|
141 | 141 | # Don't do the capture; the except_hook has already done some |
|
142 | 142 | # modifications to the IO streams, if we store them, we'll be |
|
143 | 143 | # storing the wrong ones. |
|
144 | 144 | #self.capture_output() |
|
145 | 145 | self.ipython0.showtraceback(tb_offset=-1) |
|
146 | 146 | self.release_output() |
|
147 | 147 | |
|
148 | 148 | |
|
149 | 149 | def execute(self, python_string, raw_string=None): |
|
150 | 150 | if self.debug: |
|
151 | 151 | print 'Executing Python code:', repr(python_string) |
|
152 | 152 | self.capture_output() |
|
153 | 153 | LineFrontEndBase.execute(self, python_string, |
|
154 | 154 | raw_string=raw_string) |
|
155 | 155 | self.release_output() |
|
156 | 156 | |
|
157 | 157 | |
|
158 | 158 | def save_output_hooks(self): |
|
159 | 159 | """ Store all the output hooks we can think of, to be able to |
|
160 | 160 | restore them. |
|
161 | 161 | |
|
162 | 162 | We need to do this early, as starting the ipython0 instance will |
|
163 | 163 | screw ouput hooks. |
|
164 | 164 | """ |
|
165 | 165 | self.__old_cout_write = Term.cout.write |
|
166 | 166 | self.__old_cerr_write = Term.cerr.write |
|
167 | 167 | self.__old_stdout = sys.stdout |
|
168 | 168 | self.__old_stderr= sys.stderr |
|
169 | 169 | self.__old_help_output = pydoc.help.output |
|
170 | 170 | self.__old_display_hook = sys.displayhook |
|
171 | 171 | |
|
172 | 172 | |
|
173 | 173 | def capture_output(self): |
|
174 | 174 | """ Capture all the output mechanisms we can think of. |
|
175 | 175 | """ |
|
176 | 176 | self.save_output_hooks() |
|
177 | 177 | Term.cout.write = self.write |
|
178 | 178 | Term.cerr.write = self.write |
|
179 | 179 | sys.stdout = Term.cout |
|
180 | 180 | sys.stderr = Term.cerr |
|
181 | 181 | pydoc.help.output = self.shell.output_trap.out |
|
182 | 182 | |
|
183 | 183 | |
|
184 | 184 | def release_output(self): |
|
185 | 185 | """ Release all the different captures we have made. |
|
186 | 186 | """ |
|
187 | 187 | Term.cout.write = self.__old_cout_write |
|
188 | 188 | Term.cerr.write = self.__old_cerr_write |
|
189 | 189 | sys.stdout = self.__old_stdout |
|
190 | 190 | sys.stderr = self.__old_stderr |
|
191 | 191 | pydoc.help.output = self.__old_help_output |
|
192 | 192 | sys.displayhook = self.__old_display_hook |
|
193 | 193 | |
|
194 | 194 | |
|
195 | 195 | def complete(self, line): |
|
196 | 196 | # FIXME: This should be factored out in the linefrontendbase |
|
197 | 197 | # method. |
|
198 | 198 | word = self._get_completion_text(line) |
|
199 | 199 | completions = self.ipython0.complete(word) |
|
200 | 200 | # FIXME: The proper sort should be done in the complete method. |
|
201 | 201 | key = lambda x: x.replace('_', '') |
|
202 | 202 | completions.sort(key=key) |
|
203 | 203 | if completions: |
|
204 | 204 | prefix = common_prefix(completions) |
|
205 | 205 | line = line[:-len(word)] + prefix |
|
206 | 206 | return line, completions |
|
207 | 207 | |
|
208 | 208 | |
|
209 | 209 | #-------------------------------------------------------------------------- |
|
210 | 210 | # LineFrontEndBase interface |
|
211 | 211 | #-------------------------------------------------------------------------- |
|
212 | 212 | |
|
213 | 213 | def prefilter_input(self, input_string): |
|
214 | 214 | """ Using IPython0 to prefilter the commands to turn them |
|
215 | 215 | in executable statements that are valid Python strings. |
|
216 | 216 | """ |
|
217 | 217 | input_string = LineFrontEndBase.prefilter_input(self, input_string) |
|
218 | 218 | filtered_lines = [] |
|
219 | 219 | # The IPython0 prefilters sometime produce output. We need to |
|
220 | 220 | # capture it. |
|
221 | 221 | self.capture_output() |
|
222 | 222 | self.last_result = dict(number=self.prompt_number) |
|
223 | 223 | |
|
224 | 224 | ## try: |
|
225 | 225 | ## for line in input_string.split('\n'): |
|
226 | 226 | ## filtered_lines.append( |
|
227 | 227 | ## self.ipython0.prefilter(line, False).rstrip()) |
|
228 | 228 | ## except: |
|
229 | 229 | ## # XXX: probably not the right thing to do. |
|
230 | 230 | ## self.ipython0.showsyntaxerror() |
|
231 | 231 | ## self.after_execute() |
|
232 | 232 | ## finally: |
|
233 | 233 | ## self.release_output() |
|
234 | 234 | |
|
235 | 235 | |
|
236 | 236 | try: |
|
237 | 237 | try: |
|
238 | 238 | for line in input_string.split('\n'): |
|
239 | 239 | filtered_lines.append( |
|
240 | 240 | self.ipython0.prefilter(line, False).rstrip()) |
|
241 | 241 | except: |
|
242 | 242 | # XXX: probably not the right thing to do. |
|
243 | 243 | self.ipython0.showsyntaxerror() |
|
244 | 244 | self.after_execute() |
|
245 | 245 | finally: |
|
246 | 246 | self.release_output() |
|
247 | 247 | |
|
248 | 248 | |
|
249 | 249 | |
|
250 | 250 | # Clean up the trailing whitespace, to avoid indentation errors |
|
251 | 251 | filtered_string = '\n'.join(filtered_lines) |
|
252 | 252 | return filtered_string |
|
253 | 253 | |
|
254 | 254 | |
|
255 | 255 | #-------------------------------------------------------------------------- |
|
256 | 256 | # PrefilterFrontEnd interface |
|
257 | 257 | #-------------------------------------------------------------------------- |
|
258 | 258 | |
|
259 | 259 | def system_call(self, command_string): |
|
260 | 260 | """ Allows for frontend to define their own system call, to be |
|
261 | 261 | able capture output and redirect input. |
|
262 | 262 | """ |
|
263 | 263 | return os.system(command_string) |
|
264 | 264 | |
|
265 | 265 | |
|
266 | 266 | def do_exit(self): |
|
267 | 267 | """ Exit the shell, cleanup and save the history. |
|
268 | 268 | """ |
|
269 | 269 | self.ipython0.atexit_operations() |
|
270 | 270 | |
|
271 | 271 | |
|
272 | 272 | def _get_completion_text(self, line): |
|
273 | 273 | """ Returns the text to be completed by breaking the line at specified |
|
274 | 274 | delimiters. |
|
275 | 275 | """ |
|
276 | 276 | # Break at: spaces, '=', all parentheses (except if balanced). |
|
277 | 277 | # FIXME2: In the future, we need to make the implementation similar to |
|
278 | 278 | # that in the 'pyreadline' module (modes/basemode.py) where we break at |
|
279 | 279 | # each delimiter and try to complete the residual line, until we get a |
|
280 | 280 | # successful list of completions. |
|
281 | 281 | expression = '\s|=|,|:|\((?!.*\))|\[(?!.*\])|\{(?!.*\})' |
|
282 | 282 | complete_sep = re.compile(expression) |
|
283 | 283 | text = complete_sep.split(line)[-1] |
|
284 | 284 | return text |
|
285 | 285 |
@@ -1,2171 +1,2171 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """General purpose utilities. |
|
3 | 3 | |
|
4 | 4 | This is a grab-bag of stuff I find useful in most programs I write. Some of |
|
5 | 5 | these things are also convenient when working at the command line. |
|
6 | 6 | """ |
|
7 | 7 | |
|
8 | 8 | #***************************************************************************** |
|
9 | 9 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
10 | 10 | # |
|
11 | 11 | # Distributed under the terms of the BSD License. The full license is in |
|
12 | 12 | # the file COPYING, distributed as part of this software. |
|
13 | 13 | #***************************************************************************** |
|
14 | 14 | |
|
15 | 15 | #**************************************************************************** |
|
16 | 16 | # required modules from the Python standard library |
|
17 | 17 | import __main__ |
|
18 | 18 | import commands |
|
19 | 19 | try: |
|
20 | 20 | import doctest |
|
21 | 21 | except ImportError: |
|
22 | 22 | pass |
|
23 | 23 | import os |
|
24 | 24 | import platform |
|
25 | 25 | import re |
|
26 | 26 | import shlex |
|
27 | 27 | import shutil |
|
28 | 28 | import subprocess |
|
29 | 29 | import sys |
|
30 | 30 | import tempfile |
|
31 | 31 | import time |
|
32 | 32 | import types |
|
33 | 33 | import warnings |
|
34 | 34 | |
|
35 | 35 | # Curses and termios are Unix-only modules |
|
36 | 36 | try: |
|
37 | 37 | import curses |
|
38 | 38 | # We need termios as well, so if its import happens to raise, we bail on |
|
39 | 39 | # using curses altogether. |
|
40 | 40 | import termios |
|
41 | 41 | except ImportError: |
|
42 | 42 | USE_CURSES = False |
|
43 | 43 | else: |
|
44 | 44 | # Curses on Solaris may not be complete, so we can't use it there |
|
45 | 45 | USE_CURSES = hasattr(curses,'initscr') |
|
46 | 46 | |
|
47 | 47 | # Other IPython utilities |
|
48 | 48 | import IPython |
|
49 | 49 | from IPython.Itpl import Itpl,itpl,printpl |
|
50 | 50 | from IPython import DPyGetOpt, platutils |
|
51 | 51 | from IPython.generics import result_display |
|
52 | 52 | import IPython.ipapi |
|
53 | 53 | from IPython.external.path import path |
|
54 | 54 | if os.name == "nt": |
|
55 | 55 | from IPython.winconsole import get_console_size |
|
56 | 56 | |
|
57 | 57 | try: |
|
58 | 58 | set |
|
59 | 59 | except: |
|
60 | 60 | from sets import Set as set |
|
61 | 61 | |
|
62 | 62 | |
|
63 | 63 | #**************************************************************************** |
|
64 | 64 | # Exceptions |
|
65 | 65 | class Error(Exception): |
|
66 | 66 | """Base class for exceptions in this module.""" |
|
67 | 67 | pass |
|
68 | 68 | |
|
69 | 69 | #---------------------------------------------------------------------------- |
|
70 | 70 | class IOStream: |
|
71 | 71 | def __init__(self,stream,fallback): |
|
72 | 72 | if not hasattr(stream,'write') or not hasattr(stream,'flush'): |
|
73 | 73 | stream = fallback |
|
74 | 74 | self.stream = stream |
|
75 | 75 | self._swrite = stream.write |
|
76 | 76 | self.flush = stream.flush |
|
77 | 77 | |
|
78 | 78 | def write(self,data): |
|
79 | 79 | try: |
|
80 | 80 | self._swrite(data) |
|
81 | 81 | except: |
|
82 | 82 | try: |
|
83 | 83 | # print handles some unicode issues which may trip a plain |
|
84 | 84 | # write() call. Attempt to emulate write() by using a |
|
85 | 85 | # trailing comma |
|
86 | 86 | print >> self.stream, data, |
|
87 | 87 | except: |
|
88 | 88 | # if we get here, something is seriously broken. |
|
89 | 89 | print >> sys.stderr, \ |
|
90 | 90 | 'ERROR - failed to write data to stream:', self.stream |
|
91 | 91 | |
|
92 | 92 | def close(self): |
|
93 | 93 | pass |
|
94 | 94 | |
|
95 | 95 | |
|
96 | 96 | class IOTerm: |
|
97 | 97 | """ Term holds the file or file-like objects for handling I/O operations. |
|
98 | 98 | |
|
99 | 99 | These are normally just sys.stdin, sys.stdout and sys.stderr but for |
|
100 | 100 | Windows they can can replaced to allow editing the strings before they are |
|
101 | 101 | displayed.""" |
|
102 | 102 | |
|
103 | 103 | # In the future, having IPython channel all its I/O operations through |
|
104 | 104 | # this class will make it easier to embed it into other environments which |
|
105 | 105 | # are not a normal terminal (such as a GUI-based shell) |
|
106 | 106 | def __init__(self,cin=None,cout=None,cerr=None): |
|
107 | 107 | self.cin = IOStream(cin,sys.stdin) |
|
108 | 108 | self.cout = IOStream(cout,sys.stdout) |
|
109 | 109 | self.cerr = IOStream(cerr,sys.stderr) |
|
110 | 110 | |
|
111 | 111 | # Global variable to be used for all I/O |
|
112 | 112 | Term = IOTerm() |
|
113 | 113 | |
|
114 | 114 | import IPython.rlineimpl as readline |
|
115 | 115 | # Remake Term to use the readline i/o facilities |
|
116 | 116 | if sys.platform == 'win32' and readline.have_readline: |
|
117 | 117 | |
|
118 | 118 | Term = IOTerm(cout=readline._outputfile,cerr=readline._outputfile) |
|
119 | 119 | |
|
120 | 120 | |
|
121 | 121 | #**************************************************************************** |
|
122 | 122 | # Generic warning/error printer, used by everything else |
|
123 | 123 | def warn(msg,level=2,exit_val=1): |
|
124 | 124 | """Standard warning printer. Gives formatting consistency. |
|
125 | 125 | |
|
126 | 126 | Output is sent to Term.cerr (sys.stderr by default). |
|
127 | 127 | |
|
128 | 128 | Options: |
|
129 | 129 | |
|
130 | 130 | -level(2): allows finer control: |
|
131 | 131 | 0 -> Do nothing, dummy function. |
|
132 | 132 | 1 -> Print message. |
|
133 | 133 | 2 -> Print 'WARNING:' + message. (Default level). |
|
134 | 134 | 3 -> Print 'ERROR:' + message. |
|
135 | 135 | 4 -> Print 'FATAL ERROR:' + message and trigger a sys.exit(exit_val). |
|
136 | 136 | |
|
137 | 137 | -exit_val (1): exit value returned by sys.exit() for a level 4 |
|
138 | 138 | warning. Ignored for all other levels.""" |
|
139 | 139 | |
|
140 | 140 | if level>0: |
|
141 | 141 | header = ['','','WARNING: ','ERROR: ','FATAL ERROR: '] |
|
142 | 142 | print >> Term.cerr, '%s%s' % (header[level],msg) |
|
143 | 143 | if level == 4: |
|
144 | 144 | print >> Term.cerr,'Exiting.\n' |
|
145 | 145 | sys.exit(exit_val) |
|
146 | 146 | |
|
147 | 147 | def info(msg): |
|
148 | 148 | """Equivalent to warn(msg,level=1).""" |
|
149 | 149 | |
|
150 | 150 | warn(msg,level=1) |
|
151 | 151 | |
|
152 | 152 | def error(msg): |
|
153 | 153 | """Equivalent to warn(msg,level=3).""" |
|
154 | 154 | |
|
155 | 155 | warn(msg,level=3) |
|
156 | 156 | |
|
157 | 157 | def fatal(msg,exit_val=1): |
|
158 | 158 | """Equivalent to warn(msg,exit_val=exit_val,level=4).""" |
|
159 | 159 | |
|
160 | 160 | warn(msg,exit_val=exit_val,level=4) |
|
161 | 161 | |
|
162 | 162 | #--------------------------------------------------------------------------- |
|
163 | 163 | # Debugging routines |
|
164 | 164 | # |
|
165 | 165 | def debugx(expr,pre_msg=''): |
|
166 | 166 | """Print the value of an expression from the caller's frame. |
|
167 | 167 | |
|
168 | 168 | Takes an expression, evaluates it in the caller's frame and prints both |
|
169 | 169 | the given expression and the resulting value (as well as a debug mark |
|
170 | 170 | indicating the name of the calling function. The input must be of a form |
|
171 | 171 | suitable for eval(). |
|
172 | 172 | |
|
173 | 173 | An optional message can be passed, which will be prepended to the printed |
|
174 | 174 | expr->value pair.""" |
|
175 | 175 | |
|
176 | 176 | cf = sys._getframe(1) |
|
177 | 177 | print '[DBG:%s] %s%s -> %r' % (cf.f_code.co_name,pre_msg,expr, |
|
178 | 178 | eval(expr,cf.f_globals,cf.f_locals)) |
|
179 | 179 | |
|
180 | 180 | # deactivate it by uncommenting the following line, which makes it a no-op |
|
181 | 181 | #def debugx(expr,pre_msg=''): pass |
|
182 | 182 | |
|
183 | 183 | #---------------------------------------------------------------------------- |
|
184 | 184 | StringTypes = types.StringTypes |
|
185 | 185 | |
|
186 | 186 | # Basic timing functionality |
|
187 | 187 | |
|
188 | 188 | # If possible (Unix), use the resource module instead of time.clock() |
|
189 | 189 | try: |
|
190 | 190 | import resource |
|
191 | 191 | def clocku(): |
|
192 | 192 | """clocku() -> floating point number |
|
193 | 193 | |
|
194 | 194 | Return the *USER* CPU time in seconds since the start of the process. |
|
195 | 195 | This is done via a call to resource.getrusage, so it avoids the |
|
196 | 196 | wraparound problems in time.clock().""" |
|
197 | 197 | |
|
198 | 198 | return resource.getrusage(resource.RUSAGE_SELF)[0] |
|
199 | 199 | |
|
200 | 200 | def clocks(): |
|
201 | 201 | """clocks() -> floating point number |
|
202 | 202 | |
|
203 | 203 | Return the *SYSTEM* CPU time in seconds since the start of the process. |
|
204 | 204 | This is done via a call to resource.getrusage, so it avoids the |
|
205 | 205 | wraparound problems in time.clock().""" |
|
206 | 206 | |
|
207 | 207 | return resource.getrusage(resource.RUSAGE_SELF)[1] |
|
208 | 208 | |
|
209 | 209 | def clock(): |
|
210 | 210 | """clock() -> floating point number |
|
211 | 211 | |
|
212 | 212 | Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of |
|
213 | 213 | the process. This is done via a call to resource.getrusage, so it |
|
214 | 214 | avoids the wraparound problems in time.clock().""" |
|
215 | 215 | |
|
216 | 216 | u,s = resource.getrusage(resource.RUSAGE_SELF)[:2] |
|
217 | 217 | return u+s |
|
218 | 218 | |
|
219 | 219 | def clock2(): |
|
220 | 220 | """clock2() -> (t_user,t_system) |
|
221 | 221 | |
|
222 | 222 | Similar to clock(), but return a tuple of user/system times.""" |
|
223 | 223 | return resource.getrusage(resource.RUSAGE_SELF)[:2] |
|
224 | 224 | |
|
225 | 225 | except ImportError: |
|
226 | 226 | # There is no distinction of user/system time under windows, so we just use |
|
227 | 227 | # time.clock() for everything... |
|
228 | 228 | clocku = clocks = clock = time.clock |
|
229 | 229 | def clock2(): |
|
230 | 230 | """Under windows, system CPU time can't be measured. |
|
231 | 231 | |
|
232 | 232 | This just returns clock() and zero.""" |
|
233 | 233 | return time.clock(),0.0 |
|
234 | 234 | |
|
235 | 235 | def timings_out(reps,func,*args,**kw): |
|
236 | 236 | """timings_out(reps,func,*args,**kw) -> (t_total,t_per_call,output) |
|
237 | 237 | |
|
238 | 238 | Execute a function reps times, return a tuple with the elapsed total |
|
239 | 239 | CPU time in seconds, the time per call and the function's output. |
|
240 | 240 | |
|
241 | 241 | Under Unix, the return value is the sum of user+system time consumed by |
|
242 | 242 | the process, computed via the resource module. This prevents problems |
|
243 | 243 | related to the wraparound effect which the time.clock() function has. |
|
244 | 244 | |
|
245 | 245 | Under Windows the return value is in wall clock seconds. See the |
|
246 | 246 | documentation for the time module for more details.""" |
|
247 | 247 | |
|
248 | 248 | reps = int(reps) |
|
249 | 249 | assert reps >=1, 'reps must be >= 1' |
|
250 | 250 | if reps==1: |
|
251 | 251 | start = clock() |
|
252 | 252 | out = func(*args,**kw) |
|
253 | 253 | tot_time = clock()-start |
|
254 | 254 | else: |
|
255 | 255 | rng = xrange(reps-1) # the last time is executed separately to store output |
|
256 | 256 | start = clock() |
|
257 | 257 | for dummy in rng: func(*args,**kw) |
|
258 | 258 | out = func(*args,**kw) # one last time |
|
259 | 259 | tot_time = clock()-start |
|
260 | 260 | av_time = tot_time / reps |
|
261 | 261 | return tot_time,av_time,out |
|
262 | 262 | |
|
263 | 263 | def timings(reps,func,*args,**kw): |
|
264 | 264 | """timings(reps,func,*args,**kw) -> (t_total,t_per_call) |
|
265 | 265 | |
|
266 | 266 | Execute a function reps times, return a tuple with the elapsed total CPU |
|
267 | 267 | time in seconds and the time per call. These are just the first two values |
|
268 | 268 | in timings_out().""" |
|
269 | 269 | |
|
270 | 270 | return timings_out(reps,func,*args,**kw)[0:2] |
|
271 | 271 | |
|
272 | 272 | def timing(func,*args,**kw): |
|
273 | 273 | """timing(func,*args,**kw) -> t_total |
|
274 | 274 | |
|
275 | 275 | Execute a function once, return the elapsed total CPU time in |
|
276 | 276 | seconds. This is just the first value in timings_out().""" |
|
277 | 277 | |
|
278 | 278 | return timings_out(1,func,*args,**kw)[0] |
|
279 | 279 | |
|
280 | 280 | #**************************************************************************** |
|
281 | 281 | # file and system |
|
282 | 282 | |
|
283 | 283 | def arg_split(s,posix=False): |
|
284 | 284 | """Split a command line's arguments in a shell-like manner. |
|
285 | 285 | |
|
286 | 286 | This is a modified version of the standard library's shlex.split() |
|
287 | 287 | function, but with a default of posix=False for splitting, so that quotes |
|
288 | 288 | in inputs are respected.""" |
|
289 | 289 | |
|
290 | 290 | # XXX - there may be unicode-related problems here!!! I'm not sure that |
|
291 | 291 | # shlex is truly unicode-safe, so it might be necessary to do |
|
292 | 292 | # |
|
293 | 293 | # s = s.encode(sys.stdin.encoding) |
|
294 | 294 | # |
|
295 | 295 | # first, to ensure that shlex gets a normal string. Input from anyone who |
|
296 | 296 | # knows more about unicode and shlex than I would be good to have here... |
|
297 | 297 | lex = shlex.shlex(s, posix=posix) |
|
298 | 298 | lex.whitespace_split = True |
|
299 | 299 | return list(lex) |
|
300 | 300 | |
|
301 | 301 | def system(cmd,verbose=0,debug=0,header=''): |
|
302 | 302 | """Execute a system command, return its exit status. |
|
303 | 303 | |
|
304 | 304 | Options: |
|
305 | 305 | |
|
306 | 306 | - verbose (0): print the command to be executed. |
|
307 | 307 | |
|
308 | 308 | - debug (0): only print, do not actually execute. |
|
309 | 309 | |
|
310 | 310 | - header (''): Header to print on screen prior to the executed command (it |
|
311 | 311 | is only prepended to the command, no newlines are added). |
|
312 | 312 | |
|
313 | 313 | Note: a stateful version of this function is available through the |
|
314 | 314 | SystemExec class.""" |
|
315 | 315 | |
|
316 | 316 | stat = 0 |
|
317 | 317 | if verbose or debug: print header+cmd |
|
318 | 318 | sys.stdout.flush() |
|
319 | 319 | if not debug: stat = os.system(cmd) |
|
320 | 320 | return stat |
|
321 | 321 | |
|
322 | 322 | def abbrev_cwd(): |
|
323 | 323 | """ Return abbreviated version of cwd, e.g. d:mydir """ |
|
324 | 324 | cwd = os.getcwd().replace('\\','/') |
|
325 | 325 | drivepart = '' |
|
326 | 326 | tail = cwd |
|
327 | 327 | if sys.platform == 'win32': |
|
328 | 328 | if len(cwd) < 4: |
|
329 | 329 | return cwd |
|
330 | 330 | drivepart,tail = os.path.splitdrive(cwd) |
|
331 | 331 | |
|
332 | 332 | |
|
333 | 333 | parts = tail.split('/') |
|
334 | 334 | if len(parts) > 2: |
|
335 | 335 | tail = '/'.join(parts[-2:]) |
|
336 | 336 | |
|
337 | 337 | return (drivepart + ( |
|
338 | 338 | cwd == '/' and '/' or tail)) |
|
339 | 339 | |
|
340 | 340 | |
|
341 | 341 | # This function is used by ipython in a lot of places to make system calls. |
|
342 | 342 | # We need it to be slightly different under win32, due to the vagaries of |
|
343 | 343 | # 'network shares'. A win32 override is below. |
|
344 | 344 | |
|
345 | 345 | def shell(cmd,verbose=0,debug=0,header=''): |
|
346 | 346 | """Execute a command in the system shell, always return None. |
|
347 | 347 | |
|
348 | 348 | Options: |
|
349 | 349 | |
|
350 | 350 | - verbose (0): print the command to be executed. |
|
351 | 351 | |
|
352 | 352 | - debug (0): only print, do not actually execute. |
|
353 | 353 | |
|
354 | 354 | - header (''): Header to print on screen prior to the executed command (it |
|
355 | 355 | is only prepended to the command, no newlines are added). |
|
356 | 356 | |
|
357 | 357 | Note: this is similar to genutils.system(), but it returns None so it can |
|
358 | 358 | be conveniently used in interactive loops without getting the return value |
|
359 | 359 | (typically 0) printed many times.""" |
|
360 | 360 | |
|
361 | 361 | stat = 0 |
|
362 | 362 | if verbose or debug: print header+cmd |
|
363 | 363 | # flush stdout so we don't mangle python's buffering |
|
364 | 364 | sys.stdout.flush() |
|
365 | 365 | |
|
366 | 366 | if not debug: |
|
367 | 367 | platutils.set_term_title("IPy " + cmd) |
|
368 | 368 | os.system(cmd) |
|
369 | 369 | platutils.set_term_title("IPy " + abbrev_cwd()) |
|
370 | 370 | |
|
371 | 371 | # override shell() for win32 to deal with network shares |
|
372 | 372 | if os.name in ('nt','dos'): |
|
373 | 373 | |
|
374 | 374 | shell_ori = shell |
|
375 | 375 | |
|
376 | 376 | def shell(cmd,verbose=0,debug=0,header=''): |
|
377 | 377 | if os.getcwd().startswith(r"\\"): |
|
378 | 378 | path = os.getcwd() |
|
379 | 379 | # change to c drive (cannot be on UNC-share when issuing os.system, |
|
380 | 380 | # as cmd.exe cannot handle UNC addresses) |
|
381 | 381 | os.chdir("c:") |
|
382 | 382 | # issue pushd to the UNC-share and then run the command |
|
383 | 383 | try: |
|
384 | 384 | shell_ori('"pushd %s&&"'%path+cmd,verbose,debug,header) |
|
385 | 385 | finally: |
|
386 | 386 | os.chdir(path) |
|
387 | 387 | else: |
|
388 | 388 | shell_ori(cmd,verbose,debug,header) |
|
389 | 389 | |
|
390 | 390 | shell.__doc__ = shell_ori.__doc__ |
|
391 | 391 | |
|
392 | 392 | def getoutput(cmd,verbose=0,debug=0,header='',split=0): |
|
393 | 393 | """Dummy substitute for perl's backquotes. |
|
394 | 394 | |
|
395 | 395 | Executes a command and returns the output. |
|
396 | 396 | |
|
397 | 397 | Accepts the same arguments as system(), plus: |
|
398 | 398 | |
|
399 | 399 | - split(0): if true, the output is returned as a list split on newlines. |
|
400 | 400 | |
|
401 | 401 | Note: a stateful version of this function is available through the |
|
402 | 402 | SystemExec class. |
|
403 | 403 | |
|
404 | 404 | This is pretty much deprecated and rarely used, |
|
405 | 405 | genutils.getoutputerror may be what you need. |
|
406 | 406 | |
|
407 | 407 | """ |
|
408 | 408 | |
|
409 | 409 | if verbose or debug: print header+cmd |
|
410 | 410 | if not debug: |
|
411 | 411 | output = os.popen(cmd).read() |
|
412 | 412 | # stipping last \n is here for backwards compat. |
|
413 | 413 | if output.endswith('\n'): |
|
414 | 414 | output = output[:-1] |
|
415 | 415 | if split: |
|
416 | 416 | return output.split('\n') |
|
417 | 417 | else: |
|
418 | 418 | return output |
|
419 | 419 | |
|
420 | 420 | def getoutputerror(cmd,verbose=0,debug=0,header='',split=0): |
|
421 | 421 | """Return (standard output,standard error) of executing cmd in a shell. |
|
422 | 422 | |
|
423 | 423 | Accepts the same arguments as system(), plus: |
|
424 | 424 | |
|
425 | 425 | - split(0): if true, each of stdout/err is returned as a list split on |
|
426 | 426 | newlines. |
|
427 | 427 | |
|
428 | 428 | Note: a stateful version of this function is available through the |
|
429 | 429 | SystemExec class.""" |
|
430 | 430 | |
|
431 | 431 | if verbose or debug: print header+cmd |
|
432 | 432 | if not cmd: |
|
433 | 433 | if split: |
|
434 | 434 | return [],[] |
|
435 | 435 | else: |
|
436 | 436 | return '','' |
|
437 | 437 | if not debug: |
|
438 | 438 | pin,pout,perr = os.popen3(cmd) |
|
439 | 439 | tout = pout.read().rstrip() |
|
440 | 440 | terr = perr.read().rstrip() |
|
441 | 441 | pin.close() |
|
442 | 442 | pout.close() |
|
443 | 443 | perr.close() |
|
444 | 444 | if split: |
|
445 | 445 | return tout.split('\n'),terr.split('\n') |
|
446 | 446 | else: |
|
447 | 447 | return tout,terr |
|
448 | 448 | |
|
449 | 449 | # for compatibility with older naming conventions |
|
450 | 450 | xsys = system |
|
451 | 451 | bq = getoutput |
|
452 | 452 | |
|
453 | 453 | class SystemExec: |
|
454 | 454 | """Access the system and getoutput functions through a stateful interface. |
|
455 | 455 | |
|
456 | 456 | Note: here we refer to the system and getoutput functions from this |
|
457 | 457 | library, not the ones from the standard python library. |
|
458 | 458 | |
|
459 | 459 | This class offers the system and getoutput functions as methods, but the |
|
460 | 460 | verbose, debug and header parameters can be set for the instance (at |
|
461 | 461 | creation time or later) so that they don't need to be specified on each |
|
462 | 462 | call. |
|
463 | 463 | |
|
464 | 464 | For efficiency reasons, there's no way to override the parameters on a |
|
465 | 465 | per-call basis other than by setting instance attributes. If you need |
|
466 | 466 | local overrides, it's best to directly call system() or getoutput(). |
|
467 | 467 | |
|
468 | 468 | The following names are provided as alternate options: |
|
469 | 469 | - xsys: alias to system |
|
470 | 470 | - bq: alias to getoutput |
|
471 | 471 | |
|
472 | 472 | An instance can then be created as: |
|
473 | 473 | >>> sysexec = SystemExec(verbose=1,debug=0,header='Calling: ') |
|
474 | 474 | """ |
|
475 | 475 | |
|
476 | 476 | def __init__(self,verbose=0,debug=0,header='',split=0): |
|
477 | 477 | """Specify the instance's values for verbose, debug and header.""" |
|
478 | 478 | setattr_list(self,'verbose debug header split') |
|
479 | 479 | |
|
480 | 480 | def system(self,cmd): |
|
481 | 481 | """Stateful interface to system(), with the same keyword parameters.""" |
|
482 | 482 | |
|
483 | 483 | system(cmd,self.verbose,self.debug,self.header) |
|
484 | 484 | |
|
485 | 485 | def shell(self,cmd): |
|
486 | 486 | """Stateful interface to shell(), with the same keyword parameters.""" |
|
487 | 487 | |
|
488 | 488 | shell(cmd,self.verbose,self.debug,self.header) |
|
489 | 489 | |
|
490 | 490 | xsys = system # alias |
|
491 | 491 | |
|
492 | 492 | def getoutput(self,cmd): |
|
493 | 493 | """Stateful interface to getoutput().""" |
|
494 | 494 | |
|
495 | 495 | return getoutput(cmd,self.verbose,self.debug,self.header,self.split) |
|
496 | 496 | |
|
497 | 497 | def getoutputerror(self,cmd): |
|
498 | 498 | """Stateful interface to getoutputerror().""" |
|
499 | 499 | |
|
500 | 500 | return getoutputerror(cmd,self.verbose,self.debug,self.header,self.split) |
|
501 | 501 | |
|
502 | 502 | bq = getoutput # alias |
|
503 | 503 | |
|
504 | 504 | #----------------------------------------------------------------------------- |
|
505 | 505 | def mutex_opts(dict,ex_op): |
|
506 | 506 | """Check for presence of mutually exclusive keys in a dict. |
|
507 | 507 | |
|
508 | 508 | Call: mutex_opts(dict,[[op1a,op1b],[op2a,op2b]...]""" |
|
509 | 509 | for op1,op2 in ex_op: |
|
510 | 510 | if op1 in dict and op2 in dict: |
|
511 | 511 | raise ValueError,'\n*** ERROR in Arguments *** '\ |
|
512 | 512 | 'Options '+op1+' and '+op2+' are mutually exclusive.' |
|
513 | 513 | |
|
514 | 514 | #----------------------------------------------------------------------------- |
|
515 | 515 | def get_py_filename(name): |
|
516 | 516 | """Return a valid python filename in the current directory. |
|
517 | 517 | |
|
518 | 518 | If the given name is not a file, it adds '.py' and searches again. |
|
519 | 519 | Raises IOError with an informative message if the file isn't found.""" |
|
520 | 520 | |
|
521 | 521 | name = os.path.expanduser(name) |
|
522 | 522 | if not os.path.isfile(name) and not name.endswith('.py'): |
|
523 | 523 | name += '.py' |
|
524 | 524 | if os.path.isfile(name): |
|
525 | 525 | return name |
|
526 | 526 | else: |
|
527 | 527 | raise IOError,'File `%s` not found.' % name |
|
528 | 528 | |
|
529 | 529 | #----------------------------------------------------------------------------- |
|
530 | 530 | def filefind(fname,alt_dirs = None): |
|
531 | 531 | """Return the given filename either in the current directory, if it |
|
532 | 532 | exists, or in a specified list of directories. |
|
533 | 533 | |
|
534 | 534 | ~ expansion is done on all file and directory names. |
|
535 | 535 | |
|
536 | 536 | Upon an unsuccessful search, raise an IOError exception.""" |
|
537 | 537 | |
|
538 | 538 | if alt_dirs is None: |
|
539 | 539 | try: |
|
540 | 540 | alt_dirs = get_home_dir() |
|
541 | 541 | except HomeDirError: |
|
542 | 542 | alt_dirs = os.getcwd() |
|
543 | 543 | search = [fname] + list_strings(alt_dirs) |
|
544 | 544 | search = map(os.path.expanduser,search) |
|
545 | 545 | #print 'search list for',fname,'list:',search # dbg |
|
546 | 546 | fname = search[0] |
|
547 | 547 | if os.path.isfile(fname): |
|
548 | 548 | return fname |
|
549 | 549 | for direc in search[1:]: |
|
550 | 550 | testname = os.path.join(direc,fname) |
|
551 | 551 | #print 'testname',testname # dbg |
|
552 | 552 | if os.path.isfile(testname): |
|
553 | 553 | return testname |
|
554 | 554 | raise IOError,'File' + `fname` + \ |
|
555 | 555 | ' not found in current or supplied directories:' + `alt_dirs` |
|
556 | 556 | |
|
557 | 557 | #---------------------------------------------------------------------------- |
|
558 | 558 | def file_read(filename): |
|
559 | 559 | """Read a file and close it. Returns the file source.""" |
|
560 | 560 | fobj = open(filename,'r'); |
|
561 | 561 | source = fobj.read(); |
|
562 | 562 | fobj.close() |
|
563 | 563 | return source |
|
564 | 564 | |
|
565 | 565 | def file_readlines(filename): |
|
566 | 566 | """Read a file and close it. Returns the file source using readlines().""" |
|
567 | 567 | fobj = open(filename,'r'); |
|
568 | 568 | lines = fobj.readlines(); |
|
569 | 569 | fobj.close() |
|
570 | 570 | return lines |
|
571 | 571 | |
|
572 | 572 | #---------------------------------------------------------------------------- |
|
573 | 573 | def target_outdated(target,deps): |
|
574 | 574 | """Determine whether a target is out of date. |
|
575 | 575 | |
|
576 | 576 | target_outdated(target,deps) -> 1/0 |
|
577 | 577 | |
|
578 | 578 | deps: list of filenames which MUST exist. |
|
579 | 579 | target: single filename which may or may not exist. |
|
580 | 580 | |
|
581 | 581 | If target doesn't exist or is older than any file listed in deps, return |
|
582 | 582 | true, otherwise return false. |
|
583 | 583 | """ |
|
584 | 584 | try: |
|
585 | 585 | target_time = os.path.getmtime(target) |
|
586 | 586 | except os.error: |
|
587 | 587 | return 1 |
|
588 | 588 | for dep in deps: |
|
589 | 589 | dep_time = os.path.getmtime(dep) |
|
590 | 590 | if dep_time > target_time: |
|
591 | 591 | #print "For target",target,"Dep failed:",dep # dbg |
|
592 | 592 | #print "times (dep,tar):",dep_time,target_time # dbg |
|
593 | 593 | return 1 |
|
594 | 594 | return 0 |
|
595 | 595 | |
|
596 | 596 | #----------------------------------------------------------------------------- |
|
597 | 597 | def target_update(target,deps,cmd): |
|
598 | 598 | """Update a target with a given command given a list of dependencies. |
|
599 | 599 | |
|
600 | 600 | target_update(target,deps,cmd) -> runs cmd if target is outdated. |
|
601 | 601 | |
|
602 | 602 | This is just a wrapper around target_outdated() which calls the given |
|
603 | 603 | command if target is outdated.""" |
|
604 | 604 | |
|
605 | 605 | if target_outdated(target,deps): |
|
606 | 606 | xsys(cmd) |
|
607 | 607 | |
|
608 | 608 | #---------------------------------------------------------------------------- |
|
609 | 609 | def unquote_ends(istr): |
|
610 | 610 | """Remove a single pair of quotes from the endpoints of a string.""" |
|
611 | 611 | |
|
612 | 612 | if not istr: |
|
613 | 613 | return istr |
|
614 | 614 | if (istr[0]=="'" and istr[-1]=="'") or \ |
|
615 | 615 | (istr[0]=='"' and istr[-1]=='"'): |
|
616 | 616 | return istr[1:-1] |
|
617 | 617 | else: |
|
618 | 618 | return istr |
|
619 | 619 | |
|
620 | 620 | #---------------------------------------------------------------------------- |
|
621 | 621 | def process_cmdline(argv,names=[],defaults={},usage=''): |
|
622 | 622 | """ Process command-line options and arguments. |
|
623 | 623 | |
|
624 | 624 | Arguments: |
|
625 | 625 | |
|
626 | 626 | - argv: list of arguments, typically sys.argv. |
|
627 | 627 | |
|
628 | 628 | - names: list of option names. See DPyGetOpt docs for details on options |
|
629 | 629 | syntax. |
|
630 | 630 | |
|
631 | 631 | - defaults: dict of default values. |
|
632 | 632 | |
|
633 | 633 | - usage: optional usage notice to print if a wrong argument is passed. |
|
634 | 634 | |
|
635 | 635 | Return a dict of options and a list of free arguments.""" |
|
636 | 636 | |
|
637 | 637 | getopt = DPyGetOpt.DPyGetOpt() |
|
638 | 638 | getopt.setIgnoreCase(0) |
|
639 | 639 | getopt.parseConfiguration(names) |
|
640 | 640 | |
|
641 | 641 | try: |
|
642 | 642 | getopt.processArguments(argv) |
|
643 | 643 | except DPyGetOpt.ArgumentError, exc: |
|
644 | 644 | print usage |
|
645 | 645 | warn('"%s"' % exc,level=4) |
|
646 | 646 | |
|
647 | 647 | defaults.update(getopt.optionValues) |
|
648 | 648 | args = getopt.freeValues |
|
649 | 649 | |
|
650 | 650 | return defaults,args |
|
651 | 651 | |
|
652 | 652 | #---------------------------------------------------------------------------- |
|
653 | 653 | def optstr2types(ostr): |
|
654 | 654 | """Convert a string of option names to a dict of type mappings. |
|
655 | 655 | |
|
656 | 656 | optstr2types(str) -> {None:'string_opts',int:'int_opts',float:'float_opts'} |
|
657 | 657 | |
|
658 | 658 | This is used to get the types of all the options in a string formatted |
|
659 | 659 | with the conventions of DPyGetOpt. The 'type' None is used for options |
|
660 | 660 | which are strings (they need no further conversion). This function's main |
|
661 | 661 | use is to get a typemap for use with read_dict(). |
|
662 | 662 | """ |
|
663 | 663 | |
|
664 | 664 | typeconv = {None:'',int:'',float:''} |
|
665 | 665 | typemap = {'s':None,'i':int,'f':float} |
|
666 | 666 | opt_re = re.compile(r'([\w]*)([^:=]*:?=?)([sif]?)') |
|
667 | 667 | |
|
668 | 668 | for w in ostr.split(): |
|
669 | 669 | oname,alias,otype = opt_re.match(w).groups() |
|
670 | 670 | if otype == '' or alias == '!': # simple switches are integers too |
|
671 | 671 | otype = 'i' |
|
672 | 672 | typeconv[typemap[otype]] += oname + ' ' |
|
673 | 673 | return typeconv |
|
674 | 674 | |
|
675 | 675 | #---------------------------------------------------------------------------- |
|
676 | 676 | def read_dict(filename,type_conv=None,**opt): |
|
677 | 677 | r"""Read a dictionary of key=value pairs from an input file, optionally |
|
678 | 678 | performing conversions on the resulting values. |
|
679 | 679 | |
|
680 | 680 | read_dict(filename,type_conv,**opt) -> dict |
|
681 | 681 | |
|
682 | 682 | Only one value per line is accepted, the format should be |
|
683 | 683 | # optional comments are ignored |
|
684 | 684 | key value\n |
|
685 | 685 | |
|
686 | 686 | Args: |
|
687 | 687 | |
|
688 | 688 | - type_conv: A dictionary specifying which keys need to be converted to |
|
689 | 689 | which types. By default all keys are read as strings. This dictionary |
|
690 | 690 | should have as its keys valid conversion functions for strings |
|
691 | 691 | (int,long,float,complex, or your own). The value for each key |
|
692 | 692 | (converter) should be a whitespace separated string containing the names |
|
693 | 693 | of all the entries in the file to be converted using that function. For |
|
694 | 694 | keys to be left alone, use None as the conversion function (only needed |
|
695 | 695 | with purge=1, see below). |
|
696 | 696 | |
|
697 | 697 | - opt: dictionary with extra options as below (default in parens) |
|
698 | 698 | |
|
699 | 699 | purge(0): if set to 1, all keys *not* listed in type_conv are purged out |
|
700 | 700 | of the dictionary to be returned. If purge is going to be used, the |
|
701 | 701 | set of keys to be left as strings also has to be explicitly specified |
|
702 | 702 | using the (non-existent) conversion function None. |
|
703 | 703 | |
|
704 | 704 | fs(None): field separator. This is the key/value separator to be used |
|
705 | 705 | when parsing the file. The None default means any whitespace [behavior |
|
706 | 706 | of string.split()]. |
|
707 | 707 | |
|
708 | 708 | strip(0): if 1, strip string values of leading/trailinig whitespace. |
|
709 | 709 | |
|
710 | 710 | warn(1): warning level if requested keys are not found in file. |
|
711 | 711 | - 0: silently ignore. |
|
712 | 712 | - 1: inform but proceed. |
|
713 | 713 | - 2: raise KeyError exception. |
|
714 | 714 | |
|
715 | 715 | no_empty(0): if 1, remove keys with whitespace strings as a value. |
|
716 | 716 | |
|
717 | 717 | unique([]): list of keys (or space separated string) which can't be |
|
718 | 718 | repeated. If one such key is found in the file, each new instance |
|
719 | 719 | overwrites the previous one. For keys not listed here, the behavior is |
|
720 | 720 | to make a list of all appearances. |
|
721 | 721 | |
|
722 | 722 | Example: |
|
723 | 723 | |
|
724 | 724 | If the input file test.ini contains (we put it in a string to keep the test |
|
725 | 725 | self-contained): |
|
726 | 726 | |
|
727 | 727 | >>> test_ini = '''\ |
|
728 | 728 | ... i 3 |
|
729 | 729 | ... x 4.5 |
|
730 | 730 | ... y 5.5 |
|
731 | 731 | ... s hi ho''' |
|
732 | 732 | |
|
733 | 733 | Then we can use it as follows: |
|
734 | 734 | >>> type_conv={int:'i',float:'x',None:'s'} |
|
735 | 735 | |
|
736 | 736 | >>> d = read_dict(test_ini) |
|
737 | 737 | |
|
738 | 738 | >>> sorted(d.items()) |
|
739 | 739 | [('i', '3'), ('s', 'hi ho'), ('x', '4.5'), ('y', '5.5')] |
|
740 | 740 | |
|
741 | 741 | >>> d = read_dict(test_ini,type_conv) |
|
742 | 742 | |
|
743 | 743 | >>> sorted(d.items()) |
|
744 | 744 | [('i', 3), ('s', 'hi ho'), ('x', 4.5), ('y', '5.5')] |
|
745 | 745 | |
|
746 | 746 | >>> d = read_dict(test_ini,type_conv,purge=True) |
|
747 | 747 | |
|
748 | 748 | >>> sorted(d.items()) |
|
749 | 749 | [('i', 3), ('s', 'hi ho'), ('x', 4.5)] |
|
750 | 750 | """ |
|
751 | 751 | |
|
752 | 752 | # starting config |
|
753 | 753 | opt.setdefault('purge',0) |
|
754 | 754 | opt.setdefault('fs',None) # field sep defaults to any whitespace |
|
755 | 755 | opt.setdefault('strip',0) |
|
756 | 756 | opt.setdefault('warn',1) |
|
757 | 757 | opt.setdefault('no_empty',0) |
|
758 | 758 | opt.setdefault('unique','') |
|
759 | 759 | if type(opt['unique']) in StringTypes: |
|
760 | 760 | unique_keys = qw(opt['unique']) |
|
761 | 761 | elif type(opt['unique']) in (types.TupleType,types.ListType): |
|
762 | 762 | unique_keys = opt['unique'] |
|
763 | 763 | else: |
|
764 | 764 | raise ValueError, 'Unique keys must be given as a string, List or Tuple' |
|
765 | 765 | |
|
766 | 766 | dict = {} |
|
767 | 767 | |
|
768 | 768 | # first read in table of values as strings |
|
769 | 769 | if '\n' in filename: |
|
770 | 770 | lines = filename.splitlines() |
|
771 | 771 | file = None |
|
772 | 772 | else: |
|
773 | 773 | file = open(filename,'r') |
|
774 | 774 | lines = file.readlines() |
|
775 | 775 | for line in lines: |
|
776 | 776 | line = line.strip() |
|
777 | 777 | if len(line) and line[0]=='#': continue |
|
778 | 778 | if len(line)>0: |
|
779 | 779 | lsplit = line.split(opt['fs'],1) |
|
780 | 780 | try: |
|
781 | 781 | key,val = lsplit |
|
782 | 782 | except ValueError: |
|
783 | 783 | key,val = lsplit[0],'' |
|
784 | 784 | key = key.strip() |
|
785 | 785 | if opt['strip']: val = val.strip() |
|
786 | 786 | if val == "''" or val == '""': val = '' |
|
787 | 787 | if opt['no_empty'] and (val=='' or val.isspace()): |
|
788 | 788 | continue |
|
789 | 789 | # if a key is found more than once in the file, build a list |
|
790 | 790 | # unless it's in the 'unique' list. In that case, last found in file |
|
791 | 791 | # takes precedence. User beware. |
|
792 | 792 | try: |
|
793 | 793 | if dict[key] and key in unique_keys: |
|
794 | 794 | dict[key] = val |
|
795 | 795 | elif type(dict[key]) is types.ListType: |
|
796 | 796 | dict[key].append(val) |
|
797 | 797 | else: |
|
798 | 798 | dict[key] = [dict[key],val] |
|
799 | 799 | except KeyError: |
|
800 | 800 | dict[key] = val |
|
801 | 801 | # purge if requested |
|
802 | 802 | if opt['purge']: |
|
803 | 803 | accepted_keys = qwflat(type_conv.values()) |
|
804 | 804 | for key in dict.keys(): |
|
805 | 805 | if key in accepted_keys: continue |
|
806 | 806 | del(dict[key]) |
|
807 | 807 | # now convert if requested |
|
808 | 808 | if type_conv==None: return dict |
|
809 | 809 | conversions = type_conv.keys() |
|
810 | 810 | try: conversions.remove(None) |
|
811 | 811 | except: pass |
|
812 | 812 | for convert in conversions: |
|
813 | 813 | for val in qw(type_conv[convert]): |
|
814 | 814 | try: |
|
815 | 815 | dict[val] = convert(dict[val]) |
|
816 | 816 | except KeyError,e: |
|
817 | 817 | if opt['warn'] == 0: |
|
818 | 818 | pass |
|
819 | 819 | elif opt['warn'] == 1: |
|
820 | 820 | print >>sys.stderr, 'Warning: key',val,\ |
|
821 | 821 | 'not found in file',filename |
|
822 | 822 | elif opt['warn'] == 2: |
|
823 | 823 | raise KeyError,e |
|
824 | 824 | else: |
|
825 | 825 | raise ValueError,'Warning level must be 0,1 or 2' |
|
826 | 826 | |
|
827 | 827 | return dict |
|
828 | 828 | |
|
829 | 829 | #---------------------------------------------------------------------------- |
|
830 | 830 | def flag_calls(func): |
|
831 | 831 | """Wrap a function to detect and flag when it gets called. |
|
832 | 832 | |
|
833 | 833 | This is a decorator which takes a function and wraps it in a function with |
|
834 | 834 | a 'called' attribute. wrapper.called is initialized to False. |
|
835 | 835 | |
|
836 | 836 | The wrapper.called attribute is set to False right before each call to the |
|
837 | 837 | wrapped function, so if the call fails it remains False. After the call |
|
838 | 838 | completes, wrapper.called is set to True and the output is returned. |
|
839 | 839 | |
|
840 | 840 | Testing for truth in wrapper.called allows you to determine if a call to |
|
841 | 841 | func() was attempted and succeeded.""" |
|
842 | 842 | |
|
843 | 843 | def wrapper(*args,**kw): |
|
844 | 844 | wrapper.called = False |
|
845 | 845 | out = func(*args,**kw) |
|
846 | 846 | wrapper.called = True |
|
847 | 847 | return out |
|
848 | 848 | |
|
849 | 849 | wrapper.called = False |
|
850 | 850 | wrapper.__doc__ = func.__doc__ |
|
851 | 851 | return wrapper |
|
852 | 852 | |
|
853 | 853 | #---------------------------------------------------------------------------- |
|
854 | 854 | def dhook_wrap(func,*a,**k): |
|
855 | 855 | """Wrap a function call in a sys.displayhook controller. |
|
856 | 856 | |
|
857 | 857 | Returns a wrapper around func which calls func, with all its arguments and |
|
858 | 858 | keywords unmodified, using the default sys.displayhook. Since IPython |
|
859 | 859 | modifies sys.displayhook, it breaks the behavior of certain systems that |
|
860 | 860 | rely on the default behavior, notably doctest. |
|
861 | 861 | """ |
|
862 | 862 | |
|
863 | 863 | def f(*a,**k): |
|
864 | 864 | |
|
865 | 865 | dhook_s = sys.displayhook |
|
866 | 866 | sys.displayhook = sys.__displayhook__ |
|
867 | 867 | try: |
|
868 | 868 | out = func(*a,**k) |
|
869 | 869 | finally: |
|
870 | 870 | sys.displayhook = dhook_s |
|
871 | 871 | |
|
872 | 872 | return out |
|
873 | 873 | |
|
874 | 874 | f.__doc__ = func.__doc__ |
|
875 | 875 | return f |
|
876 | 876 | |
|
877 | 877 | #---------------------------------------------------------------------------- |
|
878 | 878 | def doctest_reload(): |
|
879 | 879 | """Properly reload doctest to reuse it interactively. |
|
880 | 880 | |
|
881 | 881 | This routine: |
|
882 | 882 | |
|
883 | 883 | - imports doctest but does NOT reload it (see below). |
|
884 | 884 | |
|
885 | 885 | - resets its global 'master' attribute to None, so that multiple uses of |
|
886 | 886 | the module interactively don't produce cumulative reports. |
|
887 | 887 | |
|
888 | 888 | - Monkeypatches its core test runner method to protect it from IPython's |
|
889 | 889 | modified displayhook. Doctest expects the default displayhook behavior |
|
890 | 890 | deep down, so our modification breaks it completely. For this reason, a |
|
891 | 891 | hard monkeypatch seems like a reasonable solution rather than asking |
|
892 | 892 | users to manually use a different doctest runner when under IPython. |
|
893 | 893 | |
|
894 | Note | |
|
895 | ---- | |
|
894 | Notes | |
|
895 | ----- | |
|
896 | 896 | |
|
897 | 897 | This function *used to* reload doctest, but this has been disabled because |
|
898 | 898 | reloading doctest unconditionally can cause massive breakage of other |
|
899 | 899 | doctest-dependent modules already in memory, such as those for IPython's |
|
900 | 900 | own testing system. The name wasn't changed to avoid breaking people's |
|
901 | 901 | code, but the reload call isn't actually made anymore.""" |
|
902 | 902 | |
|
903 | 903 | import doctest |
|
904 | 904 | doctest.master = None |
|
905 | 905 | doctest.DocTestRunner.run = dhook_wrap(doctest.DocTestRunner.run) |
|
906 | 906 | |
|
907 | 907 | #---------------------------------------------------------------------------- |
|
908 | 908 | class HomeDirError(Error): |
|
909 | 909 | pass |
|
910 | 910 | |
|
911 | 911 | def get_home_dir(): |
|
912 | 912 | """Return the closest possible equivalent to a 'home' directory. |
|
913 | 913 | |
|
914 | 914 | We first try $HOME. Absent that, on NT it's $HOMEDRIVE\$HOMEPATH. |
|
915 | 915 | |
|
916 | 916 | Currently only Posix and NT are implemented, a HomeDirError exception is |
|
917 | 917 | raised for all other OSes. """ |
|
918 | 918 | |
|
919 | 919 | isdir = os.path.isdir |
|
920 | 920 | env = os.environ |
|
921 | 921 | |
|
922 | 922 | # first, check py2exe distribution root directory for _ipython. |
|
923 | 923 | # This overrides all. Normally does not exist. |
|
924 | 924 | |
|
925 | 925 | if hasattr(sys, "frozen"): #Is frozen by py2exe |
|
926 | 926 | if '\\library.zip\\' in IPython.__file__.lower():#libraries compressed to zip-file |
|
927 | 927 | root, rest = IPython.__file__.lower().split('library.zip') |
|
928 | 928 | else: |
|
929 | 929 | root=os.path.join(os.path.split(IPython.__file__)[0],"../../") |
|
930 | 930 | root=os.path.abspath(root).rstrip('\\') |
|
931 | 931 | if isdir(os.path.join(root, '_ipython')): |
|
932 | 932 | os.environ["IPYKITROOT"] = root |
|
933 | 933 | return root |
|
934 | 934 | try: |
|
935 | 935 | homedir = env['HOME'] |
|
936 | 936 | if not isdir(homedir): |
|
937 | 937 | # in case a user stuck some string which does NOT resolve to a |
|
938 | 938 | # valid path, it's as good as if we hadn't foud it |
|
939 | 939 | raise KeyError |
|
940 | 940 | return homedir |
|
941 | 941 | except KeyError: |
|
942 | 942 | if os.name == 'posix': |
|
943 | 943 | raise HomeDirError,'undefined $HOME, IPython can not proceed.' |
|
944 | 944 | elif os.name == 'nt': |
|
945 | 945 | # For some strange reason, win9x returns 'nt' for os.name. |
|
946 | 946 | try: |
|
947 | 947 | homedir = os.path.join(env['HOMEDRIVE'],env['HOMEPATH']) |
|
948 | 948 | if not isdir(homedir): |
|
949 | 949 | homedir = os.path.join(env['USERPROFILE']) |
|
950 | 950 | if not isdir(homedir): |
|
951 | 951 | raise HomeDirError |
|
952 | 952 | return homedir |
|
953 | 953 | except KeyError: |
|
954 | 954 | try: |
|
955 | 955 | # Use the registry to get the 'My Documents' folder. |
|
956 | 956 | import _winreg as wreg |
|
957 | 957 | key = wreg.OpenKey(wreg.HKEY_CURRENT_USER, |
|
958 | 958 | "Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders") |
|
959 | 959 | homedir = wreg.QueryValueEx(key,'Personal')[0] |
|
960 | 960 | key.Close() |
|
961 | 961 | if not isdir(homedir): |
|
962 | 962 | e = ('Invalid "Personal" folder registry key ' |
|
963 | 963 | 'typically "My Documents".\n' |
|
964 | 964 | 'Value: %s\n' |
|
965 | 965 | 'This is not a valid directory on your system.' % |
|
966 | 966 | homedir) |
|
967 | 967 | raise HomeDirError(e) |
|
968 | 968 | return homedir |
|
969 | 969 | except HomeDirError: |
|
970 | 970 | raise |
|
971 | 971 | except: |
|
972 | 972 | return 'C:\\' |
|
973 | 973 | elif os.name == 'dos': |
|
974 | 974 | # Desperate, may do absurd things in classic MacOS. May work under DOS. |
|
975 | 975 | return 'C:\\' |
|
976 | 976 | else: |
|
977 | 977 | raise HomeDirError,'support for your operating system not implemented.' |
|
978 | 978 | |
|
979 | 979 | |
|
980 | 980 | def get_ipython_dir(): |
|
981 | 981 | """Get the IPython directory for this platform and user. |
|
982 | 982 | |
|
983 | 983 | This uses the logic in `get_home_dir` to find the home directory |
|
984 | 984 | and the adds either .ipython or _ipython to the end of the path. |
|
985 | 985 | """ |
|
986 | 986 | if os.name == 'posix': |
|
987 | 987 | ipdir_def = '.ipython' |
|
988 | 988 | else: |
|
989 | 989 | ipdir_def = '_ipython' |
|
990 | 990 | home_dir = get_home_dir() |
|
991 | 991 | ipdir = os.path.abspath(os.environ.get('IPYTHONDIR', |
|
992 | 992 | os.path.join(home_dir, ipdir_def))) |
|
993 | 993 | return ipdir.decode(sys.getfilesystemencoding()) |
|
994 | 994 | |
|
995 | 995 | def get_security_dir(): |
|
996 | 996 | """Get the IPython security directory. |
|
997 | 997 | |
|
998 | 998 | This directory is the default location for all security related files, |
|
999 | 999 | including SSL/TLS certificates and FURL files. |
|
1000 | 1000 | |
|
1001 | 1001 | If the directory does not exist, it is created with 0700 permissions. |
|
1002 | 1002 | If it exists, permissions are set to 0700. |
|
1003 | 1003 | """ |
|
1004 | 1004 | security_dir = os.path.join(get_ipython_dir(), 'security') |
|
1005 | 1005 | if not os.path.isdir(security_dir): |
|
1006 | 1006 | os.mkdir(security_dir, 0700) |
|
1007 | 1007 | else: |
|
1008 | 1008 | os.chmod(security_dir, 0700) |
|
1009 | 1009 | return security_dir |
|
1010 | 1010 | |
|
1011 | 1011 | def get_log_dir(): |
|
1012 | 1012 | """Get the IPython log directory. |
|
1013 | 1013 | |
|
1014 | 1014 | If the log directory does not exist, it is created. |
|
1015 | 1015 | """ |
|
1016 | 1016 | log_dir = os.path.join(get_ipython_dir(), 'log') |
|
1017 | 1017 | if not os.path.isdir(log_dir): |
|
1018 | 1018 | os.mkdir(log_dir, 0777) |
|
1019 | 1019 | return log_dir |
|
1020 | 1020 | |
|
1021 | 1021 | #**************************************************************************** |
|
1022 | 1022 | # strings and text |
|
1023 | 1023 | |
|
1024 | 1024 | class LSString(str): |
|
1025 | 1025 | """String derivative with a special access attributes. |
|
1026 | 1026 | |
|
1027 | 1027 | These are normal strings, but with the special attributes: |
|
1028 | 1028 | |
|
1029 | 1029 | .l (or .list) : value as list (split on newlines). |
|
1030 | 1030 | .n (or .nlstr): original value (the string itself). |
|
1031 | 1031 | .s (or .spstr): value as whitespace-separated string. |
|
1032 | 1032 | .p (or .paths): list of path objects |
|
1033 | 1033 | |
|
1034 | 1034 | Any values which require transformations are computed only once and |
|
1035 | 1035 | cached. |
|
1036 | 1036 | |
|
1037 | 1037 | Such strings are very useful to efficiently interact with the shell, which |
|
1038 | 1038 | typically only understands whitespace-separated options for commands.""" |
|
1039 | 1039 | |
|
1040 | 1040 | def get_list(self): |
|
1041 | 1041 | try: |
|
1042 | 1042 | return self.__list |
|
1043 | 1043 | except AttributeError: |
|
1044 | 1044 | self.__list = self.split('\n') |
|
1045 | 1045 | return self.__list |
|
1046 | 1046 | |
|
1047 | 1047 | l = list = property(get_list) |
|
1048 | 1048 | |
|
1049 | 1049 | def get_spstr(self): |
|
1050 | 1050 | try: |
|
1051 | 1051 | return self.__spstr |
|
1052 | 1052 | except AttributeError: |
|
1053 | 1053 | self.__spstr = self.replace('\n',' ') |
|
1054 | 1054 | return self.__spstr |
|
1055 | 1055 | |
|
1056 | 1056 | s = spstr = property(get_spstr) |
|
1057 | 1057 | |
|
1058 | 1058 | def get_nlstr(self): |
|
1059 | 1059 | return self |
|
1060 | 1060 | |
|
1061 | 1061 | n = nlstr = property(get_nlstr) |
|
1062 | 1062 | |
|
1063 | 1063 | def get_paths(self): |
|
1064 | 1064 | try: |
|
1065 | 1065 | return self.__paths |
|
1066 | 1066 | except AttributeError: |
|
1067 | 1067 | self.__paths = [path(p) for p in self.split('\n') if os.path.exists(p)] |
|
1068 | 1068 | return self.__paths |
|
1069 | 1069 | |
|
1070 | 1070 | p = paths = property(get_paths) |
|
1071 | 1071 | |
|
1072 | 1072 | def print_lsstring(arg): |
|
1073 | 1073 | """ Prettier (non-repr-like) and more informative printer for LSString """ |
|
1074 | 1074 | print "LSString (.p, .n, .l, .s available). Value:" |
|
1075 | 1075 | print arg |
|
1076 | 1076 | |
|
1077 | 1077 | print_lsstring = result_display.when_type(LSString)(print_lsstring) |
|
1078 | 1078 | |
|
1079 | 1079 | #---------------------------------------------------------------------------- |
|
1080 | 1080 | class SList(list): |
|
1081 | 1081 | """List derivative with a special access attributes. |
|
1082 | 1082 | |
|
1083 | 1083 | These are normal lists, but with the special attributes: |
|
1084 | 1084 | |
|
1085 | 1085 | .l (or .list) : value as list (the list itself). |
|
1086 | 1086 | .n (or .nlstr): value as a string, joined on newlines. |
|
1087 | 1087 | .s (or .spstr): value as a string, joined on spaces. |
|
1088 | 1088 | .p (or .paths): list of path objects |
|
1089 | 1089 | |
|
1090 | 1090 | Any values which require transformations are computed only once and |
|
1091 | 1091 | cached.""" |
|
1092 | 1092 | |
|
1093 | 1093 | def get_list(self): |
|
1094 | 1094 | return self |
|
1095 | 1095 | |
|
1096 | 1096 | l = list = property(get_list) |
|
1097 | 1097 | |
|
1098 | 1098 | def get_spstr(self): |
|
1099 | 1099 | try: |
|
1100 | 1100 | return self.__spstr |
|
1101 | 1101 | except AttributeError: |
|
1102 | 1102 | self.__spstr = ' '.join(self) |
|
1103 | 1103 | return self.__spstr |
|
1104 | 1104 | |
|
1105 | 1105 | s = spstr = property(get_spstr) |
|
1106 | 1106 | |
|
1107 | 1107 | def get_nlstr(self): |
|
1108 | 1108 | try: |
|
1109 | 1109 | return self.__nlstr |
|
1110 | 1110 | except AttributeError: |
|
1111 | 1111 | self.__nlstr = '\n'.join(self) |
|
1112 | 1112 | return self.__nlstr |
|
1113 | 1113 | |
|
1114 | 1114 | n = nlstr = property(get_nlstr) |
|
1115 | 1115 | |
|
1116 | 1116 | def get_paths(self): |
|
1117 | 1117 | try: |
|
1118 | 1118 | return self.__paths |
|
1119 | 1119 | except AttributeError: |
|
1120 | 1120 | self.__paths = [path(p) for p in self if os.path.exists(p)] |
|
1121 | 1121 | return self.__paths |
|
1122 | 1122 | |
|
1123 | 1123 | p = paths = property(get_paths) |
|
1124 | 1124 | |
|
1125 | 1125 | def grep(self, pattern, prune = False, field = None): |
|
1126 | 1126 | """ Return all strings matching 'pattern' (a regex or callable) |
|
1127 | 1127 | |
|
1128 | 1128 | This is case-insensitive. If prune is true, return all items |
|
1129 | 1129 | NOT matching the pattern. |
|
1130 | 1130 | |
|
1131 | 1131 | If field is specified, the match must occur in the specified |
|
1132 | 1132 | whitespace-separated field. |
|
1133 | 1133 | |
|
1134 | 1134 | Examples:: |
|
1135 | 1135 | |
|
1136 | 1136 | a.grep( lambda x: x.startswith('C') ) |
|
1137 | 1137 | a.grep('Cha.*log', prune=1) |
|
1138 | 1138 | a.grep('chm', field=-1) |
|
1139 | 1139 | """ |
|
1140 | 1140 | |
|
1141 | 1141 | def match_target(s): |
|
1142 | 1142 | if field is None: |
|
1143 | 1143 | return s |
|
1144 | 1144 | parts = s.split() |
|
1145 | 1145 | try: |
|
1146 | 1146 | tgt = parts[field] |
|
1147 | 1147 | return tgt |
|
1148 | 1148 | except IndexError: |
|
1149 | 1149 | return "" |
|
1150 | 1150 | |
|
1151 | 1151 | if isinstance(pattern, basestring): |
|
1152 | 1152 | pred = lambda x : re.search(pattern, x, re.IGNORECASE) |
|
1153 | 1153 | else: |
|
1154 | 1154 | pred = pattern |
|
1155 | 1155 | if not prune: |
|
1156 | 1156 | return SList([el for el in self if pred(match_target(el))]) |
|
1157 | 1157 | else: |
|
1158 | 1158 | return SList([el for el in self if not pred(match_target(el))]) |
|
1159 | 1159 | def fields(self, *fields): |
|
1160 | 1160 | """ Collect whitespace-separated fields from string list |
|
1161 | 1161 | |
|
1162 | 1162 | Allows quick awk-like usage of string lists. |
|
1163 | 1163 | |
|
1164 | 1164 | Example data (in var a, created by 'a = !ls -l'):: |
|
1165 | 1165 | -rwxrwxrwx 1 ville None 18 Dec 14 2006 ChangeLog |
|
1166 | 1166 | drwxrwxrwx+ 6 ville None 0 Oct 24 18:05 IPython |
|
1167 | 1167 | |
|
1168 | 1168 | a.fields(0) is ['-rwxrwxrwx', 'drwxrwxrwx+'] |
|
1169 | 1169 | a.fields(1,0) is ['1 -rwxrwxrwx', '6 drwxrwxrwx+'] |
|
1170 | 1170 | (note the joining by space). |
|
1171 | 1171 | a.fields(-1) is ['ChangeLog', 'IPython'] |
|
1172 | 1172 | |
|
1173 | 1173 | IndexErrors are ignored. |
|
1174 | 1174 | |
|
1175 | 1175 | Without args, fields() just split()'s the strings. |
|
1176 | 1176 | """ |
|
1177 | 1177 | if len(fields) == 0: |
|
1178 | 1178 | return [el.split() for el in self] |
|
1179 | 1179 | |
|
1180 | 1180 | res = SList() |
|
1181 | 1181 | for el in [f.split() for f in self]: |
|
1182 | 1182 | lineparts = [] |
|
1183 | 1183 | |
|
1184 | 1184 | for fd in fields: |
|
1185 | 1185 | try: |
|
1186 | 1186 | lineparts.append(el[fd]) |
|
1187 | 1187 | except IndexError: |
|
1188 | 1188 | pass |
|
1189 | 1189 | if lineparts: |
|
1190 | 1190 | res.append(" ".join(lineparts)) |
|
1191 | 1191 | |
|
1192 | 1192 | return res |
|
1193 | 1193 | def sort(self,field= None, nums = False): |
|
1194 | 1194 | """ sort by specified fields (see fields()) |
|
1195 | 1195 | |
|
1196 | 1196 | Example:: |
|
1197 | 1197 | a.sort(1, nums = True) |
|
1198 | 1198 | |
|
1199 | 1199 | Sorts a by second field, in numerical order (so that 21 > 3) |
|
1200 | 1200 | |
|
1201 | 1201 | """ |
|
1202 | 1202 | |
|
1203 | 1203 | #decorate, sort, undecorate |
|
1204 | 1204 | if field is not None: |
|
1205 | 1205 | dsu = [[SList([line]).fields(field), line] for line in self] |
|
1206 | 1206 | else: |
|
1207 | 1207 | dsu = [[line, line] for line in self] |
|
1208 | 1208 | if nums: |
|
1209 | 1209 | for i in range(len(dsu)): |
|
1210 | 1210 | numstr = "".join([ch for ch in dsu[i][0] if ch.isdigit()]) |
|
1211 | 1211 | try: |
|
1212 | 1212 | n = int(numstr) |
|
1213 | 1213 | except ValueError: |
|
1214 | 1214 | n = 0; |
|
1215 | 1215 | dsu[i][0] = n |
|
1216 | 1216 | |
|
1217 | 1217 | |
|
1218 | 1218 | dsu.sort() |
|
1219 | 1219 | return SList([t[1] for t in dsu]) |
|
1220 | 1220 | |
|
1221 | 1221 | def print_slist(arg): |
|
1222 | 1222 | """ Prettier (non-repr-like) and more informative printer for SList """ |
|
1223 | 1223 | print "SList (.p, .n, .l, .s, .grep(), .fields(), sort() available):" |
|
1224 | 1224 | if hasattr(arg, 'hideonce') and arg.hideonce: |
|
1225 | 1225 | arg.hideonce = False |
|
1226 | 1226 | return |
|
1227 | 1227 | |
|
1228 | 1228 | nlprint(arg) |
|
1229 | 1229 | |
|
1230 | 1230 | print_slist = result_display.when_type(SList)(print_slist) |
|
1231 | 1231 | |
|
1232 | 1232 | |
|
1233 | 1233 | |
|
1234 | 1234 | #---------------------------------------------------------------------------- |
|
1235 | 1235 | def esc_quotes(strng): |
|
1236 | 1236 | """Return the input string with single and double quotes escaped out""" |
|
1237 | 1237 | |
|
1238 | 1238 | return strng.replace('"','\\"').replace("'","\\'") |
|
1239 | 1239 | |
|
1240 | 1240 | #---------------------------------------------------------------------------- |
|
1241 | 1241 | def make_quoted_expr(s): |
|
1242 | 1242 | """Return string s in appropriate quotes, using raw string if possible. |
|
1243 | 1243 | |
|
1244 | 1244 | XXX - example removed because it caused encoding errors in documentation |
|
1245 | 1245 | generation. We need a new example that doesn't contain invalid chars. |
|
1246 | 1246 | |
|
1247 | 1247 | Note the use of raw string and padding at the end to allow trailing |
|
1248 | 1248 | backslash. |
|
1249 | 1249 | """ |
|
1250 | 1250 | |
|
1251 | 1251 | tail = '' |
|
1252 | 1252 | tailpadding = '' |
|
1253 | 1253 | raw = '' |
|
1254 | 1254 | if "\\" in s: |
|
1255 | 1255 | raw = 'r' |
|
1256 | 1256 | if s.endswith('\\'): |
|
1257 | 1257 | tail = '[:-1]' |
|
1258 | 1258 | tailpadding = '_' |
|
1259 | 1259 | if '"' not in s: |
|
1260 | 1260 | quote = '"' |
|
1261 | 1261 | elif "'" not in s: |
|
1262 | 1262 | quote = "'" |
|
1263 | 1263 | elif '"""' not in s and not s.endswith('"'): |
|
1264 | 1264 | quote = '"""' |
|
1265 | 1265 | elif "'''" not in s and not s.endswith("'"): |
|
1266 | 1266 | quote = "'''" |
|
1267 | 1267 | else: |
|
1268 | 1268 | # give up, backslash-escaped string will do |
|
1269 | 1269 | return '"%s"' % esc_quotes(s) |
|
1270 | 1270 | res = raw + quote + s + tailpadding + quote + tail |
|
1271 | 1271 | return res |
|
1272 | 1272 | |
|
1273 | 1273 | |
|
1274 | 1274 | #---------------------------------------------------------------------------- |
|
1275 | 1275 | def raw_input_multi(header='', ps1='==> ', ps2='..> ',terminate_str = '.'): |
|
1276 | 1276 | """Take multiple lines of input. |
|
1277 | 1277 | |
|
1278 | 1278 | A list with each line of input as a separate element is returned when a |
|
1279 | 1279 | termination string is entered (defaults to a single '.'). Input can also |
|
1280 | 1280 | terminate via EOF (^D in Unix, ^Z-RET in Windows). |
|
1281 | 1281 | |
|
1282 | 1282 | Lines of input which end in \\ are joined into single entries (and a |
|
1283 | 1283 | secondary continuation prompt is issued as long as the user terminates |
|
1284 | 1284 | lines with \\). This allows entering very long strings which are still |
|
1285 | 1285 | meant to be treated as single entities. |
|
1286 | 1286 | """ |
|
1287 | 1287 | |
|
1288 | 1288 | try: |
|
1289 | 1289 | if header: |
|
1290 | 1290 | header += '\n' |
|
1291 | 1291 | lines = [raw_input(header + ps1)] |
|
1292 | 1292 | except EOFError: |
|
1293 | 1293 | return [] |
|
1294 | 1294 | terminate = [terminate_str] |
|
1295 | 1295 | try: |
|
1296 | 1296 | while lines[-1:] != terminate: |
|
1297 | 1297 | new_line = raw_input(ps1) |
|
1298 | 1298 | while new_line.endswith('\\'): |
|
1299 | 1299 | new_line = new_line[:-1] + raw_input(ps2) |
|
1300 | 1300 | lines.append(new_line) |
|
1301 | 1301 | |
|
1302 | 1302 | return lines[:-1] # don't return the termination command |
|
1303 | 1303 | except EOFError: |
|
1304 | 1304 | |
|
1305 | 1305 | return lines |
|
1306 | 1306 | |
|
1307 | 1307 | #---------------------------------------------------------------------------- |
|
1308 | 1308 | def raw_input_ext(prompt='', ps2='... '): |
|
1309 | 1309 | """Similar to raw_input(), but accepts extended lines if input ends with \\.""" |
|
1310 | 1310 | |
|
1311 | 1311 | line = raw_input(prompt) |
|
1312 | 1312 | while line.endswith('\\'): |
|
1313 | 1313 | line = line[:-1] + raw_input(ps2) |
|
1314 | 1314 | return line |
|
1315 | 1315 | |
|
1316 | 1316 | #---------------------------------------------------------------------------- |
|
1317 | 1317 | def ask_yes_no(prompt,default=None): |
|
1318 | 1318 | """Asks a question and returns a boolean (y/n) answer. |
|
1319 | 1319 | |
|
1320 | 1320 | If default is given (one of 'y','n'), it is used if the user input is |
|
1321 | 1321 | empty. Otherwise the question is repeated until an answer is given. |
|
1322 | 1322 | |
|
1323 | 1323 | An EOF is treated as the default answer. If there is no default, an |
|
1324 | 1324 | exception is raised to prevent infinite loops. |
|
1325 | 1325 | |
|
1326 | 1326 | Valid answers are: y/yes/n/no (match is not case sensitive).""" |
|
1327 | 1327 | |
|
1328 | 1328 | answers = {'y':True,'n':False,'yes':True,'no':False} |
|
1329 | 1329 | ans = None |
|
1330 | 1330 | while ans not in answers.keys(): |
|
1331 | 1331 | try: |
|
1332 | 1332 | ans = raw_input(prompt+' ').lower() |
|
1333 | 1333 | if not ans: # response was an empty string |
|
1334 | 1334 | ans = default |
|
1335 | 1335 | except KeyboardInterrupt: |
|
1336 | 1336 | pass |
|
1337 | 1337 | except EOFError: |
|
1338 | 1338 | if default in answers.keys(): |
|
1339 | 1339 | ans = default |
|
1340 | 1340 | |
|
1341 | 1341 | else: |
|
1342 | 1342 | raise |
|
1343 | 1343 | |
|
1344 | 1344 | return answers[ans] |
|
1345 | 1345 | |
|
1346 | 1346 | #---------------------------------------------------------------------------- |
|
1347 | 1347 | def marquee(txt='',width=78,mark='*'): |
|
1348 | 1348 | """Return the input string centered in a 'marquee'.""" |
|
1349 | 1349 | if not txt: |
|
1350 | 1350 | return (mark*width)[:width] |
|
1351 | 1351 | nmark = (width-len(txt)-2)/len(mark)/2 |
|
1352 | 1352 | if nmark < 0: nmark =0 |
|
1353 | 1353 | marks = mark*nmark |
|
1354 | 1354 | return '%s %s %s' % (marks,txt,marks) |
|
1355 | 1355 | |
|
1356 | 1356 | #---------------------------------------------------------------------------- |
|
1357 | 1357 | class EvalDict: |
|
1358 | 1358 | """ |
|
1359 | 1359 | Emulate a dict which evaluates its contents in the caller's frame. |
|
1360 | 1360 | |
|
1361 | 1361 | Usage: |
|
1362 | 1362 | >>> number = 19 |
|
1363 | 1363 | |
|
1364 | 1364 | >>> text = "python" |
|
1365 | 1365 | |
|
1366 | 1366 | >>> print "%(text.capitalize())s %(number/9.0).1f rules!" % EvalDict() |
|
1367 | 1367 | Python 2.1 rules! |
|
1368 | 1368 | """ |
|
1369 | 1369 | |
|
1370 | 1370 | # This version is due to sismex01@hebmex.com on c.l.py, and is basically a |
|
1371 | 1371 | # modified (shorter) version of: |
|
1372 | 1372 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66018 by |
|
1373 | 1373 | # Skip Montanaro (skip@pobox.com). |
|
1374 | 1374 | |
|
1375 | 1375 | def __getitem__(self, name): |
|
1376 | 1376 | frame = sys._getframe(1) |
|
1377 | 1377 | return eval(name, frame.f_globals, frame.f_locals) |
|
1378 | 1378 | |
|
1379 | 1379 | EvalString = EvalDict # for backwards compatibility |
|
1380 | 1380 | #---------------------------------------------------------------------------- |
|
1381 | 1381 | def qw(words,flat=0,sep=None,maxsplit=-1): |
|
1382 | 1382 | """Similar to Perl's qw() operator, but with some more options. |
|
1383 | 1383 | |
|
1384 | 1384 | qw(words,flat=0,sep=' ',maxsplit=-1) -> words.split(sep,maxsplit) |
|
1385 | 1385 | |
|
1386 | 1386 | words can also be a list itself, and with flat=1, the output will be |
|
1387 | 1387 | recursively flattened. |
|
1388 | 1388 | |
|
1389 | 1389 | Examples: |
|
1390 | 1390 | |
|
1391 | 1391 | >>> qw('1 2') |
|
1392 | 1392 | ['1', '2'] |
|
1393 | 1393 | |
|
1394 | 1394 | >>> qw(['a b','1 2',['m n','p q']]) |
|
1395 | 1395 | [['a', 'b'], ['1', '2'], [['m', 'n'], ['p', 'q']]] |
|
1396 | 1396 | |
|
1397 | 1397 | >>> qw(['a b','1 2',['m n','p q']],flat=1) |
|
1398 | 1398 | ['a', 'b', '1', '2', 'm', 'n', 'p', 'q'] |
|
1399 | 1399 | """ |
|
1400 | 1400 | |
|
1401 | 1401 | if type(words) in StringTypes: |
|
1402 | 1402 | return [word.strip() for word in words.split(sep,maxsplit) |
|
1403 | 1403 | if word and not word.isspace() ] |
|
1404 | 1404 | if flat: |
|
1405 | 1405 | return flatten(map(qw,words,[1]*len(words))) |
|
1406 | 1406 | return map(qw,words) |
|
1407 | 1407 | |
|
1408 | 1408 | #---------------------------------------------------------------------------- |
|
1409 | 1409 | def qwflat(words,sep=None,maxsplit=-1): |
|
1410 | 1410 | """Calls qw(words) in flat mode. It's just a convenient shorthand.""" |
|
1411 | 1411 | return qw(words,1,sep,maxsplit) |
|
1412 | 1412 | |
|
1413 | 1413 | #---------------------------------------------------------------------------- |
|
1414 | 1414 | def qw_lol(indata): |
|
1415 | 1415 | """qw_lol('a b') -> [['a','b']], |
|
1416 | 1416 | otherwise it's just a call to qw(). |
|
1417 | 1417 | |
|
1418 | 1418 | We need this to make sure the modules_some keys *always* end up as a |
|
1419 | 1419 | list of lists.""" |
|
1420 | 1420 | |
|
1421 | 1421 | if type(indata) in StringTypes: |
|
1422 | 1422 | return [qw(indata)] |
|
1423 | 1423 | else: |
|
1424 | 1424 | return qw(indata) |
|
1425 | 1425 | |
|
1426 | 1426 | #----------------------------------------------------------------------------- |
|
1427 | 1427 | def list_strings(arg): |
|
1428 | 1428 | """Always return a list of strings, given a string or list of strings |
|
1429 | 1429 | as input.""" |
|
1430 | 1430 | |
|
1431 | 1431 | if type(arg) in StringTypes: return [arg] |
|
1432 | 1432 | else: return arg |
|
1433 | 1433 | |
|
1434 | 1434 | #---------------------------------------------------------------------------- |
|
1435 | 1435 | def grep(pat,list,case=1): |
|
1436 | 1436 | """Simple minded grep-like function. |
|
1437 | 1437 | grep(pat,list) returns occurrences of pat in list, None on failure. |
|
1438 | 1438 | |
|
1439 | 1439 | It only does simple string matching, with no support for regexps. Use the |
|
1440 | 1440 | option case=0 for case-insensitive matching.""" |
|
1441 | 1441 | |
|
1442 | 1442 | # This is pretty crude. At least it should implement copying only references |
|
1443 | 1443 | # to the original data in case it's big. Now it copies the data for output. |
|
1444 | 1444 | out=[] |
|
1445 | 1445 | if case: |
|
1446 | 1446 | for term in list: |
|
1447 | 1447 | if term.find(pat)>-1: out.append(term) |
|
1448 | 1448 | else: |
|
1449 | 1449 | lpat=pat.lower() |
|
1450 | 1450 | for term in list: |
|
1451 | 1451 | if term.lower().find(lpat)>-1: out.append(term) |
|
1452 | 1452 | |
|
1453 | 1453 | if len(out): return out |
|
1454 | 1454 | else: return None |
|
1455 | 1455 | |
|
1456 | 1456 | #---------------------------------------------------------------------------- |
|
1457 | 1457 | def dgrep(pat,*opts): |
|
1458 | 1458 | """Return grep() on dir()+dir(__builtins__). |
|
1459 | 1459 | |
|
1460 | 1460 | A very common use of grep() when working interactively.""" |
|
1461 | 1461 | |
|
1462 | 1462 | return grep(pat,dir(__main__)+dir(__main__.__builtins__),*opts) |
|
1463 | 1463 | |
|
1464 | 1464 | #---------------------------------------------------------------------------- |
|
1465 | 1465 | def idgrep(pat): |
|
1466 | 1466 | """Case-insensitive dgrep()""" |
|
1467 | 1467 | |
|
1468 | 1468 | return dgrep(pat,0) |
|
1469 | 1469 | |
|
1470 | 1470 | #---------------------------------------------------------------------------- |
|
1471 | 1471 | def igrep(pat,list): |
|
1472 | 1472 | """Synonym for case-insensitive grep.""" |
|
1473 | 1473 | |
|
1474 | 1474 | return grep(pat,list,case=0) |
|
1475 | 1475 | |
|
1476 | 1476 | #---------------------------------------------------------------------------- |
|
1477 | 1477 | def indent(str,nspaces=4,ntabs=0): |
|
1478 | 1478 | """Indent a string a given number of spaces or tabstops. |
|
1479 | 1479 | |
|
1480 | 1480 | indent(str,nspaces=4,ntabs=0) -> indent str by ntabs+nspaces. |
|
1481 | 1481 | """ |
|
1482 | 1482 | if str is None: |
|
1483 | 1483 | return |
|
1484 | 1484 | ind = '\t'*ntabs+' '*nspaces |
|
1485 | 1485 | outstr = '%s%s' % (ind,str.replace(os.linesep,os.linesep+ind)) |
|
1486 | 1486 | if outstr.endswith(os.linesep+ind): |
|
1487 | 1487 | return outstr[:-len(ind)] |
|
1488 | 1488 | else: |
|
1489 | 1489 | return outstr |
|
1490 | 1490 | |
|
1491 | 1491 | #----------------------------------------------------------------------------- |
|
1492 | 1492 | def native_line_ends(filename,backup=1): |
|
1493 | 1493 | """Convert (in-place) a file to line-ends native to the current OS. |
|
1494 | 1494 | |
|
1495 | 1495 | If the optional backup argument is given as false, no backup of the |
|
1496 | 1496 | original file is left. """ |
|
1497 | 1497 | |
|
1498 | 1498 | backup_suffixes = {'posix':'~','dos':'.bak','nt':'.bak','mac':'.bak'} |
|
1499 | 1499 | |
|
1500 | 1500 | bak_filename = filename + backup_suffixes[os.name] |
|
1501 | 1501 | |
|
1502 | 1502 | original = open(filename).read() |
|
1503 | 1503 | shutil.copy2(filename,bak_filename) |
|
1504 | 1504 | try: |
|
1505 | 1505 | new = open(filename,'wb') |
|
1506 | 1506 | new.write(os.linesep.join(original.splitlines())) |
|
1507 | 1507 | new.write(os.linesep) # ALWAYS put an eol at the end of the file |
|
1508 | 1508 | new.close() |
|
1509 | 1509 | except: |
|
1510 | 1510 | os.rename(bak_filename,filename) |
|
1511 | 1511 | if not backup: |
|
1512 | 1512 | try: |
|
1513 | 1513 | os.remove(bak_filename) |
|
1514 | 1514 | except: |
|
1515 | 1515 | pass |
|
1516 | 1516 | |
|
1517 | 1517 | #---------------------------------------------------------------------------- |
|
1518 | 1518 | def get_pager_cmd(pager_cmd = None): |
|
1519 | 1519 | """Return a pager command. |
|
1520 | 1520 | |
|
1521 | 1521 | Makes some attempts at finding an OS-correct one.""" |
|
1522 | 1522 | |
|
1523 | 1523 | if os.name == 'posix': |
|
1524 | 1524 | default_pager_cmd = 'less -r' # -r for color control sequences |
|
1525 | 1525 | elif os.name in ['nt','dos']: |
|
1526 | 1526 | default_pager_cmd = 'type' |
|
1527 | 1527 | |
|
1528 | 1528 | if pager_cmd is None: |
|
1529 | 1529 | try: |
|
1530 | 1530 | pager_cmd = os.environ['PAGER'] |
|
1531 | 1531 | except: |
|
1532 | 1532 | pager_cmd = default_pager_cmd |
|
1533 | 1533 | return pager_cmd |
|
1534 | 1534 | |
|
1535 | 1535 | #----------------------------------------------------------------------------- |
|
1536 | 1536 | def get_pager_start(pager,start): |
|
1537 | 1537 | """Return the string for paging files with an offset. |
|
1538 | 1538 | |
|
1539 | 1539 | This is the '+N' argument which less and more (under Unix) accept. |
|
1540 | 1540 | """ |
|
1541 | 1541 | |
|
1542 | 1542 | if pager in ['less','more']: |
|
1543 | 1543 | if start: |
|
1544 | 1544 | start_string = '+' + str(start) |
|
1545 | 1545 | else: |
|
1546 | 1546 | start_string = '' |
|
1547 | 1547 | else: |
|
1548 | 1548 | start_string = '' |
|
1549 | 1549 | return start_string |
|
1550 | 1550 | |
|
1551 | 1551 | #---------------------------------------------------------------------------- |
|
1552 | 1552 | # (X)emacs on W32 doesn't like to be bypassed with msvcrt.getch() |
|
1553 | 1553 | if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs': |
|
1554 | 1554 | import msvcrt |
|
1555 | 1555 | def page_more(): |
|
1556 | 1556 | """ Smart pausing between pages |
|
1557 | 1557 | |
|
1558 | 1558 | @return: True if need print more lines, False if quit |
|
1559 | 1559 | """ |
|
1560 | 1560 | Term.cout.write('---Return to continue, q to quit--- ') |
|
1561 | 1561 | ans = msvcrt.getch() |
|
1562 | 1562 | if ans in ("q", "Q"): |
|
1563 | 1563 | result = False |
|
1564 | 1564 | else: |
|
1565 | 1565 | result = True |
|
1566 | 1566 | Term.cout.write("\b"*37 + " "*37 + "\b"*37) |
|
1567 | 1567 | return result |
|
1568 | 1568 | else: |
|
1569 | 1569 | def page_more(): |
|
1570 | 1570 | ans = raw_input('---Return to continue, q to quit--- ') |
|
1571 | 1571 | if ans.lower().startswith('q'): |
|
1572 | 1572 | return False |
|
1573 | 1573 | else: |
|
1574 | 1574 | return True |
|
1575 | 1575 | |
|
1576 | 1576 | esc_re = re.compile(r"(\x1b[^m]+m)") |
|
1577 | 1577 | |
|
1578 | 1578 | def page_dumb(strng,start=0,screen_lines=25): |
|
1579 | 1579 | """Very dumb 'pager' in Python, for when nothing else works. |
|
1580 | 1580 | |
|
1581 | 1581 | Only moves forward, same interface as page(), except for pager_cmd and |
|
1582 | 1582 | mode.""" |
|
1583 | 1583 | |
|
1584 | 1584 | out_ln = strng.splitlines()[start:] |
|
1585 | 1585 | screens = chop(out_ln,screen_lines-1) |
|
1586 | 1586 | if len(screens) == 1: |
|
1587 | 1587 | print >>Term.cout, os.linesep.join(screens[0]) |
|
1588 | 1588 | else: |
|
1589 | 1589 | last_escape = "" |
|
1590 | 1590 | for scr in screens[0:-1]: |
|
1591 | 1591 | hunk = os.linesep.join(scr) |
|
1592 | 1592 | print >>Term.cout, last_escape + hunk |
|
1593 | 1593 | if not page_more(): |
|
1594 | 1594 | return |
|
1595 | 1595 | esc_list = esc_re.findall(hunk) |
|
1596 | 1596 | if len(esc_list) > 0: |
|
1597 | 1597 | last_escape = esc_list[-1] |
|
1598 | 1598 | print >>Term.cout, last_escape + os.linesep.join(screens[-1]) |
|
1599 | 1599 | |
|
1600 | 1600 | #---------------------------------------------------------------------------- |
|
1601 | 1601 | def page(strng,start=0,screen_lines=0,pager_cmd = None): |
|
1602 | 1602 | """Print a string, piping through a pager after a certain length. |
|
1603 | 1603 | |
|
1604 | 1604 | The screen_lines parameter specifies the number of *usable* lines of your |
|
1605 | 1605 | terminal screen (total lines minus lines you need to reserve to show other |
|
1606 | 1606 | information). |
|
1607 | 1607 | |
|
1608 | 1608 | If you set screen_lines to a number <=0, page() will try to auto-determine |
|
1609 | 1609 | your screen size and will only use up to (screen_size+screen_lines) for |
|
1610 | 1610 | printing, paging after that. That is, if you want auto-detection but need |
|
1611 | 1611 | to reserve the bottom 3 lines of the screen, use screen_lines = -3, and for |
|
1612 | 1612 | auto-detection without any lines reserved simply use screen_lines = 0. |
|
1613 | 1613 | |
|
1614 | 1614 | If a string won't fit in the allowed lines, it is sent through the |
|
1615 | 1615 | specified pager command. If none given, look for PAGER in the environment, |
|
1616 | 1616 | and ultimately default to less. |
|
1617 | 1617 | |
|
1618 | 1618 | If no system pager works, the string is sent through a 'dumb pager' |
|
1619 | 1619 | written in python, very simplistic. |
|
1620 | 1620 | """ |
|
1621 | 1621 | |
|
1622 | 1622 | # Some routines may auto-compute start offsets incorrectly and pass a |
|
1623 | 1623 | # negative value. Offset to 0 for robustness. |
|
1624 | 1624 | start = max(0,start) |
|
1625 | 1625 | |
|
1626 | 1626 | # first, try the hook |
|
1627 | 1627 | ip = IPython.ipapi.get() |
|
1628 | 1628 | if ip: |
|
1629 | 1629 | try: |
|
1630 | 1630 | ip.IP.hooks.show_in_pager(strng) |
|
1631 | 1631 | return |
|
1632 | 1632 | except IPython.ipapi.TryNext: |
|
1633 | 1633 | pass |
|
1634 | 1634 | |
|
1635 | 1635 | # Ugly kludge, but calling curses.initscr() flat out crashes in emacs |
|
1636 | 1636 | TERM = os.environ.get('TERM','dumb') |
|
1637 | 1637 | if TERM in ['dumb','emacs'] and os.name != 'nt': |
|
1638 | 1638 | print strng |
|
1639 | 1639 | return |
|
1640 | 1640 | # chop off the topmost part of the string we don't want to see |
|
1641 | 1641 | str_lines = strng.split(os.linesep)[start:] |
|
1642 | 1642 | str_toprint = os.linesep.join(str_lines) |
|
1643 | 1643 | num_newlines = len(str_lines) |
|
1644 | 1644 | len_str = len(str_toprint) |
|
1645 | 1645 | |
|
1646 | 1646 | # Dumb heuristics to guesstimate number of on-screen lines the string |
|
1647 | 1647 | # takes. Very basic, but good enough for docstrings in reasonable |
|
1648 | 1648 | # terminals. If someone later feels like refining it, it's not hard. |
|
1649 | 1649 | numlines = max(num_newlines,int(len_str/80)+1) |
|
1650 | 1650 | |
|
1651 | 1651 | if os.name == "nt": |
|
1652 | 1652 | screen_lines_def = get_console_size(defaulty=25)[1] |
|
1653 | 1653 | else: |
|
1654 | 1654 | screen_lines_def = 25 # default value if we can't auto-determine |
|
1655 | 1655 | |
|
1656 | 1656 | # auto-determine screen size |
|
1657 | 1657 | if screen_lines <= 0: |
|
1658 | 1658 | if TERM=='xterm': |
|
1659 | 1659 | use_curses = USE_CURSES |
|
1660 | 1660 | else: |
|
1661 | 1661 | # curses causes problems on many terminals other than xterm. |
|
1662 | 1662 | use_curses = False |
|
1663 | 1663 | if use_curses: |
|
1664 | 1664 | # There is a bug in curses, where *sometimes* it fails to properly |
|
1665 | 1665 | # initialize, and then after the endwin() call is made, the |
|
1666 | 1666 | # terminal is left in an unusable state. Rather than trying to |
|
1667 | 1667 | # check everytime for this (by requesting and comparing termios |
|
1668 | 1668 | # flags each time), we just save the initial terminal state and |
|
1669 | 1669 | # unconditionally reset it every time. It's cheaper than making |
|
1670 | 1670 | # the checks. |
|
1671 | 1671 | term_flags = termios.tcgetattr(sys.stdout) |
|
1672 | 1672 | scr = curses.initscr() |
|
1673 | 1673 | screen_lines_real,screen_cols = scr.getmaxyx() |
|
1674 | 1674 | curses.endwin() |
|
1675 | 1675 | # Restore terminal state in case endwin() didn't. |
|
1676 | 1676 | termios.tcsetattr(sys.stdout,termios.TCSANOW,term_flags) |
|
1677 | 1677 | # Now we have what we needed: the screen size in rows/columns |
|
1678 | 1678 | screen_lines += screen_lines_real |
|
1679 | 1679 | #print '***Screen size:',screen_lines_real,'lines x',\ |
|
1680 | 1680 | #screen_cols,'columns.' # dbg |
|
1681 | 1681 | else: |
|
1682 | 1682 | screen_lines += screen_lines_def |
|
1683 | 1683 | |
|
1684 | 1684 | #print 'numlines',numlines,'screenlines',screen_lines # dbg |
|
1685 | 1685 | if numlines <= screen_lines : |
|
1686 | 1686 | #print '*** normal print' # dbg |
|
1687 | 1687 | print >>Term.cout, str_toprint |
|
1688 | 1688 | else: |
|
1689 | 1689 | # Try to open pager and default to internal one if that fails. |
|
1690 | 1690 | # All failure modes are tagged as 'retval=1', to match the return |
|
1691 | 1691 | # value of a failed system command. If any intermediate attempt |
|
1692 | 1692 | # sets retval to 1, at the end we resort to our own page_dumb() pager. |
|
1693 | 1693 | pager_cmd = get_pager_cmd(pager_cmd) |
|
1694 | 1694 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) |
|
1695 | 1695 | if os.name == 'nt': |
|
1696 | 1696 | if pager_cmd.startswith('type'): |
|
1697 | 1697 | # The default WinXP 'type' command is failing on complex strings. |
|
1698 | 1698 | retval = 1 |
|
1699 | 1699 | else: |
|
1700 | 1700 | tmpname = tempfile.mktemp('.txt') |
|
1701 | 1701 | tmpfile = file(tmpname,'wt') |
|
1702 | 1702 | tmpfile.write(strng) |
|
1703 | 1703 | tmpfile.close() |
|
1704 | 1704 | cmd = "%s < %s" % (pager_cmd,tmpname) |
|
1705 | 1705 | if os.system(cmd): |
|
1706 | 1706 | retval = 1 |
|
1707 | 1707 | else: |
|
1708 | 1708 | retval = None |
|
1709 | 1709 | os.remove(tmpname) |
|
1710 | 1710 | else: |
|
1711 | 1711 | try: |
|
1712 | 1712 | retval = None |
|
1713 | 1713 | # if I use popen4, things hang. No idea why. |
|
1714 | 1714 | #pager,shell_out = os.popen4(pager_cmd) |
|
1715 | 1715 | pager = os.popen(pager_cmd,'w') |
|
1716 | 1716 | pager.write(strng) |
|
1717 | 1717 | pager.close() |
|
1718 | 1718 | retval = pager.close() # success returns None |
|
1719 | 1719 | except IOError,msg: # broken pipe when user quits |
|
1720 | 1720 | if msg.args == (32,'Broken pipe'): |
|
1721 | 1721 | retval = None |
|
1722 | 1722 | else: |
|
1723 | 1723 | retval = 1 |
|
1724 | 1724 | except OSError: |
|
1725 | 1725 | # Other strange problems, sometimes seen in Win2k/cygwin |
|
1726 | 1726 | retval = 1 |
|
1727 | 1727 | if retval is not None: |
|
1728 | 1728 | page_dumb(strng,screen_lines=screen_lines) |
|
1729 | 1729 | |
|
1730 | 1730 | #---------------------------------------------------------------------------- |
|
1731 | 1731 | def page_file(fname,start = 0, pager_cmd = None): |
|
1732 | 1732 | """Page a file, using an optional pager command and starting line. |
|
1733 | 1733 | """ |
|
1734 | 1734 | |
|
1735 | 1735 | pager_cmd = get_pager_cmd(pager_cmd) |
|
1736 | 1736 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) |
|
1737 | 1737 | |
|
1738 | 1738 | try: |
|
1739 | 1739 | if os.environ['TERM'] in ['emacs','dumb']: |
|
1740 | 1740 | raise EnvironmentError |
|
1741 | 1741 | xsys(pager_cmd + ' ' + fname) |
|
1742 | 1742 | except: |
|
1743 | 1743 | try: |
|
1744 | 1744 | if start > 0: |
|
1745 | 1745 | start -= 1 |
|
1746 | 1746 | page(open(fname).read(),start) |
|
1747 | 1747 | except: |
|
1748 | 1748 | print 'Unable to show file',`fname` |
|
1749 | 1749 | |
|
1750 | 1750 | |
|
1751 | 1751 | #---------------------------------------------------------------------------- |
|
1752 | 1752 | def snip_print(str,width = 75,print_full = 0,header = ''): |
|
1753 | 1753 | """Print a string snipping the midsection to fit in width. |
|
1754 | 1754 | |
|
1755 | 1755 | print_full: mode control: |
|
1756 | 1756 | - 0: only snip long strings |
|
1757 | 1757 | - 1: send to page() directly. |
|
1758 | 1758 | - 2: snip long strings and ask for full length viewing with page() |
|
1759 | 1759 | Return 1 if snipping was necessary, 0 otherwise.""" |
|
1760 | 1760 | |
|
1761 | 1761 | if print_full == 1: |
|
1762 | 1762 | page(header+str) |
|
1763 | 1763 | return 0 |
|
1764 | 1764 | |
|
1765 | 1765 | print header, |
|
1766 | 1766 | if len(str) < width: |
|
1767 | 1767 | print str |
|
1768 | 1768 | snip = 0 |
|
1769 | 1769 | else: |
|
1770 | 1770 | whalf = int((width -5)/2) |
|
1771 | 1771 | print str[:whalf] + ' <...> ' + str[-whalf:] |
|
1772 | 1772 | snip = 1 |
|
1773 | 1773 | if snip and print_full == 2: |
|
1774 | 1774 | if raw_input(header+' Snipped. View (y/n)? [N]').lower() == 'y': |
|
1775 | 1775 | page(str) |
|
1776 | 1776 | return snip |
|
1777 | 1777 | |
|
1778 | 1778 | #**************************************************************************** |
|
1779 | 1779 | # lists, dicts and structures |
|
1780 | 1780 | |
|
1781 | 1781 | def belong(candidates,checklist): |
|
1782 | 1782 | """Check whether a list of items appear in a given list of options. |
|
1783 | 1783 | |
|
1784 | 1784 | Returns a list of 1 and 0, one for each candidate given.""" |
|
1785 | 1785 | |
|
1786 | 1786 | return [x in checklist for x in candidates] |
|
1787 | 1787 | |
|
1788 | 1788 | #---------------------------------------------------------------------------- |
|
1789 | 1789 | def uniq_stable(elems): |
|
1790 | 1790 | """uniq_stable(elems) -> list |
|
1791 | 1791 | |
|
1792 | 1792 | Return from an iterable, a list of all the unique elements in the input, |
|
1793 | 1793 | but maintaining the order in which they first appear. |
|
1794 | 1794 | |
|
1795 | 1795 | A naive solution to this problem which just makes a dictionary with the |
|
1796 | 1796 | elements as keys fails to respect the stability condition, since |
|
1797 | 1797 | dictionaries are unsorted by nature. |
|
1798 | 1798 | |
|
1799 | 1799 | Note: All elements in the input must be valid dictionary keys for this |
|
1800 | 1800 | routine to work, as it internally uses a dictionary for efficiency |
|
1801 | 1801 | reasons.""" |
|
1802 | 1802 | |
|
1803 | 1803 | unique = [] |
|
1804 | 1804 | unique_dict = {} |
|
1805 | 1805 | for nn in elems: |
|
1806 | 1806 | if nn not in unique_dict: |
|
1807 | 1807 | unique.append(nn) |
|
1808 | 1808 | unique_dict[nn] = None |
|
1809 | 1809 | return unique |
|
1810 | 1810 | |
|
1811 | 1811 | #---------------------------------------------------------------------------- |
|
1812 | 1812 | class NLprinter: |
|
1813 | 1813 | """Print an arbitrarily nested list, indicating index numbers. |
|
1814 | 1814 | |
|
1815 | 1815 | An instance of this class called nlprint is available and callable as a |
|
1816 | 1816 | function. |
|
1817 | 1817 | |
|
1818 | 1818 | nlprint(list,indent=' ',sep=': ') -> prints indenting each level by 'indent' |
|
1819 | 1819 | and using 'sep' to separate the index from the value. """ |
|
1820 | 1820 | |
|
1821 | 1821 | def __init__(self): |
|
1822 | 1822 | self.depth = 0 |
|
1823 | 1823 | |
|
1824 | 1824 | def __call__(self,lst,pos='',**kw): |
|
1825 | 1825 | """Prints the nested list numbering levels.""" |
|
1826 | 1826 | kw.setdefault('indent',' ') |
|
1827 | 1827 | kw.setdefault('sep',': ') |
|
1828 | 1828 | kw.setdefault('start',0) |
|
1829 | 1829 | kw.setdefault('stop',len(lst)) |
|
1830 | 1830 | # we need to remove start and stop from kw so they don't propagate |
|
1831 | 1831 | # into a recursive call for a nested list. |
|
1832 | 1832 | start = kw['start']; del kw['start'] |
|
1833 | 1833 | stop = kw['stop']; del kw['stop'] |
|
1834 | 1834 | if self.depth == 0 and 'header' in kw.keys(): |
|
1835 | 1835 | print kw['header'] |
|
1836 | 1836 | |
|
1837 | 1837 | for idx in range(start,stop): |
|
1838 | 1838 | elem = lst[idx] |
|
1839 | 1839 | if type(elem)==type([]): |
|
1840 | 1840 | self.depth += 1 |
|
1841 | 1841 | self.__call__(elem,itpl('$pos$idx,'),**kw) |
|
1842 | 1842 | self.depth -= 1 |
|
1843 | 1843 | else: |
|
1844 | 1844 | printpl(kw['indent']*self.depth+'$pos$idx$kw["sep"]$elem') |
|
1845 | 1845 | |
|
1846 | 1846 | nlprint = NLprinter() |
|
1847 | 1847 | #---------------------------------------------------------------------------- |
|
1848 | 1848 | def all_belong(candidates,checklist): |
|
1849 | 1849 | """Check whether a list of items ALL appear in a given list of options. |
|
1850 | 1850 | |
|
1851 | 1851 | Returns a single 1 or 0 value.""" |
|
1852 | 1852 | |
|
1853 | 1853 | return 1-(0 in [x in checklist for x in candidates]) |
|
1854 | 1854 | |
|
1855 | 1855 | #---------------------------------------------------------------------------- |
|
1856 | 1856 | def sort_compare(lst1,lst2,inplace = 1): |
|
1857 | 1857 | """Sort and compare two lists. |
|
1858 | 1858 | |
|
1859 | 1859 | By default it does it in place, thus modifying the lists. Use inplace = 0 |
|
1860 | 1860 | to avoid that (at the cost of temporary copy creation).""" |
|
1861 | 1861 | if not inplace: |
|
1862 | 1862 | lst1 = lst1[:] |
|
1863 | 1863 | lst2 = lst2[:] |
|
1864 | 1864 | lst1.sort(); lst2.sort() |
|
1865 | 1865 | return lst1 == lst2 |
|
1866 | 1866 | |
|
1867 | 1867 | #---------------------------------------------------------------------------- |
|
1868 | 1868 | def list2dict(lst): |
|
1869 | 1869 | """Takes a list of (key,value) pairs and turns it into a dict.""" |
|
1870 | 1870 | |
|
1871 | 1871 | dic = {} |
|
1872 | 1872 | for k,v in lst: dic[k] = v |
|
1873 | 1873 | return dic |
|
1874 | 1874 | |
|
1875 | 1875 | #---------------------------------------------------------------------------- |
|
1876 | 1876 | def list2dict2(lst,default=''): |
|
1877 | 1877 | """Takes a list and turns it into a dict. |
|
1878 | 1878 | Much slower than list2dict, but more versatile. This version can take |
|
1879 | 1879 | lists with sublists of arbitrary length (including sclars).""" |
|
1880 | 1880 | |
|
1881 | 1881 | dic = {} |
|
1882 | 1882 | for elem in lst: |
|
1883 | 1883 | if type(elem) in (types.ListType,types.TupleType): |
|
1884 | 1884 | size = len(elem) |
|
1885 | 1885 | if size == 0: |
|
1886 | 1886 | pass |
|
1887 | 1887 | elif size == 1: |
|
1888 | 1888 | dic[elem] = default |
|
1889 | 1889 | else: |
|
1890 | 1890 | k,v = elem[0], elem[1:] |
|
1891 | 1891 | if len(v) == 1: v = v[0] |
|
1892 | 1892 | dic[k] = v |
|
1893 | 1893 | else: |
|
1894 | 1894 | dic[elem] = default |
|
1895 | 1895 | return dic |
|
1896 | 1896 | |
|
1897 | 1897 | #---------------------------------------------------------------------------- |
|
1898 | 1898 | def flatten(seq): |
|
1899 | 1899 | """Flatten a list of lists (NOT recursive, only works for 2d lists).""" |
|
1900 | 1900 | |
|
1901 | 1901 | return [x for subseq in seq for x in subseq] |
|
1902 | 1902 | |
|
1903 | 1903 | #---------------------------------------------------------------------------- |
|
1904 | 1904 | def get_slice(seq,start=0,stop=None,step=1): |
|
1905 | 1905 | """Get a slice of a sequence with variable step. Specify start,stop,step.""" |
|
1906 | 1906 | if stop == None: |
|
1907 | 1907 | stop = len(seq) |
|
1908 | 1908 | item = lambda i: seq[i] |
|
1909 | 1909 | return map(item,xrange(start,stop,step)) |
|
1910 | 1910 | |
|
1911 | 1911 | #---------------------------------------------------------------------------- |
|
1912 | 1912 | def chop(seq,size): |
|
1913 | 1913 | """Chop a sequence into chunks of the given size.""" |
|
1914 | 1914 | chunk = lambda i: seq[i:i+size] |
|
1915 | 1915 | return map(chunk,xrange(0,len(seq),size)) |
|
1916 | 1916 | |
|
1917 | 1917 | #---------------------------------------------------------------------------- |
|
1918 | 1918 | # with is a keyword as of python 2.5, so this function is renamed to withobj |
|
1919 | 1919 | # from its old 'with' name. |
|
1920 | 1920 | def with_obj(object, **args): |
|
1921 | 1921 | """Set multiple attributes for an object, similar to Pascal's with. |
|
1922 | 1922 | |
|
1923 | 1923 | Example: |
|
1924 | 1924 | with_obj(jim, |
|
1925 | 1925 | born = 1960, |
|
1926 | 1926 | haircolour = 'Brown', |
|
1927 | 1927 | eyecolour = 'Green') |
|
1928 | 1928 | |
|
1929 | 1929 | Credit: Greg Ewing, in |
|
1930 | 1930 | http://mail.python.org/pipermail/python-list/2001-May/040703.html. |
|
1931 | 1931 | |
|
1932 | 1932 | NOTE: up until IPython 0.7.2, this was called simply 'with', but 'with' |
|
1933 | 1933 | has become a keyword for Python 2.5, so we had to rename it.""" |
|
1934 | 1934 | |
|
1935 | 1935 | object.__dict__.update(args) |
|
1936 | 1936 | |
|
1937 | 1937 | #---------------------------------------------------------------------------- |
|
1938 | 1938 | def setattr_list(obj,alist,nspace = None): |
|
1939 | 1939 | """Set a list of attributes for an object taken from a namespace. |
|
1940 | 1940 | |
|
1941 | 1941 | setattr_list(obj,alist,nspace) -> sets in obj all the attributes listed in |
|
1942 | 1942 | alist with their values taken from nspace, which must be a dict (something |
|
1943 | 1943 | like locals() will often do) If nspace isn't given, locals() of the |
|
1944 | 1944 | *caller* is used, so in most cases you can omit it. |
|
1945 | 1945 | |
|
1946 | 1946 | Note that alist can be given as a string, which will be automatically |
|
1947 | 1947 | split into a list on whitespace. If given as a list, it must be a list of |
|
1948 | 1948 | *strings* (the variable names themselves), not of variables.""" |
|
1949 | 1949 | |
|
1950 | 1950 | # this grabs the local variables from the *previous* call frame -- that is |
|
1951 | 1951 | # the locals from the function that called setattr_list(). |
|
1952 | 1952 | # - snipped from weave.inline() |
|
1953 | 1953 | if nspace is None: |
|
1954 | 1954 | call_frame = sys._getframe().f_back |
|
1955 | 1955 | nspace = call_frame.f_locals |
|
1956 | 1956 | |
|
1957 | 1957 | if type(alist) in StringTypes: |
|
1958 | 1958 | alist = alist.split() |
|
1959 | 1959 | for attr in alist: |
|
1960 | 1960 | val = eval(attr,nspace) |
|
1961 | 1961 | setattr(obj,attr,val) |
|
1962 | 1962 | |
|
1963 | 1963 | #---------------------------------------------------------------------------- |
|
1964 | 1964 | def getattr_list(obj,alist,*args): |
|
1965 | 1965 | """getattr_list(obj,alist[, default]) -> attribute list. |
|
1966 | 1966 | |
|
1967 | 1967 | Get a list of named attributes for an object. When a default argument is |
|
1968 | 1968 | given, it is returned when the attribute doesn't exist; without it, an |
|
1969 | 1969 | exception is raised in that case. |
|
1970 | 1970 | |
|
1971 | 1971 | Note that alist can be given as a string, which will be automatically |
|
1972 | 1972 | split into a list on whitespace. If given as a list, it must be a list of |
|
1973 | 1973 | *strings* (the variable names themselves), not of variables.""" |
|
1974 | 1974 | |
|
1975 | 1975 | if type(alist) in StringTypes: |
|
1976 | 1976 | alist = alist.split() |
|
1977 | 1977 | if args: |
|
1978 | 1978 | if len(args)==1: |
|
1979 | 1979 | default = args[0] |
|
1980 | 1980 | return map(lambda attr: getattr(obj,attr,default),alist) |
|
1981 | 1981 | else: |
|
1982 | 1982 | raise ValueError,'getattr_list() takes only one optional argument' |
|
1983 | 1983 | else: |
|
1984 | 1984 | return map(lambda attr: getattr(obj,attr),alist) |
|
1985 | 1985 | |
|
1986 | 1986 | #---------------------------------------------------------------------------- |
|
1987 | 1987 | def map_method(method,object_list,*argseq,**kw): |
|
1988 | 1988 | """map_method(method,object_list,*args,**kw) -> list |
|
1989 | 1989 | |
|
1990 | 1990 | Return a list of the results of applying the methods to the items of the |
|
1991 | 1991 | argument sequence(s). If more than one sequence is given, the method is |
|
1992 | 1992 | called with an argument list consisting of the corresponding item of each |
|
1993 | 1993 | sequence. All sequences must be of the same length. |
|
1994 | 1994 | |
|
1995 | 1995 | Keyword arguments are passed verbatim to all objects called. |
|
1996 | 1996 | |
|
1997 | 1997 | This is Python code, so it's not nearly as fast as the builtin map().""" |
|
1998 | 1998 | |
|
1999 | 1999 | out_list = [] |
|
2000 | 2000 | idx = 0 |
|
2001 | 2001 | for object in object_list: |
|
2002 | 2002 | try: |
|
2003 | 2003 | handler = getattr(object, method) |
|
2004 | 2004 | except AttributeError: |
|
2005 | 2005 | out_list.append(None) |
|
2006 | 2006 | else: |
|
2007 | 2007 | if argseq: |
|
2008 | 2008 | args = map(lambda lst:lst[idx],argseq) |
|
2009 | 2009 | #print 'ob',object,'hand',handler,'ar',args # dbg |
|
2010 | 2010 | out_list.append(handler(args,**kw)) |
|
2011 | 2011 | else: |
|
2012 | 2012 | out_list.append(handler(**kw)) |
|
2013 | 2013 | idx += 1 |
|
2014 | 2014 | return out_list |
|
2015 | 2015 | |
|
2016 | 2016 | #---------------------------------------------------------------------------- |
|
2017 | 2017 | def get_class_members(cls): |
|
2018 | 2018 | ret = dir(cls) |
|
2019 | 2019 | if hasattr(cls,'__bases__'): |
|
2020 | 2020 | for base in cls.__bases__: |
|
2021 | 2021 | ret.extend(get_class_members(base)) |
|
2022 | 2022 | return ret |
|
2023 | 2023 | |
|
2024 | 2024 | #---------------------------------------------------------------------------- |
|
2025 | 2025 | def dir2(obj): |
|
2026 | 2026 | """dir2(obj) -> list of strings |
|
2027 | 2027 | |
|
2028 | 2028 | Extended version of the Python builtin dir(), which does a few extra |
|
2029 | 2029 | checks, and supports common objects with unusual internals that confuse |
|
2030 | 2030 | dir(), such as Traits and PyCrust. |
|
2031 | 2031 | |
|
2032 | 2032 | This version is guaranteed to return only a list of true strings, whereas |
|
2033 | 2033 | dir() returns anything that objects inject into themselves, even if they |
|
2034 | 2034 | are later not really valid for attribute access (many extension libraries |
|
2035 | 2035 | have such bugs). |
|
2036 | 2036 | """ |
|
2037 | 2037 | |
|
2038 | 2038 | # Start building the attribute list via dir(), and then complete it |
|
2039 | 2039 | # with a few extra special-purpose calls. |
|
2040 | 2040 | words = dir(obj) |
|
2041 | 2041 | |
|
2042 | 2042 | if hasattr(obj,'__class__'): |
|
2043 | 2043 | words.append('__class__') |
|
2044 | 2044 | words.extend(get_class_members(obj.__class__)) |
|
2045 | 2045 | #if '__base__' in words: 1/0 |
|
2046 | 2046 | |
|
2047 | 2047 | # Some libraries (such as traits) may introduce duplicates, we want to |
|
2048 | 2048 | # track and clean this up if it happens |
|
2049 | 2049 | may_have_dupes = False |
|
2050 | 2050 | |
|
2051 | 2051 | # this is the 'dir' function for objects with Enthought's traits |
|
2052 | 2052 | if hasattr(obj, 'trait_names'): |
|
2053 | 2053 | try: |
|
2054 | 2054 | words.extend(obj.trait_names()) |
|
2055 | 2055 | may_have_dupes = True |
|
2056 | 2056 | except TypeError: |
|
2057 | 2057 | # This will happen if `obj` is a class and not an instance. |
|
2058 | 2058 | pass |
|
2059 | 2059 | |
|
2060 | 2060 | # Support for PyCrust-style _getAttributeNames magic method. |
|
2061 | 2061 | if hasattr(obj, '_getAttributeNames'): |
|
2062 | 2062 | try: |
|
2063 | 2063 | words.extend(obj._getAttributeNames()) |
|
2064 | 2064 | may_have_dupes = True |
|
2065 | 2065 | except TypeError: |
|
2066 | 2066 | # `obj` is a class and not an instance. Ignore |
|
2067 | 2067 | # this error. |
|
2068 | 2068 | pass |
|
2069 | 2069 | |
|
2070 | 2070 | if may_have_dupes: |
|
2071 | 2071 | # eliminate possible duplicates, as some traits may also |
|
2072 | 2072 | # appear as normal attributes in the dir() call. |
|
2073 | 2073 | words = list(set(words)) |
|
2074 | 2074 | words.sort() |
|
2075 | 2075 | |
|
2076 | 2076 | # filter out non-string attributes which may be stuffed by dir() calls |
|
2077 | 2077 | # and poor coding in third-party modules |
|
2078 | 2078 | return [w for w in words if isinstance(w, basestring)] |
|
2079 | 2079 | |
|
2080 | 2080 | #---------------------------------------------------------------------------- |
|
2081 | 2081 | def import_fail_info(mod_name,fns=None): |
|
2082 | 2082 | """Inform load failure for a module.""" |
|
2083 | 2083 | |
|
2084 | 2084 | if fns == None: |
|
2085 | 2085 | warn("Loading of %s failed.\n" % (mod_name,)) |
|
2086 | 2086 | else: |
|
2087 | 2087 | warn("Loading of %s from %s failed.\n" % (fns,mod_name)) |
|
2088 | 2088 | |
|
2089 | 2089 | #---------------------------------------------------------------------------- |
|
2090 | 2090 | # Proposed popitem() extension, written as a method |
|
2091 | 2091 | |
|
2092 | 2092 | |
|
2093 | 2093 | class NotGiven: pass |
|
2094 | 2094 | |
|
2095 | 2095 | def popkey(dct,key,default=NotGiven): |
|
2096 | 2096 | """Return dct[key] and delete dct[key]. |
|
2097 | 2097 | |
|
2098 | 2098 | If default is given, return it if dct[key] doesn't exist, otherwise raise |
|
2099 | 2099 | KeyError. """ |
|
2100 | 2100 | |
|
2101 | 2101 | try: |
|
2102 | 2102 | val = dct[key] |
|
2103 | 2103 | except KeyError: |
|
2104 | 2104 | if default is NotGiven: |
|
2105 | 2105 | raise |
|
2106 | 2106 | else: |
|
2107 | 2107 | return default |
|
2108 | 2108 | else: |
|
2109 | 2109 | del dct[key] |
|
2110 | 2110 | return val |
|
2111 | 2111 | |
|
2112 | 2112 | def wrap_deprecated(func, suggest = '<nothing>'): |
|
2113 | 2113 | def newFunc(*args, **kwargs): |
|
2114 | 2114 | warnings.warn("Call to deprecated function %s, use %s instead" % |
|
2115 | 2115 | ( func.__name__, suggest), |
|
2116 | 2116 | category=DeprecationWarning, |
|
2117 | 2117 | stacklevel = 2) |
|
2118 | 2118 | return func(*args, **kwargs) |
|
2119 | 2119 | return newFunc |
|
2120 | 2120 | |
|
2121 | 2121 | |
|
2122 | 2122 | def _num_cpus_unix(): |
|
2123 | 2123 | """Return the number of active CPUs on a Unix system.""" |
|
2124 | 2124 | return os.sysconf("SC_NPROCESSORS_ONLN") |
|
2125 | 2125 | |
|
2126 | 2126 | |
|
2127 | 2127 | def _num_cpus_darwin(): |
|
2128 | 2128 | """Return the number of active CPUs on a Darwin system.""" |
|
2129 | 2129 | p = subprocess.Popen(['sysctl','-n','hw.ncpu'],stdout=subprocess.PIPE) |
|
2130 | 2130 | return p.stdout.read() |
|
2131 | 2131 | |
|
2132 | 2132 | |
|
2133 | 2133 | def _num_cpus_windows(): |
|
2134 | 2134 | """Return the number of active CPUs on a Windows system.""" |
|
2135 | 2135 | return os.environ.get("NUMBER_OF_PROCESSORS") |
|
2136 | 2136 | |
|
2137 | 2137 | |
|
2138 | 2138 | def num_cpus(): |
|
2139 | 2139 | """Return the effective number of CPUs in the system as an integer. |
|
2140 | 2140 | |
|
2141 | 2141 | This cross-platform function makes an attempt at finding the total number of |
|
2142 | 2142 | available CPUs in the system, as returned by various underlying system and |
|
2143 | 2143 | python calls. |
|
2144 | 2144 | |
|
2145 | 2145 | If it can't find a sensible answer, it returns 1 (though an error *may* make |
|
2146 | 2146 | it return a large positive number that's actually incorrect). |
|
2147 | 2147 | """ |
|
2148 | 2148 | |
|
2149 | 2149 | # Many thanks to the Parallel Python project (http://www.parallelpython.com) |
|
2150 | 2150 | # for the names of the keys we needed to look up for this function. This |
|
2151 | 2151 | # code was inspired by their equivalent function. |
|
2152 | 2152 | |
|
2153 | 2153 | ncpufuncs = {'Linux':_num_cpus_unix, |
|
2154 | 2154 | 'Darwin':_num_cpus_darwin, |
|
2155 | 2155 | 'Windows':_num_cpus_windows, |
|
2156 | 2156 | # On Vista, python < 2.5.2 has a bug and returns 'Microsoft' |
|
2157 | 2157 | # See http://bugs.python.org/issue1082 for details. |
|
2158 | 2158 | 'Microsoft':_num_cpus_windows, |
|
2159 | 2159 | } |
|
2160 | 2160 | |
|
2161 | 2161 | ncpufunc = ncpufuncs.get(platform.system(), |
|
2162 | 2162 | # default to unix version (Solaris, AIX, etc) |
|
2163 | 2163 | _num_cpus_unix) |
|
2164 | 2164 | |
|
2165 | 2165 | try: |
|
2166 | 2166 | ncpus = max(1,int(ncpufunc())) |
|
2167 | 2167 | except: |
|
2168 | 2168 | ncpus = 1 |
|
2169 | 2169 | return ncpus |
|
2170 | 2170 | |
|
2171 | 2171 | #*************************** end of file <genutils.py> ********************** |
@@ -1,2870 +1,2870 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | IPython -- An enhanced Interactive Python |
|
4 | 4 | |
|
5 | 5 | Requires Python 2.4 or newer. |
|
6 | 6 | |
|
7 | 7 | This file contains all the classes and helper functions specific to IPython. |
|
8 | 8 | """ |
|
9 | 9 | |
|
10 | 10 | #***************************************************************************** |
|
11 | 11 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
12 | 12 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
13 | 13 | # |
|
14 | 14 | # Distributed under the terms of the BSD License. The full license is in |
|
15 | 15 | # the file COPYING, distributed as part of this software. |
|
16 | 16 | # |
|
17 | 17 | # Note: this code originally subclassed code.InteractiveConsole from the |
|
18 | 18 | # Python standard library. Over time, all of that class has been copied |
|
19 | 19 | # verbatim here for modifications which could not be accomplished by |
|
20 | 20 | # subclassing. At this point, there are no dependencies at all on the code |
|
21 | 21 | # module anymore (it is not even imported). The Python License (sec. 2) |
|
22 | 22 | # allows for this, but it's always nice to acknowledge credit where credit is |
|
23 | 23 | # due. |
|
24 | 24 | #***************************************************************************** |
|
25 | 25 | |
|
26 | 26 | #**************************************************************************** |
|
27 | 27 | # Modules and globals |
|
28 | 28 | |
|
29 | 29 | # Python standard modules |
|
30 | 30 | import __main__ |
|
31 | 31 | import __builtin__ |
|
32 | 32 | import StringIO |
|
33 | 33 | import bdb |
|
34 | 34 | import cPickle as pickle |
|
35 | 35 | import codeop |
|
36 | 36 | import exceptions |
|
37 | 37 | import glob |
|
38 | 38 | import inspect |
|
39 | 39 | import keyword |
|
40 | 40 | import new |
|
41 | 41 | import os |
|
42 | 42 | import pydoc |
|
43 | 43 | import re |
|
44 | 44 | import shutil |
|
45 | 45 | import string |
|
46 | 46 | import sys |
|
47 | 47 | import tempfile |
|
48 | 48 | import traceback |
|
49 | 49 | import types |
|
50 | 50 | from pprint import pprint, pformat |
|
51 | 51 | |
|
52 | 52 | # IPython's own modules |
|
53 | 53 | #import IPython |
|
54 | 54 | from IPython import Debugger,OInspect,PyColorize,ultraTB |
|
55 | 55 | from IPython.ColorANSI import ColorScheme,ColorSchemeTable # too long names |
|
56 | 56 | from IPython.Extensions import pickleshare |
|
57 | 57 | from IPython.FakeModule import FakeModule, init_fakemod_dict |
|
58 | 58 | from IPython.Itpl import Itpl,itpl,printpl,ItplNS,itplns |
|
59 | 59 | from IPython.Logger import Logger |
|
60 | 60 | from IPython.Magic import Magic |
|
61 | 61 | from IPython.Prompts import CachedOutput |
|
62 | 62 | from IPython.ipstruct import Struct |
|
63 | 63 | from IPython.background_jobs import BackgroundJobManager |
|
64 | 64 | from IPython.usage import cmd_line_usage,interactive_usage |
|
65 | 65 | from IPython.genutils import * |
|
66 | 66 | from IPython.strdispatch import StrDispatch |
|
67 | 67 | import IPython.ipapi |
|
68 | 68 | import IPython.history |
|
69 | 69 | import IPython.prefilter as prefilter |
|
70 | 70 | import IPython.shadowns |
|
71 | 71 | # Globals |
|
72 | 72 | |
|
73 | 73 | # store the builtin raw_input globally, and use this always, in case user code |
|
74 | 74 | # overwrites it (like wx.py.PyShell does) |
|
75 | 75 | raw_input_original = raw_input |
|
76 | 76 | |
|
77 | 77 | # compiled regexps for autoindent management |
|
78 | 78 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
79 | 79 | |
|
80 | 80 | |
|
81 | 81 | #**************************************************************************** |
|
82 | 82 | # Some utility function definitions |
|
83 | 83 | |
|
84 | 84 | ini_spaces_re = re.compile(r'^(\s+)') |
|
85 | 85 | |
|
86 | 86 | def num_ini_spaces(strng): |
|
87 | 87 | """Return the number of initial spaces in a string""" |
|
88 | 88 | |
|
89 | 89 | ini_spaces = ini_spaces_re.match(strng) |
|
90 | 90 | if ini_spaces: |
|
91 | 91 | return ini_spaces.end() |
|
92 | 92 | else: |
|
93 | 93 | return 0 |
|
94 | 94 | |
|
95 | 95 | def softspace(file, newvalue): |
|
96 | 96 | """Copied from code.py, to remove the dependency""" |
|
97 | 97 | |
|
98 | 98 | oldvalue = 0 |
|
99 | 99 | try: |
|
100 | 100 | oldvalue = file.softspace |
|
101 | 101 | except AttributeError: |
|
102 | 102 | pass |
|
103 | 103 | try: |
|
104 | 104 | file.softspace = newvalue |
|
105 | 105 | except (AttributeError, TypeError): |
|
106 | 106 | # "attribute-less object" or "read-only attributes" |
|
107 | 107 | pass |
|
108 | 108 | return oldvalue |
|
109 | 109 | |
|
110 | 110 | |
|
111 | 111 | def user_setup(ipythondir,rc_suffix,mode='install',interactive=True): |
|
112 | 112 | """Install or upgrade the user configuration directory. |
|
113 | 113 | |
|
114 | 114 | Can be called when running for the first time or to upgrade the user's |
|
115 | 115 | .ipython/ directory. |
|
116 | 116 | |
|
117 | 117 | Parameters |
|
118 | 118 | ---------- |
|
119 | 119 | ipythondir : path |
|
120 | 120 | The directory to be used for installation/upgrade. In 'install' mode, |
|
121 | 121 | if this path already exists, the function exits immediately. |
|
122 | 122 | |
|
123 | 123 | rc_suffix : str |
|
124 | 124 | Extension for the config files. On *nix platforms it is typically the |
|
125 | 125 | empty string, while Windows normally uses '.ini'. |
|
126 | 126 | |
|
127 | 127 | mode : str, optional |
|
128 | 128 | Valid modes are 'install' and 'upgrade'. |
|
129 | 129 | |
|
130 | 130 | interactive : bool, optional |
|
131 | 131 | If False, do not wait for user input on any errors. Normally after |
|
132 | 132 | printing its status information, this function waits for the user to |
|
133 | 133 | hit Return before proceeding. This is because the default use case is |
|
134 | 134 | when first installing the IPython configuration, so we want the user to |
|
135 | 135 | acknowledge the initial message, which contains some useful |
|
136 | 136 | information. |
|
137 | 137 | """ |
|
138 | 138 | |
|
139 | 139 | # For automatic use, deactivate all i/o |
|
140 | 140 | if interactive: |
|
141 | 141 | def wait(): |
|
142 | 142 | try: |
|
143 | 143 | raw_input("Please press <RETURN> to start IPython.") |
|
144 | 144 | except EOFError: |
|
145 | 145 | print >> Term.cout |
|
146 | 146 | print '*'*70 |
|
147 | 147 | |
|
148 | 148 | def printf(s): |
|
149 | 149 | print s |
|
150 | 150 | else: |
|
151 | 151 | wait = lambda : None |
|
152 | 152 | printf = lambda s : None |
|
153 | 153 | |
|
154 | 154 | # Install mode should be re-entrant: if the install dir already exists, |
|
155 | 155 | # bail out cleanly. |
|
156 | 156 | # XXX. This is too hasty to return. We need to check to make sure that |
|
157 | 157 | # all the expected config files and directories are actually there. We |
|
158 | 158 | # currently have a failure mode if someone deletes a needed config file |
|
159 | 159 | # but still has the ipythondir. |
|
160 | 160 | if mode == 'install' and os.path.isdir(ipythondir): |
|
161 | 161 | return |
|
162 | 162 | |
|
163 | 163 | cwd = os.getcwd() # remember where we started |
|
164 | 164 | glb = glob.glob |
|
165 | 165 | |
|
166 | 166 | printf('*'*70) |
|
167 | 167 | if mode == 'install': |
|
168 | 168 | printf( |
|
169 | 169 | """Welcome to IPython. I will try to create a personal configuration directory |
|
170 | 170 | where you can customize many aspects of IPython's functionality in:\n""") |
|
171 | 171 | else: |
|
172 | 172 | printf('I am going to upgrade your configuration in:') |
|
173 | 173 | |
|
174 | 174 | printf(ipythondir) |
|
175 | 175 | |
|
176 | 176 | rcdirend = os.path.join('IPython','UserConfig') |
|
177 | 177 | cfg = lambda d: os.path.join(d,rcdirend) |
|
178 | 178 | try: |
|
179 | 179 | rcdir = filter(os.path.isdir,map(cfg,sys.path))[0] |
|
180 | 180 | printf("Initializing from configuration: %s" % rcdir) |
|
181 | 181 | except IndexError: |
|
182 | 182 | warning = """ |
|
183 | 183 | Installation error. IPython's directory was not found. |
|
184 | 184 | |
|
185 | 185 | Check the following: |
|
186 | 186 | |
|
187 | 187 | The ipython/IPython directory should be in a directory belonging to your |
|
188 | 188 | PYTHONPATH environment variable (that is, it should be in a directory |
|
189 | 189 | belonging to sys.path). You can copy it explicitly there or just link to it. |
|
190 | 190 | |
|
191 | 191 | IPython will create a minimal default configuration for you. |
|
192 | 192 | |
|
193 | 193 | """ |
|
194 | 194 | warn(warning) |
|
195 | 195 | wait() |
|
196 | 196 | |
|
197 | 197 | if sys.platform =='win32': |
|
198 | 198 | inif = 'ipythonrc.ini' |
|
199 | 199 | else: |
|
200 | 200 | inif = 'ipythonrc' |
|
201 | 201 | minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', |
|
202 | 202 | inif : '# intentionally left blank' } |
|
203 | 203 | os.makedirs(ipythondir, mode = 0777) |
|
204 | 204 | for f, cont in minimal_setup.items(): |
|
205 | 205 | # In 2.5, this can be more cleanly done using 'with' |
|
206 | 206 | fobj = file(ipythondir + '/' + f,'w') |
|
207 | 207 | fobj.write(cont) |
|
208 | 208 | fobj.close() |
|
209 | 209 | |
|
210 | 210 | return |
|
211 | 211 | |
|
212 | 212 | if mode == 'install': |
|
213 | 213 | try: |
|
214 | 214 | shutil.copytree(rcdir,ipythondir) |
|
215 | 215 | os.chdir(ipythondir) |
|
216 | 216 | rc_files = glb("ipythonrc*") |
|
217 | 217 | for rc_file in rc_files: |
|
218 | 218 | os.rename(rc_file,rc_file+rc_suffix) |
|
219 | 219 | except: |
|
220 | 220 | warning = """ |
|
221 | 221 | |
|
222 | 222 | There was a problem with the installation: |
|
223 | 223 | %s |
|
224 | 224 | Try to correct it or contact the developers if you think it's a bug. |
|
225 | 225 | IPython will proceed with builtin defaults.""" % sys.exc_info()[1] |
|
226 | 226 | warn(warning) |
|
227 | 227 | wait() |
|
228 | 228 | return |
|
229 | 229 | |
|
230 | 230 | elif mode == 'upgrade': |
|
231 | 231 | try: |
|
232 | 232 | os.chdir(ipythondir) |
|
233 | 233 | except: |
|
234 | 234 | printf(""" |
|
235 | 235 | Can not upgrade: changing to directory %s failed. Details: |
|
236 | 236 | %s |
|
237 | 237 | """ % (ipythondir,sys.exc_info()[1]) ) |
|
238 | 238 | wait() |
|
239 | 239 | return |
|
240 | 240 | else: |
|
241 | 241 | sources = glb(os.path.join(rcdir,'[A-Za-z]*')) |
|
242 | 242 | for new_full_path in sources: |
|
243 | 243 | new_filename = os.path.basename(new_full_path) |
|
244 | 244 | if new_filename.startswith('ipythonrc'): |
|
245 | 245 | new_filename = new_filename + rc_suffix |
|
246 | 246 | # The config directory should only contain files, skip any |
|
247 | 247 | # directories which may be there (like CVS) |
|
248 | 248 | if os.path.isdir(new_full_path): |
|
249 | 249 | continue |
|
250 | 250 | if os.path.exists(new_filename): |
|
251 | 251 | old_file = new_filename+'.old' |
|
252 | 252 | if os.path.exists(old_file): |
|
253 | 253 | os.remove(old_file) |
|
254 | 254 | os.rename(new_filename,old_file) |
|
255 | 255 | shutil.copy(new_full_path,new_filename) |
|
256 | 256 | else: |
|
257 | 257 | raise ValueError('unrecognized mode for install: %r' % mode) |
|
258 | 258 | |
|
259 | 259 | # Fix line-endings to those native to each platform in the config |
|
260 | 260 | # directory. |
|
261 | 261 | try: |
|
262 | 262 | os.chdir(ipythondir) |
|
263 | 263 | except: |
|
264 | 264 | printf(""" |
|
265 | 265 | Problem: changing to directory %s failed. |
|
266 | 266 | Details: |
|
267 | 267 | %s |
|
268 | 268 | |
|
269 | 269 | Some configuration files may have incorrect line endings. This should not |
|
270 | 270 | cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) ) |
|
271 | 271 | wait() |
|
272 | 272 | else: |
|
273 | 273 | for fname in glb('ipythonrc*'): |
|
274 | 274 | try: |
|
275 | 275 | native_line_ends(fname,backup=0) |
|
276 | 276 | except IOError: |
|
277 | 277 | pass |
|
278 | 278 | |
|
279 | 279 | if mode == 'install': |
|
280 | 280 | printf(""" |
|
281 | 281 | Successful installation! |
|
282 | 282 | |
|
283 | 283 | Please read the sections 'Initial Configuration' and 'Quick Tips' in the |
|
284 | 284 | IPython manual (there are both HTML and PDF versions supplied with the |
|
285 | 285 | distribution) to make sure that your system environment is properly configured |
|
286 | 286 | to take advantage of IPython's features. |
|
287 | 287 | |
|
288 | 288 | Important note: the configuration system has changed! The old system is |
|
289 | 289 | still in place, but its setting may be partly overridden by the settings in |
|
290 | 290 | "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file |
|
291 | 291 | if some of the new settings bother you. |
|
292 | 292 | |
|
293 | 293 | """) |
|
294 | 294 | else: |
|
295 | 295 | printf(""" |
|
296 | 296 | Successful upgrade! |
|
297 | 297 | |
|
298 | 298 | All files in your directory: |
|
299 | 299 | %(ipythondir)s |
|
300 | 300 | which would have been overwritten by the upgrade were backed up with a .old |
|
301 | 301 | extension. If you had made particular customizations in those files you may |
|
302 | 302 | want to merge them back into the new files.""" % locals() ) |
|
303 | 303 | wait() |
|
304 | 304 | os.chdir(cwd) |
|
305 | 305 | |
|
306 | 306 | #**************************************************************************** |
|
307 | 307 | # Local use exceptions |
|
308 | 308 | class SpaceInInput(exceptions.Exception): pass |
|
309 | 309 | |
|
310 | 310 | |
|
311 | 311 | #**************************************************************************** |
|
312 | 312 | # Local use classes |
|
313 | 313 | class Bunch: pass |
|
314 | 314 | |
|
315 | 315 | class Undefined: pass |
|
316 | 316 | |
|
317 | 317 | class Quitter(object): |
|
318 | 318 | """Simple class to handle exit, similar to Python 2.5's. |
|
319 | 319 | |
|
320 | 320 | It handles exiting in an ipython-safe manner, which the one in Python 2.5 |
|
321 | 321 | doesn't do (obviously, since it doesn't know about ipython).""" |
|
322 | 322 | |
|
323 | 323 | def __init__(self,shell,name): |
|
324 | 324 | self.shell = shell |
|
325 | 325 | self.name = name |
|
326 | 326 | |
|
327 | 327 | def __repr__(self): |
|
328 | 328 | return 'Type %s() to exit.' % self.name |
|
329 | 329 | __str__ = __repr__ |
|
330 | 330 | |
|
331 | 331 | def __call__(self): |
|
332 | 332 | self.shell.exit() |
|
333 | 333 | |
|
334 | 334 | class InputList(list): |
|
335 | 335 | """Class to store user input. |
|
336 | 336 | |
|
337 | 337 | It's basically a list, but slices return a string instead of a list, thus |
|
338 | 338 | allowing things like (assuming 'In' is an instance): |
|
339 | 339 | |
|
340 | 340 | exec In[4:7] |
|
341 | 341 | |
|
342 | 342 | or |
|
343 | 343 | |
|
344 | 344 | exec In[5:9] + In[14] + In[21:25]""" |
|
345 | 345 | |
|
346 | 346 | def __getslice__(self,i,j): |
|
347 | 347 | return ''.join(list.__getslice__(self,i,j)) |
|
348 | 348 | |
|
349 | 349 | class SyntaxTB(ultraTB.ListTB): |
|
350 | 350 | """Extension which holds some state: the last exception value""" |
|
351 | 351 | |
|
352 | 352 | def __init__(self,color_scheme = 'NoColor'): |
|
353 | 353 | ultraTB.ListTB.__init__(self,color_scheme) |
|
354 | 354 | self.last_syntax_error = None |
|
355 | 355 | |
|
356 | 356 | def __call__(self, etype, value, elist): |
|
357 | 357 | self.last_syntax_error = value |
|
358 | 358 | ultraTB.ListTB.__call__(self,etype,value,elist) |
|
359 | 359 | |
|
360 | 360 | def clear_err_state(self): |
|
361 | 361 | """Return the current error state and clear it""" |
|
362 | 362 | e = self.last_syntax_error |
|
363 | 363 | self.last_syntax_error = None |
|
364 | 364 | return e |
|
365 | 365 | |
|
366 | 366 | #**************************************************************************** |
|
367 | 367 | # Main IPython class |
|
368 | 368 | |
|
369 | 369 | # FIXME: the Magic class is a mixin for now, and will unfortunately remain so |
|
370 | 370 | # until a full rewrite is made. I've cleaned all cross-class uses of |
|
371 | 371 | # attributes and methods, but too much user code out there relies on the |
|
372 | 372 | # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage. |
|
373 | 373 | # |
|
374 | 374 | # But at least now, all the pieces have been separated and we could, in |
|
375 | 375 | # principle, stop using the mixin. This will ease the transition to the |
|
376 | 376 | # chainsaw branch. |
|
377 | 377 | |
|
378 | 378 | # For reference, the following is the list of 'self.foo' uses in the Magic |
|
379 | 379 | # class as of 2005-12-28. These are names we CAN'T use in the main ipython |
|
380 | 380 | # class, to prevent clashes. |
|
381 | 381 | |
|
382 | 382 | # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind', |
|
383 | 383 | # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic', |
|
384 | 384 | # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell', |
|
385 | 385 | # 'self.value'] |
|
386 | 386 | |
|
387 | 387 | class InteractiveShell(object,Magic): |
|
388 | 388 | """An enhanced console for Python.""" |
|
389 | 389 | |
|
390 | 390 | # class attribute to indicate whether the class supports threads or not. |
|
391 | 391 | # Subclasses with thread support should override this as needed. |
|
392 | 392 | isthreaded = False |
|
393 | 393 | |
|
394 | 394 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
395 | 395 | user_ns=None,user_global_ns=None,banner2='', |
|
396 | 396 | custom_exceptions=((),None),embedded=False): |
|
397 | 397 | |
|
398 | 398 | # log system |
|
399 | 399 | self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate') |
|
400 | 400 | |
|
401 | 401 | # Job manager (for jobs run as background threads) |
|
402 | 402 | self.jobs = BackgroundJobManager() |
|
403 | 403 | |
|
404 | 404 | # Store the actual shell's name |
|
405 | 405 | self.name = name |
|
406 | 406 | self.more = False |
|
407 | 407 | |
|
408 | 408 | # We need to know whether the instance is meant for embedding, since |
|
409 | 409 | # global/local namespaces need to be handled differently in that case |
|
410 | 410 | self.embedded = embedded |
|
411 | 411 | if embedded: |
|
412 | 412 | # Control variable so users can, from within the embedded instance, |
|
413 | 413 | # permanently deactivate it. |
|
414 | 414 | self.embedded_active = True |
|
415 | 415 | |
|
416 | 416 | # command compiler |
|
417 | 417 | self.compile = codeop.CommandCompiler() |
|
418 | 418 | |
|
419 | 419 | # User input buffer |
|
420 | 420 | self.buffer = [] |
|
421 | 421 | |
|
422 | 422 | # Default name given in compilation of code |
|
423 | 423 | self.filename = '<ipython console>' |
|
424 | 424 | |
|
425 | 425 | # Install our own quitter instead of the builtins. For python2.3-2.4, |
|
426 | 426 | # this brings in behavior like 2.5, and for 2.5 it's identical. |
|
427 | 427 | __builtin__.exit = Quitter(self,'exit') |
|
428 | 428 | __builtin__.quit = Quitter(self,'quit') |
|
429 | 429 | |
|
430 | 430 | # Make an empty namespace, which extension writers can rely on both |
|
431 | 431 | # existing and NEVER being used by ipython itself. This gives them a |
|
432 | 432 | # convenient location for storing additional information and state |
|
433 | 433 | # their extensions may require, without fear of collisions with other |
|
434 | 434 | # ipython names that may develop later. |
|
435 | 435 | self.meta = Struct() |
|
436 | 436 | |
|
437 | 437 | # Create the namespace where the user will operate. user_ns is |
|
438 | 438 | # normally the only one used, and it is passed to the exec calls as |
|
439 | 439 | # the locals argument. But we do carry a user_global_ns namespace |
|
440 | 440 | # given as the exec 'globals' argument, This is useful in embedding |
|
441 | 441 | # situations where the ipython shell opens in a context where the |
|
442 | 442 | # distinction between locals and globals is meaningful. For |
|
443 | 443 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
444 | 444 | |
|
445 | 445 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
446 | 446 | # level as a dict instead of a module. This is a manual fix, but I |
|
447 | 447 | # should really track down where the problem is coming from. Alex |
|
448 | 448 | # Schmolck reported this problem first. |
|
449 | 449 | |
|
450 | 450 | # A useful post by Alex Martelli on this topic: |
|
451 | 451 | # Re: inconsistent value from __builtins__ |
|
452 | 452 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
453 | 453 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
454 | 454 | # Gruppen: comp.lang.python |
|
455 | 455 | |
|
456 | 456 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
457 | 457 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
458 | 458 | # > <type 'dict'> |
|
459 | 459 | # > >>> print type(__builtins__) |
|
460 | 460 | # > <type 'module'> |
|
461 | 461 | # > Is this difference in return value intentional? |
|
462 | 462 | |
|
463 | 463 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
464 | 464 | # or a module, and it's been that way for a long time. Whether it's |
|
465 | 465 | # intentional (or sensible), I don't know. In any case, the idea is |
|
466 | 466 | # that if you need to access the built-in namespace directly, you |
|
467 | 467 | # should start with "import __builtin__" (note, no 's') which will |
|
468 | 468 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
469 | 469 | |
|
470 | 470 | # These routines return properly built dicts as needed by the rest of |
|
471 | 471 | # the code, and can also be used by extension writers to generate |
|
472 | 472 | # properly initialized namespaces. |
|
473 | 473 | user_ns, user_global_ns = IPython.ipapi.make_user_namespaces(user_ns, |
|
474 | 474 | user_global_ns) |
|
475 | 475 | |
|
476 | 476 | # Assign namespaces |
|
477 | 477 | # This is the namespace where all normal user variables live |
|
478 | 478 | self.user_ns = user_ns |
|
479 | 479 | self.user_global_ns = user_global_ns |
|
480 | 480 | |
|
481 | 481 | # An auxiliary namespace that checks what parts of the user_ns were |
|
482 | 482 | # loaded at startup, so we can list later only variables defined in |
|
483 | 483 | # actual interactive use. Since it is always a subset of user_ns, it |
|
484 | 484 | # doesn't need to be seaparately tracked in the ns_table |
|
485 | 485 | self.user_config_ns = {} |
|
486 | 486 | |
|
487 | 487 | # A namespace to keep track of internal data structures to prevent |
|
488 | 488 | # them from cluttering user-visible stuff. Will be updated later |
|
489 | 489 | self.internal_ns = {} |
|
490 | 490 | |
|
491 | 491 | # Namespace of system aliases. Each entry in the alias |
|
492 | 492 | # table must be a 2-tuple of the form (N,name), where N is the number |
|
493 | 493 | # of positional arguments of the alias. |
|
494 | 494 | self.alias_table = {} |
|
495 | 495 | |
|
496 | 496 | # Now that FakeModule produces a real module, we've run into a nasty |
|
497 | 497 | # problem: after script execution (via %run), the module where the user |
|
498 | 498 | # code ran is deleted. Now that this object is a true module (needed |
|
499 | 499 | # so docetst and other tools work correctly), the Python module |
|
500 | 500 | # teardown mechanism runs over it, and sets to None every variable |
|
501 | 501 | # present in that module. Top-level references to objects from the |
|
502 | 502 | # script survive, because the user_ns is updated with them. However, |
|
503 | 503 | # calling functions defined in the script that use other things from |
|
504 | 504 | # the script will fail, because the function's closure had references |
|
505 | 505 | # to the original objects, which are now all None. So we must protect |
|
506 | 506 | # these modules from deletion by keeping a cache. |
|
507 | 507 | # |
|
508 | 508 | # To avoid keeping stale modules around (we only need the one from the |
|
509 | 509 | # last run), we use a dict keyed with the full path to the script, so |
|
510 | 510 | # only the last version of the module is held in the cache. Note, |
|
511 | 511 | # however, that we must cache the module *namespace contents* (their |
|
512 | 512 | # __dict__). Because if we try to cache the actual modules, old ones |
|
513 | 513 | # (uncached) could be destroyed while still holding references (such as |
|
514 | 514 | # those held by GUI objects that tend to be long-lived)> |
|
515 | 515 | # |
|
516 | 516 | # The %reset command will flush this cache. See the cache_main_mod() |
|
517 | 517 | # and clear_main_mod_cache() methods for details on use. |
|
518 | 518 | |
|
519 | 519 | # This is the cache used for 'main' namespaces |
|
520 | 520 | self._main_ns_cache = {} |
|
521 | 521 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
522 | 522 | # copying and clearing for reuse on each %run |
|
523 | 523 | self._user_main_module = FakeModule() |
|
524 | 524 | |
|
525 | 525 | # A table holding all the namespaces IPython deals with, so that |
|
526 | 526 | # introspection facilities can search easily. |
|
527 | 527 | self.ns_table = {'user':user_ns, |
|
528 | 528 | 'user_global':user_global_ns, |
|
529 | 529 | 'alias':self.alias_table, |
|
530 | 530 | 'internal':self.internal_ns, |
|
531 | 531 | 'builtin':__builtin__.__dict__ |
|
532 | 532 | } |
|
533 | 533 | |
|
534 | 534 | # Similarly, track all namespaces where references can be held and that |
|
535 | 535 | # we can safely clear (so it can NOT include builtin). This one can be |
|
536 | 536 | # a simple list. |
|
537 | 537 | self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns, |
|
538 | 538 | self.alias_table, self.internal_ns, |
|
539 | 539 | self._main_ns_cache ] |
|
540 | 540 | |
|
541 | 541 | # We need to insert into sys.modules something that looks like a |
|
542 | 542 | # module but which accesses the IPython namespace, for shelve and |
|
543 | 543 | # pickle to work interactively. Normally they rely on getting |
|
544 | 544 | # everything out of __main__, but for embedding purposes each IPython |
|
545 | 545 | # instance has its own private namespace, so we can't go shoving |
|
546 | 546 | # everything into __main__. |
|
547 | 547 | |
|
548 | 548 | # note, however, that we should only do this for non-embedded |
|
549 | 549 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
550 | 550 | # namespace. Embedded instances, on the other hand, should not do |
|
551 | 551 | # this because they need to manage the user local/global namespaces |
|
552 | 552 | # only, but they live within a 'normal' __main__ (meaning, they |
|
553 | 553 | # shouldn't overtake the execution environment of the script they're |
|
554 | 554 | # embedded in). |
|
555 | 555 | |
|
556 | 556 | if not embedded: |
|
557 | 557 | try: |
|
558 | 558 | main_name = self.user_ns['__name__'] |
|
559 | 559 | except KeyError: |
|
560 | 560 | raise KeyError,'user_ns dictionary MUST have a "__name__" key' |
|
561 | 561 | else: |
|
562 | 562 | #print "pickle hack in place" # dbg |
|
563 | 563 | #print 'main_name:',main_name # dbg |
|
564 | 564 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
565 | 565 | |
|
566 | 566 | # List of input with multi-line handling. |
|
567 | 567 | self.input_hist = InputList() |
|
568 | 568 | # This one will hold the 'raw' input history, without any |
|
569 | 569 | # pre-processing. This will allow users to retrieve the input just as |
|
570 | 570 | # it was exactly typed in by the user, with %hist -r. |
|
571 | 571 | self.input_hist_raw = InputList() |
|
572 | 572 | |
|
573 | 573 | # list of visited directories |
|
574 | 574 | try: |
|
575 | 575 | self.dir_hist = [os.getcwd()] |
|
576 | 576 | except OSError: |
|
577 | 577 | self.dir_hist = [] |
|
578 | 578 | |
|
579 | 579 | # dict of output history |
|
580 | 580 | self.output_hist = {} |
|
581 | 581 | |
|
582 | 582 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
583 | 583 | # under Win32 have it set to None, and we need to have a known valid |
|
584 | 584 | # encoding to use in the raw_input() method |
|
585 | 585 | try: |
|
586 | 586 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
587 | 587 | except AttributeError: |
|
588 | 588 | self.stdin_encoding = 'ascii' |
|
589 | 589 | |
|
590 | 590 | # dict of things NOT to alias (keywords, builtins and some magics) |
|
591 | 591 | no_alias = {} |
|
592 | 592 | no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias'] |
|
593 | 593 | for key in keyword.kwlist + no_alias_magics: |
|
594 | 594 | no_alias[key] = 1 |
|
595 | 595 | no_alias.update(__builtin__.__dict__) |
|
596 | 596 | self.no_alias = no_alias |
|
597 | 597 | |
|
598 | 598 | # Object variable to store code object waiting execution. This is |
|
599 | 599 | # used mainly by the multithreaded shells, but it can come in handy in |
|
600 | 600 | # other situations. No need to use a Queue here, since it's a single |
|
601 | 601 | # item which gets cleared once run. |
|
602 | 602 | self.code_to_run = None |
|
603 | 603 | |
|
604 | 604 | # escapes for automatic behavior on the command line |
|
605 | 605 | self.ESC_SHELL = '!' |
|
606 | 606 | self.ESC_SH_CAP = '!!' |
|
607 | 607 | self.ESC_HELP = '?' |
|
608 | 608 | self.ESC_MAGIC = '%' |
|
609 | 609 | self.ESC_QUOTE = ',' |
|
610 | 610 | self.ESC_QUOTE2 = ';' |
|
611 | 611 | self.ESC_PAREN = '/' |
|
612 | 612 | |
|
613 | 613 | # And their associated handlers |
|
614 | 614 | self.esc_handlers = {self.ESC_PAREN : self.handle_auto, |
|
615 | 615 | self.ESC_QUOTE : self.handle_auto, |
|
616 | 616 | self.ESC_QUOTE2 : self.handle_auto, |
|
617 | 617 | self.ESC_MAGIC : self.handle_magic, |
|
618 | 618 | self.ESC_HELP : self.handle_help, |
|
619 | 619 | self.ESC_SHELL : self.handle_shell_escape, |
|
620 | 620 | self.ESC_SH_CAP : self.handle_shell_escape, |
|
621 | 621 | } |
|
622 | 622 | |
|
623 | 623 | # class initializations |
|
624 | 624 | Magic.__init__(self,self) |
|
625 | 625 | |
|
626 | 626 | # Python source parser/formatter for syntax highlighting |
|
627 | 627 | pyformat = PyColorize.Parser().format |
|
628 | 628 | self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors']) |
|
629 | 629 | |
|
630 | 630 | # hooks holds pointers used for user-side customizations |
|
631 | 631 | self.hooks = Struct() |
|
632 | 632 | |
|
633 | 633 | self.strdispatchers = {} |
|
634 | 634 | |
|
635 | 635 | # Set all default hooks, defined in the IPython.hooks module. |
|
636 | 636 | hooks = IPython.hooks |
|
637 | 637 | for hook_name in hooks.__all__: |
|
638 | 638 | # default hooks have priority 100, i.e. low; user hooks should have |
|
639 | 639 | # 0-100 priority |
|
640 | 640 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
641 | 641 | #print "bound hook",hook_name |
|
642 | 642 | |
|
643 | 643 | # Flag to mark unconditional exit |
|
644 | 644 | self.exit_now = False |
|
645 | 645 | |
|
646 | 646 | self.usage_min = """\ |
|
647 | 647 | An enhanced console for Python. |
|
648 | 648 | Some of its features are: |
|
649 | 649 | - Readline support if the readline library is present. |
|
650 | 650 | - Tab completion in the local namespace. |
|
651 | 651 | - Logging of input, see command-line options. |
|
652 | 652 | - System shell escape via ! , eg !ls. |
|
653 | 653 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) |
|
654 | 654 | - Keeps track of locally defined variables via %who, %whos. |
|
655 | 655 | - Show object information with a ? eg ?x or x? (use ?? for more info). |
|
656 | 656 | """ |
|
657 | 657 | if usage: self.usage = usage |
|
658 | 658 | else: self.usage = self.usage_min |
|
659 | 659 | |
|
660 | 660 | # Storage |
|
661 | 661 | self.rc = rc # This will hold all configuration information |
|
662 | 662 | self.pager = 'less' |
|
663 | 663 | # temporary files used for various purposes. Deleted at exit. |
|
664 | 664 | self.tempfiles = [] |
|
665 | 665 | |
|
666 | 666 | # Keep track of readline usage (later set by init_readline) |
|
667 | 667 | self.has_readline = False |
|
668 | 668 | |
|
669 | 669 | # template for logfile headers. It gets resolved at runtime by the |
|
670 | 670 | # logstart method. |
|
671 | 671 | self.loghead_tpl = \ |
|
672 | 672 | """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE *** |
|
673 | 673 | #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW |
|
674 | 674 | #log# opts = %s |
|
675 | 675 | #log# args = %s |
|
676 | 676 | #log# It is safe to make manual edits below here. |
|
677 | 677 | #log#----------------------------------------------------------------------- |
|
678 | 678 | """ |
|
679 | 679 | # for pushd/popd management |
|
680 | 680 | try: |
|
681 | 681 | self.home_dir = get_home_dir() |
|
682 | 682 | except HomeDirError,msg: |
|
683 | 683 | fatal(msg) |
|
684 | 684 | |
|
685 | 685 | self.dir_stack = [] |
|
686 | 686 | |
|
687 | 687 | # Functions to call the underlying shell. |
|
688 | 688 | |
|
689 | 689 | # The first is similar to os.system, but it doesn't return a value, |
|
690 | 690 | # and it allows interpolation of variables in the user's namespace. |
|
691 | 691 | self.system = lambda cmd: \ |
|
692 | 692 | self.hooks.shell_hook(self.var_expand(cmd,depth=2)) |
|
693 | 693 | |
|
694 | 694 | # These are for getoutput and getoutputerror: |
|
695 | 695 | self.getoutput = lambda cmd: \ |
|
696 | 696 | getoutput(self.var_expand(cmd,depth=2), |
|
697 | 697 | header=self.rc.system_header, |
|
698 | 698 | verbose=self.rc.system_verbose) |
|
699 | 699 | |
|
700 | 700 | self.getoutputerror = lambda cmd: \ |
|
701 | 701 | getoutputerror(self.var_expand(cmd,depth=2), |
|
702 | 702 | header=self.rc.system_header, |
|
703 | 703 | verbose=self.rc.system_verbose) |
|
704 | 704 | |
|
705 | 705 | |
|
706 | 706 | # keep track of where we started running (mainly for crash post-mortem) |
|
707 | 707 | self.starting_dir = os.getcwd() |
|
708 | 708 | |
|
709 | 709 | # Various switches which can be set |
|
710 | 710 | self.CACHELENGTH = 5000 # this is cheap, it's just text |
|
711 | 711 | self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__ |
|
712 | 712 | self.banner2 = banner2 |
|
713 | 713 | |
|
714 | 714 | # TraceBack handlers: |
|
715 | 715 | |
|
716 | 716 | # Syntax error handler. |
|
717 | 717 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') |
|
718 | 718 | |
|
719 | 719 | # The interactive one is initialized with an offset, meaning we always |
|
720 | 720 | # want to remove the topmost item in the traceback, which is our own |
|
721 | 721 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
722 | 722 | self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain', |
|
723 | 723 | color_scheme='NoColor', |
|
724 | 724 | tb_offset = 1) |
|
725 | 725 | |
|
726 | 726 | # IPython itself shouldn't crash. This will produce a detailed |
|
727 | 727 | # post-mortem if it does. But we only install the crash handler for |
|
728 | 728 | # non-threaded shells, the threaded ones use a normal verbose reporter |
|
729 | 729 | # and lose the crash handler. This is because exceptions in the main |
|
730 | 730 | # thread (such as in GUI code) propagate directly to sys.excepthook, |
|
731 | 731 | # and there's no point in printing crash dumps for every user exception. |
|
732 | 732 | if self.isthreaded: |
|
733 | 733 | ipCrashHandler = ultraTB.FormattedTB() |
|
734 | 734 | else: |
|
735 | 735 | from IPython import CrashHandler |
|
736 | 736 | ipCrashHandler = CrashHandler.IPythonCrashHandler(self) |
|
737 | 737 | self.set_crash_handler(ipCrashHandler) |
|
738 | 738 | |
|
739 | 739 | # and add any custom exception handlers the user may have specified |
|
740 | 740 | self.set_custom_exc(*custom_exceptions) |
|
741 | 741 | |
|
742 | 742 | # indentation management |
|
743 | 743 | self.autoindent = False |
|
744 | 744 | self.indent_current_nsp = 0 |
|
745 | 745 | |
|
746 | 746 | # Make some aliases automatically |
|
747 | 747 | # Prepare list of shell aliases to auto-define |
|
748 | 748 | if os.name == 'posix': |
|
749 | 749 | auto_alias = ('mkdir mkdir', 'rmdir rmdir', |
|
750 | 750 | 'mv mv -i','rm rm -i','cp cp -i', |
|
751 | 751 | 'cat cat','less less','clear clear', |
|
752 | 752 | # a better ls |
|
753 | 753 | 'ls ls -F', |
|
754 | 754 | # long ls |
|
755 | 755 | 'll ls -lF') |
|
756 | 756 | # Extra ls aliases with color, which need special treatment on BSD |
|
757 | 757 | # variants |
|
758 | 758 | ls_extra = ( # color ls |
|
759 | 759 | 'lc ls -F -o --color', |
|
760 | 760 | # ls normal files only |
|
761 | 761 | 'lf ls -F -o --color %l | grep ^-', |
|
762 | 762 | # ls symbolic links |
|
763 | 763 | 'lk ls -F -o --color %l | grep ^l', |
|
764 | 764 | # directories or links to directories, |
|
765 | 765 | 'ldir ls -F -o --color %l | grep /$', |
|
766 | 766 | # things which are executable |
|
767 | 767 | 'lx ls -F -o --color %l | grep ^-..x', |
|
768 | 768 | ) |
|
769 | 769 | # The BSDs don't ship GNU ls, so they don't understand the |
|
770 | 770 | # --color switch out of the box |
|
771 | 771 | if 'bsd' in sys.platform: |
|
772 | 772 | ls_extra = ( # ls normal files only |
|
773 | 773 | 'lf ls -lF | grep ^-', |
|
774 | 774 | # ls symbolic links |
|
775 | 775 | 'lk ls -lF | grep ^l', |
|
776 | 776 | # directories or links to directories, |
|
777 | 777 | 'ldir ls -lF | grep /$', |
|
778 | 778 | # things which are executable |
|
779 | 779 | 'lx ls -lF | grep ^-..x', |
|
780 | 780 | ) |
|
781 | 781 | auto_alias = auto_alias + ls_extra |
|
782 | 782 | elif os.name in ['nt','dos']: |
|
783 | 783 | auto_alias = ('ls dir /on', |
|
784 | 784 | 'ddir dir /ad /on', 'ldir dir /ad /on', |
|
785 | 785 | 'mkdir mkdir','rmdir rmdir','echo echo', |
|
786 | 786 | 'ren ren','cls cls','copy copy') |
|
787 | 787 | else: |
|
788 | 788 | auto_alias = () |
|
789 | 789 | self.auto_alias = [s.split(None,1) for s in auto_alias] |
|
790 | 790 | |
|
791 | 791 | # Produce a public API instance |
|
792 | 792 | self.api = IPython.ipapi.IPApi(self) |
|
793 | 793 | |
|
794 | 794 | # Initialize all user-visible namespaces |
|
795 | 795 | self.init_namespaces() |
|
796 | 796 | |
|
797 | 797 | # Call the actual (public) initializer |
|
798 | 798 | self.init_auto_alias() |
|
799 | 799 | |
|
800 | 800 | # track which builtins we add, so we can clean up later |
|
801 | 801 | self.builtins_added = {} |
|
802 | 802 | # This method will add the necessary builtins for operation, but |
|
803 | 803 | # tracking what it did via the builtins_added dict. |
|
804 | 804 | |
|
805 | 805 | #TODO: remove this, redundant |
|
806 | 806 | self.add_builtins() |
|
807 | 807 | # end __init__ |
|
808 | 808 | |
|
809 | 809 | def var_expand(self,cmd,depth=0): |
|
810 | 810 | """Expand python variables in a string. |
|
811 | 811 | |
|
812 | 812 | The depth argument indicates how many frames above the caller should |
|
813 | 813 | be walked to look for the local namespace where to expand variables. |
|
814 | 814 | |
|
815 | 815 | The global namespace for expansion is always the user's interactive |
|
816 | 816 | namespace. |
|
817 | 817 | """ |
|
818 | 818 | |
|
819 | 819 | return str(ItplNS(cmd, |
|
820 | 820 | self.user_ns, # globals |
|
821 | 821 | # Skip our own frame in searching for locals: |
|
822 | 822 | sys._getframe(depth+1).f_locals # locals |
|
823 | 823 | )) |
|
824 | 824 | |
|
825 | 825 | def pre_config_initialization(self): |
|
826 | 826 | """Pre-configuration init method |
|
827 | 827 | |
|
828 | 828 | This is called before the configuration files are processed to |
|
829 | 829 | prepare the services the config files might need. |
|
830 | 830 | |
|
831 | 831 | self.rc already has reasonable default values at this point. |
|
832 | 832 | """ |
|
833 | 833 | rc = self.rc |
|
834 | 834 | try: |
|
835 | 835 | self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db") |
|
836 | 836 | except exceptions.UnicodeDecodeError: |
|
837 | 837 | print "Your ipythondir can't be decoded to unicode!" |
|
838 | 838 | print "Please set HOME environment variable to something that" |
|
839 | 839 | print r"only has ASCII characters, e.g. c:\home" |
|
840 | 840 | print "Now it is",rc.ipythondir |
|
841 | 841 | sys.exit() |
|
842 | 842 | self.shadowhist = IPython.history.ShadowHist(self.db) |
|
843 | 843 | |
|
844 | 844 | def post_config_initialization(self): |
|
845 | 845 | """Post configuration init method |
|
846 | 846 | |
|
847 | 847 | This is called after the configuration files have been processed to |
|
848 | 848 | 'finalize' the initialization.""" |
|
849 | 849 | |
|
850 | 850 | rc = self.rc |
|
851 | 851 | |
|
852 | 852 | # Object inspector |
|
853 | 853 | self.inspector = OInspect.Inspector(OInspect.InspectColors, |
|
854 | 854 | PyColorize.ANSICodeColors, |
|
855 | 855 | 'NoColor', |
|
856 | 856 | rc.object_info_string_level) |
|
857 | 857 | |
|
858 | 858 | self.rl_next_input = None |
|
859 | 859 | self.rl_do_indent = False |
|
860 | 860 | # Load readline proper |
|
861 | 861 | if rc.readline: |
|
862 | 862 | self.init_readline() |
|
863 | 863 | |
|
864 | 864 | # local shortcut, this is used a LOT |
|
865 | 865 | self.log = self.logger.log |
|
866 | 866 | |
|
867 | 867 | # Initialize cache, set in/out prompts and printing system |
|
868 | 868 | self.outputcache = CachedOutput(self, |
|
869 | 869 | rc.cache_size, |
|
870 | 870 | rc.pprint, |
|
871 | 871 | input_sep = rc.separate_in, |
|
872 | 872 | output_sep = rc.separate_out, |
|
873 | 873 | output_sep2 = rc.separate_out2, |
|
874 | 874 | ps1 = rc.prompt_in1, |
|
875 | 875 | ps2 = rc.prompt_in2, |
|
876 | 876 | ps_out = rc.prompt_out, |
|
877 | 877 | pad_left = rc.prompts_pad_left) |
|
878 | 878 | |
|
879 | 879 | # user may have over-ridden the default print hook: |
|
880 | 880 | try: |
|
881 | 881 | self.outputcache.__class__.display = self.hooks.display |
|
882 | 882 | except AttributeError: |
|
883 | 883 | pass |
|
884 | 884 | |
|
885 | 885 | # I don't like assigning globally to sys, because it means when |
|
886 | 886 | # embedding instances, each embedded instance overrides the previous |
|
887 | 887 | # choice. But sys.displayhook seems to be called internally by exec, |
|
888 | 888 | # so I don't see a way around it. We first save the original and then |
|
889 | 889 | # overwrite it. |
|
890 | 890 | self.sys_displayhook = sys.displayhook |
|
891 | 891 | sys.displayhook = self.outputcache |
|
892 | 892 | |
|
893 | 893 | # Do a proper resetting of doctest, including the necessary displayhook |
|
894 | 894 | # monkeypatching |
|
895 | 895 | try: |
|
896 | 896 | doctest_reload() |
|
897 | 897 | except ImportError: |
|
898 | 898 | warn("doctest module does not exist.") |
|
899 | 899 | |
|
900 | 900 | # Set user colors (don't do it in the constructor above so that it |
|
901 | 901 | # doesn't crash if colors option is invalid) |
|
902 | 902 | self.magic_colors(rc.colors) |
|
903 | 903 | |
|
904 | 904 | # Set calling of pdb on exceptions |
|
905 | 905 | self.call_pdb = rc.pdb |
|
906 | 906 | |
|
907 | 907 | # Load user aliases |
|
908 | 908 | for alias in rc.alias: |
|
909 | 909 | self.magic_alias(alias) |
|
910 | 910 | |
|
911 | 911 | self.hooks.late_startup_hook() |
|
912 | 912 | |
|
913 | 913 | for cmd in self.rc.autoexec: |
|
914 | 914 | #print "autoexec>",cmd #dbg |
|
915 | 915 | self.api.runlines(cmd) |
|
916 | 916 | |
|
917 | 917 | batchrun = False |
|
918 | 918 | for batchfile in [path(arg) for arg in self.rc.args |
|
919 | 919 | if arg.lower().endswith('.ipy')]: |
|
920 | 920 | if not batchfile.isfile(): |
|
921 | 921 | print "No such batch file:", batchfile |
|
922 | 922 | continue |
|
923 | 923 | self.api.runlines(batchfile.text()) |
|
924 | 924 | batchrun = True |
|
925 | 925 | # without -i option, exit after running the batch file |
|
926 | 926 | if batchrun and not self.rc.interact: |
|
927 | 927 | self.ask_exit() |
|
928 | 928 | |
|
929 | 929 | def init_namespaces(self): |
|
930 | 930 | """Initialize all user-visible namespaces to their minimum defaults. |
|
931 | 931 | |
|
932 | 932 | Certain history lists are also initialized here, as they effectively |
|
933 | 933 | act as user namespaces. |
|
934 | 934 | |
|
935 | Note | |
|
936 | ---- | |
|
935 | Notes | |
|
936 | ----- | |
|
937 | 937 | All data structures here are only filled in, they are NOT reset by this |
|
938 | 938 | method. If they were not empty before, data will simply be added to |
|
939 | 939 | therm. |
|
940 | 940 | """ |
|
941 | 941 | # The user namespace MUST have a pointer to the shell itself. |
|
942 | 942 | self.user_ns[self.name] = self |
|
943 | 943 | |
|
944 | 944 | # Store the public api instance |
|
945 | 945 | self.user_ns['_ip'] = self.api |
|
946 | 946 | |
|
947 | 947 | # make global variables for user access to the histories |
|
948 | 948 | self.user_ns['_ih'] = self.input_hist |
|
949 | 949 | self.user_ns['_oh'] = self.output_hist |
|
950 | 950 | self.user_ns['_dh'] = self.dir_hist |
|
951 | 951 | |
|
952 | 952 | # user aliases to input and output histories |
|
953 | 953 | self.user_ns['In'] = self.input_hist |
|
954 | 954 | self.user_ns['Out'] = self.output_hist |
|
955 | 955 | |
|
956 | 956 | self.user_ns['_sh'] = IPython.shadowns |
|
957 | 957 | |
|
958 | 958 | # Fill the history zero entry, user counter starts at 1 |
|
959 | 959 | self.input_hist.append('\n') |
|
960 | 960 | self.input_hist_raw.append('\n') |
|
961 | 961 | |
|
962 | 962 | def add_builtins(self): |
|
963 | 963 | """Store ipython references into the builtin namespace. |
|
964 | 964 | |
|
965 | 965 | Some parts of ipython operate via builtins injected here, which hold a |
|
966 | 966 | reference to IPython itself.""" |
|
967 | 967 | |
|
968 | 968 | # TODO: deprecate all of these, they are unsafe |
|
969 | 969 | builtins_new = dict(__IPYTHON__ = self, |
|
970 | 970 | ip_set_hook = self.set_hook, |
|
971 | 971 | jobs = self.jobs, |
|
972 | 972 | ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'), |
|
973 | 973 | ipalias = wrap_deprecated(self.ipalias), |
|
974 | 974 | ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'), |
|
975 | 975 | #_ip = self.api |
|
976 | 976 | ) |
|
977 | 977 | for biname,bival in builtins_new.items(): |
|
978 | 978 | try: |
|
979 | 979 | # store the orignal value so we can restore it |
|
980 | 980 | self.builtins_added[biname] = __builtin__.__dict__[biname] |
|
981 | 981 | except KeyError: |
|
982 | 982 | # or mark that it wasn't defined, and we'll just delete it at |
|
983 | 983 | # cleanup |
|
984 | 984 | self.builtins_added[biname] = Undefined |
|
985 | 985 | __builtin__.__dict__[biname] = bival |
|
986 | 986 | |
|
987 | 987 | # Keep in the builtins a flag for when IPython is active. We set it |
|
988 | 988 | # with setdefault so that multiple nested IPythons don't clobber one |
|
989 | 989 | # another. Each will increase its value by one upon being activated, |
|
990 | 990 | # which also gives us a way to determine the nesting level. |
|
991 | 991 | __builtin__.__dict__.setdefault('__IPYTHON__active',0) |
|
992 | 992 | |
|
993 | 993 | def clean_builtins(self): |
|
994 | 994 | """Remove any builtins which might have been added by add_builtins, or |
|
995 | 995 | restore overwritten ones to their previous values.""" |
|
996 | 996 | for biname,bival in self.builtins_added.items(): |
|
997 | 997 | if bival is Undefined: |
|
998 | 998 | del __builtin__.__dict__[biname] |
|
999 | 999 | else: |
|
1000 | 1000 | __builtin__.__dict__[biname] = bival |
|
1001 | 1001 | self.builtins_added.clear() |
|
1002 | 1002 | |
|
1003 | 1003 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
1004 | 1004 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
1005 | 1005 | |
|
1006 | 1006 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
1007 | 1007 | adding your function to one of these hooks, you can modify IPython's |
|
1008 | 1008 | behavior to call at runtime your own routines.""" |
|
1009 | 1009 | |
|
1010 | 1010 | # At some point in the future, this should validate the hook before it |
|
1011 | 1011 | # accepts it. Probably at least check that the hook takes the number |
|
1012 | 1012 | # of args it's supposed to. |
|
1013 | 1013 | |
|
1014 | 1014 | f = new.instancemethod(hook,self,self.__class__) |
|
1015 | 1015 | |
|
1016 | 1016 | # check if the hook is for strdispatcher first |
|
1017 | 1017 | if str_key is not None: |
|
1018 | 1018 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1019 | 1019 | sdp.add_s(str_key, f, priority ) |
|
1020 | 1020 | self.strdispatchers[name] = sdp |
|
1021 | 1021 | return |
|
1022 | 1022 | if re_key is not None: |
|
1023 | 1023 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1024 | 1024 | sdp.add_re(re.compile(re_key), f, priority ) |
|
1025 | 1025 | self.strdispatchers[name] = sdp |
|
1026 | 1026 | return |
|
1027 | 1027 | |
|
1028 | 1028 | dp = getattr(self.hooks, name, None) |
|
1029 | 1029 | if name not in IPython.hooks.__all__: |
|
1030 | 1030 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.hooks.__all__ ) |
|
1031 | 1031 | if not dp: |
|
1032 | 1032 | dp = IPython.hooks.CommandChainDispatcher() |
|
1033 | 1033 | |
|
1034 | 1034 | try: |
|
1035 | 1035 | dp.add(f,priority) |
|
1036 | 1036 | except AttributeError: |
|
1037 | 1037 | # it was not commandchain, plain old func - replace |
|
1038 | 1038 | dp = f |
|
1039 | 1039 | |
|
1040 | 1040 | setattr(self.hooks,name, dp) |
|
1041 | 1041 | |
|
1042 | 1042 | |
|
1043 | 1043 | #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__)) |
|
1044 | 1044 | |
|
1045 | 1045 | def set_crash_handler(self,crashHandler): |
|
1046 | 1046 | """Set the IPython crash handler. |
|
1047 | 1047 | |
|
1048 | 1048 | This must be a callable with a signature suitable for use as |
|
1049 | 1049 | sys.excepthook.""" |
|
1050 | 1050 | |
|
1051 | 1051 | # Install the given crash handler as the Python exception hook |
|
1052 | 1052 | sys.excepthook = crashHandler |
|
1053 | 1053 | |
|
1054 | 1054 | # The instance will store a pointer to this, so that runtime code |
|
1055 | 1055 | # (such as magics) can access it. This is because during the |
|
1056 | 1056 | # read-eval loop, it gets temporarily overwritten (to deal with GUI |
|
1057 | 1057 | # frameworks). |
|
1058 | 1058 | self.sys_excepthook = sys.excepthook |
|
1059 | 1059 | |
|
1060 | 1060 | |
|
1061 | 1061 | def set_custom_exc(self,exc_tuple,handler): |
|
1062 | 1062 | """set_custom_exc(exc_tuple,handler) |
|
1063 | 1063 | |
|
1064 | 1064 | Set a custom exception handler, which will be called if any of the |
|
1065 | 1065 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1066 | 1066 | runcode() method. |
|
1067 | 1067 | |
|
1068 | 1068 | Inputs: |
|
1069 | 1069 | |
|
1070 | 1070 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
1071 | 1071 | handler for. It is very important that you use a tuple, and NOT A |
|
1072 | 1072 | LIST here, because of the way Python's except statement works. If |
|
1073 | 1073 | you only want to trap a single exception, use a singleton tuple: |
|
1074 | 1074 | |
|
1075 | 1075 | exc_tuple == (MyCustomException,) |
|
1076 | 1076 | |
|
1077 | 1077 | - handler: this must be defined as a function with the following |
|
1078 | 1078 | basic interface: def my_handler(self,etype,value,tb). |
|
1079 | 1079 | |
|
1080 | 1080 | This will be made into an instance method (via new.instancemethod) |
|
1081 | 1081 | of IPython itself, and it will be called if any of the exceptions |
|
1082 | 1082 | listed in the exc_tuple are caught. If the handler is None, an |
|
1083 | 1083 | internal basic one is used, which just prints basic info. |
|
1084 | 1084 | |
|
1085 | 1085 | WARNING: by putting in your own exception handler into IPython's main |
|
1086 | 1086 | execution loop, you run a very good chance of nasty crashes. This |
|
1087 | 1087 | facility should only be used if you really know what you are doing.""" |
|
1088 | 1088 | |
|
1089 | 1089 | assert type(exc_tuple)==type(()) , \ |
|
1090 | 1090 | "The custom exceptions must be given AS A TUPLE." |
|
1091 | 1091 | |
|
1092 | 1092 | def dummy_handler(self,etype,value,tb): |
|
1093 | 1093 | print '*** Simple custom exception handler ***' |
|
1094 | 1094 | print 'Exception type :',etype |
|
1095 | 1095 | print 'Exception value:',value |
|
1096 | 1096 | print 'Traceback :',tb |
|
1097 | 1097 | print 'Source code :','\n'.join(self.buffer) |
|
1098 | 1098 | |
|
1099 | 1099 | if handler is None: handler = dummy_handler |
|
1100 | 1100 | |
|
1101 | 1101 | self.CustomTB = new.instancemethod(handler,self,self.__class__) |
|
1102 | 1102 | self.custom_exceptions = exc_tuple |
|
1103 | 1103 | |
|
1104 | 1104 | def set_custom_completer(self,completer,pos=0): |
|
1105 | 1105 | """set_custom_completer(completer,pos=0) |
|
1106 | 1106 | |
|
1107 | 1107 | Adds a new custom completer function. |
|
1108 | 1108 | |
|
1109 | 1109 | The position argument (defaults to 0) is the index in the completers |
|
1110 | 1110 | list where you want the completer to be inserted.""" |
|
1111 | 1111 | |
|
1112 | 1112 | newcomp = new.instancemethod(completer,self.Completer, |
|
1113 | 1113 | self.Completer.__class__) |
|
1114 | 1114 | self.Completer.matchers.insert(pos,newcomp) |
|
1115 | 1115 | |
|
1116 | 1116 | def set_completer(self): |
|
1117 | 1117 | """reset readline's completer to be our own.""" |
|
1118 | 1118 | self.readline.set_completer(self.Completer.complete) |
|
1119 | 1119 | |
|
1120 | 1120 | def _get_call_pdb(self): |
|
1121 | 1121 | return self._call_pdb |
|
1122 | 1122 | |
|
1123 | 1123 | def _set_call_pdb(self,val): |
|
1124 | 1124 | |
|
1125 | 1125 | if val not in (0,1,False,True): |
|
1126 | 1126 | raise ValueError,'new call_pdb value must be boolean' |
|
1127 | 1127 | |
|
1128 | 1128 | # store value in instance |
|
1129 | 1129 | self._call_pdb = val |
|
1130 | 1130 | |
|
1131 | 1131 | # notify the actual exception handlers |
|
1132 | 1132 | self.InteractiveTB.call_pdb = val |
|
1133 | 1133 | if self.isthreaded: |
|
1134 | 1134 | try: |
|
1135 | 1135 | self.sys_excepthook.call_pdb = val |
|
1136 | 1136 | except: |
|
1137 | 1137 | warn('Failed to activate pdb for threaded exception handler') |
|
1138 | 1138 | |
|
1139 | 1139 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
1140 | 1140 | 'Control auto-activation of pdb at exceptions') |
|
1141 | 1141 | |
|
1142 | 1142 | # These special functions get installed in the builtin namespace, to |
|
1143 | 1143 | # provide programmatic (pure python) access to magics, aliases and system |
|
1144 | 1144 | # calls. This is important for logging, user scripting, and more. |
|
1145 | 1145 | |
|
1146 | 1146 | # We are basically exposing, via normal python functions, the three |
|
1147 | 1147 | # mechanisms in which ipython offers special call modes (magics for |
|
1148 | 1148 | # internal control, aliases for direct system access via pre-selected |
|
1149 | 1149 | # names, and !cmd for calling arbitrary system commands). |
|
1150 | 1150 | |
|
1151 | 1151 | def ipmagic(self,arg_s): |
|
1152 | 1152 | """Call a magic function by name. |
|
1153 | 1153 | |
|
1154 | 1154 | Input: a string containing the name of the magic function to call and any |
|
1155 | 1155 | additional arguments to be passed to the magic. |
|
1156 | 1156 | |
|
1157 | 1157 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython |
|
1158 | 1158 | prompt: |
|
1159 | 1159 | |
|
1160 | 1160 | In[1]: %name -opt foo bar |
|
1161 | 1161 | |
|
1162 | 1162 | To call a magic without arguments, simply use ipmagic('name'). |
|
1163 | 1163 | |
|
1164 | 1164 | This provides a proper Python function to call IPython's magics in any |
|
1165 | 1165 | valid Python code you can type at the interpreter, including loops and |
|
1166 | 1166 | compound statements. It is added by IPython to the Python builtin |
|
1167 | 1167 | namespace upon initialization.""" |
|
1168 | 1168 | |
|
1169 | 1169 | args = arg_s.split(' ',1) |
|
1170 | 1170 | magic_name = args[0] |
|
1171 | 1171 | magic_name = magic_name.lstrip(self.ESC_MAGIC) |
|
1172 | 1172 | |
|
1173 | 1173 | try: |
|
1174 | 1174 | magic_args = args[1] |
|
1175 | 1175 | except IndexError: |
|
1176 | 1176 | magic_args = '' |
|
1177 | 1177 | fn = getattr(self,'magic_'+magic_name,None) |
|
1178 | 1178 | if fn is None: |
|
1179 | 1179 | error("Magic function `%s` not found." % magic_name) |
|
1180 | 1180 | else: |
|
1181 | 1181 | magic_args = self.var_expand(magic_args,1) |
|
1182 | 1182 | return fn(magic_args) |
|
1183 | 1183 | |
|
1184 | 1184 | def ipalias(self,arg_s): |
|
1185 | 1185 | """Call an alias by name. |
|
1186 | 1186 | |
|
1187 | 1187 | Input: a string containing the name of the alias to call and any |
|
1188 | 1188 | additional arguments to be passed to the magic. |
|
1189 | 1189 | |
|
1190 | 1190 | ipalias('name -opt foo bar') is equivalent to typing at the ipython |
|
1191 | 1191 | prompt: |
|
1192 | 1192 | |
|
1193 | 1193 | In[1]: name -opt foo bar |
|
1194 | 1194 | |
|
1195 | 1195 | To call an alias without arguments, simply use ipalias('name'). |
|
1196 | 1196 | |
|
1197 | 1197 | This provides a proper Python function to call IPython's aliases in any |
|
1198 | 1198 | valid Python code you can type at the interpreter, including loops and |
|
1199 | 1199 | compound statements. It is added by IPython to the Python builtin |
|
1200 | 1200 | namespace upon initialization.""" |
|
1201 | 1201 | |
|
1202 | 1202 | args = arg_s.split(' ',1) |
|
1203 | 1203 | alias_name = args[0] |
|
1204 | 1204 | try: |
|
1205 | 1205 | alias_args = args[1] |
|
1206 | 1206 | except IndexError: |
|
1207 | 1207 | alias_args = '' |
|
1208 | 1208 | if alias_name in self.alias_table: |
|
1209 | 1209 | self.call_alias(alias_name,alias_args) |
|
1210 | 1210 | else: |
|
1211 | 1211 | error("Alias `%s` not found." % alias_name) |
|
1212 | 1212 | |
|
1213 | 1213 | def ipsystem(self,arg_s): |
|
1214 | 1214 | """Make a system call, using IPython.""" |
|
1215 | 1215 | |
|
1216 | 1216 | self.system(arg_s) |
|
1217 | 1217 | |
|
1218 | 1218 | def complete(self,text): |
|
1219 | 1219 | """Return a sorted list of all possible completions on text. |
|
1220 | 1220 | |
|
1221 | 1221 | Inputs: |
|
1222 | 1222 | |
|
1223 | 1223 | - text: a string of text to be completed on. |
|
1224 | 1224 | |
|
1225 | 1225 | This is a wrapper around the completion mechanism, similar to what |
|
1226 | 1226 | readline does at the command line when the TAB key is hit. By |
|
1227 | 1227 | exposing it as a method, it can be used by other non-readline |
|
1228 | 1228 | environments (such as GUIs) for text completion. |
|
1229 | 1229 | |
|
1230 | 1230 | Simple usage example: |
|
1231 | 1231 | |
|
1232 | 1232 | In [7]: x = 'hello' |
|
1233 | 1233 | |
|
1234 | 1234 | In [8]: x |
|
1235 | 1235 | Out[8]: 'hello' |
|
1236 | 1236 | |
|
1237 | 1237 | In [9]: print x |
|
1238 | 1238 | hello |
|
1239 | 1239 | |
|
1240 | 1240 | In [10]: _ip.IP.complete('x.l') |
|
1241 | 1241 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] |
|
1242 | 1242 | """ |
|
1243 | 1243 | |
|
1244 | 1244 | complete = self.Completer.complete |
|
1245 | 1245 | state = 0 |
|
1246 | 1246 | # use a dict so we get unique keys, since ipyhton's multiple |
|
1247 | 1247 | # completers can return duplicates. When we make 2.4 a requirement, |
|
1248 | 1248 | # start using sets instead, which are faster. |
|
1249 | 1249 | comps = {} |
|
1250 | 1250 | while True: |
|
1251 | 1251 | newcomp = complete(text,state,line_buffer=text) |
|
1252 | 1252 | if newcomp is None: |
|
1253 | 1253 | break |
|
1254 | 1254 | comps[newcomp] = 1 |
|
1255 | 1255 | state += 1 |
|
1256 | 1256 | outcomps = comps.keys() |
|
1257 | 1257 | outcomps.sort() |
|
1258 | 1258 | #print "T:",text,"OC:",outcomps # dbg |
|
1259 | 1259 | #print "vars:",self.user_ns.keys() |
|
1260 | 1260 | return outcomps |
|
1261 | 1261 | |
|
1262 | 1262 | def set_completer_frame(self, frame=None): |
|
1263 | 1263 | if frame: |
|
1264 | 1264 | self.Completer.namespace = frame.f_locals |
|
1265 | 1265 | self.Completer.global_namespace = frame.f_globals |
|
1266 | 1266 | else: |
|
1267 | 1267 | self.Completer.namespace = self.user_ns |
|
1268 | 1268 | self.Completer.global_namespace = self.user_global_ns |
|
1269 | 1269 | |
|
1270 | 1270 | def init_auto_alias(self): |
|
1271 | 1271 | """Define some aliases automatically. |
|
1272 | 1272 | |
|
1273 | 1273 | These are ALL parameter-less aliases""" |
|
1274 | 1274 | |
|
1275 | 1275 | for alias,cmd in self.auto_alias: |
|
1276 | 1276 | self.getapi().defalias(alias,cmd) |
|
1277 | 1277 | |
|
1278 | 1278 | |
|
1279 | 1279 | def alias_table_validate(self,verbose=0): |
|
1280 | 1280 | """Update information about the alias table. |
|
1281 | 1281 | |
|
1282 | 1282 | In particular, make sure no Python keywords/builtins are in it.""" |
|
1283 | 1283 | |
|
1284 | 1284 | no_alias = self.no_alias |
|
1285 | 1285 | for k in self.alias_table.keys(): |
|
1286 | 1286 | if k in no_alias: |
|
1287 | 1287 | del self.alias_table[k] |
|
1288 | 1288 | if verbose: |
|
1289 | 1289 | print ("Deleting alias <%s>, it's a Python " |
|
1290 | 1290 | "keyword or builtin." % k) |
|
1291 | 1291 | |
|
1292 | 1292 | def set_autoindent(self,value=None): |
|
1293 | 1293 | """Set the autoindent flag, checking for readline support. |
|
1294 | 1294 | |
|
1295 | 1295 | If called with no arguments, it acts as a toggle.""" |
|
1296 | 1296 | |
|
1297 | 1297 | if not self.has_readline: |
|
1298 | 1298 | if os.name == 'posix': |
|
1299 | 1299 | warn("The auto-indent feature requires the readline library") |
|
1300 | 1300 | self.autoindent = 0 |
|
1301 | 1301 | return |
|
1302 | 1302 | if value is None: |
|
1303 | 1303 | self.autoindent = not self.autoindent |
|
1304 | 1304 | else: |
|
1305 | 1305 | self.autoindent = value |
|
1306 | 1306 | |
|
1307 | 1307 | def rc_set_toggle(self,rc_field,value=None): |
|
1308 | 1308 | """Set or toggle a field in IPython's rc config. structure. |
|
1309 | 1309 | |
|
1310 | 1310 | If called with no arguments, it acts as a toggle. |
|
1311 | 1311 | |
|
1312 | 1312 | If called with a non-existent field, the resulting AttributeError |
|
1313 | 1313 | exception will propagate out.""" |
|
1314 | 1314 | |
|
1315 | 1315 | rc_val = getattr(self.rc,rc_field) |
|
1316 | 1316 | if value is None: |
|
1317 | 1317 | value = not rc_val |
|
1318 | 1318 | setattr(self.rc,rc_field,value) |
|
1319 | 1319 | |
|
1320 | 1320 | def user_setup(self,ipythondir,rc_suffix,mode='install'): |
|
1321 | 1321 | """Install the user configuration directory. |
|
1322 | 1322 | |
|
1323 | Note | |
|
1324 | ---- | |
|
1323 | Notes | |
|
1324 | ----- | |
|
1325 | 1325 | DEPRECATED: use the top-level user_setup() function instead. |
|
1326 | 1326 | """ |
|
1327 | 1327 | return user_setup(ipythondir,rc_suffix,mode) |
|
1328 | 1328 | |
|
1329 | 1329 | def atexit_operations(self): |
|
1330 | 1330 | """This will be executed at the time of exit. |
|
1331 | 1331 | |
|
1332 | 1332 | Saving of persistent data should be performed here. """ |
|
1333 | 1333 | |
|
1334 | 1334 | #print '*** IPython exit cleanup ***' # dbg |
|
1335 | 1335 | # input history |
|
1336 | 1336 | self.savehist() |
|
1337 | 1337 | |
|
1338 | 1338 | # Cleanup all tempfiles left around |
|
1339 | 1339 | for tfile in self.tempfiles: |
|
1340 | 1340 | try: |
|
1341 | 1341 | os.unlink(tfile) |
|
1342 | 1342 | except OSError: |
|
1343 | 1343 | pass |
|
1344 | 1344 | |
|
1345 | 1345 | # Clear all user namespaces to release all references cleanly. |
|
1346 | 1346 | self.reset() |
|
1347 | 1347 | |
|
1348 | 1348 | # Run user hooks |
|
1349 | 1349 | self.hooks.shutdown_hook() |
|
1350 | 1350 | |
|
1351 | 1351 | def reset(self): |
|
1352 | 1352 | """Clear all internal namespaces. |
|
1353 | 1353 | |
|
1354 | 1354 | Note that this is much more aggressive than %reset, since it clears |
|
1355 | 1355 | fully all namespaces, as well as all input/output lists. |
|
1356 | 1356 | """ |
|
1357 | 1357 | for ns in self.ns_refs_table: |
|
1358 | 1358 | ns.clear() |
|
1359 | 1359 | |
|
1360 | 1360 | # Clear input and output histories |
|
1361 | 1361 | self.input_hist[:] = [] |
|
1362 | 1362 | self.input_hist_raw[:] = [] |
|
1363 | 1363 | self.output_hist.clear() |
|
1364 | 1364 | # Restore the user namespaces to minimal usability |
|
1365 | 1365 | self.init_namespaces() |
|
1366 | 1366 | |
|
1367 | 1367 | def savehist(self): |
|
1368 | 1368 | """Save input history to a file (via readline library).""" |
|
1369 | 1369 | |
|
1370 | 1370 | if not self.has_readline: |
|
1371 | 1371 | return |
|
1372 | 1372 | |
|
1373 | 1373 | try: |
|
1374 | 1374 | self.readline.write_history_file(self.histfile) |
|
1375 | 1375 | except: |
|
1376 | 1376 | print 'Unable to save IPython command history to file: ' + \ |
|
1377 | 1377 | `self.histfile` |
|
1378 | 1378 | |
|
1379 | 1379 | def reloadhist(self): |
|
1380 | 1380 | """Reload the input history from disk file.""" |
|
1381 | 1381 | |
|
1382 | 1382 | if self.has_readline: |
|
1383 | 1383 | try: |
|
1384 | 1384 | self.readline.clear_history() |
|
1385 | 1385 | self.readline.read_history_file(self.shell.histfile) |
|
1386 | 1386 | except AttributeError: |
|
1387 | 1387 | pass |
|
1388 | 1388 | |
|
1389 | 1389 | |
|
1390 | 1390 | def history_saving_wrapper(self, func): |
|
1391 | 1391 | """ Wrap func for readline history saving |
|
1392 | 1392 | |
|
1393 | 1393 | Convert func into callable that saves & restores |
|
1394 | 1394 | history around the call """ |
|
1395 | 1395 | |
|
1396 | 1396 | if not self.has_readline: |
|
1397 | 1397 | return func |
|
1398 | 1398 | |
|
1399 | 1399 | def wrapper(): |
|
1400 | 1400 | self.savehist() |
|
1401 | 1401 | try: |
|
1402 | 1402 | func() |
|
1403 | 1403 | finally: |
|
1404 | 1404 | readline.read_history_file(self.histfile) |
|
1405 | 1405 | return wrapper |
|
1406 | 1406 | |
|
1407 | 1407 | def pre_readline(self): |
|
1408 | 1408 | """readline hook to be used at the start of each line. |
|
1409 | 1409 | |
|
1410 | 1410 | Currently it handles auto-indent only.""" |
|
1411 | 1411 | |
|
1412 | 1412 | #debugx('self.indent_current_nsp','pre_readline:') |
|
1413 | 1413 | |
|
1414 | 1414 | if self.rl_do_indent: |
|
1415 | 1415 | self.readline.insert_text(self.indent_current_str()) |
|
1416 | 1416 | if self.rl_next_input is not None: |
|
1417 | 1417 | self.readline.insert_text(self.rl_next_input) |
|
1418 | 1418 | self.rl_next_input = None |
|
1419 | 1419 | |
|
1420 | 1420 | def init_readline(self): |
|
1421 | 1421 | """Command history completion/saving/reloading.""" |
|
1422 | 1422 | |
|
1423 | 1423 | |
|
1424 | 1424 | import IPython.rlineimpl as readline |
|
1425 | 1425 | |
|
1426 | 1426 | if not readline.have_readline: |
|
1427 | 1427 | self.has_readline = 0 |
|
1428 | 1428 | self.readline = None |
|
1429 | 1429 | # no point in bugging windows users with this every time: |
|
1430 | 1430 | warn('Readline services not available on this platform.') |
|
1431 | 1431 | else: |
|
1432 | 1432 | sys.modules['readline'] = readline |
|
1433 | 1433 | import atexit |
|
1434 | 1434 | from IPython.completer import IPCompleter |
|
1435 | 1435 | self.Completer = IPCompleter(self, |
|
1436 | 1436 | self.user_ns, |
|
1437 | 1437 | self.user_global_ns, |
|
1438 | 1438 | self.rc.readline_omit__names, |
|
1439 | 1439 | self.alias_table) |
|
1440 | 1440 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1441 | 1441 | self.strdispatchers['complete_command'] = sdisp |
|
1442 | 1442 | self.Completer.custom_completers = sdisp |
|
1443 | 1443 | # Platform-specific configuration |
|
1444 | 1444 | if os.name == 'nt': |
|
1445 | 1445 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1446 | 1446 | else: |
|
1447 | 1447 | self.readline_startup_hook = readline.set_startup_hook |
|
1448 | 1448 | |
|
1449 | 1449 | # Load user's initrc file (readline config) |
|
1450 | 1450 | # Or if libedit is used, load editrc. |
|
1451 | 1451 | inputrc_name = os.environ.get('INPUTRC') |
|
1452 | 1452 | if inputrc_name is None: |
|
1453 | 1453 | home_dir = get_home_dir() |
|
1454 | 1454 | if home_dir is not None: |
|
1455 | 1455 | inputrc_name = '.inputrc' |
|
1456 | 1456 | if readline.uses_libedit: |
|
1457 | 1457 | inputrc_name = '.editrc' |
|
1458 | 1458 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1459 | 1459 | if os.path.isfile(inputrc_name): |
|
1460 | 1460 | try: |
|
1461 | 1461 | readline.read_init_file(inputrc_name) |
|
1462 | 1462 | except: |
|
1463 | 1463 | warn('Problems reading readline initialization file <%s>' |
|
1464 | 1464 | % inputrc_name) |
|
1465 | 1465 | |
|
1466 | 1466 | self.has_readline = 1 |
|
1467 | 1467 | self.readline = readline |
|
1468 | 1468 | # save this in sys so embedded copies can restore it properly |
|
1469 | 1469 | sys.ipcompleter = self.Completer.complete |
|
1470 | 1470 | self.set_completer() |
|
1471 | 1471 | |
|
1472 | 1472 | # Configure readline according to user's prefs |
|
1473 | 1473 | # This is only done if GNU readline is being used. If libedit |
|
1474 | 1474 | # is being used (as on Leopard) the readline config is |
|
1475 | 1475 | # not run as the syntax for libedit is different. |
|
1476 | 1476 | if not readline.uses_libedit: |
|
1477 | 1477 | for rlcommand in self.rc.readline_parse_and_bind: |
|
1478 | 1478 | #print "loading rl:",rlcommand # dbg |
|
1479 | 1479 | readline.parse_and_bind(rlcommand) |
|
1480 | 1480 | |
|
1481 | 1481 | # Remove some chars from the delimiters list. If we encounter |
|
1482 | 1482 | # unicode chars, discard them. |
|
1483 | 1483 | delims = readline.get_completer_delims().encode("ascii", "ignore") |
|
1484 | 1484 | delims = delims.translate(string._idmap, |
|
1485 | 1485 | self.rc.readline_remove_delims) |
|
1486 | 1486 | readline.set_completer_delims(delims) |
|
1487 | 1487 | # otherwise we end up with a monster history after a while: |
|
1488 | 1488 | readline.set_history_length(1000) |
|
1489 | 1489 | try: |
|
1490 | 1490 | #print '*** Reading readline history' # dbg |
|
1491 | 1491 | readline.read_history_file(self.histfile) |
|
1492 | 1492 | except IOError: |
|
1493 | 1493 | pass # It doesn't exist yet. |
|
1494 | 1494 | |
|
1495 | 1495 | atexit.register(self.atexit_operations) |
|
1496 | 1496 | del atexit |
|
1497 | 1497 | |
|
1498 | 1498 | # Configure auto-indent for all platforms |
|
1499 | 1499 | self.set_autoindent(self.rc.autoindent) |
|
1500 | 1500 | |
|
1501 | 1501 | def ask_yes_no(self,prompt,default=True): |
|
1502 | 1502 | if self.rc.quiet: |
|
1503 | 1503 | return True |
|
1504 | 1504 | return ask_yes_no(prompt,default) |
|
1505 | 1505 | |
|
1506 | 1506 | def new_main_mod(self,ns=None): |
|
1507 | 1507 | """Return a new 'main' module object for user code execution. |
|
1508 | 1508 | """ |
|
1509 | 1509 | main_mod = self._user_main_module |
|
1510 | 1510 | init_fakemod_dict(main_mod,ns) |
|
1511 | 1511 | return main_mod |
|
1512 | 1512 | |
|
1513 | 1513 | def cache_main_mod(self,ns,fname): |
|
1514 | 1514 | """Cache a main module's namespace. |
|
1515 | 1515 | |
|
1516 | 1516 | When scripts are executed via %run, we must keep a reference to the |
|
1517 | 1517 | namespace of their __main__ module (a FakeModule instance) around so |
|
1518 | 1518 | that Python doesn't clear it, rendering objects defined therein |
|
1519 | 1519 | useless. |
|
1520 | 1520 | |
|
1521 | 1521 | This method keeps said reference in a private dict, keyed by the |
|
1522 | 1522 | absolute path of the module object (which corresponds to the script |
|
1523 | 1523 | path). This way, for multiple executions of the same script we only |
|
1524 | 1524 | keep one copy of the namespace (the last one), thus preventing memory |
|
1525 | 1525 | leaks from old references while allowing the objects from the last |
|
1526 | 1526 | execution to be accessible. |
|
1527 | 1527 | |
|
1528 | 1528 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
1529 | 1529 | because of how Python tears down modules (it hard-sets all their |
|
1530 | 1530 | references to None without regard for reference counts). This method |
|
1531 | 1531 | must therefore make a *copy* of the given namespace, to allow the |
|
1532 | 1532 | original module's __dict__ to be cleared and reused. |
|
1533 | 1533 | |
|
1534 | 1534 | |
|
1535 | 1535 | Parameters |
|
1536 | 1536 | ---------- |
|
1537 | 1537 | ns : a namespace (a dict, typically) |
|
1538 | 1538 | |
|
1539 | 1539 | fname : str |
|
1540 | 1540 | Filename associated with the namespace. |
|
1541 | 1541 | |
|
1542 | 1542 | Examples |
|
1543 | 1543 | -------- |
|
1544 | 1544 | |
|
1545 | 1545 | In [10]: import IPython |
|
1546 | 1546 | |
|
1547 | 1547 | In [11]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
1548 | 1548 | |
|
1549 | 1549 | In [12]: IPython.__file__ in _ip.IP._main_ns_cache |
|
1550 | 1550 | Out[12]: True |
|
1551 | 1551 | """ |
|
1552 | 1552 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
1553 | 1553 | |
|
1554 | 1554 | def clear_main_mod_cache(self): |
|
1555 | 1555 | """Clear the cache of main modules. |
|
1556 | 1556 | |
|
1557 | 1557 | Mainly for use by utilities like %reset. |
|
1558 | 1558 | |
|
1559 | 1559 | Examples |
|
1560 | 1560 | -------- |
|
1561 | 1561 | |
|
1562 | 1562 | In [15]: import IPython |
|
1563 | 1563 | |
|
1564 | 1564 | In [16]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
1565 | 1565 | |
|
1566 | 1566 | In [17]: len(_ip.IP._main_ns_cache) > 0 |
|
1567 | 1567 | Out[17]: True |
|
1568 | 1568 | |
|
1569 | 1569 | In [18]: _ip.IP.clear_main_mod_cache() |
|
1570 | 1570 | |
|
1571 | 1571 | In [19]: len(_ip.IP._main_ns_cache) == 0 |
|
1572 | 1572 | Out[19]: True |
|
1573 | 1573 | """ |
|
1574 | 1574 | self._main_ns_cache.clear() |
|
1575 | 1575 | |
|
1576 | 1576 | def _should_recompile(self,e): |
|
1577 | 1577 | """Utility routine for edit_syntax_error""" |
|
1578 | 1578 | |
|
1579 | 1579 | if e.filename in ('<ipython console>','<input>','<string>', |
|
1580 | 1580 | '<console>','<BackgroundJob compilation>', |
|
1581 | 1581 | None): |
|
1582 | 1582 | |
|
1583 | 1583 | return False |
|
1584 | 1584 | try: |
|
1585 | 1585 | if (self.rc.autoedit_syntax and |
|
1586 | 1586 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
1587 | 1587 | '[Y/n] ','y')): |
|
1588 | 1588 | return False |
|
1589 | 1589 | except EOFError: |
|
1590 | 1590 | return False |
|
1591 | 1591 | |
|
1592 | 1592 | def int0(x): |
|
1593 | 1593 | try: |
|
1594 | 1594 | return int(x) |
|
1595 | 1595 | except TypeError: |
|
1596 | 1596 | return 0 |
|
1597 | 1597 | # always pass integer line and offset values to editor hook |
|
1598 | 1598 | try: |
|
1599 | 1599 | self.hooks.fix_error_editor(e.filename, |
|
1600 | 1600 | int0(e.lineno),int0(e.offset),e.msg) |
|
1601 | 1601 | except IPython.ipapi.TryNext: |
|
1602 | 1602 | warn('Could not open editor') |
|
1603 | 1603 | return False |
|
1604 | 1604 | return True |
|
1605 | 1605 | |
|
1606 | 1606 | def edit_syntax_error(self): |
|
1607 | 1607 | """The bottom half of the syntax error handler called in the main loop. |
|
1608 | 1608 | |
|
1609 | 1609 | Loop until syntax error is fixed or user cancels. |
|
1610 | 1610 | """ |
|
1611 | 1611 | |
|
1612 | 1612 | while self.SyntaxTB.last_syntax_error: |
|
1613 | 1613 | # copy and clear last_syntax_error |
|
1614 | 1614 | err = self.SyntaxTB.clear_err_state() |
|
1615 | 1615 | if not self._should_recompile(err): |
|
1616 | 1616 | return |
|
1617 | 1617 | try: |
|
1618 | 1618 | # may set last_syntax_error again if a SyntaxError is raised |
|
1619 | 1619 | self.safe_execfile(err.filename,self.user_ns) |
|
1620 | 1620 | except: |
|
1621 | 1621 | self.showtraceback() |
|
1622 | 1622 | else: |
|
1623 | 1623 | try: |
|
1624 | 1624 | f = file(err.filename) |
|
1625 | 1625 | try: |
|
1626 | 1626 | sys.displayhook(f.read()) |
|
1627 | 1627 | finally: |
|
1628 | 1628 | f.close() |
|
1629 | 1629 | except: |
|
1630 | 1630 | self.showtraceback() |
|
1631 | 1631 | |
|
1632 | 1632 | def showsyntaxerror(self, filename=None): |
|
1633 | 1633 | """Display the syntax error that just occurred. |
|
1634 | 1634 | |
|
1635 | 1635 | This doesn't display a stack trace because there isn't one. |
|
1636 | 1636 | |
|
1637 | 1637 | If a filename is given, it is stuffed in the exception instead |
|
1638 | 1638 | of what was there before (because Python's parser always uses |
|
1639 | 1639 | "<string>" when reading from a string). |
|
1640 | 1640 | """ |
|
1641 | 1641 | etype, value, last_traceback = sys.exc_info() |
|
1642 | 1642 | |
|
1643 | 1643 | # See note about these variables in showtraceback() below |
|
1644 | 1644 | sys.last_type = etype |
|
1645 | 1645 | sys.last_value = value |
|
1646 | 1646 | sys.last_traceback = last_traceback |
|
1647 | 1647 | |
|
1648 | 1648 | if filename and etype is SyntaxError: |
|
1649 | 1649 | # Work hard to stuff the correct filename in the exception |
|
1650 | 1650 | try: |
|
1651 | 1651 | msg, (dummy_filename, lineno, offset, line) = value |
|
1652 | 1652 | except: |
|
1653 | 1653 | # Not the format we expect; leave it alone |
|
1654 | 1654 | pass |
|
1655 | 1655 | else: |
|
1656 | 1656 | # Stuff in the right filename |
|
1657 | 1657 | try: |
|
1658 | 1658 | # Assume SyntaxError is a class exception |
|
1659 | 1659 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1660 | 1660 | except: |
|
1661 | 1661 | # If that failed, assume SyntaxError is a string |
|
1662 | 1662 | value = msg, (filename, lineno, offset, line) |
|
1663 | 1663 | self.SyntaxTB(etype,value,[]) |
|
1664 | 1664 | |
|
1665 | 1665 | def debugger(self,force=False): |
|
1666 | 1666 | """Call the pydb/pdb debugger. |
|
1667 | 1667 | |
|
1668 | 1668 | Keywords: |
|
1669 | 1669 | |
|
1670 | 1670 | - force(False): by default, this routine checks the instance call_pdb |
|
1671 | 1671 | flag and does not actually invoke the debugger if the flag is false. |
|
1672 | 1672 | The 'force' option forces the debugger to activate even if the flag |
|
1673 | 1673 | is false. |
|
1674 | 1674 | """ |
|
1675 | 1675 | |
|
1676 | 1676 | if not (force or self.call_pdb): |
|
1677 | 1677 | return |
|
1678 | 1678 | |
|
1679 | 1679 | if not hasattr(sys,'last_traceback'): |
|
1680 | 1680 | error('No traceback has been produced, nothing to debug.') |
|
1681 | 1681 | return |
|
1682 | 1682 | |
|
1683 | 1683 | # use pydb if available |
|
1684 | 1684 | if Debugger.has_pydb: |
|
1685 | 1685 | from pydb import pm |
|
1686 | 1686 | else: |
|
1687 | 1687 | # fallback to our internal debugger |
|
1688 | 1688 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
1689 | 1689 | self.history_saving_wrapper(pm)() |
|
1690 | 1690 | |
|
1691 | 1691 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): |
|
1692 | 1692 | """Display the exception that just occurred. |
|
1693 | 1693 | |
|
1694 | 1694 | If nothing is known about the exception, this is the method which |
|
1695 | 1695 | should be used throughout the code for presenting user tracebacks, |
|
1696 | 1696 | rather than directly invoking the InteractiveTB object. |
|
1697 | 1697 | |
|
1698 | 1698 | A specific showsyntaxerror() also exists, but this method can take |
|
1699 | 1699 | care of calling it if needed, so unless you are explicitly catching a |
|
1700 | 1700 | SyntaxError exception, don't try to analyze the stack manually and |
|
1701 | 1701 | simply call this method.""" |
|
1702 | 1702 | |
|
1703 | 1703 | |
|
1704 | 1704 | # Though this won't be called by syntax errors in the input line, |
|
1705 | 1705 | # there may be SyntaxError cases whith imported code. |
|
1706 | 1706 | |
|
1707 | 1707 | try: |
|
1708 | 1708 | if exc_tuple is None: |
|
1709 | 1709 | etype, value, tb = sys.exc_info() |
|
1710 | 1710 | else: |
|
1711 | 1711 | etype, value, tb = exc_tuple |
|
1712 | 1712 | |
|
1713 | 1713 | if etype is SyntaxError: |
|
1714 | 1714 | self.showsyntaxerror(filename) |
|
1715 | 1715 | elif etype is IPython.ipapi.UsageError: |
|
1716 | 1716 | print "UsageError:", value |
|
1717 | 1717 | else: |
|
1718 | 1718 | # WARNING: these variables are somewhat deprecated and not |
|
1719 | 1719 | # necessarily safe to use in a threaded environment, but tools |
|
1720 | 1720 | # like pdb depend on their existence, so let's set them. If we |
|
1721 | 1721 | # find problems in the field, we'll need to revisit their use. |
|
1722 | 1722 | sys.last_type = etype |
|
1723 | 1723 | sys.last_value = value |
|
1724 | 1724 | sys.last_traceback = tb |
|
1725 | 1725 | |
|
1726 | 1726 | if etype in self.custom_exceptions: |
|
1727 | 1727 | self.CustomTB(etype,value,tb) |
|
1728 | 1728 | else: |
|
1729 | 1729 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) |
|
1730 | 1730 | if self.InteractiveTB.call_pdb and self.has_readline: |
|
1731 | 1731 | # pdb mucks up readline, fix it back |
|
1732 | 1732 | self.set_completer() |
|
1733 | 1733 | except KeyboardInterrupt: |
|
1734 | 1734 | self.write("\nKeyboardInterrupt\n") |
|
1735 | 1735 | |
|
1736 | 1736 | def mainloop(self,banner=None): |
|
1737 | 1737 | """Creates the local namespace and starts the mainloop. |
|
1738 | 1738 | |
|
1739 | 1739 | If an optional banner argument is given, it will override the |
|
1740 | 1740 | internally created default banner.""" |
|
1741 | 1741 | |
|
1742 | 1742 | if self.rc.c: # Emulate Python's -c option |
|
1743 | 1743 | self.exec_init_cmd() |
|
1744 | 1744 | if banner is None: |
|
1745 | 1745 | if not self.rc.banner: |
|
1746 | 1746 | banner = '' |
|
1747 | 1747 | # banner is string? Use it directly! |
|
1748 | 1748 | elif isinstance(self.rc.banner,basestring): |
|
1749 | 1749 | banner = self.rc.banner |
|
1750 | 1750 | else: |
|
1751 | 1751 | banner = self.BANNER+self.banner2 |
|
1752 | 1752 | |
|
1753 | 1753 | # if you run stuff with -c <cmd>, raw hist is not updated |
|
1754 | 1754 | # ensure that it's in sync |
|
1755 | 1755 | if len(self.input_hist) != len (self.input_hist_raw): |
|
1756 | 1756 | self.input_hist_raw = InputList(self.input_hist) |
|
1757 | 1757 | |
|
1758 | 1758 | while 1: |
|
1759 | 1759 | try: |
|
1760 | 1760 | self.interact(banner) |
|
1761 | 1761 | #self.interact_with_readline() |
|
1762 | 1762 | |
|
1763 | 1763 | # XXX for testing of a readline-decoupled repl loop, call |
|
1764 | 1764 | # interact_with_readline above |
|
1765 | 1765 | |
|
1766 | 1766 | break |
|
1767 | 1767 | except KeyboardInterrupt: |
|
1768 | 1768 | # this should not be necessary, but KeyboardInterrupt |
|
1769 | 1769 | # handling seems rather unpredictable... |
|
1770 | 1770 | self.write("\nKeyboardInterrupt in interact()\n") |
|
1771 | 1771 | |
|
1772 | 1772 | def exec_init_cmd(self): |
|
1773 | 1773 | """Execute a command given at the command line. |
|
1774 | 1774 | |
|
1775 | 1775 | This emulates Python's -c option.""" |
|
1776 | 1776 | |
|
1777 | 1777 | #sys.argv = ['-c'] |
|
1778 | 1778 | self.push(self.prefilter(self.rc.c, False)) |
|
1779 | 1779 | if not self.rc.interact: |
|
1780 | 1780 | self.ask_exit() |
|
1781 | 1781 | |
|
1782 | 1782 | def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0): |
|
1783 | 1783 | """Embeds IPython into a running python program. |
|
1784 | 1784 | |
|
1785 | 1785 | Input: |
|
1786 | 1786 | |
|
1787 | 1787 | - header: An optional header message can be specified. |
|
1788 | 1788 | |
|
1789 | 1789 | - local_ns, global_ns: working namespaces. If given as None, the |
|
1790 | 1790 | IPython-initialized one is updated with __main__.__dict__, so that |
|
1791 | 1791 | program variables become visible but user-specific configuration |
|
1792 | 1792 | remains possible. |
|
1793 | 1793 | |
|
1794 | 1794 | - stack_depth: specifies how many levels in the stack to go to |
|
1795 | 1795 | looking for namespaces (when local_ns and global_ns are None). This |
|
1796 | 1796 | allows an intermediate caller to make sure that this function gets |
|
1797 | 1797 | the namespace from the intended level in the stack. By default (0) |
|
1798 | 1798 | it will get its locals and globals from the immediate caller. |
|
1799 | 1799 | |
|
1800 | 1800 | Warning: it's possible to use this in a program which is being run by |
|
1801 | 1801 | IPython itself (via %run), but some funny things will happen (a few |
|
1802 | 1802 | globals get overwritten). In the future this will be cleaned up, as |
|
1803 | 1803 | there is no fundamental reason why it can't work perfectly.""" |
|
1804 | 1804 | |
|
1805 | 1805 | # Get locals and globals from caller |
|
1806 | 1806 | if local_ns is None or global_ns is None: |
|
1807 | 1807 | call_frame = sys._getframe(stack_depth).f_back |
|
1808 | 1808 | |
|
1809 | 1809 | if local_ns is None: |
|
1810 | 1810 | local_ns = call_frame.f_locals |
|
1811 | 1811 | if global_ns is None: |
|
1812 | 1812 | global_ns = call_frame.f_globals |
|
1813 | 1813 | |
|
1814 | 1814 | # Update namespaces and fire up interpreter |
|
1815 | 1815 | |
|
1816 | 1816 | # The global one is easy, we can just throw it in |
|
1817 | 1817 | self.user_global_ns = global_ns |
|
1818 | 1818 | |
|
1819 | 1819 | # but the user/local one is tricky: ipython needs it to store internal |
|
1820 | 1820 | # data, but we also need the locals. We'll copy locals in the user |
|
1821 | 1821 | # one, but will track what got copied so we can delete them at exit. |
|
1822 | 1822 | # This is so that a later embedded call doesn't see locals from a |
|
1823 | 1823 | # previous call (which most likely existed in a separate scope). |
|
1824 | 1824 | local_varnames = local_ns.keys() |
|
1825 | 1825 | self.user_ns.update(local_ns) |
|
1826 | 1826 | #self.user_ns['local_ns'] = local_ns # dbg |
|
1827 | 1827 | |
|
1828 | 1828 | # Patch for global embedding to make sure that things don't overwrite |
|
1829 | 1829 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> |
|
1830 | 1830 | # FIXME. Test this a bit more carefully (the if.. is new) |
|
1831 | 1831 | if local_ns is None and global_ns is None: |
|
1832 | 1832 | self.user_global_ns.update(__main__.__dict__) |
|
1833 | 1833 | |
|
1834 | 1834 | # make sure the tab-completer has the correct frame information, so it |
|
1835 | 1835 | # actually completes using the frame's locals/globals |
|
1836 | 1836 | self.set_completer_frame() |
|
1837 | 1837 | |
|
1838 | 1838 | # before activating the interactive mode, we need to make sure that |
|
1839 | 1839 | # all names in the builtin namespace needed by ipython point to |
|
1840 | 1840 | # ourselves, and not to other instances. |
|
1841 | 1841 | self.add_builtins() |
|
1842 | 1842 | |
|
1843 | 1843 | self.interact(header) |
|
1844 | 1844 | |
|
1845 | 1845 | # now, purge out the user namespace from anything we might have added |
|
1846 | 1846 | # from the caller's local namespace |
|
1847 | 1847 | delvar = self.user_ns.pop |
|
1848 | 1848 | for var in local_varnames: |
|
1849 | 1849 | delvar(var,None) |
|
1850 | 1850 | # and clean builtins we may have overridden |
|
1851 | 1851 | self.clean_builtins() |
|
1852 | 1852 | |
|
1853 | 1853 | def interact_prompt(self): |
|
1854 | 1854 | """ Print the prompt (in read-eval-print loop) |
|
1855 | 1855 | |
|
1856 | 1856 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1857 | 1857 | used in standard IPython flow. |
|
1858 | 1858 | """ |
|
1859 | 1859 | if self.more: |
|
1860 | 1860 | try: |
|
1861 | 1861 | prompt = self.hooks.generate_prompt(True) |
|
1862 | 1862 | except: |
|
1863 | 1863 | self.showtraceback() |
|
1864 | 1864 | if self.autoindent: |
|
1865 | 1865 | self.rl_do_indent = True |
|
1866 | 1866 | |
|
1867 | 1867 | else: |
|
1868 | 1868 | try: |
|
1869 | 1869 | prompt = self.hooks.generate_prompt(False) |
|
1870 | 1870 | except: |
|
1871 | 1871 | self.showtraceback() |
|
1872 | 1872 | self.write(prompt) |
|
1873 | 1873 | |
|
1874 | 1874 | def interact_handle_input(self,line): |
|
1875 | 1875 | """ Handle the input line (in read-eval-print loop) |
|
1876 | 1876 | |
|
1877 | 1877 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1878 | 1878 | used in standard IPython flow. |
|
1879 | 1879 | """ |
|
1880 | 1880 | if line.lstrip() == line: |
|
1881 | 1881 | self.shadowhist.add(line.strip()) |
|
1882 | 1882 | lineout = self.prefilter(line,self.more) |
|
1883 | 1883 | |
|
1884 | 1884 | if line.strip(): |
|
1885 | 1885 | if self.more: |
|
1886 | 1886 | self.input_hist_raw[-1] += '%s\n' % line |
|
1887 | 1887 | else: |
|
1888 | 1888 | self.input_hist_raw.append('%s\n' % line) |
|
1889 | 1889 | |
|
1890 | 1890 | |
|
1891 | 1891 | self.more = self.push(lineout) |
|
1892 | 1892 | if (self.SyntaxTB.last_syntax_error and |
|
1893 | 1893 | self.rc.autoedit_syntax): |
|
1894 | 1894 | self.edit_syntax_error() |
|
1895 | 1895 | |
|
1896 | 1896 | def interact_with_readline(self): |
|
1897 | 1897 | """ Demo of using interact_handle_input, interact_prompt |
|
1898 | 1898 | |
|
1899 | 1899 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), |
|
1900 | 1900 | it should work like this. |
|
1901 | 1901 | """ |
|
1902 | 1902 | self.readline_startup_hook(self.pre_readline) |
|
1903 | 1903 | while not self.exit_now: |
|
1904 | 1904 | self.interact_prompt() |
|
1905 | 1905 | if self.more: |
|
1906 | 1906 | self.rl_do_indent = True |
|
1907 | 1907 | else: |
|
1908 | 1908 | self.rl_do_indent = False |
|
1909 | 1909 | line = raw_input_original().decode(self.stdin_encoding) |
|
1910 | 1910 | self.interact_handle_input(line) |
|
1911 | 1911 | |
|
1912 | 1912 | |
|
1913 | 1913 | def interact(self, banner=None): |
|
1914 | 1914 | """Closely emulate the interactive Python console. |
|
1915 | 1915 | |
|
1916 | 1916 | The optional banner argument specify the banner to print |
|
1917 | 1917 | before the first interaction; by default it prints a banner |
|
1918 | 1918 | similar to the one printed by the real Python interpreter, |
|
1919 | 1919 | followed by the current class name in parentheses (so as not |
|
1920 | 1920 | to confuse this with the real interpreter -- since it's so |
|
1921 | 1921 | close!). |
|
1922 | 1922 | |
|
1923 | 1923 | """ |
|
1924 | 1924 | |
|
1925 | 1925 | if self.exit_now: |
|
1926 | 1926 | # batch run -> do not interact |
|
1927 | 1927 | return |
|
1928 | 1928 | cprt = 'Type "copyright", "credits" or "license" for more information.' |
|
1929 | 1929 | if banner is None: |
|
1930 | 1930 | self.write("Python %s on %s\n%s\n(%s)\n" % |
|
1931 | 1931 | (sys.version, sys.platform, cprt, |
|
1932 | 1932 | self.__class__.__name__)) |
|
1933 | 1933 | else: |
|
1934 | 1934 | self.write(banner) |
|
1935 | 1935 | |
|
1936 | 1936 | more = 0 |
|
1937 | 1937 | |
|
1938 | 1938 | # Mark activity in the builtins |
|
1939 | 1939 | __builtin__.__dict__['__IPYTHON__active'] += 1 |
|
1940 | 1940 | |
|
1941 | 1941 | if self.has_readline: |
|
1942 | 1942 | self.readline_startup_hook(self.pre_readline) |
|
1943 | 1943 | # exit_now is set by a call to %Exit or %Quit, through the |
|
1944 | 1944 | # ask_exit callback. |
|
1945 | 1945 | |
|
1946 | 1946 | while not self.exit_now: |
|
1947 | 1947 | self.hooks.pre_prompt_hook() |
|
1948 | 1948 | if more: |
|
1949 | 1949 | try: |
|
1950 | 1950 | prompt = self.hooks.generate_prompt(True) |
|
1951 | 1951 | except: |
|
1952 | 1952 | self.showtraceback() |
|
1953 | 1953 | if self.autoindent: |
|
1954 | 1954 | self.rl_do_indent = True |
|
1955 | 1955 | |
|
1956 | 1956 | else: |
|
1957 | 1957 | try: |
|
1958 | 1958 | prompt = self.hooks.generate_prompt(False) |
|
1959 | 1959 | except: |
|
1960 | 1960 | self.showtraceback() |
|
1961 | 1961 | try: |
|
1962 | 1962 | line = self.raw_input(prompt,more) |
|
1963 | 1963 | if self.exit_now: |
|
1964 | 1964 | # quick exit on sys.std[in|out] close |
|
1965 | 1965 | break |
|
1966 | 1966 | if self.autoindent: |
|
1967 | 1967 | self.rl_do_indent = False |
|
1968 | 1968 | |
|
1969 | 1969 | except KeyboardInterrupt: |
|
1970 | 1970 | #double-guard against keyboardinterrupts during kbdint handling |
|
1971 | 1971 | try: |
|
1972 | 1972 | self.write('\nKeyboardInterrupt\n') |
|
1973 | 1973 | self.resetbuffer() |
|
1974 | 1974 | # keep cache in sync with the prompt counter: |
|
1975 | 1975 | self.outputcache.prompt_count -= 1 |
|
1976 | 1976 | |
|
1977 | 1977 | if self.autoindent: |
|
1978 | 1978 | self.indent_current_nsp = 0 |
|
1979 | 1979 | more = 0 |
|
1980 | 1980 | except KeyboardInterrupt: |
|
1981 | 1981 | pass |
|
1982 | 1982 | except EOFError: |
|
1983 | 1983 | if self.autoindent: |
|
1984 | 1984 | self.rl_do_indent = False |
|
1985 | 1985 | self.readline_startup_hook(None) |
|
1986 | 1986 | self.write('\n') |
|
1987 | 1987 | self.exit() |
|
1988 | 1988 | except bdb.BdbQuit: |
|
1989 | 1989 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
1990 | 1990 | 'Because of how pdb handles the stack, it is impossible\n' |
|
1991 | 1991 | 'for IPython to properly format this particular exception.\n' |
|
1992 | 1992 | 'IPython will resume normal operation.') |
|
1993 | 1993 | except: |
|
1994 | 1994 | # exceptions here are VERY RARE, but they can be triggered |
|
1995 | 1995 | # asynchronously by signal handlers, for example. |
|
1996 | 1996 | self.showtraceback() |
|
1997 | 1997 | else: |
|
1998 | 1998 | more = self.push(line) |
|
1999 | 1999 | if (self.SyntaxTB.last_syntax_error and |
|
2000 | 2000 | self.rc.autoedit_syntax): |
|
2001 | 2001 | self.edit_syntax_error() |
|
2002 | 2002 | |
|
2003 | 2003 | # We are off again... |
|
2004 | 2004 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
2005 | 2005 | |
|
2006 | 2006 | def excepthook(self, etype, value, tb): |
|
2007 | 2007 | """One more defense for GUI apps that call sys.excepthook. |
|
2008 | 2008 | |
|
2009 | 2009 | GUI frameworks like wxPython trap exceptions and call |
|
2010 | 2010 | sys.excepthook themselves. I guess this is a feature that |
|
2011 | 2011 | enables them to keep running after exceptions that would |
|
2012 | 2012 | otherwise kill their mainloop. This is a bother for IPython |
|
2013 | 2013 | which excepts to catch all of the program exceptions with a try: |
|
2014 | 2014 | except: statement. |
|
2015 | 2015 | |
|
2016 | 2016 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
2017 | 2017 | any app directly invokes sys.excepthook, it will look to the user like |
|
2018 | 2018 | IPython crashed. In order to work around this, we can disable the |
|
2019 | 2019 | CrashHandler and replace it with this excepthook instead, which prints a |
|
2020 | 2020 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
2021 | 2021 | call sys.excepthook will generate a regular-looking exception from |
|
2022 | 2022 | IPython, and the CrashHandler will only be triggered by real IPython |
|
2023 | 2023 | crashes. |
|
2024 | 2024 | |
|
2025 | 2025 | This hook should be used sparingly, only in places which are not likely |
|
2026 | 2026 | to be true IPython errors. |
|
2027 | 2027 | """ |
|
2028 | 2028 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
2029 | 2029 | |
|
2030 | 2030 | def expand_aliases(self,fn,rest): |
|
2031 | 2031 | """ Expand multiple levels of aliases: |
|
2032 | 2032 | |
|
2033 | 2033 | if: |
|
2034 | 2034 | |
|
2035 | 2035 | alias foo bar /tmp |
|
2036 | 2036 | alias baz foo |
|
2037 | 2037 | |
|
2038 | 2038 | then: |
|
2039 | 2039 | |
|
2040 | 2040 | baz huhhahhei -> bar /tmp huhhahhei |
|
2041 | 2041 | |
|
2042 | 2042 | """ |
|
2043 | 2043 | line = fn + " " + rest |
|
2044 | 2044 | |
|
2045 | 2045 | done = set() |
|
2046 | 2046 | while 1: |
|
2047 | 2047 | pre,fn,rest = prefilter.splitUserInput(line, |
|
2048 | 2048 | prefilter.shell_line_split) |
|
2049 | 2049 | if fn in self.alias_table: |
|
2050 | 2050 | if fn in done: |
|
2051 | 2051 | warn("Cyclic alias definition, repeated '%s'" % fn) |
|
2052 | 2052 | return "" |
|
2053 | 2053 | done.add(fn) |
|
2054 | 2054 | |
|
2055 | 2055 | l2 = self.transform_alias(fn,rest) |
|
2056 | 2056 | # dir -> dir |
|
2057 | 2057 | # print "alias",line, "->",l2 #dbg |
|
2058 | 2058 | if l2 == line: |
|
2059 | 2059 | break |
|
2060 | 2060 | # ls -> ls -F should not recurse forever |
|
2061 | 2061 | if l2.split(None,1)[0] == line.split(None,1)[0]: |
|
2062 | 2062 | line = l2 |
|
2063 | 2063 | break |
|
2064 | 2064 | |
|
2065 | 2065 | line=l2 |
|
2066 | 2066 | |
|
2067 | 2067 | |
|
2068 | 2068 | # print "al expand to",line #dbg |
|
2069 | 2069 | else: |
|
2070 | 2070 | break |
|
2071 | 2071 | |
|
2072 | 2072 | return line |
|
2073 | 2073 | |
|
2074 | 2074 | def transform_alias(self, alias,rest=''): |
|
2075 | 2075 | """ Transform alias to system command string. |
|
2076 | 2076 | """ |
|
2077 | 2077 | trg = self.alias_table[alias] |
|
2078 | 2078 | |
|
2079 | 2079 | nargs,cmd = trg |
|
2080 | 2080 | # print trg #dbg |
|
2081 | 2081 | if ' ' in cmd and os.path.isfile(cmd): |
|
2082 | 2082 | cmd = '"%s"' % cmd |
|
2083 | 2083 | |
|
2084 | 2084 | # Expand the %l special to be the user's input line |
|
2085 | 2085 | if cmd.find('%l') >= 0: |
|
2086 | 2086 | cmd = cmd.replace('%l',rest) |
|
2087 | 2087 | rest = '' |
|
2088 | 2088 | if nargs==0: |
|
2089 | 2089 | # Simple, argument-less aliases |
|
2090 | 2090 | cmd = '%s %s' % (cmd,rest) |
|
2091 | 2091 | else: |
|
2092 | 2092 | # Handle aliases with positional arguments |
|
2093 | 2093 | args = rest.split(None,nargs) |
|
2094 | 2094 | if len(args)< nargs: |
|
2095 | 2095 | error('Alias <%s> requires %s arguments, %s given.' % |
|
2096 | 2096 | (alias,nargs,len(args))) |
|
2097 | 2097 | return None |
|
2098 | 2098 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) |
|
2099 | 2099 | # Now call the macro, evaluating in the user's namespace |
|
2100 | 2100 | #print 'new command: <%r>' % cmd # dbg |
|
2101 | 2101 | return cmd |
|
2102 | 2102 | |
|
2103 | 2103 | def call_alias(self,alias,rest=''): |
|
2104 | 2104 | """Call an alias given its name and the rest of the line. |
|
2105 | 2105 | |
|
2106 | 2106 | This is only used to provide backwards compatibility for users of |
|
2107 | 2107 | ipalias(), use of which is not recommended for anymore.""" |
|
2108 | 2108 | |
|
2109 | 2109 | # Now call the macro, evaluating in the user's namespace |
|
2110 | 2110 | cmd = self.transform_alias(alias, rest) |
|
2111 | 2111 | try: |
|
2112 | 2112 | self.system(cmd) |
|
2113 | 2113 | except: |
|
2114 | 2114 | self.showtraceback() |
|
2115 | 2115 | |
|
2116 | 2116 | def indent_current_str(self): |
|
2117 | 2117 | """return the current level of indentation as a string""" |
|
2118 | 2118 | return self.indent_current_nsp * ' ' |
|
2119 | 2119 | |
|
2120 | 2120 | def autoindent_update(self,line): |
|
2121 | 2121 | """Keep track of the indent level.""" |
|
2122 | 2122 | |
|
2123 | 2123 | #debugx('line') |
|
2124 | 2124 | #debugx('self.indent_current_nsp') |
|
2125 | 2125 | if self.autoindent: |
|
2126 | 2126 | if line: |
|
2127 | 2127 | inisp = num_ini_spaces(line) |
|
2128 | 2128 | if inisp < self.indent_current_nsp: |
|
2129 | 2129 | self.indent_current_nsp = inisp |
|
2130 | 2130 | |
|
2131 | 2131 | if line[-1] == ':': |
|
2132 | 2132 | self.indent_current_nsp += 4 |
|
2133 | 2133 | elif dedent_re.match(line): |
|
2134 | 2134 | self.indent_current_nsp -= 4 |
|
2135 | 2135 | else: |
|
2136 | 2136 | self.indent_current_nsp = 0 |
|
2137 | 2137 | |
|
2138 | 2138 | def runlines(self,lines): |
|
2139 | 2139 | """Run a string of one or more lines of source. |
|
2140 | 2140 | |
|
2141 | 2141 | This method is capable of running a string containing multiple source |
|
2142 | 2142 | lines, as if they had been entered at the IPython prompt. Since it |
|
2143 | 2143 | exposes IPython's processing machinery, the given strings can contain |
|
2144 | 2144 | magic calls (%magic), special shell access (!cmd), etc.""" |
|
2145 | 2145 | |
|
2146 | 2146 | # We must start with a clean buffer, in case this is run from an |
|
2147 | 2147 | # interactive IPython session (via a magic, for example). |
|
2148 | 2148 | self.resetbuffer() |
|
2149 | 2149 | lines = lines.split('\n') |
|
2150 | 2150 | more = 0 |
|
2151 | 2151 | |
|
2152 | 2152 | for line in lines: |
|
2153 | 2153 | # skip blank lines so we don't mess up the prompt counter, but do |
|
2154 | 2154 | # NOT skip even a blank line if we are in a code block (more is |
|
2155 | 2155 | # true) |
|
2156 | 2156 | |
|
2157 | 2157 | if line or more: |
|
2158 | 2158 | # push to raw history, so hist line numbers stay in sync |
|
2159 | 2159 | self.input_hist_raw.append("# " + line + "\n") |
|
2160 | 2160 | more = self.push(self.prefilter(line,more)) |
|
2161 | 2161 | # IPython's runsource returns None if there was an error |
|
2162 | 2162 | # compiling the code. This allows us to stop processing right |
|
2163 | 2163 | # away, so the user gets the error message at the right place. |
|
2164 | 2164 | if more is None: |
|
2165 | 2165 | break |
|
2166 | 2166 | else: |
|
2167 | 2167 | self.input_hist_raw.append("\n") |
|
2168 | 2168 | # final newline in case the input didn't have it, so that the code |
|
2169 | 2169 | # actually does get executed |
|
2170 | 2170 | if more: |
|
2171 | 2171 | self.push('\n') |
|
2172 | 2172 | |
|
2173 | 2173 | def runsource(self, source, filename='<input>', symbol='single'): |
|
2174 | 2174 | """Compile and run some source in the interpreter. |
|
2175 | 2175 | |
|
2176 | 2176 | Arguments are as for compile_command(). |
|
2177 | 2177 | |
|
2178 | 2178 | One several things can happen: |
|
2179 | 2179 | |
|
2180 | 2180 | 1) The input is incorrect; compile_command() raised an |
|
2181 | 2181 | exception (SyntaxError or OverflowError). A syntax traceback |
|
2182 | 2182 | will be printed by calling the showsyntaxerror() method. |
|
2183 | 2183 | |
|
2184 | 2184 | 2) The input is incomplete, and more input is required; |
|
2185 | 2185 | compile_command() returned None. Nothing happens. |
|
2186 | 2186 | |
|
2187 | 2187 | 3) The input is complete; compile_command() returned a code |
|
2188 | 2188 | object. The code is executed by calling self.runcode() (which |
|
2189 | 2189 | also handles run-time exceptions, except for SystemExit). |
|
2190 | 2190 | |
|
2191 | 2191 | The return value is: |
|
2192 | 2192 | |
|
2193 | 2193 | - True in case 2 |
|
2194 | 2194 | |
|
2195 | 2195 | - False in the other cases, unless an exception is raised, where |
|
2196 | 2196 | None is returned instead. This can be used by external callers to |
|
2197 | 2197 | know whether to continue feeding input or not. |
|
2198 | 2198 | |
|
2199 | 2199 | The return value can be used to decide whether to use sys.ps1 or |
|
2200 | 2200 | sys.ps2 to prompt the next line.""" |
|
2201 | 2201 | |
|
2202 | 2202 | # if the source code has leading blanks, add 'if 1:\n' to it |
|
2203 | 2203 | # this allows execution of indented pasted code. It is tempting |
|
2204 | 2204 | # to add '\n' at the end of source to run commands like ' a=1' |
|
2205 | 2205 | # directly, but this fails for more complicated scenarios |
|
2206 | 2206 | source=source.encode(self.stdin_encoding) |
|
2207 | 2207 | if source[:1] in [' ', '\t']: |
|
2208 | 2208 | source = 'if 1:\n%s' % source |
|
2209 | 2209 | |
|
2210 | 2210 | try: |
|
2211 | 2211 | code = self.compile(source,filename,symbol) |
|
2212 | 2212 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): |
|
2213 | 2213 | # Case 1 |
|
2214 | 2214 | self.showsyntaxerror(filename) |
|
2215 | 2215 | return None |
|
2216 | 2216 | |
|
2217 | 2217 | if code is None: |
|
2218 | 2218 | # Case 2 |
|
2219 | 2219 | return True |
|
2220 | 2220 | |
|
2221 | 2221 | # Case 3 |
|
2222 | 2222 | # We store the code object so that threaded shells and |
|
2223 | 2223 | # custom exception handlers can access all this info if needed. |
|
2224 | 2224 | # The source corresponding to this can be obtained from the |
|
2225 | 2225 | # buffer attribute as '\n'.join(self.buffer). |
|
2226 | 2226 | self.code_to_run = code |
|
2227 | 2227 | # now actually execute the code object |
|
2228 | 2228 | if self.runcode(code) == 0: |
|
2229 | 2229 | return False |
|
2230 | 2230 | else: |
|
2231 | 2231 | return None |
|
2232 | 2232 | |
|
2233 | 2233 | def runcode(self,code_obj): |
|
2234 | 2234 | """Execute a code object. |
|
2235 | 2235 | |
|
2236 | 2236 | When an exception occurs, self.showtraceback() is called to display a |
|
2237 | 2237 | traceback. |
|
2238 | 2238 | |
|
2239 | 2239 | Return value: a flag indicating whether the code to be run completed |
|
2240 | 2240 | successfully: |
|
2241 | 2241 | |
|
2242 | 2242 | - 0: successful execution. |
|
2243 | 2243 | - 1: an error occurred. |
|
2244 | 2244 | """ |
|
2245 | 2245 | |
|
2246 | 2246 | # Set our own excepthook in case the user code tries to call it |
|
2247 | 2247 | # directly, so that the IPython crash handler doesn't get triggered |
|
2248 | 2248 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2249 | 2249 | |
|
2250 | 2250 | # we save the original sys.excepthook in the instance, in case config |
|
2251 | 2251 | # code (such as magics) needs access to it. |
|
2252 | 2252 | self.sys_excepthook = old_excepthook |
|
2253 | 2253 | outflag = 1 # happens in more places, so it's easier as default |
|
2254 | 2254 | try: |
|
2255 | 2255 | try: |
|
2256 | 2256 | self.hooks.pre_runcode_hook() |
|
2257 | 2257 | exec code_obj in self.user_global_ns, self.user_ns |
|
2258 | 2258 | finally: |
|
2259 | 2259 | # Reset our crash handler in place |
|
2260 | 2260 | sys.excepthook = old_excepthook |
|
2261 | 2261 | except SystemExit: |
|
2262 | 2262 | self.resetbuffer() |
|
2263 | 2263 | self.showtraceback() |
|
2264 | 2264 | warn("Type %exit or %quit to exit IPython " |
|
2265 | 2265 | "(%Exit or %Quit do so unconditionally).",level=1) |
|
2266 | 2266 | except self.custom_exceptions: |
|
2267 | 2267 | etype,value,tb = sys.exc_info() |
|
2268 | 2268 | self.CustomTB(etype,value,tb) |
|
2269 | 2269 | except: |
|
2270 | 2270 | self.showtraceback() |
|
2271 | 2271 | else: |
|
2272 | 2272 | outflag = 0 |
|
2273 | 2273 | if softspace(sys.stdout, 0): |
|
2274 | 2274 | |
|
2275 | 2275 | # Flush out code object which has been run (and source) |
|
2276 | 2276 | self.code_to_run = None |
|
2277 | 2277 | return outflag |
|
2278 | 2278 | |
|
2279 | 2279 | def push(self, line): |
|
2280 | 2280 | """Push a line to the interpreter. |
|
2281 | 2281 | |
|
2282 | 2282 | The line should not have a trailing newline; it may have |
|
2283 | 2283 | internal newlines. The line is appended to a buffer and the |
|
2284 | 2284 | interpreter's runsource() method is called with the |
|
2285 | 2285 | concatenated contents of the buffer as source. If this |
|
2286 | 2286 | indicates that the command was executed or invalid, the buffer |
|
2287 | 2287 | is reset; otherwise, the command is incomplete, and the buffer |
|
2288 | 2288 | is left as it was after the line was appended. The return |
|
2289 | 2289 | value is 1 if more input is required, 0 if the line was dealt |
|
2290 | 2290 | with in some way (this is the same as runsource()). |
|
2291 | 2291 | """ |
|
2292 | 2292 | |
|
2293 | 2293 | # autoindent management should be done here, and not in the |
|
2294 | 2294 | # interactive loop, since that one is only seen by keyboard input. We |
|
2295 | 2295 | # need this done correctly even for code run via runlines (which uses |
|
2296 | 2296 | # push). |
|
2297 | 2297 | |
|
2298 | 2298 | #print 'push line: <%s>' % line # dbg |
|
2299 | 2299 | for subline in line.splitlines(): |
|
2300 | 2300 | self.autoindent_update(subline) |
|
2301 | 2301 | self.buffer.append(line) |
|
2302 | 2302 | more = self.runsource('\n'.join(self.buffer), self.filename) |
|
2303 | 2303 | if not more: |
|
2304 | 2304 | self.resetbuffer() |
|
2305 | 2305 | return more |
|
2306 | 2306 | |
|
2307 | 2307 | def split_user_input(self, line): |
|
2308 | 2308 | # This is really a hold-over to support ipapi and some extensions |
|
2309 | 2309 | return prefilter.splitUserInput(line) |
|
2310 | 2310 | |
|
2311 | 2311 | def resetbuffer(self): |
|
2312 | 2312 | """Reset the input buffer.""" |
|
2313 | 2313 | self.buffer[:] = [] |
|
2314 | 2314 | |
|
2315 | 2315 | def raw_input(self,prompt='',continue_prompt=False): |
|
2316 | 2316 | """Write a prompt and read a line. |
|
2317 | 2317 | |
|
2318 | 2318 | The returned line does not include the trailing newline. |
|
2319 | 2319 | When the user enters the EOF key sequence, EOFError is raised. |
|
2320 | 2320 | |
|
2321 | 2321 | Optional inputs: |
|
2322 | 2322 | |
|
2323 | 2323 | - prompt(''): a string to be printed to prompt the user. |
|
2324 | 2324 | |
|
2325 | 2325 | - continue_prompt(False): whether this line is the first one or a |
|
2326 | 2326 | continuation in a sequence of inputs. |
|
2327 | 2327 | """ |
|
2328 | 2328 | |
|
2329 | 2329 | # Code run by the user may have modified the readline completer state. |
|
2330 | 2330 | # We must ensure that our completer is back in place. |
|
2331 | 2331 | if self.has_readline: |
|
2332 | 2332 | self.set_completer() |
|
2333 | 2333 | |
|
2334 | 2334 | try: |
|
2335 | 2335 | line = raw_input_original(prompt).decode(self.stdin_encoding) |
|
2336 | 2336 | except ValueError: |
|
2337 | 2337 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
2338 | 2338 | " or sys.stdout.close()!\nExiting IPython!") |
|
2339 | 2339 | self.ask_exit() |
|
2340 | 2340 | return "" |
|
2341 | 2341 | |
|
2342 | 2342 | # Try to be reasonably smart about not re-indenting pasted input more |
|
2343 | 2343 | # than necessary. We do this by trimming out the auto-indent initial |
|
2344 | 2344 | # spaces, if the user's actual input started itself with whitespace. |
|
2345 | 2345 | #debugx('self.buffer[-1]') |
|
2346 | 2346 | |
|
2347 | 2347 | if self.autoindent: |
|
2348 | 2348 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
2349 | 2349 | line = line[self.indent_current_nsp:] |
|
2350 | 2350 | self.indent_current_nsp = 0 |
|
2351 | 2351 | |
|
2352 | 2352 | # store the unfiltered input before the user has any chance to modify |
|
2353 | 2353 | # it. |
|
2354 | 2354 | if line.strip(): |
|
2355 | 2355 | if continue_prompt: |
|
2356 | 2356 | self.input_hist_raw[-1] += '%s\n' % line |
|
2357 | 2357 | if self.has_readline: # and some config option is set? |
|
2358 | 2358 | try: |
|
2359 | 2359 | histlen = self.readline.get_current_history_length() |
|
2360 | 2360 | if histlen > 1: |
|
2361 | 2361 | newhist = self.input_hist_raw[-1].rstrip() |
|
2362 | 2362 | self.readline.remove_history_item(histlen-1) |
|
2363 | 2363 | self.readline.replace_history_item(histlen-2, |
|
2364 | 2364 | newhist.encode(self.stdin_encoding)) |
|
2365 | 2365 | except AttributeError: |
|
2366 | 2366 | pass # re{move,place}_history_item are new in 2.4. |
|
2367 | 2367 | else: |
|
2368 | 2368 | self.input_hist_raw.append('%s\n' % line) |
|
2369 | 2369 | # only entries starting at first column go to shadow history |
|
2370 | 2370 | if line.lstrip() == line: |
|
2371 | 2371 | self.shadowhist.add(line.strip()) |
|
2372 | 2372 | elif not continue_prompt: |
|
2373 | 2373 | self.input_hist_raw.append('\n') |
|
2374 | 2374 | try: |
|
2375 | 2375 | lineout = self.prefilter(line,continue_prompt) |
|
2376 | 2376 | except: |
|
2377 | 2377 | # blanket except, in case a user-defined prefilter crashes, so it |
|
2378 | 2378 | # can't take all of ipython with it. |
|
2379 | 2379 | self.showtraceback() |
|
2380 | 2380 | return '' |
|
2381 | 2381 | else: |
|
2382 | 2382 | return lineout |
|
2383 | 2383 | |
|
2384 | 2384 | def _prefilter(self, line, continue_prompt): |
|
2385 | 2385 | """Calls different preprocessors, depending on the form of line.""" |
|
2386 | 2386 | |
|
2387 | 2387 | # All handlers *must* return a value, even if it's blank (''). |
|
2388 | 2388 | |
|
2389 | 2389 | # Lines are NOT logged here. Handlers should process the line as |
|
2390 | 2390 | # needed, update the cache AND log it (so that the input cache array |
|
2391 | 2391 | # stays synced). |
|
2392 | 2392 | |
|
2393 | 2393 | #..................................................................... |
|
2394 | 2394 | # Code begins |
|
2395 | 2395 | |
|
2396 | 2396 | #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg |
|
2397 | 2397 | |
|
2398 | 2398 | # save the line away in case we crash, so the post-mortem handler can |
|
2399 | 2399 | # record it |
|
2400 | 2400 | self._last_input_line = line |
|
2401 | 2401 | |
|
2402 | 2402 | #print '***line: <%s>' % line # dbg |
|
2403 | 2403 | |
|
2404 | 2404 | if not line: |
|
2405 | 2405 | # Return immediately on purely empty lines, so that if the user |
|
2406 | 2406 | # previously typed some whitespace that started a continuation |
|
2407 | 2407 | # prompt, he can break out of that loop with just an empty line. |
|
2408 | 2408 | # This is how the default python prompt works. |
|
2409 | 2409 | |
|
2410 | 2410 | # Only return if the accumulated input buffer was just whitespace! |
|
2411 | 2411 | if ''.join(self.buffer).isspace(): |
|
2412 | 2412 | self.buffer[:] = [] |
|
2413 | 2413 | return '' |
|
2414 | 2414 | |
|
2415 | 2415 | line_info = prefilter.LineInfo(line, continue_prompt) |
|
2416 | 2416 | |
|
2417 | 2417 | # the input history needs to track even empty lines |
|
2418 | 2418 | stripped = line.strip() |
|
2419 | 2419 | |
|
2420 | 2420 | if not stripped: |
|
2421 | 2421 | if not continue_prompt: |
|
2422 | 2422 | self.outputcache.prompt_count -= 1 |
|
2423 | 2423 | return self.handle_normal(line_info) |
|
2424 | 2424 | |
|
2425 | 2425 | # print '***cont',continue_prompt # dbg |
|
2426 | 2426 | # special handlers are only allowed for single line statements |
|
2427 | 2427 | if continue_prompt and not self.rc.multi_line_specials: |
|
2428 | 2428 | return self.handle_normal(line_info) |
|
2429 | 2429 | |
|
2430 | 2430 | |
|
2431 | 2431 | # See whether any pre-existing handler can take care of it |
|
2432 | 2432 | rewritten = self.hooks.input_prefilter(stripped) |
|
2433 | 2433 | if rewritten != stripped: # ok, some prefilter did something |
|
2434 | 2434 | rewritten = line_info.pre + rewritten # add indentation |
|
2435 | 2435 | return self.handle_normal(prefilter.LineInfo(rewritten, |
|
2436 | 2436 | continue_prompt)) |
|
2437 | 2437 | |
|
2438 | 2438 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2439 | 2439 | |
|
2440 | 2440 | return prefilter.prefilter(line_info, self) |
|
2441 | 2441 | |
|
2442 | 2442 | |
|
2443 | 2443 | def _prefilter_dumb(self, line, continue_prompt): |
|
2444 | 2444 | """simple prefilter function, for debugging""" |
|
2445 | 2445 | return self.handle_normal(line,continue_prompt) |
|
2446 | 2446 | |
|
2447 | 2447 | |
|
2448 | 2448 | def multiline_prefilter(self, line, continue_prompt): |
|
2449 | 2449 | """ Run _prefilter for each line of input |
|
2450 | 2450 | |
|
2451 | 2451 | Covers cases where there are multiple lines in the user entry, |
|
2452 | 2452 | which is the case when the user goes back to a multiline history |
|
2453 | 2453 | entry and presses enter. |
|
2454 | 2454 | |
|
2455 | 2455 | """ |
|
2456 | 2456 | out = [] |
|
2457 | 2457 | for l in line.rstrip('\n').split('\n'): |
|
2458 | 2458 | out.append(self._prefilter(l, continue_prompt)) |
|
2459 | 2459 | return '\n'.join(out) |
|
2460 | 2460 | |
|
2461 | 2461 | # Set the default prefilter() function (this can be user-overridden) |
|
2462 | 2462 | prefilter = multiline_prefilter |
|
2463 | 2463 | |
|
2464 | 2464 | def handle_normal(self,line_info): |
|
2465 | 2465 | """Handle normal input lines. Use as a template for handlers.""" |
|
2466 | 2466 | |
|
2467 | 2467 | # With autoindent on, we need some way to exit the input loop, and I |
|
2468 | 2468 | # don't want to force the user to have to backspace all the way to |
|
2469 | 2469 | # clear the line. The rule will be in this case, that either two |
|
2470 | 2470 | # lines of pure whitespace in a row, or a line of pure whitespace but |
|
2471 | 2471 | # of a size different to the indent level, will exit the input loop. |
|
2472 | 2472 | line = line_info.line |
|
2473 | 2473 | continue_prompt = line_info.continue_prompt |
|
2474 | 2474 | |
|
2475 | 2475 | if (continue_prompt and self.autoindent and line.isspace() and |
|
2476 | 2476 | (0 < abs(len(line) - self.indent_current_nsp) <= 2 or |
|
2477 | 2477 | (self.buffer[-1]).isspace() )): |
|
2478 | 2478 | line = '' |
|
2479 | 2479 | |
|
2480 | 2480 | self.log(line,line,continue_prompt) |
|
2481 | 2481 | return line |
|
2482 | 2482 | |
|
2483 | 2483 | def handle_alias(self,line_info): |
|
2484 | 2484 | """Handle alias input lines. """ |
|
2485 | 2485 | tgt = self.alias_table[line_info.iFun] |
|
2486 | 2486 | # print "=>",tgt #dbg |
|
2487 | 2487 | if callable(tgt): |
|
2488 | 2488 | if '$' in line_info.line: |
|
2489 | 2489 | call_meth = '(_ip, _ip.itpl(%s))' |
|
2490 | 2490 | else: |
|
2491 | 2491 | call_meth = '(_ip,%s)' |
|
2492 | 2492 | line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace, |
|
2493 | 2493 | line_info.iFun, |
|
2494 | 2494 | make_quoted_expr(line_info.line)) |
|
2495 | 2495 | else: |
|
2496 | 2496 | transformed = self.expand_aliases(line_info.iFun,line_info.theRest) |
|
2497 | 2497 | |
|
2498 | 2498 | # pre is needed, because it carries the leading whitespace. Otherwise |
|
2499 | 2499 | # aliases won't work in indented sections. |
|
2500 | 2500 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2501 | 2501 | make_quoted_expr( transformed )) |
|
2502 | 2502 | |
|
2503 | 2503 | self.log(line_info.line,line_out,line_info.continue_prompt) |
|
2504 | 2504 | #print 'line out:',line_out # dbg |
|
2505 | 2505 | return line_out |
|
2506 | 2506 | |
|
2507 | 2507 | def handle_shell_escape(self, line_info): |
|
2508 | 2508 | """Execute the line in a shell, empty return value""" |
|
2509 | 2509 | #print 'line in :', `line` # dbg |
|
2510 | 2510 | line = line_info.line |
|
2511 | 2511 | if line.lstrip().startswith('!!'): |
|
2512 | 2512 | # rewrite LineInfo's line, iFun and theRest to properly hold the |
|
2513 | 2513 | # call to %sx and the actual command to be executed, so |
|
2514 | 2514 | # handle_magic can work correctly. Note that this works even if |
|
2515 | 2515 | # the line is indented, so it handles multi_line_specials |
|
2516 | 2516 | # properly. |
|
2517 | 2517 | new_rest = line.lstrip()[2:] |
|
2518 | 2518 | line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest) |
|
2519 | 2519 | line_info.iFun = 'sx' |
|
2520 | 2520 | line_info.theRest = new_rest |
|
2521 | 2521 | return self.handle_magic(line_info) |
|
2522 | 2522 | else: |
|
2523 | 2523 | cmd = line.lstrip().lstrip('!') |
|
2524 | 2524 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2525 | 2525 | make_quoted_expr(cmd)) |
|
2526 | 2526 | # update cache/log and return |
|
2527 | 2527 | self.log(line,line_out,line_info.continue_prompt) |
|
2528 | 2528 | return line_out |
|
2529 | 2529 | |
|
2530 | 2530 | def handle_magic(self, line_info): |
|
2531 | 2531 | """Execute magic functions.""" |
|
2532 | 2532 | iFun = line_info.iFun |
|
2533 | 2533 | theRest = line_info.theRest |
|
2534 | 2534 | cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace, |
|
2535 | 2535 | make_quoted_expr(iFun + " " + theRest)) |
|
2536 | 2536 | self.log(line_info.line,cmd,line_info.continue_prompt) |
|
2537 | 2537 | #print 'in handle_magic, cmd=<%s>' % cmd # dbg |
|
2538 | 2538 | return cmd |
|
2539 | 2539 | |
|
2540 | 2540 | def handle_auto(self, line_info): |
|
2541 | 2541 | """Hande lines which can be auto-executed, quoting if requested.""" |
|
2542 | 2542 | |
|
2543 | 2543 | line = line_info.line |
|
2544 | 2544 | iFun = line_info.iFun |
|
2545 | 2545 | theRest = line_info.theRest |
|
2546 | 2546 | pre = line_info.pre |
|
2547 | 2547 | continue_prompt = line_info.continue_prompt |
|
2548 | 2548 | obj = line_info.ofind(self)['obj'] |
|
2549 | 2549 | |
|
2550 | 2550 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2551 | 2551 | |
|
2552 | 2552 | # This should only be active for single-line input! |
|
2553 | 2553 | if continue_prompt: |
|
2554 | 2554 | self.log(line,line,continue_prompt) |
|
2555 | 2555 | return line |
|
2556 | 2556 | |
|
2557 | 2557 | force_auto = isinstance(obj, IPython.ipapi.IPyAutocall) |
|
2558 | 2558 | auto_rewrite = True |
|
2559 | 2559 | |
|
2560 | 2560 | if pre == self.ESC_QUOTE: |
|
2561 | 2561 | # Auto-quote splitting on whitespace |
|
2562 | 2562 | newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) ) |
|
2563 | 2563 | elif pre == self.ESC_QUOTE2: |
|
2564 | 2564 | # Auto-quote whole string |
|
2565 | 2565 | newcmd = '%s("%s")' % (iFun,theRest) |
|
2566 | 2566 | elif pre == self.ESC_PAREN: |
|
2567 | 2567 | newcmd = '%s(%s)' % (iFun,",".join(theRest.split())) |
|
2568 | 2568 | else: |
|
2569 | 2569 | # Auto-paren. |
|
2570 | 2570 | # We only apply it to argument-less calls if the autocall |
|
2571 | 2571 | # parameter is set to 2. We only need to check that autocall is < |
|
2572 | 2572 | # 2, since this function isn't called unless it's at least 1. |
|
2573 | 2573 | if not theRest and (self.rc.autocall < 2) and not force_auto: |
|
2574 | 2574 | newcmd = '%s %s' % (iFun,theRest) |
|
2575 | 2575 | auto_rewrite = False |
|
2576 | 2576 | else: |
|
2577 | 2577 | if not force_auto and theRest.startswith('['): |
|
2578 | 2578 | if hasattr(obj,'__getitem__'): |
|
2579 | 2579 | # Don't autocall in this case: item access for an object |
|
2580 | 2580 | # which is BOTH callable and implements __getitem__. |
|
2581 | 2581 | newcmd = '%s %s' % (iFun,theRest) |
|
2582 | 2582 | auto_rewrite = False |
|
2583 | 2583 | else: |
|
2584 | 2584 | # if the object doesn't support [] access, go ahead and |
|
2585 | 2585 | # autocall |
|
2586 | 2586 | newcmd = '%s(%s)' % (iFun.rstrip(),theRest) |
|
2587 | 2587 | elif theRest.endswith(';'): |
|
2588 | 2588 | newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1]) |
|
2589 | 2589 | else: |
|
2590 | 2590 | newcmd = '%s(%s)' % (iFun.rstrip(), theRest) |
|
2591 | 2591 | |
|
2592 | 2592 | if auto_rewrite: |
|
2593 | 2593 | rw = self.outputcache.prompt1.auto_rewrite() + newcmd |
|
2594 | 2594 | |
|
2595 | 2595 | try: |
|
2596 | 2596 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2597 | 2597 | # we use it and only print uncolored rewrite if we have unicode |
|
2598 | 2598 | rw = str(rw) |
|
2599 | 2599 | print >>Term.cout, rw |
|
2600 | 2600 | except UnicodeEncodeError: |
|
2601 | 2601 | print "-------------->" + newcmd |
|
2602 | 2602 | |
|
2603 | 2603 | # log what is now valid Python, not the actual user input (without the |
|
2604 | 2604 | # final newline) |
|
2605 | 2605 | self.log(line,newcmd,continue_prompt) |
|
2606 | 2606 | return newcmd |
|
2607 | 2607 | |
|
2608 | 2608 | def handle_help(self, line_info): |
|
2609 | 2609 | """Try to get some help for the object. |
|
2610 | 2610 | |
|
2611 | 2611 | obj? or ?obj -> basic information. |
|
2612 | 2612 | obj?? or ??obj -> more details. |
|
2613 | 2613 | """ |
|
2614 | 2614 | |
|
2615 | 2615 | line = line_info.line |
|
2616 | 2616 | # We need to make sure that we don't process lines which would be |
|
2617 | 2617 | # otherwise valid python, such as "x=1 # what?" |
|
2618 | 2618 | try: |
|
2619 | 2619 | codeop.compile_command(line) |
|
2620 | 2620 | except SyntaxError: |
|
2621 | 2621 | # We should only handle as help stuff which is NOT valid syntax |
|
2622 | 2622 | if line[0]==self.ESC_HELP: |
|
2623 | 2623 | line = line[1:] |
|
2624 | 2624 | elif line[-1]==self.ESC_HELP: |
|
2625 | 2625 | line = line[:-1] |
|
2626 | 2626 | self.log(line,'#?'+line,line_info.continue_prompt) |
|
2627 | 2627 | if line: |
|
2628 | 2628 | #print 'line:<%r>' % line # dbg |
|
2629 | 2629 | self.magic_pinfo(line) |
|
2630 | 2630 | else: |
|
2631 | 2631 | page(self.usage,screen_lines=self.rc.screen_length) |
|
2632 | 2632 | return '' # Empty string is needed here! |
|
2633 | 2633 | except: |
|
2634 | 2634 | # Pass any other exceptions through to the normal handler |
|
2635 | 2635 | return self.handle_normal(line_info) |
|
2636 | 2636 | else: |
|
2637 | 2637 | # If the code compiles ok, we should handle it normally |
|
2638 | 2638 | return self.handle_normal(line_info) |
|
2639 | 2639 | |
|
2640 | 2640 | def getapi(self): |
|
2641 | 2641 | """ Get an IPApi object for this shell instance |
|
2642 | 2642 | |
|
2643 | 2643 | Getting an IPApi object is always preferable to accessing the shell |
|
2644 | 2644 | directly, but this holds true especially for extensions. |
|
2645 | 2645 | |
|
2646 | 2646 | It should always be possible to implement an extension with IPApi |
|
2647 | 2647 | alone. If not, contact maintainer to request an addition. |
|
2648 | 2648 | |
|
2649 | 2649 | """ |
|
2650 | 2650 | return self.api |
|
2651 | 2651 | |
|
2652 | 2652 | def handle_emacs(self, line_info): |
|
2653 | 2653 | """Handle input lines marked by python-mode.""" |
|
2654 | 2654 | |
|
2655 | 2655 | # Currently, nothing is done. Later more functionality can be added |
|
2656 | 2656 | # here if needed. |
|
2657 | 2657 | |
|
2658 | 2658 | # The input cache shouldn't be updated |
|
2659 | 2659 | return line_info.line |
|
2660 | 2660 | |
|
2661 | 2661 | |
|
2662 | 2662 | def mktempfile(self,data=None): |
|
2663 | 2663 | """Make a new tempfile and return its filename. |
|
2664 | 2664 | |
|
2665 | 2665 | This makes a call to tempfile.mktemp, but it registers the created |
|
2666 | 2666 | filename internally so ipython cleans it up at exit time. |
|
2667 | 2667 | |
|
2668 | 2668 | Optional inputs: |
|
2669 | 2669 | |
|
2670 | 2670 | - data(None): if data is given, it gets written out to the temp file |
|
2671 | 2671 | immediately, and the file is closed again.""" |
|
2672 | 2672 | |
|
2673 | 2673 | filename = tempfile.mktemp('.py','ipython_edit_') |
|
2674 | 2674 | self.tempfiles.append(filename) |
|
2675 | 2675 | |
|
2676 | 2676 | if data: |
|
2677 | 2677 | tmp_file = open(filename,'w') |
|
2678 | 2678 | tmp_file.write(data) |
|
2679 | 2679 | tmp_file.close() |
|
2680 | 2680 | return filename |
|
2681 | 2681 | |
|
2682 | 2682 | def write(self,data): |
|
2683 | 2683 | """Write a string to the default output""" |
|
2684 | 2684 | Term.cout.write(data) |
|
2685 | 2685 | |
|
2686 | 2686 | def write_err(self,data): |
|
2687 | 2687 | """Write a string to the default error output""" |
|
2688 | 2688 | Term.cerr.write(data) |
|
2689 | 2689 | |
|
2690 | 2690 | def ask_exit(self): |
|
2691 | 2691 | """ Call for exiting. Can be overiden and used as a callback. """ |
|
2692 | 2692 | self.exit_now = True |
|
2693 | 2693 | |
|
2694 | 2694 | def exit(self): |
|
2695 | 2695 | """Handle interactive exit. |
|
2696 | 2696 | |
|
2697 | 2697 | This method calls the ask_exit callback.""" |
|
2698 | 2698 | |
|
2699 | 2699 | if self.rc.confirm_exit: |
|
2700 | 2700 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
2701 | 2701 | self.ask_exit() |
|
2702 | 2702 | else: |
|
2703 | 2703 | self.ask_exit() |
|
2704 | 2704 | |
|
2705 | 2705 | def safe_execfile(self,fname,*where,**kw): |
|
2706 | 2706 | """A safe version of the builtin execfile(). |
|
2707 | 2707 | |
|
2708 | 2708 | This version will never throw an exception, and knows how to handle |
|
2709 | 2709 | ipython logs as well. |
|
2710 | 2710 | |
|
2711 | 2711 | :Parameters: |
|
2712 | 2712 | fname : string |
|
2713 | 2713 | Name of the file to be executed. |
|
2714 | 2714 | |
|
2715 | 2715 | where : tuple |
|
2716 | 2716 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2717 | 2717 | If only one is given, it is passed as both. |
|
2718 | 2718 | |
|
2719 | 2719 | :Keywords: |
|
2720 | 2720 | islog : boolean (False) |
|
2721 | 2721 | |
|
2722 | 2722 | quiet : boolean (True) |
|
2723 | 2723 | |
|
2724 | 2724 | exit_ignore : boolean (False) |
|
2725 | 2725 | """ |
|
2726 | 2726 | |
|
2727 | 2727 | def syspath_cleanup(): |
|
2728 | 2728 | """Internal cleanup routine for sys.path.""" |
|
2729 | 2729 | if add_dname: |
|
2730 | 2730 | try: |
|
2731 | 2731 | sys.path.remove(dname) |
|
2732 | 2732 | except ValueError: |
|
2733 | 2733 | # For some reason the user has already removed it, ignore. |
|
2734 | 2734 | pass |
|
2735 | 2735 | |
|
2736 | 2736 | fname = os.path.expanduser(fname) |
|
2737 | 2737 | |
|
2738 | 2738 | # Find things also in current directory. This is needed to mimic the |
|
2739 | 2739 | # behavior of running a script from the system command line, where |
|
2740 | 2740 | # Python inserts the script's directory into sys.path |
|
2741 | 2741 | dname = os.path.dirname(os.path.abspath(fname)) |
|
2742 | 2742 | add_dname = False |
|
2743 | 2743 | if dname not in sys.path: |
|
2744 | 2744 | sys.path.insert(0,dname) |
|
2745 | 2745 | add_dname = True |
|
2746 | 2746 | |
|
2747 | 2747 | try: |
|
2748 | 2748 | xfile = open(fname) |
|
2749 | 2749 | except: |
|
2750 | 2750 | print >> Term.cerr, \ |
|
2751 | 2751 | 'Could not open file <%s> for safe execution.' % fname |
|
2752 | 2752 | syspath_cleanup() |
|
2753 | 2753 | return None |
|
2754 | 2754 | |
|
2755 | 2755 | kw.setdefault('islog',0) |
|
2756 | 2756 | kw.setdefault('quiet',1) |
|
2757 | 2757 | kw.setdefault('exit_ignore',0) |
|
2758 | 2758 | |
|
2759 | 2759 | first = xfile.readline() |
|
2760 | 2760 | loghead = str(self.loghead_tpl).split('\n',1)[0].strip() |
|
2761 | 2761 | xfile.close() |
|
2762 | 2762 | # line by line execution |
|
2763 | 2763 | if first.startswith(loghead) or kw['islog']: |
|
2764 | 2764 | print 'Loading log file <%s> one line at a time...' % fname |
|
2765 | 2765 | if kw['quiet']: |
|
2766 | 2766 | stdout_save = sys.stdout |
|
2767 | 2767 | sys.stdout = StringIO.StringIO() |
|
2768 | 2768 | try: |
|
2769 | 2769 | globs,locs = where[0:2] |
|
2770 | 2770 | except: |
|
2771 | 2771 | try: |
|
2772 | 2772 | globs = locs = where[0] |
|
2773 | 2773 | except: |
|
2774 | 2774 | globs = locs = globals() |
|
2775 | 2775 | badblocks = [] |
|
2776 | 2776 | |
|
2777 | 2777 | # we also need to identify indented blocks of code when replaying |
|
2778 | 2778 | # logs and put them together before passing them to an exec |
|
2779 | 2779 | # statement. This takes a bit of regexp and look-ahead work in the |
|
2780 | 2780 | # file. It's easiest if we swallow the whole thing in memory |
|
2781 | 2781 | # first, and manually walk through the lines list moving the |
|
2782 | 2782 | # counter ourselves. |
|
2783 | 2783 | indent_re = re.compile('\s+\S') |
|
2784 | 2784 | xfile = open(fname) |
|
2785 | 2785 | filelines = xfile.readlines() |
|
2786 | 2786 | xfile.close() |
|
2787 | 2787 | nlines = len(filelines) |
|
2788 | 2788 | lnum = 0 |
|
2789 | 2789 | while lnum < nlines: |
|
2790 | 2790 | line = filelines[lnum] |
|
2791 | 2791 | lnum += 1 |
|
2792 | 2792 | # don't re-insert logger status info into cache |
|
2793 | 2793 | if line.startswith('#log#'): |
|
2794 | 2794 | continue |
|
2795 | 2795 | else: |
|
2796 | 2796 | # build a block of code (maybe a single line) for execution |
|
2797 | 2797 | block = line |
|
2798 | 2798 | try: |
|
2799 | 2799 | next = filelines[lnum] # lnum has already incremented |
|
2800 | 2800 | except: |
|
2801 | 2801 | next = None |
|
2802 | 2802 | while next and indent_re.match(next): |
|
2803 | 2803 | block += next |
|
2804 | 2804 | lnum += 1 |
|
2805 | 2805 | try: |
|
2806 | 2806 | next = filelines[lnum] |
|
2807 | 2807 | except: |
|
2808 | 2808 | next = None |
|
2809 | 2809 | # now execute the block of one or more lines |
|
2810 | 2810 | try: |
|
2811 | 2811 | exec block in globs,locs |
|
2812 | 2812 | except SystemExit: |
|
2813 | 2813 | pass |
|
2814 | 2814 | except: |
|
2815 | 2815 | badblocks.append(block.rstrip()) |
|
2816 | 2816 | if kw['quiet']: # restore stdout |
|
2817 | 2817 | sys.stdout.close() |
|
2818 | 2818 | sys.stdout = stdout_save |
|
2819 | 2819 | print 'Finished replaying log file <%s>' % fname |
|
2820 | 2820 | if badblocks: |
|
2821 | 2821 | print >> sys.stderr, ('\nThe following lines/blocks in file ' |
|
2822 | 2822 | '<%s> reported errors:' % fname) |
|
2823 | 2823 | |
|
2824 | 2824 | for badline in badblocks: |
|
2825 | 2825 | print >> sys.stderr, badline |
|
2826 | 2826 | else: # regular file execution |
|
2827 | 2827 | try: |
|
2828 | 2828 | if sys.platform == 'win32' and sys.version_info < (2,5,1): |
|
2829 | 2829 | # Work around a bug in Python for Windows. The bug was |
|
2830 | 2830 | # fixed in in Python 2.5 r54159 and 54158, but that's still |
|
2831 | 2831 | # SVN Python as of March/07. For details, see: |
|
2832 | 2832 | # http://projects.scipy.org/ipython/ipython/ticket/123 |
|
2833 | 2833 | try: |
|
2834 | 2834 | globs,locs = where[0:2] |
|
2835 | 2835 | except: |
|
2836 | 2836 | try: |
|
2837 | 2837 | globs = locs = where[0] |
|
2838 | 2838 | except: |
|
2839 | 2839 | globs = locs = globals() |
|
2840 | 2840 | exec file(fname) in globs,locs |
|
2841 | 2841 | else: |
|
2842 | 2842 | execfile(fname,*where) |
|
2843 | 2843 | except SyntaxError: |
|
2844 | 2844 | self.showsyntaxerror() |
|
2845 | 2845 | warn('Failure executing file: <%s>' % fname) |
|
2846 | 2846 | except SystemExit,status: |
|
2847 | 2847 | # Code that correctly sets the exit status flag to success (0) |
|
2848 | 2848 | # shouldn't be bothered with a traceback. Note that a plain |
|
2849 | 2849 | # sys.exit() does NOT set the message to 0 (it's empty) so that |
|
2850 | 2850 | # will still get a traceback. Note that the structure of the |
|
2851 | 2851 | # SystemExit exception changed between Python 2.4 and 2.5, so |
|
2852 | 2852 | # the checks must be done in a version-dependent way. |
|
2853 | 2853 | show = False |
|
2854 | 2854 | |
|
2855 | 2855 | if sys.version_info[:2] > (2,5): |
|
2856 | 2856 | if status.message!=0 and not kw['exit_ignore']: |
|
2857 | 2857 | show = True |
|
2858 | 2858 | else: |
|
2859 | 2859 | if status.code and not kw['exit_ignore']: |
|
2860 | 2860 | show = True |
|
2861 | 2861 | if show: |
|
2862 | 2862 | self.showtraceback() |
|
2863 | 2863 | warn('Failure executing file: <%s>' % fname) |
|
2864 | 2864 | except: |
|
2865 | 2865 | self.showtraceback() |
|
2866 | 2866 | warn('Failure executing file: <%s>' % fname) |
|
2867 | 2867 | |
|
2868 | 2868 | syspath_cleanup() |
|
2869 | 2869 | |
|
2870 | 2870 | #************************* end of file <iplib.py> ***************************** |
@@ -1,761 +1,761 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | |
|
3 | 3 | """Central interpreter object for an IPython engine. |
|
4 | 4 | |
|
5 | 5 | The interpreter is the object whose job is to process lines of user input and |
|
6 | 6 | actually execute them in the user's namespace. |
|
7 | 7 | """ |
|
8 | 8 | |
|
9 | 9 | __docformat__ = "restructuredtext en" |
|
10 | 10 | |
|
11 | 11 | #------------------------------------------------------------------------------- |
|
12 | 12 | # Copyright (C) 2008 The IPython Development Team |
|
13 | 13 | # |
|
14 | 14 | # Distributed under the terms of the BSD License. The full license is in |
|
15 | 15 | # the file COPYING, distributed as part of this software. |
|
16 | 16 | #------------------------------------------------------------------------------- |
|
17 | 17 | |
|
18 | 18 | #------------------------------------------------------------------------------- |
|
19 | 19 | # Imports |
|
20 | 20 | #------------------------------------------------------------------------------- |
|
21 | 21 | |
|
22 | 22 | # Standard library imports. |
|
23 | 23 | from types import FunctionType |
|
24 | 24 | |
|
25 | 25 | import __builtin__ |
|
26 | 26 | import codeop |
|
27 | 27 | import compiler |
|
28 | 28 | import sys |
|
29 | 29 | import traceback |
|
30 | 30 | |
|
31 | 31 | # Local imports. |
|
32 | 32 | from IPython.kernel.core import ultraTB |
|
33 | 33 | from IPython.kernel.core.display_trap import DisplayTrap |
|
34 | 34 | from IPython.kernel.core.macro import Macro |
|
35 | 35 | from IPython.kernel.core.prompts import CachedOutput |
|
36 | 36 | from IPython.kernel.core.traceback_trap import TracebackTrap |
|
37 | 37 | from IPython.kernel.core.util import Bunch, system_shell |
|
38 | 38 | from IPython.external.Itpl import ItplNS |
|
39 | 39 | |
|
40 | 40 | # Global constants |
|
41 | 41 | COMPILER_ERROR = 'error' |
|
42 | 42 | INCOMPLETE_INPUT = 'incomplete' |
|
43 | 43 | COMPLETE_INPUT = 'complete' |
|
44 | 44 | |
|
45 | 45 | ############################################################################## |
|
46 | 46 | # TEMPORARY!!! fake configuration, while we decide whether to use tconfig or |
|
47 | 47 | # not |
|
48 | 48 | |
|
49 | 49 | rc = Bunch() |
|
50 | 50 | rc.cache_size = 100 |
|
51 | 51 | rc.pprint = True |
|
52 | 52 | rc.separate_in = '\n' |
|
53 | 53 | rc.separate_out = '\n' |
|
54 | 54 | rc.separate_out2 = '' |
|
55 | 55 | rc.prompt_in1 = r'In [\#]: ' |
|
56 | 56 | rc.prompt_in2 = r' .\\D.: ' |
|
57 | 57 | rc.prompt_out = '' |
|
58 | 58 | rc.prompts_pad_left = False |
|
59 | 59 | |
|
60 | 60 | ############################################################################## |
|
61 | 61 | |
|
62 | 62 | # Top-level utilities |
|
63 | 63 | def default_display_formatters(): |
|
64 | 64 | """ Return a list of default display formatters. |
|
65 | 65 | """ |
|
66 | 66 | |
|
67 | 67 | from display_formatter import PPrintDisplayFormatter, ReprDisplayFormatter |
|
68 | 68 | return [PPrintDisplayFormatter(), ReprDisplayFormatter()] |
|
69 | 69 | |
|
70 | 70 | def default_traceback_formatters(): |
|
71 | 71 | """ Return a list of default traceback formatters. |
|
72 | 72 | """ |
|
73 | 73 | |
|
74 | 74 | from traceback_formatter import PlainTracebackFormatter |
|
75 | 75 | return [PlainTracebackFormatter()] |
|
76 | 76 | |
|
77 | 77 | # Top-level classes |
|
78 | 78 | class NotDefined(object): pass |
|
79 | 79 | |
|
80 | 80 | class Interpreter(object): |
|
81 | 81 | """ An interpreter object. |
|
82 | 82 | |
|
83 | 83 | fixme: needs to negotiate available formatters with frontends. |
|
84 | 84 | |
|
85 | 85 | Important: the interpeter should be built so that it exposes a method |
|
86 | 86 | for each attribute/method of its sub-object. This way it can be |
|
87 | 87 | replaced by a network adapter. |
|
88 | 88 | """ |
|
89 | 89 | |
|
90 | 90 | def __init__(self, user_ns=None, global_ns=None,translator=None, |
|
91 | 91 | magic=None, display_formatters=None, |
|
92 | 92 | traceback_formatters=None, output_trap=None, history=None, |
|
93 | 93 | message_cache=None, filename='<string>', config=None): |
|
94 | 94 | |
|
95 | 95 | # The local/global namespaces for code execution |
|
96 | 96 | local_ns = user_ns # compatibility name |
|
97 | 97 | if local_ns is None: |
|
98 | 98 | local_ns = {} |
|
99 | 99 | self.user_ns = local_ns |
|
100 | 100 | # The local namespace |
|
101 | 101 | if global_ns is None: |
|
102 | 102 | global_ns = {} |
|
103 | 103 | self.user_global_ns = global_ns |
|
104 | 104 | |
|
105 | 105 | # An object that will translate commands into executable Python. |
|
106 | 106 | # The current translator does not work properly so for now we are going |
|
107 | 107 | # without! |
|
108 | 108 | # if translator is None: |
|
109 | 109 | # from IPython.kernel.core.translator import IPythonTranslator |
|
110 | 110 | # translator = IPythonTranslator() |
|
111 | 111 | self.translator = translator |
|
112 | 112 | |
|
113 | 113 | # An object that maintains magic commands. |
|
114 | 114 | if magic is None: |
|
115 | 115 | from IPython.kernel.core.magic import Magic |
|
116 | 116 | magic = Magic(self) |
|
117 | 117 | self.magic = magic |
|
118 | 118 | |
|
119 | 119 | # A list of formatters for the displayhook. |
|
120 | 120 | if display_formatters is None: |
|
121 | 121 | display_formatters = default_display_formatters() |
|
122 | 122 | self.display_formatters = display_formatters |
|
123 | 123 | |
|
124 | 124 | # A list of formatters for tracebacks. |
|
125 | 125 | if traceback_formatters is None: |
|
126 | 126 | traceback_formatters = default_traceback_formatters() |
|
127 | 127 | self.traceback_formatters = traceback_formatters |
|
128 | 128 | |
|
129 | 129 | # The object trapping stdout/stderr. |
|
130 | 130 | if output_trap is None: |
|
131 | 131 | from IPython.kernel.core.output_trap import OutputTrap |
|
132 | 132 | output_trap = OutputTrap() |
|
133 | 133 | self.output_trap = output_trap |
|
134 | 134 | |
|
135 | 135 | # An object that manages the history. |
|
136 | 136 | if history is None: |
|
137 | 137 | from IPython.kernel.core.history import InterpreterHistory |
|
138 | 138 | history = InterpreterHistory() |
|
139 | 139 | self.history = history |
|
140 | 140 | self.get_history_item = history.get_history_item |
|
141 | 141 | self.get_history_input_cache = history.get_input_cache |
|
142 | 142 | self.get_history_input_after = history.get_input_after |
|
143 | 143 | |
|
144 | 144 | # An object that caches all of the return messages. |
|
145 | 145 | if message_cache is None: |
|
146 | 146 | from IPython.kernel.core.message_cache import SimpleMessageCache |
|
147 | 147 | message_cache = SimpleMessageCache() |
|
148 | 148 | self.message_cache = message_cache |
|
149 | 149 | |
|
150 | 150 | # The "filename" of the code that is executed in this interpreter. |
|
151 | 151 | self.filename = filename |
|
152 | 152 | |
|
153 | 153 | # An object that contains much configuration information. |
|
154 | 154 | if config is None: |
|
155 | 155 | # fixme: Move this constant elsewhere! |
|
156 | 156 | config = Bunch(ESC_MAGIC='%') |
|
157 | 157 | self.config = config |
|
158 | 158 | |
|
159 | 159 | # Hook managers. |
|
160 | 160 | # fixme: make the display callbacks configurable. In the meantime, |
|
161 | 161 | # enable macros. |
|
162 | 162 | self.display_trap = DisplayTrap( |
|
163 | 163 | formatters=self.display_formatters, |
|
164 | 164 | callbacks=[self._possible_macro], |
|
165 | 165 | ) |
|
166 | 166 | self.traceback_trap = TracebackTrap( |
|
167 | 167 | formatters=self.traceback_formatters) |
|
168 | 168 | |
|
169 | 169 | # This is used temporarily for reformating exceptions in certain |
|
170 | 170 | # cases. It will go away once the ultraTB stuff is ported |
|
171 | 171 | # to ipython1 |
|
172 | 172 | self.tbHandler = ultraTB.FormattedTB(color_scheme='NoColor', |
|
173 | 173 | mode='Context', |
|
174 | 174 | tb_offset=2) |
|
175 | 175 | |
|
176 | 176 | # An object that can compile commands and remember __future__ |
|
177 | 177 | # statements. |
|
178 | 178 | self.command_compiler = codeop.CommandCompiler() |
|
179 | 179 | |
|
180 | 180 | # A replacement for the raw_input() and input() builtins. Change these |
|
181 | 181 | # attributes later to configure them. |
|
182 | 182 | self.raw_input_builtin = raw_input |
|
183 | 183 | self.input_builtin = input |
|
184 | 184 | |
|
185 | 185 | # The number of the current cell. |
|
186 | 186 | self.current_cell_number = 1 |
|
187 | 187 | |
|
188 | 188 | # Initialize cache, set in/out prompts and printing system |
|
189 | 189 | self.outputcache = CachedOutput(self, |
|
190 | 190 | rc.cache_size, |
|
191 | 191 | rc.pprint, |
|
192 | 192 | input_sep = rc.separate_in, |
|
193 | 193 | output_sep = rc.separate_out, |
|
194 | 194 | output_sep2 = rc.separate_out2, |
|
195 | 195 | ps1 = rc.prompt_in1, |
|
196 | 196 | ps2 = rc.prompt_in2, |
|
197 | 197 | ps_out = rc.prompt_out, |
|
198 | 198 | pad_left = rc.prompts_pad_left) |
|
199 | 199 | |
|
200 | 200 | # Need to decide later if this is the right approach, but clients |
|
201 | 201 | # commonly use sys.ps1/2, so it may be best to just set them here |
|
202 | 202 | sys.ps1 = self.outputcache.prompt1.p_str |
|
203 | 203 | sys.ps2 = self.outputcache.prompt2.p_str |
|
204 | 204 | |
|
205 | 205 | # This is the message dictionary assigned temporarily when running the |
|
206 | 206 | # code. |
|
207 | 207 | self.message = None |
|
208 | 208 | |
|
209 | 209 | self.setup_namespace() |
|
210 | 210 | |
|
211 | 211 | |
|
212 | 212 | #### Public 'Interpreter' interface ######################################## |
|
213 | 213 | |
|
214 | 214 | def formatTraceback(self, et, ev, tb, message=''): |
|
215 | 215 | """Put a formatted version of the traceback into value and reraise. |
|
216 | 216 | |
|
217 | 217 | When exceptions have to be sent over the network, the traceback |
|
218 | 218 | needs to be put into the value of the exception in a nicely |
|
219 | 219 | formatted way. The method takes the type, value and tb of an |
|
220 | 220 | exception and puts a string representation of the tb into the |
|
221 | 221 | value of the exception and reraises it. |
|
222 | 222 | |
|
223 | 223 | Currently this method uses the ultraTb formatter from IPython trunk. |
|
224 | 224 | Eventually it should simply use the traceback formatters in core |
|
225 | 225 | that are loaded into self.tracback_trap.formatters. |
|
226 | 226 | """ |
|
227 | 227 | tbinfo = self.tbHandler.text(et,ev,tb) |
|
228 | 228 | ev._ipython_traceback_text = tbinfo |
|
229 | 229 | return et, ev, tb |
|
230 | 230 | |
|
231 | 231 | def execute(self, commands, raiseException=True): |
|
232 | 232 | """ Execute some IPython commands. |
|
233 | 233 | |
|
234 | 234 | 1. Translate them into Python. |
|
235 | 235 | 2. Run them. |
|
236 | 236 | 3. Trap stdout/stderr. |
|
237 | 237 | 4. Trap sys.displayhook(). |
|
238 | 238 | 5. Trap exceptions. |
|
239 | 239 | 6. Return a message object. |
|
240 | 240 | |
|
241 | 241 | Parameters |
|
242 | 242 | ---------- |
|
243 | 243 | commands : str |
|
244 | 244 | The raw commands that the user typed into the prompt. |
|
245 | 245 | |
|
246 | 246 | Returns |
|
247 | 247 | ------- |
|
248 | 248 | message : dict |
|
249 | 249 | The dictionary of responses. See the README.txt in this directory |
|
250 | 250 | for an explanation of the format. |
|
251 | 251 | """ |
|
252 | 252 | |
|
253 | 253 | # Create a message dictionary with all of the information we will be |
|
254 | 254 | # returning to the frontend and other listeners. |
|
255 | 255 | message = self.setup_message() |
|
256 | 256 | |
|
257 | 257 | # Massage the input and store the raw and translated commands into |
|
258 | 258 | # a dict. |
|
259 | 259 | user_input = dict(raw=commands) |
|
260 | 260 | if self.translator is not None: |
|
261 | 261 | python = self.translator(commands, message) |
|
262 | 262 | if python is None: |
|
263 | 263 | # Something went wrong with the translation. The translator |
|
264 | 264 | # should have added an appropriate entry to the message object. |
|
265 | 265 | return message |
|
266 | 266 | else: |
|
267 | 267 | python = commands |
|
268 | 268 | user_input['translated'] = python |
|
269 | 269 | message['input'] = user_input |
|
270 | 270 | |
|
271 | 271 | # Set the message object so that any magics executed in the code have |
|
272 | 272 | # access. |
|
273 | 273 | self.message = message |
|
274 | 274 | |
|
275 | 275 | # Set all of the output/exception traps. |
|
276 | 276 | self.set_traps() |
|
277 | 277 | |
|
278 | 278 | # Actually execute the Python code. |
|
279 | 279 | status = self.execute_python(python) |
|
280 | 280 | |
|
281 | 281 | # Unset all of the traps. |
|
282 | 282 | self.unset_traps() |
|
283 | 283 | |
|
284 | 284 | # Unset the message object. |
|
285 | 285 | self.message = None |
|
286 | 286 | |
|
287 | 287 | # Update the history variables in the namespace. |
|
288 | 288 | # E.g. In, Out, _, __, ___ |
|
289 | 289 | if self.history is not None: |
|
290 | 290 | self.history.update_history(self, python) |
|
291 | 291 | |
|
292 | 292 | # Let all of the traps contribute to the message and then clear their |
|
293 | 293 | # stored information. |
|
294 | 294 | self.output_trap.add_to_message(message) |
|
295 | 295 | self.output_trap.clear() |
|
296 | 296 | self.display_trap.add_to_message(message) |
|
297 | 297 | self.display_trap.clear() |
|
298 | 298 | self.traceback_trap.add_to_message(message) |
|
299 | 299 | # Pull out the type, value and tb of the current exception |
|
300 | 300 | # before clearing it. |
|
301 | 301 | einfo = self.traceback_trap.args |
|
302 | 302 | self.traceback_trap.clear() |
|
303 | 303 | |
|
304 | 304 | # Cache the message. |
|
305 | 305 | self.message_cache.add_message(self.current_cell_number, message) |
|
306 | 306 | |
|
307 | 307 | # Bump the number. |
|
308 | 308 | self.current_cell_number += 1 |
|
309 | 309 | |
|
310 | 310 | # This conditional lets the execute method either raise any |
|
311 | 311 | # exception that has occured in user code OR return the message |
|
312 | 312 | # dict containing the traceback and other useful info. |
|
313 | 313 | if raiseException and einfo: |
|
314 | 314 | raise einfo[0],einfo[1],einfo[2] |
|
315 | 315 | else: |
|
316 | 316 | return message |
|
317 | 317 | |
|
318 | 318 | def generate_prompt(self, is_continuation): |
|
319 | 319 | """Calculate and return a string with the prompt to display. |
|
320 | 320 | |
|
321 | 321 | :Parameters: |
|
322 | 322 | is_continuation : bool |
|
323 | 323 | Whether the input line is continuing multiline input or not, so |
|
324 | 324 | that a proper continuation prompt can be computed.""" |
|
325 | 325 | |
|
326 | 326 | if is_continuation: |
|
327 | 327 | return str(self.outputcache.prompt2) |
|
328 | 328 | else: |
|
329 | 329 | return str(self.outputcache.prompt1) |
|
330 | 330 | |
|
331 | 331 | def execute_python(self, python): |
|
332 | 332 | """ Actually run the Python code in the namespace. |
|
333 | 333 | |
|
334 | 334 | :Parameters: |
|
335 | 335 | |
|
336 | 336 | python : str |
|
337 | 337 | Pure, exec'able Python code. Special IPython commands should have |
|
338 | 338 | already been translated into pure Python. |
|
339 | 339 | """ |
|
340 | 340 | |
|
341 | 341 | # We use a CommandCompiler instance to compile the code so as to keep |
|
342 | 342 | # track of __future__ imports. |
|
343 | 343 | try: |
|
344 | 344 | commands = self.split_commands(python) |
|
345 | 345 | except (SyntaxError, IndentationError), e: |
|
346 | 346 | # Save the exc_info so compilation related exceptions can be |
|
347 | 347 | # reraised |
|
348 | 348 | self.traceback_trap.args = sys.exc_info() |
|
349 | 349 | self.pack_exception(self.message,e) |
|
350 | 350 | return None |
|
351 | 351 | |
|
352 | 352 | for cmd in commands: |
|
353 | 353 | try: |
|
354 | 354 | code = self.command_compiler(cmd, self.filename, 'single') |
|
355 | 355 | except (SyntaxError, OverflowError, ValueError), e: |
|
356 | 356 | self.traceback_trap.args = sys.exc_info() |
|
357 | 357 | self.pack_exception(self.message,e) |
|
358 | 358 | # No point in continuing if one block raised |
|
359 | 359 | return None |
|
360 | 360 | else: |
|
361 | 361 | self.execute_block(code) |
|
362 | 362 | |
|
363 | 363 | def execute_block(self,code): |
|
364 | 364 | """Execute a single block of code in the user namespace. |
|
365 | 365 | |
|
366 | 366 | Return value: a flag indicating whether the code to be run completed |
|
367 | 367 | successfully: |
|
368 | 368 | |
|
369 | 369 | - 0: successful execution. |
|
370 | 370 | - 1: an error occurred. |
|
371 | 371 | """ |
|
372 | 372 | |
|
373 | 373 | outflag = 1 # start by assuming error, success will reset it |
|
374 | 374 | try: |
|
375 | 375 | exec code in self.user_ns |
|
376 | 376 | outflag = 0 |
|
377 | 377 | except SystemExit: |
|
378 | 378 | self.resetbuffer() |
|
379 | 379 | self.traceback_trap.args = sys.exc_info() |
|
380 | 380 | except: |
|
381 | 381 | self.traceback_trap.args = sys.exc_info() |
|
382 | 382 | |
|
383 | 383 | return outflag |
|
384 | 384 | |
|
385 | 385 | def execute_macro(self, macro): |
|
386 | 386 | """ Execute the value of a macro. |
|
387 | 387 | |
|
388 | 388 | Parameters |
|
389 | 389 | ---------- |
|
390 | 390 | macro : Macro |
|
391 | 391 | """ |
|
392 | 392 | |
|
393 | 393 | python = macro.value |
|
394 | 394 | if self.translator is not None: |
|
395 | 395 | python = self.translator(python) |
|
396 | 396 | self.execute_python(python) |
|
397 | 397 | |
|
398 | 398 | def getCommand(self, i=None): |
|
399 | 399 | """Gets the ith message in the message_cache. |
|
400 | 400 | |
|
401 | 401 | This is implemented here for compatibility with the old ipython1 shell |
|
402 | 402 | I am not sure we need this though. I even seem to remember that we |
|
403 | 403 | were going to get rid of it. |
|
404 | 404 | """ |
|
405 | 405 | return self.message_cache.get_message(i) |
|
406 | 406 | |
|
407 | 407 | def reset(self): |
|
408 | 408 | """Reset the interpreter. |
|
409 | 409 | |
|
410 | 410 | Currently this only resets the users variables in the namespace. |
|
411 | 411 | In the future we might want to also reset the other stateful |
|
412 | 412 | things like that the Interpreter has, like In, Out, etc. |
|
413 | 413 | """ |
|
414 | 414 | self.user_ns.clear() |
|
415 | 415 | self.setup_namespace() |
|
416 | 416 | |
|
417 | 417 | def complete(self,line,text=None, pos=None): |
|
418 | 418 | """Complete the given text. |
|
419 | 419 | |
|
420 | 420 | :Parameters: |
|
421 | 421 | |
|
422 | 422 | text : str |
|
423 | 423 | Text fragment to be completed on. Typically this is |
|
424 | 424 | """ |
|
425 | 425 | # fixme: implement |
|
426 | 426 | raise NotImplementedError |
|
427 | 427 | |
|
428 | 428 | def push(self, ns): |
|
429 | 429 | """ Put value into the namespace with name key. |
|
430 | 430 | |
|
431 | 431 | Parameters |
|
432 | 432 | ---------- |
|
433 | 433 | **kwds |
|
434 | 434 | """ |
|
435 | 435 | |
|
436 | 436 | self.user_ns.update(ns) |
|
437 | 437 | |
|
438 | 438 | def push_function(self, ns): |
|
439 | 439 | # First set the func_globals for all functions to self.user_ns |
|
440 | 440 | new_kwds = {} |
|
441 | 441 | for k, v in ns.iteritems(): |
|
442 | 442 | if not isinstance(v, FunctionType): |
|
443 | 443 | raise TypeError("function object expected") |
|
444 | 444 | new_kwds[k] = FunctionType(v.func_code, self.user_ns) |
|
445 | 445 | self.user_ns.update(new_kwds) |
|
446 | 446 | |
|
447 | 447 | def pack_exception(self,message,exc): |
|
448 | 448 | message['exception'] = exc.__class__ |
|
449 | 449 | message['exception_value'] = \ |
|
450 | 450 | traceback.format_exception_only(exc.__class__, exc) |
|
451 | 451 | |
|
452 | 452 | def feed_block(self, source, filename='<input>', symbol='single'): |
|
453 | 453 | """Compile some source in the interpreter. |
|
454 | 454 | |
|
455 | 455 | One several things can happen: |
|
456 | 456 | |
|
457 | 457 | 1) The input is incorrect; compile_command() raised an |
|
458 | 458 | exception (SyntaxError or OverflowError). |
|
459 | 459 | |
|
460 | 460 | 2) The input is incomplete, and more input is required; |
|
461 | 461 | compile_command() returned None. Nothing happens. |
|
462 | 462 | |
|
463 | 463 | 3) The input is complete; compile_command() returned a code |
|
464 | 464 | object. The code is executed by calling self.runcode() (which |
|
465 | 465 | also handles run-time exceptions, except for SystemExit). |
|
466 | 466 | |
|
467 | 467 | The return value is: |
|
468 | 468 | |
|
469 | 469 | - True in case 2 |
|
470 | 470 | |
|
471 | 471 | - False in the other cases, unless an exception is raised, where |
|
472 | 472 | None is returned instead. This can be used by external callers to |
|
473 | 473 | know whether to continue feeding input or not. |
|
474 | 474 | |
|
475 | 475 | The return value can be used to decide whether to use sys.ps1 or |
|
476 | 476 | sys.ps2 to prompt the next line.""" |
|
477 | 477 | |
|
478 | 478 | self.message = self.setup_message() |
|
479 | 479 | |
|
480 | 480 | try: |
|
481 | 481 | code = self.command_compiler(source,filename,symbol) |
|
482 | 482 | except (OverflowError, SyntaxError, IndentationError, ValueError ), e: |
|
483 | 483 | # Case 1 |
|
484 | 484 | self.traceback_trap.args = sys.exc_info() |
|
485 | 485 | self.pack_exception(self.message,e) |
|
486 | 486 | return COMPILER_ERROR,False |
|
487 | 487 | |
|
488 | 488 | if code is None: |
|
489 | 489 | # Case 2: incomplete input. This means that the input can span |
|
490 | 490 | # multiple lines. But we still need to decide when to actually |
|
491 | 491 | # stop taking user input. Later we'll add auto-indentation support |
|
492 | 492 | # somehow. In the meantime, we'll just stop if there are two lines |
|
493 | 493 | # of pure whitespace at the end. |
|
494 | 494 | last_two = source.rsplit('\n',2)[-2:] |
|
495 | 495 | print 'last two:',last_two # dbg |
|
496 | 496 | if len(last_two)==2 and all(s.isspace() for s in last_two): |
|
497 | 497 | return COMPLETE_INPUT,False |
|
498 | 498 | else: |
|
499 | 499 | return INCOMPLETE_INPUT, True |
|
500 | 500 | else: |
|
501 | 501 | # Case 3 |
|
502 | 502 | return COMPLETE_INPUT, False |
|
503 | 503 | |
|
504 | 504 | def pull(self, keys): |
|
505 | 505 | """ Get an item out of the namespace by key. |
|
506 | 506 | |
|
507 | 507 | Parameters |
|
508 | 508 | ---------- |
|
509 | 509 | key : str |
|
510 | 510 | |
|
511 | 511 | Returns |
|
512 | 512 | ------- |
|
513 | 513 | value : object |
|
514 | 514 | |
|
515 | 515 | Raises |
|
516 | 516 | ------ |
|
517 | 517 | TypeError if the key is not a string. |
|
518 | 518 | NameError if the object doesn't exist. |
|
519 | 519 | """ |
|
520 | 520 | |
|
521 | 521 | if isinstance(keys, str): |
|
522 | 522 | result = self.user_ns.get(keys, NotDefined()) |
|
523 | 523 | if isinstance(result, NotDefined): |
|
524 | 524 | raise NameError('name %s is not defined' % keys) |
|
525 | 525 | elif isinstance(keys, (list, tuple)): |
|
526 | 526 | result = [] |
|
527 | 527 | for key in keys: |
|
528 | 528 | if not isinstance(key, str): |
|
529 | 529 | raise TypeError("objects must be keyed by strings.") |
|
530 | 530 | else: |
|
531 | 531 | r = self.user_ns.get(key, NotDefined()) |
|
532 | 532 | if isinstance(r, NotDefined): |
|
533 | 533 | raise NameError('name %s is not defined' % key) |
|
534 | 534 | else: |
|
535 | 535 | result.append(r) |
|
536 | 536 | if len(keys)==1: |
|
537 | 537 | result = result[0] |
|
538 | 538 | else: |
|
539 | 539 | raise TypeError("keys must be a strong or a list/tuple of strings") |
|
540 | 540 | return result |
|
541 | 541 | |
|
542 | 542 | def pull_function(self, keys): |
|
543 | 543 | return self.pull(keys) |
|
544 | 544 | |
|
545 | 545 | #### Interactive user API ################################################## |
|
546 | 546 | |
|
547 | 547 | def ipsystem(self, command): |
|
548 | 548 | """ Execute a command in a system shell while expanding variables in the |
|
549 | 549 | current namespace. |
|
550 | 550 | |
|
551 | 551 | Parameters |
|
552 | 552 | ---------- |
|
553 | 553 | command : str |
|
554 | 554 | """ |
|
555 | 555 | |
|
556 | 556 | # Expand $variables. |
|
557 | 557 | command = self.var_expand(command) |
|
558 | 558 | |
|
559 | 559 | system_shell(command, |
|
560 | 560 | header='IPython system call: ', |
|
561 | 561 | verbose=self.rc.system_verbose, |
|
562 | 562 | ) |
|
563 | 563 | |
|
564 | 564 | def ipmagic(self, arg_string): |
|
565 | 565 | """ Call a magic function by name. |
|
566 | 566 | |
|
567 | 567 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython |
|
568 | 568 | prompt: |
|
569 | 569 | |
|
570 | 570 | In[1]: %name -opt foo bar |
|
571 | 571 | |
|
572 | 572 | To call a magic without arguments, simply use ipmagic('name'). |
|
573 | 573 | |
|
574 | 574 | This provides a proper Python function to call IPython's magics in any |
|
575 | 575 | valid Python code you can type at the interpreter, including loops and |
|
576 | 576 | compound statements. It is added by IPython to the Python builtin |
|
577 | 577 | namespace upon initialization. |
|
578 | 578 | |
|
579 | 579 | Parameters |
|
580 | 580 | ---------- |
|
581 | 581 | arg_string : str |
|
582 | 582 | A string containing the name of the magic function to call and any |
|
583 | 583 | additional arguments to be passed to the magic. |
|
584 | 584 | |
|
585 | 585 | Returns |
|
586 | 586 | ------- |
|
587 | 587 | something : object |
|
588 | 588 | The return value of the actual object. |
|
589 | 589 | """ |
|
590 | 590 | |
|
591 | 591 | # Taken from IPython. |
|
592 | 592 | raise NotImplementedError('Not ported yet') |
|
593 | 593 | |
|
594 | 594 | args = arg_string.split(' ', 1) |
|
595 | 595 | magic_name = args[0] |
|
596 | 596 | magic_name = magic_name.lstrip(self.config.ESC_MAGIC) |
|
597 | 597 | |
|
598 | 598 | try: |
|
599 | 599 | magic_args = args[1] |
|
600 | 600 | except IndexError: |
|
601 | 601 | magic_args = '' |
|
602 | 602 | fn = getattr(self.magic, 'magic_'+magic_name, None) |
|
603 | 603 | if fn is None: |
|
604 | 604 | self.error("Magic function `%s` not found." % magic_name) |
|
605 | 605 | else: |
|
606 | 606 | magic_args = self.var_expand(magic_args) |
|
607 | 607 | return fn(magic_args) |
|
608 | 608 | |
|
609 | 609 | |
|
610 | 610 | #### Private 'Interpreter' interface ####################################### |
|
611 | 611 | |
|
612 | 612 | def setup_message(self): |
|
613 | 613 | """Return a message object. |
|
614 | 614 | |
|
615 | 615 | This method prepares and returns a message dictionary. This dict |
|
616 | 616 | contains the various fields that are used to transfer information about |
|
617 | 617 | execution, results, tracebacks, etc, to clients (either in or out of |
|
618 | 618 | process ones). Because of the need to work with possibly out of |
|
619 | 619 | process clients, this dict MUST contain strictly pickle-safe values. |
|
620 | 620 | """ |
|
621 | 621 | |
|
622 | 622 | return dict(number=self.current_cell_number) |
|
623 | 623 | |
|
624 | 624 | def setup_namespace(self): |
|
625 | 625 | """ Add things to the namespace. |
|
626 | 626 | """ |
|
627 | 627 | |
|
628 | 628 | self.user_ns.setdefault('__name__', '__main__') |
|
629 | 629 | self.user_ns.setdefault('__builtins__', __builtin__) |
|
630 | 630 | self.user_ns['__IP'] = self |
|
631 | 631 | if self.raw_input_builtin is not None: |
|
632 | 632 | self.user_ns['raw_input'] = self.raw_input_builtin |
|
633 | 633 | if self.input_builtin is not None: |
|
634 | 634 | self.user_ns['input'] = self.input_builtin |
|
635 | 635 | |
|
636 | 636 | builtin_additions = dict( |
|
637 | 637 | ipmagic=self.ipmagic, |
|
638 | 638 | ) |
|
639 | 639 | __builtin__.__dict__.update(builtin_additions) |
|
640 | 640 | |
|
641 | 641 | if self.history is not None: |
|
642 | 642 | self.history.setup_namespace(self.user_ns) |
|
643 | 643 | |
|
644 | 644 | def set_traps(self): |
|
645 | 645 | """ Set all of the output, display, and traceback traps. |
|
646 | 646 | """ |
|
647 | 647 | |
|
648 | 648 | self.output_trap.set() |
|
649 | 649 | self.display_trap.set() |
|
650 | 650 | self.traceback_trap.set() |
|
651 | 651 | |
|
652 | 652 | def unset_traps(self): |
|
653 | 653 | """ Unset all of the output, display, and traceback traps. |
|
654 | 654 | """ |
|
655 | 655 | |
|
656 | 656 | self.output_trap.unset() |
|
657 | 657 | self.display_trap.unset() |
|
658 | 658 | self.traceback_trap.unset() |
|
659 | 659 | |
|
660 | 660 | def split_commands(self, python): |
|
661 | 661 | """ Split multiple lines of code into discrete commands that can be |
|
662 | 662 | executed singly. |
|
663 | 663 | |
|
664 | 664 | Parameters |
|
665 | 665 | ---------- |
|
666 | 666 | python : str |
|
667 | 667 | Pure, exec'able Python code. |
|
668 | 668 | |
|
669 | 669 | Returns |
|
670 | 670 | ------- |
|
671 | 671 | commands : list of str |
|
672 | 672 | Separate commands that can be exec'ed independently. |
|
673 | 673 | """ |
|
674 | 674 | |
|
675 | 675 | # compiler.parse treats trailing spaces after a newline as a |
|
676 | 676 | # SyntaxError. This is different than codeop.CommandCompiler, which |
|
677 | 677 | # will compile the trailng spaces just fine. We simply strip any |
|
678 | 678 | # trailing whitespace off. Passing a string with trailing whitespace |
|
679 | 679 | # to exec will fail however. There seems to be some inconsistency in |
|
680 | 680 | # how trailing whitespace is handled, but this seems to work. |
|
681 | 681 | python = python.strip() |
|
682 | 682 | |
|
683 | 683 | # The compiler module does not like unicode. We need to convert |
|
684 | 684 | # it encode it: |
|
685 | 685 | if isinstance(python, unicode): |
|
686 | 686 | # Use the utf-8-sig BOM so the compiler detects this a UTF-8 |
|
687 | 687 | # encode string. |
|
688 | 688 | python = '\xef\xbb\xbf' + python.encode('utf-8') |
|
689 | 689 | |
|
690 | 690 | # The compiler module will parse the code into an abstract syntax tree. |
|
691 | 691 | # This has a bug with str("a\nb"), but not str("""a\nb""")!!! |
|
692 | 692 | ast = compiler.parse(python) |
|
693 | 693 | |
|
694 | 694 | # Uncomment to help debug the ast tree |
|
695 | 695 | # for n in ast.node: |
|
696 | 696 | # print n.lineno,'->',n |
|
697 | 697 | |
|
698 | 698 | # Each separate command is available by iterating over ast.node. The |
|
699 | 699 | # lineno attribute is the line number (1-indexed) beginning the commands |
|
700 | 700 | # suite. |
|
701 | 701 | # lines ending with ";" yield a Discard Node that doesn't have a lineno |
|
702 | 702 | # attribute. These nodes can and should be discarded. But there are |
|
703 | 703 | # other situations that cause Discard nodes that shouldn't be discarded. |
|
704 | 704 | # We might eventually discover other cases where lineno is None and have |
|
705 | 705 | # to put in a more sophisticated test. |
|
706 | 706 | linenos = [x.lineno-1 for x in ast.node if x.lineno is not None] |
|
707 | 707 | |
|
708 | 708 | # When we finally get the slices, we will need to slice all the way to |
|
709 | 709 | # the end even though we don't have a line number for it. Fortunately, |
|
710 | 710 | # None does the job nicely. |
|
711 | 711 | linenos.append(None) |
|
712 | 712 | |
|
713 | 713 | # Same problem at the other end: sometimes the ast tree has its |
|
714 | 714 | # first complete statement not starting on line 0. In this case |
|
715 | 715 | # we might miss part of it. This fixes ticket 266993. Thanks Gael! |
|
716 | 716 | linenos[0] = 0 |
|
717 | 717 | |
|
718 | 718 | lines = python.splitlines() |
|
719 | 719 | |
|
720 | 720 | # Create a list of atomic commands. |
|
721 | 721 | cmds = [] |
|
722 | 722 | for i, j in zip(linenos[:-1], linenos[1:]): |
|
723 | 723 | cmd = lines[i:j] |
|
724 | 724 | if cmd: |
|
725 | 725 | cmds.append('\n'.join(cmd)+'\n') |
|
726 | 726 | |
|
727 | 727 | return cmds |
|
728 | 728 | |
|
729 | 729 | def error(self, text): |
|
730 | 730 | """ Pass an error message back to the shell. |
|
731 | 731 | |
|
732 | Preconditions | |
|
733 |
----- |
|
|
732 | Notes | |
|
733 | ----- | |
|
734 | 734 | This should only be called when self.message is set. In other words, |
|
735 | 735 | when code is being executed. |
|
736 | 736 | |
|
737 | 737 | Parameters |
|
738 | 738 | ---------- |
|
739 | 739 | text : str |
|
740 | 740 | """ |
|
741 | 741 | |
|
742 | 742 | errors = self.message.get('IPYTHON_ERROR', []) |
|
743 | 743 | errors.append(text) |
|
744 | 744 | |
|
745 | 745 | def var_expand(self, template): |
|
746 | 746 | """ Expand $variables in the current namespace using Itpl. |
|
747 | 747 | |
|
748 | 748 | Parameters |
|
749 | 749 | ---------- |
|
750 | 750 | template : str |
|
751 | 751 | """ |
|
752 | 752 | |
|
753 | 753 | return str(ItplNS(template, self.user_ns)) |
|
754 | 754 | |
|
755 | 755 | def _possible_macro(self, obj): |
|
756 | 756 | """ If the object is a macro, execute it. |
|
757 | 757 | """ |
|
758 | 758 | |
|
759 | 759 | if isinstance(obj, Macro): |
|
760 | 760 | self.execute_macro(obj) |
|
761 | 761 |
@@ -1,125 +1,125 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | |
|
3 | 3 | """The IPython Core Notification Center. |
|
4 | 4 | |
|
5 | 5 | See docs/source/development/notification_blueprint.txt for an overview of the |
|
6 | 6 | notification module. |
|
7 | 7 | """ |
|
8 | 8 | |
|
9 | 9 | __docformat__ = "restructuredtext en" |
|
10 | 10 | |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | # Copyright (C) 2008 The IPython Development Team |
|
13 | 13 | # |
|
14 | 14 | # Distributed under the terms of the BSD License. The full license is in |
|
15 | 15 | # the file COPYING, distributed as part of this software. |
|
16 | 16 | #----------------------------------------------------------------------------- |
|
17 | 17 | |
|
18 | 18 | # Tell nose to skip the testing of this module |
|
19 | 19 | __test__ = {} |
|
20 | 20 | |
|
21 | 21 | class NotificationCenter(object): |
|
22 | 22 | """Synchronous notification center |
|
23 | 23 | |
|
24 | Example | |
|
25 | ------- | |
|
24 | Examples | |
|
25 | -------- | |
|
26 | 26 | >>> import IPython.kernel.core.notification as notification |
|
27 | 27 | >>> def callback(theType, theSender, args={}): |
|
28 | 28 | ... print theType,theSender,args |
|
29 | 29 | ... |
|
30 | 30 | >>> notification.sharedCenter.add_observer(callback, 'NOTIFICATION_TYPE', None) |
|
31 | 31 | >>> notification.sharedCenter.post_notification('NOTIFICATION_TYPE', object()) # doctest:+ELLIPSIS |
|
32 | 32 | NOTIFICATION_TYPE ... |
|
33 | 33 | |
|
34 | 34 | """ |
|
35 | 35 | def __init__(self): |
|
36 | 36 | super(NotificationCenter, self).__init__() |
|
37 | 37 | self._init_observers() |
|
38 | 38 | |
|
39 | 39 | |
|
40 | 40 | def _init_observers(self): |
|
41 | 41 | """Initialize observer storage""" |
|
42 | 42 | |
|
43 | 43 | self.registered_types = set() #set of types that are observed |
|
44 | 44 | self.registered_senders = set() #set of senders that are observed |
|
45 | 45 | self.observers = {} #map (type,sender) => callback (callable) |
|
46 | 46 | |
|
47 | 47 | |
|
48 | 48 | def post_notification(self, theType, sender, **kwargs): |
|
49 | 49 | """Post notification (type,sender,**kwargs) to all registered |
|
50 |
observers. |
|
|
51 | ||
|
52 | Implementation | |
|
53 | -------------- | |
|
50 | observers. | |
|
51 | ||
|
52 | Implementation notes: | |
|
53 | ||
|
54 | 54 | * If no registered observers, performance is O(1). |
|
55 | 55 | * Notificaiton order is undefined. |
|
56 | 56 | * Notifications are posted synchronously. |
|
57 | 57 | """ |
|
58 | 58 | |
|
59 | 59 | if(theType==None or sender==None): |
|
60 | 60 | raise Exception("NotificationCenter.post_notification requires \ |
|
61 | 61 | type and sender.") |
|
62 | 62 | |
|
63 | 63 | # If there are no registered observers for the type/sender pair |
|
64 | 64 | if((theType not in self.registered_types and |
|
65 | 65 | None not in self.registered_types) or |
|
66 | 66 | (sender not in self.registered_senders and |
|
67 | 67 | None not in self.registered_senders)): |
|
68 | 68 | return |
|
69 | 69 | |
|
70 | 70 | for o in self._observers_for_notification(theType, sender): |
|
71 | 71 | o(theType, sender, args=kwargs) |
|
72 | 72 | |
|
73 | 73 | |
|
74 | 74 | def _observers_for_notification(self, theType, sender): |
|
75 | 75 | """Find all registered observers that should recieve notification""" |
|
76 | 76 | |
|
77 | 77 | keys = ( |
|
78 | 78 | (theType,sender), |
|
79 | 79 | (theType, None), |
|
80 | 80 | (None, sender), |
|
81 | 81 | (None,None) |
|
82 | 82 | ) |
|
83 | 83 | |
|
84 | 84 | |
|
85 | 85 | obs = set() |
|
86 | 86 | for k in keys: |
|
87 | 87 | obs.update(self.observers.get(k, set())) |
|
88 | 88 | |
|
89 | 89 | return obs |
|
90 | 90 | |
|
91 | 91 | |
|
92 | 92 | def add_observer(self, callback, theType, sender): |
|
93 | 93 | """Add an observer callback to this notification center. |
|
94 | 94 | |
|
95 | 95 | The given callback will be called upon posting of notifications of |
|
96 | 96 | the given type/sender and will receive any additional kwargs passed |
|
97 | 97 | to post_notification. |
|
98 | 98 | |
|
99 | 99 | Parameters |
|
100 | 100 | ---------- |
|
101 | 101 | observerCallback : callable |
|
102 | 102 | Callable. Must take at least two arguments:: |
|
103 | 103 | observerCallback(type, sender, args={}) |
|
104 | 104 | |
|
105 | 105 | theType : hashable |
|
106 | 106 | The notification type. If None, all notifications from sender |
|
107 | 107 | will be posted. |
|
108 | 108 | |
|
109 | 109 | sender : hashable |
|
110 | 110 | The notification sender. If None, all notifications of theType |
|
111 | 111 | will be posted. |
|
112 | 112 | """ |
|
113 | 113 | assert(callback != None) |
|
114 | 114 | self.registered_types.add(theType) |
|
115 | 115 | self.registered_senders.add(sender) |
|
116 | 116 | self.observers.setdefault((theType,sender), set()).add(callback) |
|
117 | 117 | |
|
118 | 118 | def remove_all_observers(self): |
|
119 | 119 | """Removes all observers from this notification center""" |
|
120 | 120 | |
|
121 | 121 | self._init_observers() |
|
122 | 122 | |
|
123 | 123 | |
|
124 | 124 | |
|
125 | sharedCenter = NotificationCenter() No newline at end of file | |
|
125 | sharedCenter = NotificationCenter() |
@@ -1,197 +1,195 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | |
|
3 | 3 | __docformat__ = "restructuredtext en" |
|
4 | 4 | |
|
5 | 5 | #------------------------------------------------------------------------------- |
|
6 | 6 | # Copyright (C) 2008 The IPython Development Team |
|
7 | 7 | # |
|
8 | 8 | # Distributed under the terms of the BSD License. The full license is in |
|
9 | 9 | # the file COPYING, distributed as part of this software. |
|
10 | 10 | #------------------------------------------------------------------------------- |
|
11 | 11 | |
|
12 | 12 | #------------------------------------------------------------------------------- |
|
13 | 13 | # Imports |
|
14 | 14 | #------------------------------------------------------------------------------- |
|
15 | 15 | |
|
16 | 16 | import os |
|
17 | 17 | import sys |
|
18 | 18 | |
|
19 | 19 | |
|
20 | 20 | # This class is mostly taken from IPython. |
|
21 | 21 | class InputList(list): |
|
22 | 22 | """ Class to store user input. |
|
23 | 23 | |
|
24 | 24 | It's basically a list, but slices return a string instead of a list, thus |
|
25 | 25 | allowing things like (assuming 'In' is an instance): |
|
26 | 26 | |
|
27 | 27 | exec In[4:7] |
|
28 | 28 | |
|
29 | 29 | or |
|
30 | 30 | |
|
31 | 31 | exec In[5:9] + In[14] + In[21:25] |
|
32 | 32 | """ |
|
33 | 33 | |
|
34 | 34 | def __getslice__(self, i, j): |
|
35 | 35 | return ''.join(list.__getslice__(self, i, j)) |
|
36 | 36 | |
|
37 | 37 | def add(self, index, command): |
|
38 | 38 | """ Add a command to the list with the appropriate index. |
|
39 | 39 | |
|
40 | 40 | If the index is greater than the current length of the list, empty |
|
41 | 41 | strings are added in between. |
|
42 | 42 | """ |
|
43 | 43 | |
|
44 | 44 | length = len(self) |
|
45 | 45 | if length == index: |
|
46 | 46 | self.append(command) |
|
47 | 47 | elif length > index: |
|
48 | 48 | self[index] = command |
|
49 | 49 | else: |
|
50 | 50 | extras = index - length |
|
51 | 51 | self.extend([''] * extras) |
|
52 | 52 | self.append(command) |
|
53 | 53 | |
|
54 | 54 | |
|
55 | 55 | class Bunch(dict): |
|
56 | 56 | """ A dictionary that exposes its keys as attributes. |
|
57 | 57 | """ |
|
58 | 58 | |
|
59 | 59 | def __init__(self, *args, **kwds): |
|
60 | 60 | dict.__init__(self, *args, **kwds) |
|
61 | 61 | self.__dict__ = self |
|
62 | 62 | |
|
63 | 63 | |
|
64 | 64 | def esc_quotes(strng): |
|
65 | 65 | """ Return the input string with single and double quotes escaped out. |
|
66 | 66 | """ |
|
67 | 67 | |
|
68 | 68 | return strng.replace('"', '\\"').replace("'", "\\'") |
|
69 | 69 | |
|
70 | 70 | def make_quoted_expr(s): |
|
71 | 71 | """Return string s in appropriate quotes, using raw string if possible. |
|
72 | 72 | |
|
73 | 73 | XXX - example removed because it caused encoding errors in documentation |
|
74 | 74 | generation. We need a new example that doesn't contain invalid chars. |
|
75 | 75 | |
|
76 | 76 | Note the use of raw string and padding at the end to allow trailing |
|
77 | 77 | backslash. |
|
78 | 78 | """ |
|
79 | 79 | |
|
80 | 80 | tail = '' |
|
81 | 81 | tailpadding = '' |
|
82 | 82 | raw = '' |
|
83 | 83 | if "\\" in s: |
|
84 | 84 | raw = 'r' |
|
85 | 85 | if s.endswith('\\'): |
|
86 | 86 | tail = '[:-1]' |
|
87 | 87 | tailpadding = '_' |
|
88 | 88 | if '"' not in s: |
|
89 | 89 | quote = '"' |
|
90 | 90 | elif "'" not in s: |
|
91 | 91 | quote = "'" |
|
92 | 92 | elif '"""' not in s and not s.endswith('"'): |
|
93 | 93 | quote = '"""' |
|
94 | 94 | elif "'''" not in s and not s.endswith("'"): |
|
95 | 95 | quote = "'''" |
|
96 | 96 | else: |
|
97 | 97 | # Give up, backslash-escaped string will do |
|
98 | 98 | return '"%s"' % esc_quotes(s) |
|
99 | 99 | res = ''.join([raw, quote, s, tailpadding, quote, tail]) |
|
100 | 100 | return res |
|
101 | 101 | |
|
102 | 102 | # This function is used by ipython in a lot of places to make system calls. |
|
103 | 103 | # We need it to be slightly different under win32, due to the vagaries of |
|
104 | 104 | # 'network shares'. A win32 override is below. |
|
105 | 105 | |
|
106 | 106 | def system_shell(cmd, verbose=False, debug=False, header=''): |
|
107 | 107 | """ Execute a command in the system shell; always return None. |
|
108 | 108 | |
|
109 | This returns None so it can be conveniently used in interactive loops | |
|
110 | without getting the return value (typically 0) printed many times. | |
|
111 | ||
|
109 | 112 | Parameters |
|
110 | 113 | ---------- |
|
111 | 114 | cmd : str |
|
112 | 115 | The command to execute. |
|
113 | 116 | verbose : bool |
|
114 | 117 | If True, print the command to be executed. |
|
115 | 118 | debug : bool |
|
116 | 119 | Only print, do not actually execute. |
|
117 | 120 | header : str |
|
118 | 121 | Header to print to screen prior to the executed command. No extra |
|
119 | 122 | newlines are added. |
|
120 | ||
|
121 | Description | |
|
122 | ----------- | |
|
123 | This returns None so it can be conveniently used in interactive loops | |
|
124 | without getting the return value (typically 0) printed many times. | |
|
125 | 123 | """ |
|
126 | 124 | |
|
127 | 125 | if verbose or debug: |
|
128 | 126 | print header + cmd |
|
129 | 127 | |
|
130 | 128 | # Flush stdout so we don't mangle python's buffering. |
|
131 | 129 | sys.stdout.flush() |
|
132 | 130 | if not debug: |
|
133 | 131 | os.system(cmd) |
|
134 | 132 | |
|
135 | 133 | # Override shell() for win32 to deal with network shares. |
|
136 | 134 | if os.name in ('nt', 'dos'): |
|
137 | 135 | |
|
138 | 136 | system_shell_ori = system_shell |
|
139 | 137 | |
|
140 | 138 | def system_shell(cmd, verbose=False, debug=False, header=''): |
|
141 | 139 | if os.getcwd().startswith(r"\\"): |
|
142 | 140 | path = os.getcwd() |
|
143 | 141 | # Change to c drive (cannot be on UNC-share when issuing os.system, |
|
144 | 142 | # as cmd.exe cannot handle UNC addresses). |
|
145 | 143 | os.chdir("c:") |
|
146 | 144 | # Issue pushd to the UNC-share and then run the command. |
|
147 | 145 | try: |
|
148 | 146 | system_shell_ori('"pushd %s&&"'%path+cmd,verbose,debug,header) |
|
149 | 147 | finally: |
|
150 | 148 | os.chdir(path) |
|
151 | 149 | else: |
|
152 | 150 | system_shell_ori(cmd,verbose,debug,header) |
|
153 | 151 | |
|
154 | 152 | system_shell.__doc__ = system_shell_ori.__doc__ |
|
155 | 153 | |
|
156 | 154 | def getoutputerror(cmd, verbose=False, debug=False, header='', split=False): |
|
157 | 155 | """ Executes a command and returns the output. |
|
158 | 156 | |
|
159 | 157 | Parameters |
|
160 | 158 | ---------- |
|
161 | 159 | cmd : str |
|
162 | 160 | The command to execute. |
|
163 | 161 | verbose : bool |
|
164 | 162 | If True, print the command to be executed. |
|
165 | 163 | debug : bool |
|
166 | 164 | Only print, do not actually execute. |
|
167 | 165 | header : str |
|
168 | 166 | Header to print to screen prior to the executed command. No extra |
|
169 | 167 | newlines are added. |
|
170 | 168 | split : bool |
|
171 | 169 | If True, return the output as a list split on newlines. |
|
172 | 170 | |
|
173 | 171 | """ |
|
174 | 172 | |
|
175 | 173 | if verbose or debug: |
|
176 | 174 | print header+cmd |
|
177 | 175 | |
|
178 | 176 | if not cmd: |
|
179 | 177 | # Return empty lists or strings. |
|
180 | 178 | if split: |
|
181 | 179 | return [], [] |
|
182 | 180 | else: |
|
183 | 181 | return '', '' |
|
184 | 182 | |
|
185 | 183 | if not debug: |
|
186 | 184 | # fixme: use subprocess. |
|
187 | 185 | pin,pout,perr = os.popen3(cmd) |
|
188 | 186 | tout = pout.read().rstrip() |
|
189 | 187 | terr = perr.read().rstrip() |
|
190 | 188 | pin.close() |
|
191 | 189 | pout.close() |
|
192 | 190 | perr.close() |
|
193 | 191 | if split: |
|
194 | 192 | return tout.split('\n'), terr.split('\n') |
|
195 | 193 | else: |
|
196 | 194 | return tout, terr |
|
197 | 195 |
@@ -1,965 +1,964 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | # -*- test-case-name: IPython.kernel.test.test_multiengineclient -*- |
|
3 | 3 | |
|
4 | 4 | """General Classes for IMultiEngine clients.""" |
|
5 | 5 | |
|
6 | 6 | __docformat__ = "restructuredtext en" |
|
7 | 7 | |
|
8 | 8 | #------------------------------------------------------------------------------- |
|
9 | 9 | # Copyright (C) 2008 The IPython Development Team |
|
10 | 10 | # |
|
11 | 11 | # Distributed under the terms of the BSD License. The full license is in |
|
12 | 12 | # the file COPYING, distributed as part of this software. |
|
13 | 13 | #------------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | #------------------------------------------------------------------------------- |
|
16 | 16 | # Imports |
|
17 | 17 | #------------------------------------------------------------------------------- |
|
18 | 18 | |
|
19 | 19 | import sys |
|
20 | 20 | import cPickle as pickle |
|
21 | 21 | from types import FunctionType |
|
22 | 22 | import linecache |
|
23 | 23 | import warnings |
|
24 | 24 | |
|
25 | 25 | from twisted.internet import reactor |
|
26 | 26 | from twisted.python import components, log |
|
27 | 27 | from twisted.python.failure import Failure |
|
28 | 28 | from zope.interface import Interface, implements, Attribute |
|
29 | 29 | |
|
30 | 30 | from IPython.ColorANSI import TermColors |
|
31 | 31 | |
|
32 | 32 | from IPython.kernel.twistedutil import blockingCallFromThread |
|
33 | 33 | from IPython.kernel import error |
|
34 | 34 | from IPython.kernel.parallelfunction import ParallelFunction |
|
35 | 35 | from IPython.kernel.mapper import ( |
|
36 | 36 | MultiEngineMapper, |
|
37 | 37 | IMultiEngineMapperFactory, |
|
38 | 38 | IMapper |
|
39 | 39 | ) |
|
40 | 40 | from IPython.kernel import map as Map |
|
41 | 41 | from IPython.kernel import multiengine as me |
|
42 | 42 | from IPython.kernel.multiengine import (IFullMultiEngine, |
|
43 | 43 | IFullSynchronousMultiEngine) |
|
44 | 44 | |
|
45 | 45 | |
|
46 | 46 | #------------------------------------------------------------------------------- |
|
47 | 47 | # Pending Result things |
|
48 | 48 | #------------------------------------------------------------------------------- |
|
49 | 49 | |
|
50 | 50 | class IPendingResult(Interface): |
|
51 | 51 | """A representation of a result that is pending. |
|
52 | 52 | |
|
53 | 53 | This class is similar to Twisted's `Deferred` object, but is designed to be |
|
54 | 54 | used in a synchronous context. |
|
55 | 55 | """ |
|
56 | 56 | |
|
57 | 57 | result_id=Attribute("ID of the deferred on the other side") |
|
58 | 58 | client=Attribute("A client that I came from") |
|
59 | 59 | r=Attribute("An attribute that is a property that calls and returns get_result") |
|
60 | 60 | |
|
61 | 61 | def get_result(default=None, block=True): |
|
62 | 62 | """ |
|
63 | 63 | Get a result that is pending. |
|
64 | 64 | |
|
65 | 65 | :Parameters: |
|
66 | 66 | default |
|
67 | 67 | The value to return if the result is not ready. |
|
68 | 68 | block : boolean |
|
69 | 69 | Should I block for the result. |
|
70 | 70 | |
|
71 | 71 | :Returns: The actual result or the default value. |
|
72 | 72 | """ |
|
73 | 73 | |
|
74 | 74 | def add_callback(f, *args, **kwargs): |
|
75 | 75 | """ |
|
76 | 76 | Add a callback that is called with the result. |
|
77 | 77 | |
|
78 | 78 | If the original result is foo, adding a callback will cause |
|
79 | 79 | f(foo, *args, **kwargs) to be returned instead. If multiple |
|
80 | 80 | callbacks are registered, they are chained together: the result of |
|
81 | 81 | one is passed to the next and so on. |
|
82 | 82 | |
|
83 | 83 | Unlike Twisted's Deferred object, there is no errback chain. Thus |
|
84 | 84 | any exception raised will not be caught and handled. User must |
|
85 | 85 | catch these by hand when calling `get_result`. |
|
86 | 86 | """ |
|
87 | 87 | |
|
88 | 88 | |
|
89 | 89 | class PendingResult(object): |
|
90 | 90 | """A representation of a result that is not yet ready. |
|
91 | 91 | |
|
92 | 92 | A user should not create a `PendingResult` instance by hand. |
|
93 | 93 | |
|
94 | Methods | |
|
95 | ======= | |
|
94 | Methods: | |
|
96 | 95 | |
|
97 | 96 | * `get_result` |
|
98 | 97 | * `add_callback` |
|
99 | 98 | |
|
100 | Properties | |
|
101 | ========== | |
|
99 | Properties: | |
|
100 | ||
|
102 | 101 | * `r` |
|
103 | 102 | """ |
|
104 | 103 | |
|
105 | 104 | def __init__(self, client, result_id): |
|
106 | 105 | """Create a PendingResult with a result_id and a client instance. |
|
107 | 106 | |
|
108 | 107 | The client should implement `_getPendingResult(result_id, block)`. |
|
109 | 108 | """ |
|
110 | 109 | self.client = client |
|
111 | 110 | self.result_id = result_id |
|
112 | 111 | self.called = False |
|
113 | 112 | self.raised = False |
|
114 | 113 | self.callbacks = [] |
|
115 | 114 | |
|
116 | 115 | def get_result(self, default=None, block=True): |
|
117 | 116 | """Get a result that is pending. |
|
118 | 117 | |
|
119 | 118 | This method will connect to an IMultiEngine adapted controller |
|
120 | 119 | and see if the result is ready. If the action triggers an exception |
|
121 | 120 | raise it and record it. This method records the result/exception once it is |
|
122 | 121 | retrieved. Calling `get_result` again will get this cached result or will |
|
123 | 122 | re-raise the exception. The .r attribute is a property that calls |
|
124 | 123 | `get_result` with block=True. |
|
125 | 124 | |
|
126 | 125 | :Parameters: |
|
127 | 126 | default |
|
128 | 127 | The value to return if the result is not ready. |
|
129 | 128 | block : boolean |
|
130 | 129 | Should I block for the result. |
|
131 | 130 | |
|
132 | 131 | :Returns: The actual result or the default value. |
|
133 | 132 | """ |
|
134 | 133 | |
|
135 | 134 | if self.called: |
|
136 | 135 | if self.raised: |
|
137 | 136 | raise self.result[0], self.result[1], self.result[2] |
|
138 | 137 | else: |
|
139 | 138 | return self.result |
|
140 | 139 | try: |
|
141 | 140 | result = self.client.get_pending_deferred(self.result_id, block) |
|
142 | 141 | except error.ResultNotCompleted: |
|
143 | 142 | return default |
|
144 | 143 | except: |
|
145 | 144 | # Reraise other error, but first record them so they can be reraised |
|
146 | 145 | # later if .r or get_result is called again. |
|
147 | 146 | self.result = sys.exc_info() |
|
148 | 147 | self.called = True |
|
149 | 148 | self.raised = True |
|
150 | 149 | raise |
|
151 | 150 | else: |
|
152 | 151 | for cb in self.callbacks: |
|
153 | 152 | result = cb[0](result, *cb[1], **cb[2]) |
|
154 | 153 | self.result = result |
|
155 | 154 | self.called = True |
|
156 | 155 | return result |
|
157 | 156 | |
|
158 | 157 | def add_callback(self, f, *args, **kwargs): |
|
159 | 158 | """Add a callback that is called with the result. |
|
160 | 159 | |
|
161 | 160 | If the original result is result, adding a callback will cause |
|
162 | 161 | f(result, *args, **kwargs) to be returned instead. If multiple |
|
163 | 162 | callbacks are registered, they are chained together: the result of |
|
164 | 163 | one is passed to the next and so on. |
|
165 | 164 | |
|
166 | 165 | Unlike Twisted's Deferred object, there is no errback chain. Thus |
|
167 | 166 | any exception raised will not be caught and handled. User must |
|
168 | 167 | catch these by hand when calling `get_result`. |
|
169 | 168 | """ |
|
170 | 169 | assert callable(f) |
|
171 | 170 | self.callbacks.append((f, args, kwargs)) |
|
172 | 171 | |
|
173 | 172 | def __cmp__(self, other): |
|
174 | 173 | if self.result_id < other.result_id: |
|
175 | 174 | return -1 |
|
176 | 175 | else: |
|
177 | 176 | return 1 |
|
178 | 177 | |
|
179 | 178 | def _get_r(self): |
|
180 | 179 | return self.get_result(block=True) |
|
181 | 180 | |
|
182 | 181 | r = property(_get_r) |
|
183 | 182 | """This property is a shortcut to a `get_result(block=True)`.""" |
|
184 | 183 | |
|
185 | 184 | |
|
186 | 185 | #------------------------------------------------------------------------------- |
|
187 | 186 | # Pretty printing wrappers for certain lists |
|
188 | 187 | #------------------------------------------------------------------------------- |
|
189 | 188 | |
|
190 | 189 | class ResultList(list): |
|
191 | 190 | """A subclass of list that pretty prints the output of `execute`/`get_result`.""" |
|
192 | 191 | |
|
193 | 192 | def __repr__(self): |
|
194 | 193 | output = [] |
|
195 | 194 | # These colored prompts were not working on Windows |
|
196 | 195 | if sys.platform == 'win32': |
|
197 | 196 | blue = normal = red = green = '' |
|
198 | 197 | else: |
|
199 | 198 | blue = TermColors.Blue |
|
200 | 199 | normal = TermColors.Normal |
|
201 | 200 | red = TermColors.Red |
|
202 | 201 | green = TermColors.Green |
|
203 | 202 | output.append("<Results List>\n") |
|
204 | 203 | for cmd in self: |
|
205 | 204 | if isinstance(cmd, Failure): |
|
206 | 205 | output.append(cmd) |
|
207 | 206 | else: |
|
208 | 207 | target = cmd.get('id',None) |
|
209 | 208 | cmd_num = cmd.get('number',None) |
|
210 | 209 | cmd_stdin = cmd.get('input',{}).get('translated','No Input') |
|
211 | 210 | cmd_stdout = cmd.get('stdout', None) |
|
212 | 211 | cmd_stderr = cmd.get('stderr', None) |
|
213 | 212 | output.append("%s[%i]%s In [%i]:%s %s\n" % \ |
|
214 | 213 | (green, target, |
|
215 | 214 | blue, cmd_num, normal, cmd_stdin)) |
|
216 | 215 | if cmd_stdout: |
|
217 | 216 | output.append("%s[%i]%s Out[%i]:%s %s\n" % \ |
|
218 | 217 | (green, target, |
|
219 | 218 | red, cmd_num, normal, cmd_stdout)) |
|
220 | 219 | if cmd_stderr: |
|
221 | 220 | output.append("%s[%i]%s Err[%i]:\n%s %s" % \ |
|
222 | 221 | (green, target, |
|
223 | 222 | red, cmd_num, normal, cmd_stderr)) |
|
224 | 223 | return ''.join(output) |
|
225 | 224 | |
|
226 | 225 | |
|
227 | 226 | def wrapResultList(result): |
|
228 | 227 | """A function that wraps the output of `execute`/`get_result` -> `ResultList`.""" |
|
229 | 228 | if len(result) == 0: |
|
230 | 229 | result = [result] |
|
231 | 230 | return ResultList(result) |
|
232 | 231 | |
|
233 | 232 | |
|
234 | 233 | class QueueStatusList(list): |
|
235 | 234 | """A subclass of list that pretty prints the output of `queue_status`.""" |
|
236 | 235 | |
|
237 | 236 | def __repr__(self): |
|
238 | 237 | output = [] |
|
239 | 238 | output.append("<Queue Status List>\n") |
|
240 | 239 | for e in self: |
|
241 | 240 | output.append("Engine: %s\n" % repr(e[0])) |
|
242 | 241 | output.append(" Pending: %s\n" % repr(e[1]['pending'])) |
|
243 | 242 | for q in e[1]['queue']: |
|
244 | 243 | output.append(" Command: %s\n" % repr(q)) |
|
245 | 244 | return ''.join(output) |
|
246 | 245 | |
|
247 | 246 | |
|
248 | 247 | #------------------------------------------------------------------------------- |
|
249 | 248 | # InteractiveMultiEngineClient |
|
250 | 249 | #------------------------------------------------------------------------------- |
|
251 | 250 | |
|
252 | 251 | class InteractiveMultiEngineClient(object): |
|
253 | 252 | """A mixin class that add a few methods to a multiengine client. |
|
254 | 253 | |
|
255 | 254 | The methods in this mixin class are designed for interactive usage. |
|
256 | 255 | """ |
|
257 | 256 | |
|
258 | 257 | def activate(self): |
|
259 | 258 | """Make this `MultiEngineClient` active for parallel magic commands. |
|
260 | 259 | |
|
261 | 260 | IPython has a magic command syntax to work with `MultiEngineClient` objects. |
|
262 | 261 | In a given IPython session there is a single active one. While |
|
263 | 262 | there can be many `MultiEngineClient` created and used by the user, |
|
264 | 263 | there is only one active one. The active `MultiEngineClient` is used whenever |
|
265 | 264 | the magic commands %px and %autopx are used. |
|
266 | 265 | |
|
267 | 266 | The activate() method is called on a given `MultiEngineClient` to make it |
|
268 | 267 | active. Once this has been done, the magic commands can be used. |
|
269 | 268 | """ |
|
270 | 269 | |
|
271 | 270 | try: |
|
272 | 271 | __IPYTHON__.activeController = self |
|
273 | 272 | except NameError: |
|
274 | 273 | print "The IPython Controller magics only work within IPython." |
|
275 | 274 | |
|
276 | 275 | def __setitem__(self, key, value): |
|
277 | 276 | """Add a dictionary interface for pushing/pulling. |
|
278 | 277 | |
|
279 | 278 | This functions as a shorthand for `push`. |
|
280 | 279 | |
|
281 | 280 | :Parameters: |
|
282 | 281 | key : str |
|
283 | 282 | What to call the remote object. |
|
284 | 283 | value : object |
|
285 | 284 | The local Python object to push. |
|
286 | 285 | """ |
|
287 | 286 | targets, block = self._findTargetsAndBlock() |
|
288 | 287 | return self.push({key:value}, targets=targets, block=block) |
|
289 | 288 | |
|
290 | 289 | def __getitem__(self, key): |
|
291 | 290 | """Add a dictionary interface for pushing/pulling. |
|
292 | 291 | |
|
293 | 292 | This functions as a shorthand to `pull`. |
|
294 | 293 | |
|
295 | 294 | :Parameters: |
|
296 | 295 | - `key`: A string representing the key. |
|
297 | 296 | """ |
|
298 | 297 | if isinstance(key, str): |
|
299 | 298 | targets, block = self._findTargetsAndBlock() |
|
300 | 299 | return self.pull(key, targets=targets, block=block) |
|
301 | 300 | else: |
|
302 | 301 | raise TypeError("__getitem__ only takes strs") |
|
303 | 302 | |
|
304 | 303 | def __len__(self): |
|
305 | 304 | """Return the number of available engines.""" |
|
306 | 305 | return len(self.get_ids()) |
|
307 | 306 | |
|
308 | 307 | #--------------------------------------------------------------------------- |
|
309 | 308 | # Make this a context manager for with |
|
310 | 309 | #--------------------------------------------------------------------------- |
|
311 | 310 | |
|
312 | 311 | def findsource_file(self,f): |
|
313 | 312 | linecache.checkcache() |
|
314 | 313 | s = findsource(f.f_code) |
|
315 | 314 | lnum = f.f_lineno |
|
316 | 315 | wsource = s[0][f.f_lineno:] |
|
317 | 316 | return strip_whitespace(wsource) |
|
318 | 317 | |
|
319 | 318 | def findsource_ipython(self,f): |
|
320 | 319 | from IPython import ipapi |
|
321 | 320 | self.ip = ipapi.get() |
|
322 | 321 | wsource = [l+'\n' for l in |
|
323 | 322 | self.ip.IP.input_hist_raw[-1].splitlines()[1:]] |
|
324 | 323 | return strip_whitespace(wsource) |
|
325 | 324 | |
|
326 | 325 | def __enter__(self): |
|
327 | 326 | f = sys._getframe(1) |
|
328 | 327 | local_ns = f.f_locals |
|
329 | 328 | global_ns = f.f_globals |
|
330 | 329 | if f.f_code.co_filename == '<ipython console>': |
|
331 | 330 | s = self.findsource_ipython(f) |
|
332 | 331 | else: |
|
333 | 332 | s = self.findsource_file(f) |
|
334 | 333 | |
|
335 | 334 | self._with_context_result = self.execute(s) |
|
336 | 335 | |
|
337 | 336 | def __exit__ (self, etype, value, tb): |
|
338 | 337 | if issubclass(etype,error.StopLocalExecution): |
|
339 | 338 | return True |
|
340 | 339 | |
|
341 | 340 | |
|
342 | 341 | def remote(): |
|
343 | 342 | m = 'Special exception to stop local execution of parallel code.' |
|
344 | 343 | raise error.StopLocalExecution(m) |
|
345 | 344 | |
|
346 | 345 | def strip_whitespace(source): |
|
347 | 346 | # Expand tabs to avoid any confusion. |
|
348 | 347 | wsource = [l.expandtabs(4) for l in source] |
|
349 | 348 | # Detect the indentation level |
|
350 | 349 | done = False |
|
351 | 350 | for line in wsource: |
|
352 | 351 | if line.isspace(): |
|
353 | 352 | continue |
|
354 | 353 | for col,char in enumerate(line): |
|
355 | 354 | if char != ' ': |
|
356 | 355 | done = True |
|
357 | 356 | break |
|
358 | 357 | if done: |
|
359 | 358 | break |
|
360 | 359 | # Now we know how much leading space there is in the code. Next, we |
|
361 | 360 | # extract up to the first line that has less indentation. |
|
362 | 361 | # WARNINGS: we skip comments that may be misindented, but we do NOT yet |
|
363 | 362 | # detect triple quoted strings that may have flush left text. |
|
364 | 363 | for lno,line in enumerate(wsource): |
|
365 | 364 | lead = line[:col] |
|
366 | 365 | if lead.isspace(): |
|
367 | 366 | continue |
|
368 | 367 | else: |
|
369 | 368 | if not lead.lstrip().startswith('#'): |
|
370 | 369 | break |
|
371 | 370 | # The real 'with' source is up to lno |
|
372 | 371 | src_lines = [l[col:] for l in wsource[:lno+1]] |
|
373 | 372 | |
|
374 | 373 | # Finally, check that the source's first non-comment line begins with the |
|
375 | 374 | # special call 'remote()' |
|
376 | 375 | for nline,line in enumerate(src_lines): |
|
377 | 376 | if line.isspace() or line.startswith('#'): |
|
378 | 377 | continue |
|
379 | 378 | if 'remote()' in line: |
|
380 | 379 | break |
|
381 | 380 | else: |
|
382 | 381 | raise ValueError('remote() call missing at the start of code') |
|
383 | 382 | src = ''.join(src_lines[nline+1:]) |
|
384 | 383 | #print 'SRC:\n<<<<<<<>>>>>>>\n%s<<<<<>>>>>>' % src # dbg |
|
385 | 384 | return src |
|
386 | 385 | |
|
387 | 386 | |
|
388 | 387 | #------------------------------------------------------------------------------- |
|
389 | 388 | # The top-level MultiEngine client adaptor |
|
390 | 389 | #------------------------------------------------------------------------------- |
|
391 | 390 | |
|
392 | 391 | |
|
393 | 392 | _prop_warn = """\ |
|
394 | 393 | |
|
395 | 394 | We are currently refactoring the task dependency system. This might |
|
396 | 395 | involve the removal of this method and other methods related to engine |
|
397 | 396 | properties. Please see the docstrings for IPython.kernel.TaskRejectError |
|
398 | 397 | for more information.""" |
|
399 | 398 | |
|
400 | 399 | |
|
401 | 400 | class IFullBlockingMultiEngineClient(Interface): |
|
402 | 401 | pass |
|
403 | 402 | |
|
404 | 403 | |
|
405 | 404 | class FullBlockingMultiEngineClient(InteractiveMultiEngineClient): |
|
406 | 405 | """ |
|
407 | 406 | A blocking client to the `IMultiEngine` controller interface. |
|
408 | 407 | |
|
409 | 408 | This class allows users to use a set of engines for a parallel |
|
410 | 409 | computation through the `IMultiEngine` interface. In this interface, |
|
411 | 410 | each engine has a specific id (an int) that is used to refer to the |
|
412 | 411 | engine, run code on it, etc. |
|
413 | 412 | """ |
|
414 | 413 | |
|
415 | 414 | implements( |
|
416 | 415 | IFullBlockingMultiEngineClient, |
|
417 | 416 | IMultiEngineMapperFactory, |
|
418 | 417 | IMapper |
|
419 | 418 | ) |
|
420 | 419 | |
|
421 | 420 | def __init__(self, smultiengine): |
|
422 | 421 | self.smultiengine = smultiengine |
|
423 | 422 | self.block = True |
|
424 | 423 | self.targets = 'all' |
|
425 | 424 | |
|
426 | 425 | def _findBlock(self, block=None): |
|
427 | 426 | if block is None: |
|
428 | 427 | return self.block |
|
429 | 428 | else: |
|
430 | 429 | if block in (True, False): |
|
431 | 430 | return block |
|
432 | 431 | else: |
|
433 | 432 | raise ValueError("block must be True or False") |
|
434 | 433 | |
|
435 | 434 | def _findTargets(self, targets=None): |
|
436 | 435 | if targets is None: |
|
437 | 436 | return self.targets |
|
438 | 437 | else: |
|
439 | 438 | if not isinstance(targets, (str,list,tuple,int)): |
|
440 | 439 | raise ValueError("targets must be a str, list, tuple or int") |
|
441 | 440 | return targets |
|
442 | 441 | |
|
443 | 442 | def _findTargetsAndBlock(self, targets=None, block=None): |
|
444 | 443 | return self._findTargets(targets), self._findBlock(block) |
|
445 | 444 | |
|
446 | 445 | def _blockFromThread(self, function, *args, **kwargs): |
|
447 | 446 | block = kwargs.get('block', None) |
|
448 | 447 | if block is None: |
|
449 | 448 | raise error.MissingBlockArgument("'block' keyword argument is missing") |
|
450 | 449 | result = blockingCallFromThread(function, *args, **kwargs) |
|
451 | 450 | if not block: |
|
452 | 451 | result = PendingResult(self, result) |
|
453 | 452 | return result |
|
454 | 453 | |
|
455 | 454 | def get_pending_deferred(self, deferredID, block): |
|
456 | 455 | return blockingCallFromThread(self.smultiengine.get_pending_deferred, deferredID, block) |
|
457 | 456 | |
|
458 | 457 | def barrier(self, pendingResults): |
|
459 | 458 | """Synchronize a set of `PendingResults`. |
|
460 | 459 | |
|
461 | 460 | This method is a synchronization primitive that waits for a set of |
|
462 | 461 | `PendingResult` objects to complete. More specifically, barier does |
|
463 | 462 | the following. |
|
464 | 463 | |
|
465 | 464 | * The `PendingResult`s are sorted by result_id. |
|
466 | 465 | * The `get_result` method is called for each `PendingResult` sequentially |
|
467 | 466 | with block=True. |
|
468 | 467 | * If a `PendingResult` gets a result that is an exception, it is |
|
469 | 468 | trapped and can be re-raised later by calling `get_result` again. |
|
470 | 469 | * The `PendingResult`s are flushed from the controller. |
|
471 | 470 | |
|
472 | 471 | After barrier has been called on a `PendingResult`, its results can |
|
473 | 472 | be retrieved by calling `get_result` again or accesing the `r` attribute |
|
474 | 473 | of the instance. |
|
475 | 474 | """ |
|
476 | 475 | |
|
477 | 476 | # Convert to list for sorting and check class type |
|
478 | 477 | prList = list(pendingResults) |
|
479 | 478 | for pr in prList: |
|
480 | 479 | if not isinstance(pr, PendingResult): |
|
481 | 480 | raise error.NotAPendingResult("Objects passed to barrier must be PendingResult instances") |
|
482 | 481 | |
|
483 | 482 | # Sort the PendingResults so they are in order |
|
484 | 483 | prList.sort() |
|
485 | 484 | # Block on each PendingResult object |
|
486 | 485 | for pr in prList: |
|
487 | 486 | try: |
|
488 | 487 | result = pr.get_result(block=True) |
|
489 | 488 | except Exception: |
|
490 | 489 | pass |
|
491 | 490 | |
|
492 | 491 | def flush(self): |
|
493 | 492 | """ |
|
494 | 493 | Clear all pending deferreds/results from the controller. |
|
495 | 494 | |
|
496 | 495 | For each `PendingResult` that is created by this client, the controller |
|
497 | 496 | holds on to the result for that `PendingResult`. This can be a problem |
|
498 | 497 | if there are a large number of `PendingResult` objects that are created. |
|
499 | 498 | |
|
500 | 499 | Once the result of the `PendingResult` has been retrieved, the result |
|
501 | 500 | is removed from the controller, but if a user doesn't get a result ( |
|
502 | 501 | they just ignore the `PendingResult`) the result is kept forever on the |
|
503 | 502 | controller. This method allows the user to clear out all un-retrieved |
|
504 | 503 | results on the controller. |
|
505 | 504 | """ |
|
506 | 505 | r = blockingCallFromThread(self.smultiengine.clear_pending_deferreds) |
|
507 | 506 | return r |
|
508 | 507 | |
|
509 | 508 | clear_pending_results = flush |
|
510 | 509 | |
|
511 | 510 | #--------------------------------------------------------------------------- |
|
512 | 511 | # IEngineMultiplexer related methods |
|
513 | 512 | #--------------------------------------------------------------------------- |
|
514 | 513 | |
|
515 | 514 | def execute(self, lines, targets=None, block=None): |
|
516 | 515 | """ |
|
517 | 516 | Execute code on a set of engines. |
|
518 | 517 | |
|
519 | 518 | :Parameters: |
|
520 | 519 | lines : str |
|
521 | 520 | The Python code to execute as a string |
|
522 | 521 | targets : id or list of ids |
|
523 | 522 | The engine to use for the execution |
|
524 | 523 | block : boolean |
|
525 | 524 | If False, this method will return the actual result. If False, |
|
526 | 525 | a `PendingResult` is returned which can be used to get the result |
|
527 | 526 | at a later time. |
|
528 | 527 | """ |
|
529 | 528 | targets, block = self._findTargetsAndBlock(targets, block) |
|
530 | 529 | result = blockingCallFromThread(self.smultiengine.execute, lines, |
|
531 | 530 | targets=targets, block=block) |
|
532 | 531 | if block: |
|
533 | 532 | result = ResultList(result) |
|
534 | 533 | else: |
|
535 | 534 | result = PendingResult(self, result) |
|
536 | 535 | result.add_callback(wrapResultList) |
|
537 | 536 | return result |
|
538 | 537 | |
|
539 | 538 | def push(self, namespace, targets=None, block=None): |
|
540 | 539 | """ |
|
541 | 540 | Push a dictionary of keys and values to engines namespace. |
|
542 | 541 | |
|
543 | 542 | Each engine has a persistent namespace. This method is used to push |
|
544 | 543 | Python objects into that namespace. |
|
545 | 544 | |
|
546 | 545 | The objects in the namespace must be pickleable. |
|
547 | 546 | |
|
548 | 547 | :Parameters: |
|
549 | 548 | namespace : dict |
|
550 | 549 | A dict that contains Python objects to be injected into |
|
551 | 550 | the engine persistent namespace. |
|
552 | 551 | targets : id or list of ids |
|
553 | 552 | The engine to use for the execution |
|
554 | 553 | block : boolean |
|
555 | 554 | If False, this method will return the actual result. If False, |
|
556 | 555 | a `PendingResult` is returned which can be used to get the result |
|
557 | 556 | at a later time. |
|
558 | 557 | """ |
|
559 | 558 | targets, block = self._findTargetsAndBlock(targets, block) |
|
560 | 559 | return self._blockFromThread(self.smultiengine.push, namespace, |
|
561 | 560 | targets=targets, block=block) |
|
562 | 561 | |
|
563 | 562 | def pull(self, keys, targets=None, block=None): |
|
564 | 563 | """ |
|
565 | 564 | Pull Python objects by key out of engines namespaces. |
|
566 | 565 | |
|
567 | 566 | :Parameters: |
|
568 | 567 | keys : str or list of str |
|
569 | 568 | The names of the variables to be pulled |
|
570 | 569 | targets : id or list of ids |
|
571 | 570 | The engine to use for the execution |
|
572 | 571 | block : boolean |
|
573 | 572 | If False, this method will return the actual result. If False, |
|
574 | 573 | a `PendingResult` is returned which can be used to get the result |
|
575 | 574 | at a later time. |
|
576 | 575 | """ |
|
577 | 576 | targets, block = self._findTargetsAndBlock(targets, block) |
|
578 | 577 | return self._blockFromThread(self.smultiengine.pull, keys, targets=targets, block=block) |
|
579 | 578 | |
|
580 | 579 | def push_function(self, namespace, targets=None, block=None): |
|
581 | 580 | """ |
|
582 | 581 | Push a Python function to an engine. |
|
583 | 582 | |
|
584 | 583 | This method is used to push a Python function to an engine. This |
|
585 | 584 | method can then be used in code on the engines. Closures are not supported. |
|
586 | 585 | |
|
587 | 586 | :Parameters: |
|
588 | 587 | namespace : dict |
|
589 | 588 | A dict whose values are the functions to be pushed. The keys give |
|
590 | 589 | that names that the function will appear as in the engines |
|
591 | 590 | namespace. |
|
592 | 591 | targets : id or list of ids |
|
593 | 592 | The engine to use for the execution |
|
594 | 593 | block : boolean |
|
595 | 594 | If False, this method will return the actual result. If False, |
|
596 | 595 | a `PendingResult` is returned which can be used to get the result |
|
597 | 596 | at a later time. |
|
598 | 597 | """ |
|
599 | 598 | targets, block = self._findTargetsAndBlock(targets, block) |
|
600 | 599 | return self._blockFromThread(self.smultiengine.push_function, namespace, targets=targets, block=block) |
|
601 | 600 | |
|
602 | 601 | def pull_function(self, keys, targets=None, block=None): |
|
603 | 602 | """ |
|
604 | 603 | Pull a Python function from an engine. |
|
605 | 604 | |
|
606 | 605 | This method is used to pull a Python function from an engine. |
|
607 | 606 | Closures are not supported. |
|
608 | 607 | |
|
609 | 608 | :Parameters: |
|
610 | 609 | keys : str or list of str |
|
611 | 610 | The names of the functions to be pulled |
|
612 | 611 | targets : id or list of ids |
|
613 | 612 | The engine to use for the execution |
|
614 | 613 | block : boolean |
|
615 | 614 | If False, this method will return the actual result. If False, |
|
616 | 615 | a `PendingResult` is returned which can be used to get the result |
|
617 | 616 | at a later time. |
|
618 | 617 | """ |
|
619 | 618 | targets, block = self._findTargetsAndBlock(targets, block) |
|
620 | 619 | return self._blockFromThread(self.smultiengine.pull_function, keys, targets=targets, block=block) |
|
621 | 620 | |
|
622 | 621 | def push_serialized(self, namespace, targets=None, block=None): |
|
623 | 622 | targets, block = self._findTargetsAndBlock(targets, block) |
|
624 | 623 | return self._blockFromThread(self.smultiengine.push_serialized, namespace, targets=targets, block=block) |
|
625 | 624 | |
|
626 | 625 | def pull_serialized(self, keys, targets=None, block=None): |
|
627 | 626 | targets, block = self._findTargetsAndBlock(targets, block) |
|
628 | 627 | return self._blockFromThread(self.smultiengine.pull_serialized, keys, targets=targets, block=block) |
|
629 | 628 | |
|
630 | 629 | def get_result(self, i=None, targets=None, block=None): |
|
631 | 630 | """ |
|
632 | 631 | Get a previous result. |
|
633 | 632 | |
|
634 | 633 | When code is executed in an engine, a dict is created and returned. This |
|
635 | 634 | method retrieves that dict for previous commands. |
|
636 | 635 | |
|
637 | 636 | :Parameters: |
|
638 | 637 | i : int |
|
639 | 638 | The number of the result to get |
|
640 | 639 | targets : id or list of ids |
|
641 | 640 | The engine to use for the execution |
|
642 | 641 | block : boolean |
|
643 | 642 | If False, this method will return the actual result. If False, |
|
644 | 643 | a `PendingResult` is returned which can be used to get the result |
|
645 | 644 | at a later time. |
|
646 | 645 | """ |
|
647 | 646 | targets, block = self._findTargetsAndBlock(targets, block) |
|
648 | 647 | result = blockingCallFromThread(self.smultiengine.get_result, i, targets=targets, block=block) |
|
649 | 648 | if block: |
|
650 | 649 | result = ResultList(result) |
|
651 | 650 | else: |
|
652 | 651 | result = PendingResult(self, result) |
|
653 | 652 | result.add_callback(wrapResultList) |
|
654 | 653 | return result |
|
655 | 654 | |
|
656 | 655 | def reset(self, targets=None, block=None): |
|
657 | 656 | """ |
|
658 | 657 | Reset an engine. |
|
659 | 658 | |
|
660 | 659 | This method clears out the namespace of an engine. |
|
661 | 660 | |
|
662 | 661 | :Parameters: |
|
663 | 662 | targets : id or list of ids |
|
664 | 663 | The engine to use for the execution |
|
665 | 664 | block : boolean |
|
666 | 665 | If False, this method will return the actual result. If False, |
|
667 | 666 | a `PendingResult` is returned which can be used to get the result |
|
668 | 667 | at a later time. |
|
669 | 668 | """ |
|
670 | 669 | targets, block = self._findTargetsAndBlock(targets, block) |
|
671 | 670 | return self._blockFromThread(self.smultiengine.reset, targets=targets, block=block) |
|
672 | 671 | |
|
673 | 672 | def keys(self, targets=None, block=None): |
|
674 | 673 | """ |
|
675 | 674 | Get a list of all the variables in an engine's namespace. |
|
676 | 675 | |
|
677 | 676 | :Parameters: |
|
678 | 677 | targets : id or list of ids |
|
679 | 678 | The engine to use for the execution |
|
680 | 679 | block : boolean |
|
681 | 680 | If False, this method will return the actual result. If False, |
|
682 | 681 | a `PendingResult` is returned which can be used to get the result |
|
683 | 682 | at a later time. |
|
684 | 683 | """ |
|
685 | 684 | targets, block = self._findTargetsAndBlock(targets, block) |
|
686 | 685 | return self._blockFromThread(self.smultiengine.keys, targets=targets, block=block) |
|
687 | 686 | |
|
688 | 687 | def kill(self, controller=False, targets=None, block=None): |
|
689 | 688 | """ |
|
690 | 689 | Kill the engines and controller. |
|
691 | 690 | |
|
692 | 691 | This method is used to stop the engine and controller by calling |
|
693 | 692 | `reactor.stop`. |
|
694 | 693 | |
|
695 | 694 | :Parameters: |
|
696 | 695 | controller : boolean |
|
697 | 696 | If True, kill the engines and controller. If False, just the |
|
698 | 697 | engines |
|
699 | 698 | targets : id or list of ids |
|
700 | 699 | The engine to use for the execution |
|
701 | 700 | block : boolean |
|
702 | 701 | If False, this method will return the actual result. If False, |
|
703 | 702 | a `PendingResult` is returned which can be used to get the result |
|
704 | 703 | at a later time. |
|
705 | 704 | """ |
|
706 | 705 | targets, block = self._findTargetsAndBlock(targets, block) |
|
707 | 706 | return self._blockFromThread(self.smultiengine.kill, controller, targets=targets, block=block) |
|
708 | 707 | |
|
709 | 708 | def clear_queue(self, targets=None, block=None): |
|
710 | 709 | """ |
|
711 | 710 | Clear out the controller's queue for an engine. |
|
712 | 711 | |
|
713 | 712 | The controller maintains a queue for each engine. This clear it out. |
|
714 | 713 | |
|
715 | 714 | :Parameters: |
|
716 | 715 | targets : id or list of ids |
|
717 | 716 | The engine to use for the execution |
|
718 | 717 | block : boolean |
|
719 | 718 | If False, this method will return the actual result. If False, |
|
720 | 719 | a `PendingResult` is returned which can be used to get the result |
|
721 | 720 | at a later time. |
|
722 | 721 | """ |
|
723 | 722 | targets, block = self._findTargetsAndBlock(targets, block) |
|
724 | 723 | return self._blockFromThread(self.smultiengine.clear_queue, targets=targets, block=block) |
|
725 | 724 | |
|
726 | 725 | def queue_status(self, targets=None, block=None): |
|
727 | 726 | """ |
|
728 | 727 | Get the status of an engines queue. |
|
729 | 728 | |
|
730 | 729 | :Parameters: |
|
731 | 730 | targets : id or list of ids |
|
732 | 731 | The engine to use for the execution |
|
733 | 732 | block : boolean |
|
734 | 733 | If False, this method will return the actual result. If False, |
|
735 | 734 | a `PendingResult` is returned which can be used to get the result |
|
736 | 735 | at a later time. |
|
737 | 736 | """ |
|
738 | 737 | targets, block = self._findTargetsAndBlock(targets, block) |
|
739 | 738 | return self._blockFromThread(self.smultiengine.queue_status, targets=targets, block=block) |
|
740 | 739 | |
|
741 | 740 | def set_properties(self, properties, targets=None, block=None): |
|
742 | 741 | warnings.warn(_prop_warn) |
|
743 | 742 | targets, block = self._findTargetsAndBlock(targets, block) |
|
744 | 743 | return self._blockFromThread(self.smultiengine.set_properties, properties, targets=targets, block=block) |
|
745 | 744 | |
|
746 | 745 | def get_properties(self, keys=None, targets=None, block=None): |
|
747 | 746 | warnings.warn(_prop_warn) |
|
748 | 747 | targets, block = self._findTargetsAndBlock(targets, block) |
|
749 | 748 | return self._blockFromThread(self.smultiengine.get_properties, keys, targets=targets, block=block) |
|
750 | 749 | |
|
751 | 750 | def has_properties(self, keys, targets=None, block=None): |
|
752 | 751 | warnings.warn(_prop_warn) |
|
753 | 752 | targets, block = self._findTargetsAndBlock(targets, block) |
|
754 | 753 | return self._blockFromThread(self.smultiengine.has_properties, keys, targets=targets, block=block) |
|
755 | 754 | |
|
756 | 755 | def del_properties(self, keys, targets=None, block=None): |
|
757 | 756 | warnings.warn(_prop_warn) |
|
758 | 757 | targets, block = self._findTargetsAndBlock(targets, block) |
|
759 | 758 | return self._blockFromThread(self.smultiengine.del_properties, keys, targets=targets, block=block) |
|
760 | 759 | |
|
761 | 760 | def clear_properties(self, targets=None, block=None): |
|
762 | 761 | warnings.warn(_prop_warn) |
|
763 | 762 | targets, block = self._findTargetsAndBlock(targets, block) |
|
764 | 763 | return self._blockFromThread(self.smultiengine.clear_properties, targets=targets, block=block) |
|
765 | 764 | |
|
766 | 765 | #--------------------------------------------------------------------------- |
|
767 | 766 | # IMultiEngine related methods |
|
768 | 767 | #--------------------------------------------------------------------------- |
|
769 | 768 | |
|
770 | 769 | def get_ids(self): |
|
771 | 770 | """ |
|
772 | 771 | Returns the ids of currently registered engines. |
|
773 | 772 | """ |
|
774 | 773 | result = blockingCallFromThread(self.smultiengine.get_ids) |
|
775 | 774 | return result |
|
776 | 775 | |
|
777 | 776 | #--------------------------------------------------------------------------- |
|
778 | 777 | # IMultiEngineCoordinator |
|
779 | 778 | #--------------------------------------------------------------------------- |
|
780 | 779 | |
|
781 | 780 | def scatter(self, key, seq, dist='b', flatten=False, targets=None, block=None): |
|
782 | 781 | """ |
|
783 | 782 | Partition a Python sequence and send the partitions to a set of engines. |
|
784 | 783 | """ |
|
785 | 784 | targets, block = self._findTargetsAndBlock(targets, block) |
|
786 | 785 | return self._blockFromThread(self.smultiengine.scatter, key, seq, |
|
787 | 786 | dist, flatten, targets=targets, block=block) |
|
788 | 787 | |
|
789 | 788 | def gather(self, key, dist='b', targets=None, block=None): |
|
790 | 789 | """ |
|
791 | 790 | Gather a partitioned sequence on a set of engines as a single local seq. |
|
792 | 791 | """ |
|
793 | 792 | targets, block = self._findTargetsAndBlock(targets, block) |
|
794 | 793 | return self._blockFromThread(self.smultiengine.gather, key, dist, |
|
795 | 794 | targets=targets, block=block) |
|
796 | 795 | |
|
797 | 796 | def raw_map(self, func, seq, dist='b', targets=None, block=None): |
|
798 | 797 | """ |
|
799 | 798 | A parallelized version of Python's builtin map. |
|
800 | 799 | |
|
801 | 800 | This has a slightly different syntax than the builtin `map`. |
|
802 | 801 | This is needed because we need to have keyword arguments and thus |
|
803 | 802 | can't use *args to capture all the sequences. Instead, they must |
|
804 | 803 | be passed in a list or tuple. |
|
805 | 804 | |
|
806 | 805 | raw_map(func, seqs) -> map(func, seqs[0], seqs[1], ...) |
|
807 | 806 | |
|
808 | 807 | Most users will want to use parallel functions or the `mapper` |
|
809 | 808 | and `map` methods for an API that follows that of the builtin |
|
810 | 809 | `map`. |
|
811 | 810 | """ |
|
812 | 811 | targets, block = self._findTargetsAndBlock(targets, block) |
|
813 | 812 | return self._blockFromThread(self.smultiengine.raw_map, func, seq, |
|
814 | 813 | dist, targets=targets, block=block) |
|
815 | 814 | |
|
816 | 815 | def map(self, func, *sequences): |
|
817 | 816 | """ |
|
818 | 817 | A parallel version of Python's builtin `map` function. |
|
819 | 818 | |
|
820 | 819 | This method applies a function to sequences of arguments. It |
|
821 | 820 | follows the same syntax as the builtin `map`. |
|
822 | 821 | |
|
823 | 822 | This method creates a mapper objects by calling `self.mapper` with |
|
824 | 823 | no arguments and then uses that mapper to do the mapping. See |
|
825 | 824 | the documentation of `mapper` for more details. |
|
826 | 825 | """ |
|
827 | 826 | return self.mapper().map(func, *sequences) |
|
828 | 827 | |
|
829 | 828 | def mapper(self, dist='b', targets='all', block=None): |
|
830 | 829 | """ |
|
831 | 830 | Create a mapper object that has a `map` method. |
|
832 | 831 | |
|
833 | 832 | This method returns an object that implements the `IMapper` |
|
834 | 833 | interface. This method is a factory that is used to control how |
|
835 | 834 | the map happens. |
|
836 | 835 | |
|
837 | 836 | :Parameters: |
|
838 | 837 | dist : str |
|
839 | 838 | What decomposition to use, 'b' is the only one supported |
|
840 | 839 | currently |
|
841 | 840 | targets : str, int, sequence of ints |
|
842 | 841 | Which engines to use for the map |
|
843 | 842 | block : boolean |
|
844 | 843 | Should calls to `map` block or not |
|
845 | 844 | """ |
|
846 | 845 | return MultiEngineMapper(self, dist, targets, block) |
|
847 | 846 | |
|
848 | 847 | def parallel(self, dist='b', targets=None, block=None): |
|
849 | 848 | """ |
|
850 | 849 | A decorator that turns a function into a parallel function. |
|
851 | 850 | |
|
852 | 851 | This can be used as: |
|
853 | 852 | |
|
854 | 853 | @parallel() |
|
855 | 854 | def f(x, y) |
|
856 | 855 | ... |
|
857 | 856 | |
|
858 | 857 | f(range(10), range(10)) |
|
859 | 858 | |
|
860 | 859 | This causes f(0,0), f(1,1), ... to be called in parallel. |
|
861 | 860 | |
|
862 | 861 | :Parameters: |
|
863 | 862 | dist : str |
|
864 | 863 | What decomposition to use, 'b' is the only one supported |
|
865 | 864 | currently |
|
866 | 865 | targets : str, int, sequence of ints |
|
867 | 866 | Which engines to use for the map |
|
868 | 867 | block : boolean |
|
869 | 868 | Should calls to `map` block or not |
|
870 | 869 | """ |
|
871 | 870 | targets, block = self._findTargetsAndBlock(targets, block) |
|
872 | 871 | mapper = self.mapper(dist, targets, block) |
|
873 | 872 | pf = ParallelFunction(mapper) |
|
874 | 873 | return pf |
|
875 | 874 | |
|
876 | 875 | #--------------------------------------------------------------------------- |
|
877 | 876 | # IMultiEngineExtras |
|
878 | 877 | #--------------------------------------------------------------------------- |
|
879 | 878 | |
|
880 | 879 | def zip_pull(self, keys, targets=None, block=None): |
|
881 | 880 | targets, block = self._findTargetsAndBlock(targets, block) |
|
882 | 881 | return self._blockFromThread(self.smultiengine.zip_pull, keys, |
|
883 | 882 | targets=targets, block=block) |
|
884 | 883 | |
|
885 | 884 | def run(self, filename, targets=None, block=None): |
|
886 | 885 | """ |
|
887 | 886 | Run a Python code in a file on the engines. |
|
888 | 887 | |
|
889 | 888 | :Parameters: |
|
890 | 889 | filename : str |
|
891 | 890 | The name of the local file to run |
|
892 | 891 | targets : id or list of ids |
|
893 | 892 | The engine to use for the execution |
|
894 | 893 | block : boolean |
|
895 | 894 | If False, this method will return the actual result. If False, |
|
896 | 895 | a `PendingResult` is returned which can be used to get the result |
|
897 | 896 | at a later time. |
|
898 | 897 | """ |
|
899 | 898 | targets, block = self._findTargetsAndBlock(targets, block) |
|
900 | 899 | return self._blockFromThread(self.smultiengine.run, filename, |
|
901 | 900 | targets=targets, block=block) |
|
902 | 901 | |
|
903 | 902 | def benchmark(self, push_size=10000): |
|
904 | 903 | """ |
|
905 | 904 | Run performance benchmarks for the current IPython cluster. |
|
906 | 905 | |
|
907 | 906 | This method tests both the latency of sending command and data to the |
|
908 | 907 | engines as well as the throughput of sending large objects to the |
|
909 | 908 | engines using push. The latency is measured by having one or more |
|
910 | 909 | engines execute the command 'pass'. The throughput is measure by |
|
911 | 910 | sending an NumPy array of size `push_size` to one or more engines. |
|
912 | 911 | |
|
913 | 912 | These benchmarks will vary widely on different hardware and networks |
|
914 | 913 | and thus can be used to get an idea of the performance characteristics |
|
915 | 914 | of a particular configuration of an IPython controller and engines. |
|
916 | 915 | |
|
917 | 916 | This function is not testable within our current testing framework. |
|
918 | 917 | """ |
|
919 | 918 | import timeit, __builtin__ |
|
920 | 919 | __builtin__._mec_self = self |
|
921 | 920 | benchmarks = {} |
|
922 | 921 | repeat = 3 |
|
923 | 922 | count = 10 |
|
924 | 923 | |
|
925 | 924 | timer = timeit.Timer('_mec_self.execute("pass",0)') |
|
926 | 925 | result = 1000*min(timer.repeat(repeat,count))/count |
|
927 | 926 | benchmarks['single_engine_latency'] = (result,'msec') |
|
928 | 927 | |
|
929 | 928 | timer = timeit.Timer('_mec_self.execute("pass")') |
|
930 | 929 | result = 1000*min(timer.repeat(repeat,count))/count |
|
931 | 930 | benchmarks['all_engine_latency'] = (result,'msec') |
|
932 | 931 | |
|
933 | 932 | try: |
|
934 | 933 | import numpy as np |
|
935 | 934 | except: |
|
936 | 935 | pass |
|
937 | 936 | else: |
|
938 | 937 | timer = timeit.Timer( |
|
939 | 938 | "_mec_self.push(d)", |
|
940 | 939 | "import numpy as np; d = dict(a=np.zeros(%r,dtype='float64'))" % push_size |
|
941 | 940 | ) |
|
942 | 941 | result = min(timer.repeat(repeat,count))/count |
|
943 | 942 | benchmarks['all_engine_push'] = (1e-6*push_size*8/result, 'MB/sec') |
|
944 | 943 | |
|
945 | 944 | try: |
|
946 | 945 | import numpy as np |
|
947 | 946 | except: |
|
948 | 947 | pass |
|
949 | 948 | else: |
|
950 | 949 | timer = timeit.Timer( |
|
951 | 950 | "_mec_self.push(d,0)", |
|
952 | 951 | "import numpy as np; d = dict(a=np.zeros(%r,dtype='float64'))" % push_size |
|
953 | 952 | ) |
|
954 | 953 | result = min(timer.repeat(repeat,count))/count |
|
955 | 954 | benchmarks['single_engine_push'] = (1e-6*push_size*8/result, 'MB/sec') |
|
956 | 955 | |
|
957 | 956 | return benchmarks |
|
958 | 957 | |
|
959 | 958 | |
|
960 | 959 | components.registerAdapter(FullBlockingMultiEngineClient, |
|
961 | 960 | IFullSynchronousMultiEngine, IFullBlockingMultiEngineClient) |
|
962 | 961 | |
|
963 | 962 | |
|
964 | 963 | |
|
965 | 964 |
@@ -1,1116 +1,1116 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | # -*- test-case-name: IPython.kernel.tests.test_task -*- |
|
3 | 3 | |
|
4 | 4 | """Task farming representation of the ControllerService.""" |
|
5 | 5 | |
|
6 | 6 | __docformat__ = "restructuredtext en" |
|
7 | 7 | |
|
8 | 8 | #----------------------------------------------------------------------------- |
|
9 | 9 | # Copyright (C) 2008 The IPython Development Team |
|
10 | 10 | # |
|
11 | 11 | # Distributed under the terms of the BSD License. The full license is in |
|
12 | 12 | # the file COPYING, distributed as part of this software. |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | # Imports |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | |
|
19 | 19 | # Tell nose to skip the testing of this module |
|
20 | 20 | __test__ = {} |
|
21 | 21 | |
|
22 | 22 | import copy, time |
|
23 | 23 | from types import FunctionType |
|
24 | 24 | |
|
25 | 25 | import zope.interface as zi, string |
|
26 | 26 | from twisted.internet import defer, reactor |
|
27 | 27 | from twisted.python import components, log, failure |
|
28 | 28 | |
|
29 | 29 | from IPython.kernel.util import printer |
|
30 | 30 | from IPython.kernel import engineservice as es, error |
|
31 | 31 | from IPython.kernel import controllerservice as cs |
|
32 | 32 | from IPython.kernel.twistedutil import gatherBoth, DeferredList |
|
33 | 33 | |
|
34 | 34 | from IPython.kernel.pickleutil import can, uncan, CannedFunction |
|
35 | 35 | |
|
36 | 36 | #----------------------------------------------------------------------------- |
|
37 | 37 | # Definition of the Task objects |
|
38 | 38 | #----------------------------------------------------------------------------- |
|
39 | 39 | |
|
40 | 40 | time_format = '%Y/%m/%d %H:%M:%S' |
|
41 | 41 | |
|
42 | 42 | class ITask(zi.Interface): |
|
43 | 43 | """ |
|
44 | 44 | This interface provides a generic definition of what constitutes a task. |
|
45 | 45 | |
|
46 | 46 | There are two sides to a task. First a task needs to take input from |
|
47 | 47 | a user to determine what work is performed by the task. Second, the |
|
48 | 48 | task needs to have the logic that knows how to turn that information |
|
49 | 49 | info specific calls to a worker, through the `IQueuedEngine` interface. |
|
50 | 50 | |
|
51 | 51 | Many method in this class get two things passed to them: a Deferred |
|
52 | 52 | and an IQueuedEngine implementer. Such methods should register callbacks |
|
53 | 53 | on the Deferred that use the IQueuedEngine to accomplish something. See |
|
54 | 54 | the existing task objects for examples. |
|
55 | 55 | """ |
|
56 | 56 | |
|
57 | 57 | zi.Attribute('retries','How many times to retry the task') |
|
58 | 58 | zi.Attribute('recovery_task','A task to try if the initial one fails') |
|
59 | 59 | zi.Attribute('taskid','the id of the task') |
|
60 | 60 | |
|
61 | 61 | def start_time(result): |
|
62 | 62 | """ |
|
63 | 63 | Do anything needed to start the timing of the task. |
|
64 | 64 | |
|
65 | 65 | Must simply return the result after starting the timers. |
|
66 | 66 | """ |
|
67 | 67 | |
|
68 | 68 | def stop_time(result): |
|
69 | 69 | """ |
|
70 | 70 | Do anything needed to stop the timing of the task. |
|
71 | 71 | |
|
72 | 72 | Must simply return the result after stopping the timers. This |
|
73 | 73 | method will usually set attributes that are used by `process_result` |
|
74 | 74 | in building result of the task. |
|
75 | 75 | """ |
|
76 | 76 | |
|
77 | 77 | def pre_task(d, queued_engine): |
|
78 | 78 | """Do something with the queued_engine before the task is run. |
|
79 | 79 | |
|
80 | 80 | This method should simply add callbacks to the input Deferred |
|
81 | 81 | that do something with the `queued_engine` before the task is run. |
|
82 | 82 | |
|
83 | 83 | :Parameters: |
|
84 | 84 | d : Deferred |
|
85 | 85 | The deferred that actions should be attached to |
|
86 | 86 | queued_engine : IQueuedEngine implementer |
|
87 | 87 | The worker that has been allocated to perform the task |
|
88 | 88 | """ |
|
89 | 89 | |
|
90 | 90 | def post_task(d, queued_engine): |
|
91 | 91 | """Do something with the queued_engine after the task is run. |
|
92 | 92 | |
|
93 | 93 | This method should simply add callbacks to the input Deferred |
|
94 | 94 | that do something with the `queued_engine` before the task is run. |
|
95 | 95 | |
|
96 | 96 | :Parameters: |
|
97 | 97 | d : Deferred |
|
98 | 98 | The deferred that actions should be attached to |
|
99 | 99 | queued_engine : IQueuedEngine implementer |
|
100 | 100 | The worker that has been allocated to perform the task |
|
101 | 101 | """ |
|
102 | 102 | |
|
103 | 103 | def submit_task(d, queued_engine): |
|
104 | 104 | """Submit a task using the `queued_engine` we have been allocated. |
|
105 | 105 | |
|
106 | 106 | When a task is ready to run, this method is called. This method |
|
107 | 107 | must take the internal information of the task and make suitable |
|
108 | 108 | calls on the queued_engine to have the actual work done. |
|
109 | 109 | |
|
110 | 110 | This method should simply add callbacks to the input Deferred |
|
111 | 111 | that do something with the `queued_engine` before the task is run. |
|
112 | 112 | |
|
113 | 113 | :Parameters: |
|
114 | 114 | d : Deferred |
|
115 | 115 | The deferred that actions should be attached to |
|
116 | 116 | queued_engine : IQueuedEngine implementer |
|
117 | 117 | The worker that has been allocated to perform the task |
|
118 | 118 | """ |
|
119 | 119 | |
|
120 | 120 | def process_result(d, result, engine_id): |
|
121 | 121 | """Take a raw task result. |
|
122 | 122 | |
|
123 | 123 | Objects that implement `ITask` can choose how the result of running |
|
124 | 124 | the task is presented. This method takes the raw result and |
|
125 | 125 | does this logic. Two example are the `MapTask` which simply returns |
|
126 | 126 | the raw result or a `Failure` object and the `StringTask` which |
|
127 | 127 | returns a `TaskResult` object. |
|
128 | 128 | |
|
129 | 129 | :Parameters: |
|
130 | 130 | d : Deferred |
|
131 | 131 | The deferred that actions should be attached to |
|
132 | 132 | result : object |
|
133 | 133 | The raw task result that needs to be wrapped |
|
134 | 134 | engine_id : int |
|
135 | 135 | The id of the engine that did the task |
|
136 | 136 | |
|
137 | 137 | :Returns: |
|
138 | 138 | The result, as a tuple of the form: (success, result). |
|
139 | 139 | Here, success is a boolean indicating if the task |
|
140 | 140 | succeeded or failed and result is the result. |
|
141 | 141 | """ |
|
142 | 142 | |
|
143 | 143 | def check_depend(properties): |
|
144 | 144 | """Check properties to see if the task should be run. |
|
145 | 145 | |
|
146 | 146 | :Parameters: |
|
147 | 147 | properties : dict |
|
148 | 148 | A dictionary of properties that an engine has set |
|
149 | 149 | |
|
150 | 150 | :Returns: |
|
151 | 151 | True if the task should be run, False otherwise |
|
152 | 152 | """ |
|
153 | 153 | |
|
154 | 154 | def can_task(self): |
|
155 | 155 | """Serialize (can) any functions in the task for pickling. |
|
156 | 156 | |
|
157 | 157 | Subclasses must override this method and make sure that all |
|
158 | 158 | functions in the task are canned by calling `can` on the |
|
159 | 159 | function. |
|
160 | 160 | """ |
|
161 | 161 | |
|
162 | 162 | def uncan_task(self): |
|
163 | 163 | """Unserialize (uncan) any canned function in the task.""" |
|
164 | 164 | |
|
165 | 165 | class BaseTask(object): |
|
166 | 166 | """ |
|
167 | 167 | Common fuctionality for all objects implementing `ITask`. |
|
168 | 168 | """ |
|
169 | 169 | |
|
170 | 170 | zi.implements(ITask) |
|
171 | 171 | |
|
172 | 172 | def __init__(self, clear_before=False, clear_after=False, retries=0, |
|
173 | 173 | recovery_task=None, depend=None): |
|
174 | 174 | """ |
|
175 | 175 | Make a generic task. |
|
176 | 176 | |
|
177 | 177 | :Parameters: |
|
178 | 178 | clear_before : boolean |
|
179 | 179 | Should the engines namespace be cleared before the task |
|
180 | 180 | is run |
|
181 | 181 | clear_after : boolean |
|
182 | 182 | Should the engines namespace be clear after the task is run |
|
183 | 183 | retries : int |
|
184 | 184 | The number of times a task should be retries upon failure |
|
185 | 185 | recovery_task : any task object |
|
186 | 186 | If a task fails and it has a recovery_task, that is run |
|
187 | 187 | upon a retry |
|
188 | 188 | depend : FunctionType |
|
189 | 189 | A function that is called to test for properties. This function |
|
190 | 190 | must take one argument, the properties dict and return a boolean |
|
191 | 191 | """ |
|
192 | 192 | self.clear_before = clear_before |
|
193 | 193 | self.clear_after = clear_after |
|
194 | 194 | self.retries = retries |
|
195 | 195 | self.recovery_task = recovery_task |
|
196 | 196 | self.depend = depend |
|
197 | 197 | self.taskid = None |
|
198 | 198 | |
|
199 | 199 | def start_time(self, result): |
|
200 | 200 | """ |
|
201 | 201 | Start the basic timers. |
|
202 | 202 | """ |
|
203 | 203 | self.start = time.time() |
|
204 | 204 | self.start_struct = time.localtime() |
|
205 | 205 | return result |
|
206 | 206 | |
|
207 | 207 | def stop_time(self, result): |
|
208 | 208 | """ |
|
209 | 209 | Stop the basic timers. |
|
210 | 210 | """ |
|
211 | 211 | self.stop = time.time() |
|
212 | 212 | self.stop_struct = time.localtime() |
|
213 | 213 | self.duration = self.stop - self.start |
|
214 | 214 | self.submitted = time.strftime(time_format, self.start_struct) |
|
215 | 215 | self.completed = time.strftime(time_format) |
|
216 | 216 | return result |
|
217 | 217 | |
|
218 | 218 | def pre_task(self, d, queued_engine): |
|
219 | 219 | """ |
|
220 | 220 | Clear the engine before running the task if clear_before is set. |
|
221 | 221 | """ |
|
222 | 222 | if self.clear_before: |
|
223 | 223 | d.addCallback(lambda r: queued_engine.reset()) |
|
224 | 224 | |
|
225 | 225 | def post_task(self, d, queued_engine): |
|
226 | 226 | """ |
|
227 | 227 | Clear the engine after running the task if clear_after is set. |
|
228 | 228 | """ |
|
229 | 229 | def reseter(result): |
|
230 | 230 | queued_engine.reset() |
|
231 | 231 | return result |
|
232 | 232 | if self.clear_after: |
|
233 | 233 | d.addBoth(reseter) |
|
234 | 234 | |
|
235 | 235 | def submit_task(self, d, queued_engine): |
|
236 | 236 | raise NotImplementedError('submit_task must be implemented in a subclass') |
|
237 | 237 | |
|
238 | 238 | def process_result(self, result, engine_id): |
|
239 | 239 | """ |
|
240 | 240 | Process a task result. |
|
241 | 241 | |
|
242 | 242 | This is the default `process_result` that just returns the raw |
|
243 | 243 | result or a `Failure`. |
|
244 | 244 | """ |
|
245 | 245 | if isinstance(result, failure.Failure): |
|
246 | 246 | return (False, result) |
|
247 | 247 | else: |
|
248 | 248 | return (True, result) |
|
249 | 249 | |
|
250 | 250 | def check_depend(self, properties): |
|
251 | 251 | """ |
|
252 | 252 | Calls self.depend(properties) to see if a task should be run. |
|
253 | 253 | """ |
|
254 | 254 | if self.depend is not None: |
|
255 | 255 | return self.depend(properties) |
|
256 | 256 | else: |
|
257 | 257 | return True |
|
258 | 258 | |
|
259 | 259 | def can_task(self): |
|
260 | 260 | self.depend = can(self.depend) |
|
261 | 261 | if isinstance(self.recovery_task, BaseTask): |
|
262 | 262 | self.recovery_task.can_task() |
|
263 | 263 | |
|
264 | 264 | def uncan_task(self): |
|
265 | 265 | self.depend = uncan(self.depend) |
|
266 | 266 | if isinstance(self.recovery_task, BaseTask): |
|
267 | 267 | self.recovery_task.uncan_task() |
|
268 | 268 | |
|
269 | 269 | class MapTask(BaseTask): |
|
270 | 270 | """ |
|
271 | 271 | A task that consists of a function and arguments. |
|
272 | 272 | """ |
|
273 | 273 | |
|
274 | 274 | zi.implements(ITask) |
|
275 | 275 | |
|
276 | 276 | def __init__(self, function, args=None, kwargs=None, clear_before=False, |
|
277 | 277 | clear_after=False, retries=0, recovery_task=None, depend=None): |
|
278 | 278 | """ |
|
279 | 279 | Create a task based on a function, args and kwargs. |
|
280 | 280 | |
|
281 | 281 | This is a simple type of task that consists of calling: |
|
282 | 282 | function(*args, **kwargs) and wrapping the result in a `TaskResult`. |
|
283 | 283 | |
|
284 | 284 | The return value of the function, or a `Failure` wrapping an |
|
285 | 285 | exception is the task result for this type of task. |
|
286 | 286 | """ |
|
287 | 287 | BaseTask.__init__(self, clear_before, clear_after, retries, |
|
288 | 288 | recovery_task, depend) |
|
289 | 289 | if not isinstance(function, FunctionType): |
|
290 | 290 | raise TypeError('a task function must be a FunctionType') |
|
291 | 291 | self.function = function |
|
292 | 292 | if args is None: |
|
293 | 293 | self.args = () |
|
294 | 294 | else: |
|
295 | 295 | self.args = args |
|
296 | 296 | if not isinstance(self.args, (list, tuple)): |
|
297 | 297 | raise TypeError('a task args must be a list or tuple') |
|
298 | 298 | if kwargs is None: |
|
299 | 299 | self.kwargs = {} |
|
300 | 300 | else: |
|
301 | 301 | self.kwargs = kwargs |
|
302 | 302 | if not isinstance(self.kwargs, dict): |
|
303 | 303 | raise TypeError('a task kwargs must be a dict') |
|
304 | 304 | |
|
305 | 305 | def submit_task(self, d, queued_engine): |
|
306 | 306 | d.addCallback(lambda r: queued_engine.push_function( |
|
307 | 307 | dict(_ipython_task_function=self.function)) |
|
308 | 308 | ) |
|
309 | 309 | d.addCallback(lambda r: queued_engine.push( |
|
310 | 310 | dict(_ipython_task_args=self.args,_ipython_task_kwargs=self.kwargs)) |
|
311 | 311 | ) |
|
312 | 312 | d.addCallback(lambda r: queued_engine.execute( |
|
313 | 313 | '_ipython_task_result = _ipython_task_function(*_ipython_task_args,**_ipython_task_kwargs)') |
|
314 | 314 | ) |
|
315 | 315 | d.addCallback(lambda r: queued_engine.pull('_ipython_task_result')) |
|
316 | 316 | |
|
317 | 317 | def can_task(self): |
|
318 | 318 | self.function = can(self.function) |
|
319 | 319 | BaseTask.can_task(self) |
|
320 | 320 | |
|
321 | 321 | def uncan_task(self): |
|
322 | 322 | self.function = uncan(self.function) |
|
323 | 323 | BaseTask.uncan_task(self) |
|
324 | 324 | |
|
325 | 325 | |
|
326 | 326 | class StringTask(BaseTask): |
|
327 | 327 | """ |
|
328 | 328 | A task that consists of a string of Python code to run. |
|
329 | 329 | """ |
|
330 | 330 | |
|
331 | 331 | def __init__(self, expression, pull=None, push=None, |
|
332 | 332 | clear_before=False, clear_after=False, retries=0, |
|
333 | 333 | recovery_task=None, depend=None): |
|
334 | 334 | """ |
|
335 | 335 | Create a task based on a Python expression and variables |
|
336 | 336 | |
|
337 | 337 | This type of task lets you push a set of variables to the engines |
|
338 | 338 | namespace, run a Python string in that namespace and then bring back |
|
339 | 339 | a different set of Python variables as the result. |
|
340 | 340 | |
|
341 | 341 | Because this type of task can return many results (through the |
|
342 | 342 | `pull` keyword argument) it returns a special `TaskResult` object |
|
343 | 343 | that wraps the pulled variables, statistics about the run and |
|
344 | 344 | any exceptions raised. |
|
345 | 345 | """ |
|
346 | 346 | if not isinstance(expression, str): |
|
347 | 347 | raise TypeError('a task expression must be a string') |
|
348 | 348 | self.expression = expression |
|
349 | 349 | |
|
350 | 350 | if pull==None: |
|
351 | 351 | self.pull = () |
|
352 | 352 | elif isinstance(pull, str): |
|
353 | 353 | self.pull = (pull,) |
|
354 | 354 | elif isinstance(pull, (list, tuple)): |
|
355 | 355 | self.pull = pull |
|
356 | 356 | else: |
|
357 | 357 | raise TypeError('pull must be str or a sequence of strs') |
|
358 | 358 | |
|
359 | 359 | if push==None: |
|
360 | 360 | self.push = {} |
|
361 | 361 | elif isinstance(push, dict): |
|
362 | 362 | self.push = push |
|
363 | 363 | else: |
|
364 | 364 | raise TypeError('push must be a dict') |
|
365 | 365 | |
|
366 | 366 | BaseTask.__init__(self, clear_before, clear_after, retries, |
|
367 | 367 | recovery_task, depend) |
|
368 | 368 | |
|
369 | 369 | def submit_task(self, d, queued_engine): |
|
370 | 370 | if self.push is not None: |
|
371 | 371 | d.addCallback(lambda r: queued_engine.push(self.push)) |
|
372 | 372 | |
|
373 | 373 | d.addCallback(lambda r: queued_engine.execute(self.expression)) |
|
374 | 374 | |
|
375 | 375 | if self.pull is not None: |
|
376 | 376 | d.addCallback(lambda r: queued_engine.pull(self.pull)) |
|
377 | 377 | else: |
|
378 | 378 | d.addCallback(lambda r: None) |
|
379 | 379 | |
|
380 | 380 | def process_result(self, result, engine_id): |
|
381 | 381 | if isinstance(result, failure.Failure): |
|
382 | 382 | tr = TaskResult(result, engine_id) |
|
383 | 383 | else: |
|
384 | 384 | if self.pull is None: |
|
385 | 385 | resultDict = {} |
|
386 | 386 | elif len(self.pull) == 1: |
|
387 | 387 | resultDict = {self.pull[0]:result} |
|
388 | 388 | else: |
|
389 | 389 | resultDict = dict(zip(self.pull, result)) |
|
390 | 390 | tr = TaskResult(resultDict, engine_id) |
|
391 | 391 | # Assign task attributes |
|
392 | 392 | tr.submitted = self.submitted |
|
393 | 393 | tr.completed = self.completed |
|
394 | 394 | tr.duration = self.duration |
|
395 | 395 | if hasattr(self,'taskid'): |
|
396 | 396 | tr.taskid = self.taskid |
|
397 | 397 | else: |
|
398 | 398 | tr.taskid = None |
|
399 | 399 | if isinstance(result, failure.Failure): |
|
400 | 400 | return (False, tr) |
|
401 | 401 | else: |
|
402 | 402 | return (True, tr) |
|
403 | 403 | |
|
404 | 404 | class ResultNS(object): |
|
405 | 405 | """ |
|
406 | 406 | A dict like object for holding the results of a task. |
|
407 | 407 | |
|
408 | 408 | The result namespace object for use in `TaskResult` objects as tr.ns. |
|
409 | 409 | It builds an object from a dictionary, such that it has attributes |
|
410 | 410 | according to the key,value pairs of the dictionary. |
|
411 | 411 | |
|
412 | 412 | This works by calling setattr on ALL key,value pairs in the dict. If a user |
|
413 | 413 | chooses to overwrite the `__repr__` or `__getattr__` attributes, they can. |
|
414 | 414 | This can be a bad idea, as it may corrupt standard behavior of the |
|
415 | 415 | ns object. |
|
416 | 416 | |
|
417 | Example | |
|
417 | Examples | |
|
418 | 418 | -------- |
|
419 | 419 | |
|
420 | 420 | >>> ns = ResultNS({'a':17,'foo':range(3)}) |
|
421 | 421 | >>> print ns |
|
422 | 422 | NS{'a': 17, 'foo': [0, 1, 2]} |
|
423 | 423 | >>> ns.a |
|
424 | 424 | 17 |
|
425 | 425 | >>> ns['foo'] |
|
426 | 426 | [0, 1, 2] |
|
427 | 427 | """ |
|
428 | 428 | def __init__(self, dikt): |
|
429 | 429 | for k,v in dikt.iteritems(): |
|
430 | 430 | setattr(self,k,v) |
|
431 | 431 | |
|
432 | 432 | def __repr__(self): |
|
433 | 433 | l = dir(self) |
|
434 | 434 | d = {} |
|
435 | 435 | for k in l: |
|
436 | 436 | # do not print private objects |
|
437 | 437 | if k[:2] != '__' and k[-2:] != '__': |
|
438 | 438 | d[k] = getattr(self, k) |
|
439 | 439 | return "NS"+repr(d) |
|
440 | 440 | |
|
441 | 441 | def __getitem__(self, key): |
|
442 | 442 | return getattr(self, key) |
|
443 | 443 | |
|
444 | 444 | class TaskResult(object): |
|
445 | 445 | """ |
|
446 | 446 | An object for returning task results for certain types of tasks. |
|
447 | 447 | |
|
448 | 448 | This object encapsulates the results of a task. On task |
|
449 | 449 | success it will have a keys attribute that will have a list |
|
450 | 450 | of the variables that have been pulled back. These variables |
|
451 | 451 | are accessible as attributes of this class as well. On |
|
452 | 452 | success the failure attribute will be None. |
|
453 | 453 | |
|
454 | 454 | In task failure, keys will be empty, but failure will contain |
|
455 | 455 | the failure object that encapsulates the remote exception. |
|
456 | 456 | One can also simply call the `raise_exception` method of |
|
457 | 457 | this class to re-raise any remote exception in the local |
|
458 | 458 | session. |
|
459 | 459 | |
|
460 | 460 | The `TaskResult` has a `.ns` member, which is a property for access |
|
461 | 461 | to the results. If the Task had pull=['a', 'b'], then the |
|
462 | 462 | Task Result will have attributes `tr.ns.a`, `tr.ns.b` for those values. |
|
463 | 463 | Accessing `tr.ns` will raise the remote failure if the task failed. |
|
464 | 464 | |
|
465 | 465 | The `engineid` attribute should have the `engineid` of the engine |
|
466 | 466 | that ran the task. But, because engines can come and go, |
|
467 | 467 | the `engineid` may not continue to be |
|
468 | 468 | valid or accurate. |
|
469 | 469 | |
|
470 | 470 | The `taskid` attribute simply gives the `taskid` that the task |
|
471 | 471 | is tracked under. |
|
472 | 472 | """ |
|
473 | 473 | taskid = None |
|
474 | 474 | |
|
475 | 475 | def _getNS(self): |
|
476 | 476 | if isinstance(self.failure, failure.Failure): |
|
477 | 477 | return self.failure.raiseException() |
|
478 | 478 | else: |
|
479 | 479 | return self._ns |
|
480 | 480 | |
|
481 | 481 | def _setNS(self, v): |
|
482 | 482 | raise Exception("the ns attribute cannot be changed") |
|
483 | 483 | |
|
484 | 484 | ns = property(_getNS, _setNS) |
|
485 | 485 | |
|
486 | 486 | def __init__(self, results, engineid): |
|
487 | 487 | self.engineid = engineid |
|
488 | 488 | if isinstance(results, failure.Failure): |
|
489 | 489 | self.failure = results |
|
490 | 490 | self.results = {} |
|
491 | 491 | else: |
|
492 | 492 | self.results = results |
|
493 | 493 | self.failure = None |
|
494 | 494 | |
|
495 | 495 | self._ns = ResultNS(self.results) |
|
496 | 496 | |
|
497 | 497 | self.keys = self.results.keys() |
|
498 | 498 | |
|
499 | 499 | def __repr__(self): |
|
500 | 500 | if self.failure is not None: |
|
501 | 501 | contents = self.failure |
|
502 | 502 | else: |
|
503 | 503 | contents = self.results |
|
504 | 504 | return "TaskResult[ID:%r]:%r"%(self.taskid, contents) |
|
505 | 505 | |
|
506 | 506 | def __getitem__(self, key): |
|
507 | 507 | if self.failure is not None: |
|
508 | 508 | self.raise_exception() |
|
509 | 509 | return self.results[key] |
|
510 | 510 | |
|
511 | 511 | def raise_exception(self): |
|
512 | 512 | """Re-raise any remote exceptions in the local python session.""" |
|
513 | 513 | if self.failure is not None: |
|
514 | 514 | self.failure.raiseException() |
|
515 | 515 | |
|
516 | 516 | |
|
517 | 517 | #----------------------------------------------------------------------------- |
|
518 | 518 | # The controller side of things |
|
519 | 519 | #----------------------------------------------------------------------------- |
|
520 | 520 | |
|
521 | 521 | class IWorker(zi.Interface): |
|
522 | 522 | """The Basic Worker Interface. |
|
523 | 523 | |
|
524 | 524 | A worked is a representation of an Engine that is ready to run tasks. |
|
525 | 525 | """ |
|
526 | 526 | |
|
527 | 527 | zi.Attribute("workerid", "the id of the worker") |
|
528 | 528 | |
|
529 | 529 | def run(task): |
|
530 | 530 | """Run task in worker's namespace. |
|
531 | 531 | |
|
532 | 532 | :Parameters: |
|
533 | 533 | task : a `Task` object |
|
534 | 534 | |
|
535 | 535 | :Returns: `Deferred` to a tuple of (success, result) where |
|
536 | 536 | success if a boolean that signifies success or failure |
|
537 | 537 | and result is the task result. |
|
538 | 538 | """ |
|
539 | 539 | |
|
540 | 540 | |
|
541 | 541 | class WorkerFromQueuedEngine(object): |
|
542 | 542 | """Adapt an `IQueuedEngine` to an `IWorker` object""" |
|
543 | 543 | |
|
544 | 544 | zi.implements(IWorker) |
|
545 | 545 | |
|
546 | 546 | def __init__(self, qe): |
|
547 | 547 | self.queuedEngine = qe |
|
548 | 548 | self.workerid = None |
|
549 | 549 | |
|
550 | 550 | def _get_properties(self): |
|
551 | 551 | return self.queuedEngine.properties |
|
552 | 552 | |
|
553 | 553 | properties = property(_get_properties, lambda self, _:None) |
|
554 | 554 | |
|
555 | 555 | def run(self, task): |
|
556 | 556 | """Run task in worker's namespace. |
|
557 | 557 | |
|
558 | 558 | This takes a task and calls methods on the task that actually |
|
559 | 559 | cause `self.queuedEngine` to do the task. See the methods of |
|
560 | 560 | `ITask` for more information about how these methods are called. |
|
561 | 561 | |
|
562 | 562 | :Parameters: |
|
563 | 563 | task : a `Task` object |
|
564 | 564 | |
|
565 | 565 | :Returns: `Deferred` to a tuple of (success, result) where |
|
566 | 566 | success if a boolean that signifies success or failure |
|
567 | 567 | and result is the task result. |
|
568 | 568 | """ |
|
569 | 569 | d = defer.succeed(None) |
|
570 | 570 | d.addCallback(task.start_time) |
|
571 | 571 | task.pre_task(d, self.queuedEngine) |
|
572 | 572 | task.submit_task(d, self.queuedEngine) |
|
573 | 573 | task.post_task(d, self.queuedEngine) |
|
574 | 574 | d.addBoth(task.stop_time) |
|
575 | 575 | d.addBoth(task.process_result, self.queuedEngine.id) |
|
576 | 576 | # At this point, there will be (success, result) coming down the line |
|
577 | 577 | return d |
|
578 | 578 | |
|
579 | 579 | |
|
580 | 580 | components.registerAdapter(WorkerFromQueuedEngine, es.IEngineQueued, IWorker) |
|
581 | 581 | |
|
582 | 582 | class IScheduler(zi.Interface): |
|
583 | 583 | """The interface for a Scheduler. |
|
584 | 584 | """ |
|
585 | 585 | zi.Attribute("nworkers", "the number of unassigned workers") |
|
586 | 586 | zi.Attribute("ntasks", "the number of unscheduled tasks") |
|
587 | 587 | zi.Attribute("workerids", "a list of the worker ids") |
|
588 | 588 | zi.Attribute("taskids", "a list of the task ids") |
|
589 | 589 | |
|
590 | 590 | def add_task(task, **flags): |
|
591 | 591 | """Add a task to the queue of the Scheduler. |
|
592 | 592 | |
|
593 | 593 | :Parameters: |
|
594 | 594 | task : an `ITask` implementer |
|
595 | 595 | The task to be queued. |
|
596 | 596 | flags : dict |
|
597 | 597 | General keywords for more sophisticated scheduling |
|
598 | 598 | """ |
|
599 | 599 | |
|
600 | 600 | def pop_task(id=None): |
|
601 | 601 | """Pops a task object from the queue. |
|
602 | 602 | |
|
603 | 603 | This gets the next task to be run. If no `id` is requested, the highest priority |
|
604 | 604 | task is returned. |
|
605 | 605 | |
|
606 | 606 | :Parameters: |
|
607 | 607 | id |
|
608 | 608 | The id of the task to be popped. The default (None) is to return |
|
609 | 609 | the highest priority task. |
|
610 | 610 | |
|
611 | 611 | :Returns: an `ITask` implementer |
|
612 | 612 | |
|
613 | 613 | :Exceptions: |
|
614 | 614 | IndexError : raised if no taskid in queue |
|
615 | 615 | """ |
|
616 | 616 | |
|
617 | 617 | def add_worker(worker, **flags): |
|
618 | 618 | """Add a worker to the worker queue. |
|
619 | 619 | |
|
620 | 620 | :Parameters: |
|
621 | 621 | worker : an `IWorker` implementer |
|
622 | 622 | flags : dict |
|
623 | 623 | General keywords for more sophisticated scheduling |
|
624 | 624 | """ |
|
625 | 625 | |
|
626 | 626 | def pop_worker(id=None): |
|
627 | 627 | """Pops an IWorker object that is ready to do work. |
|
628 | 628 | |
|
629 | 629 | This gets the next IWorker that is ready to do work. |
|
630 | 630 | |
|
631 | 631 | :Parameters: |
|
632 | 632 | id : if specified, will pop worker with workerid=id, else pops |
|
633 | 633 | highest priority worker. Defaults to None. |
|
634 | 634 | |
|
635 | 635 | :Returns: |
|
636 | 636 | an IWorker object |
|
637 | 637 | |
|
638 | 638 | :Exceptions: |
|
639 | 639 | IndexError : raised if no workerid in queue |
|
640 | 640 | """ |
|
641 | 641 | |
|
642 | 642 | def ready(): |
|
643 | 643 | """Returns True if there is something to do, False otherwise""" |
|
644 | 644 | |
|
645 | 645 | def schedule(): |
|
646 | 646 | """Returns (worker,task) pair for the next task to be run.""" |
|
647 | 647 | |
|
648 | 648 | |
|
649 | 649 | class FIFOScheduler(object): |
|
650 | 650 | """ |
|
651 | 651 | A basic First-In-First-Out (Queue) Scheduler. |
|
652 | 652 | |
|
653 | 653 | This is the default Scheduler for the `TaskController`. |
|
654 | 654 | See the docstrings for `IScheduler` for interface details. |
|
655 | 655 | """ |
|
656 | 656 | |
|
657 | 657 | zi.implements(IScheduler) |
|
658 | 658 | |
|
659 | 659 | def __init__(self): |
|
660 | 660 | self.tasks = [] |
|
661 | 661 | self.workers = [] |
|
662 | 662 | |
|
663 | 663 | def _ntasks(self): |
|
664 | 664 | return len(self.tasks) |
|
665 | 665 | |
|
666 | 666 | def _nworkers(self): |
|
667 | 667 | return len(self.workers) |
|
668 | 668 | |
|
669 | 669 | ntasks = property(_ntasks, lambda self, _:None) |
|
670 | 670 | nworkers = property(_nworkers, lambda self, _:None) |
|
671 | 671 | |
|
672 | 672 | def _taskids(self): |
|
673 | 673 | return [t.taskid for t in self.tasks] |
|
674 | 674 | |
|
675 | 675 | def _workerids(self): |
|
676 | 676 | return [w.workerid for w in self.workers] |
|
677 | 677 | |
|
678 | 678 | taskids = property(_taskids, lambda self,_:None) |
|
679 | 679 | workerids = property(_workerids, lambda self,_:None) |
|
680 | 680 | |
|
681 | 681 | def add_task(self, task, **flags): |
|
682 | 682 | self.tasks.append(task) |
|
683 | 683 | |
|
684 | 684 | def pop_task(self, id=None): |
|
685 | 685 | if id is None: |
|
686 | 686 | return self.tasks.pop(0) |
|
687 | 687 | else: |
|
688 | 688 | for i in range(len(self.tasks)): |
|
689 | 689 | taskid = self.tasks[i].taskid |
|
690 | 690 | if id == taskid: |
|
691 | 691 | return self.tasks.pop(i) |
|
692 | 692 | raise IndexError("No task #%i"%id) |
|
693 | 693 | |
|
694 | 694 | def add_worker(self, worker, **flags): |
|
695 | 695 | self.workers.append(worker) |
|
696 | 696 | |
|
697 | 697 | def pop_worker(self, id=None): |
|
698 | 698 | if id is None: |
|
699 | 699 | return self.workers.pop(0) |
|
700 | 700 | else: |
|
701 | 701 | for i in range(len(self.workers)): |
|
702 | 702 | workerid = self.workers[i].workerid |
|
703 | 703 | if id == workerid: |
|
704 | 704 | return self.workers.pop(i) |
|
705 | 705 | raise IndexError("No worker #%i"%id) |
|
706 | 706 | |
|
707 | 707 | def schedule(self): |
|
708 | 708 | for t in self.tasks: |
|
709 | 709 | for w in self.workers: |
|
710 | 710 | try:# do not allow exceptions to break this |
|
711 | 711 | # Allow the task to check itself using its |
|
712 | 712 | # check_depend method. |
|
713 | 713 | cando = t.check_depend(w.properties) |
|
714 | 714 | except: |
|
715 | 715 | cando = False |
|
716 | 716 | if cando: |
|
717 | 717 | return self.pop_worker(w.workerid), self.pop_task(t.taskid) |
|
718 | 718 | return None, None |
|
719 | 719 | |
|
720 | 720 | |
|
721 | 721 | |
|
722 | 722 | class LIFOScheduler(FIFOScheduler): |
|
723 | 723 | """ |
|
724 | 724 | A Last-In-First-Out (Stack) Scheduler. |
|
725 | 725 | |
|
726 | 726 | This scheduler should naively reward fast engines by giving |
|
727 | 727 | them more jobs. This risks starvation, but only in cases with |
|
728 | 728 | low load, where starvation does not really matter. |
|
729 | 729 | """ |
|
730 | 730 | |
|
731 | 731 | def add_task(self, task, **flags): |
|
732 | 732 | # self.tasks.reverse() |
|
733 | 733 | self.tasks.insert(0, task) |
|
734 | 734 | # self.tasks.reverse() |
|
735 | 735 | |
|
736 | 736 | def add_worker(self, worker, **flags): |
|
737 | 737 | # self.workers.reverse() |
|
738 | 738 | self.workers.insert(0, worker) |
|
739 | 739 | # self.workers.reverse() |
|
740 | 740 | |
|
741 | 741 | |
|
742 | 742 | class ITaskController(cs.IControllerBase): |
|
743 | 743 | """ |
|
744 | 744 | The Task based interface to a `ControllerService` object |
|
745 | 745 | |
|
746 | 746 | This adapts a `ControllerService` to the ITaskController interface. |
|
747 | 747 | """ |
|
748 | 748 | |
|
749 | 749 | def run(task): |
|
750 | 750 | """ |
|
751 | 751 | Run a task. |
|
752 | 752 | |
|
753 | 753 | :Parameters: |
|
754 | 754 | task : an IPython `Task` object |
|
755 | 755 | |
|
756 | 756 | :Returns: the integer ID of the task |
|
757 | 757 | """ |
|
758 | 758 | |
|
759 | 759 | def get_task_result(taskid, block=False): |
|
760 | 760 | """ |
|
761 | 761 | Get the result of a task by its ID. |
|
762 | 762 | |
|
763 | 763 | :Parameters: |
|
764 | 764 | taskid : int |
|
765 | 765 | the id of the task whose result is requested |
|
766 | 766 | |
|
767 | 767 | :Returns: `Deferred` to the task result if the task is done, and None |
|
768 | 768 | if not. |
|
769 | 769 | |
|
770 | 770 | :Exceptions: |
|
771 | 771 | actualResult will be an `IndexError` if no such task has been submitted |
|
772 | 772 | """ |
|
773 | 773 | |
|
774 | 774 | def abort(taskid): |
|
775 | 775 | """Remove task from queue if task is has not been submitted. |
|
776 | 776 | |
|
777 | 777 | If the task has already been submitted, wait for it to finish and discard |
|
778 | 778 | results and prevent resubmission. |
|
779 | 779 | |
|
780 | 780 | :Parameters: |
|
781 | 781 | taskid : the id of the task to be aborted |
|
782 | 782 | |
|
783 | 783 | :Returns: |
|
784 | 784 | `Deferred` to abort attempt completion. Will be None on success. |
|
785 | 785 | |
|
786 | 786 | :Exceptions: |
|
787 | 787 | deferred will fail with `IndexError` if no such task has been submitted |
|
788 | 788 | or the task has already completed. |
|
789 | 789 | """ |
|
790 | 790 | |
|
791 | 791 | def barrier(taskids): |
|
792 | 792 | """ |
|
793 | 793 | Block until the list of taskids are completed. |
|
794 | 794 | |
|
795 | 795 | Returns None on success. |
|
796 | 796 | """ |
|
797 | 797 | |
|
798 | 798 | def spin(): |
|
799 | 799 | """ |
|
800 | 800 | Touch the scheduler, to resume scheduling without submitting a task. |
|
801 | 801 | """ |
|
802 | 802 | |
|
803 | 803 | def queue_status(verbose=False): |
|
804 | 804 | """ |
|
805 | 805 | Get a dictionary with the current state of the task queue. |
|
806 | 806 | |
|
807 | 807 | If verbose is True, then return lists of taskids, otherwise, |
|
808 | 808 | return the number of tasks with each status. |
|
809 | 809 | """ |
|
810 | 810 | |
|
811 | 811 | def clear(): |
|
812 | 812 | """ |
|
813 | 813 | Clear all previously run tasks from the task controller. |
|
814 | 814 | |
|
815 | 815 | This is needed because the task controller keep all task results |
|
816 | 816 | in memory. This can be a problem is there are many completed |
|
817 | 817 | tasks. Users should call this periodically to clean out these |
|
818 | 818 | cached task results. |
|
819 | 819 | """ |
|
820 | 820 | |
|
821 | 821 | |
|
822 | 822 | class TaskController(cs.ControllerAdapterBase): |
|
823 | 823 | """The Task based interface to a Controller object. |
|
824 | 824 | |
|
825 | 825 | If you want to use a different scheduler, just subclass this and set |
|
826 | 826 | the `SchedulerClass` member to the *class* of your chosen scheduler. |
|
827 | 827 | """ |
|
828 | 828 | |
|
829 | 829 | zi.implements(ITaskController) |
|
830 | 830 | SchedulerClass = FIFOScheduler |
|
831 | 831 | |
|
832 | 832 | timeout = 30 |
|
833 | 833 | |
|
834 | 834 | def __init__(self, controller): |
|
835 | 835 | self.controller = controller |
|
836 | 836 | self.controller.on_register_engine_do(self.registerWorker, True) |
|
837 | 837 | self.controller.on_unregister_engine_do(self.unregisterWorker, True) |
|
838 | 838 | self.taskid = 0 |
|
839 | 839 | self.failurePenalty = 1 # the time in seconds to penalize |
|
840 | 840 | # a worker for failing a task |
|
841 | 841 | self.pendingTasks = {} # dict of {workerid:(taskid, task)} |
|
842 | 842 | self.deferredResults = {} # dict of {taskid:deferred} |
|
843 | 843 | self.finishedResults = {} # dict of {taskid:actualResult} |
|
844 | 844 | self.workers = {} # dict of {workerid:worker} |
|
845 | 845 | self.abortPending = [] # dict of {taskid:abortDeferred} |
|
846 | 846 | self.idleLater = None # delayed call object for timeout |
|
847 | 847 | self.scheduler = self.SchedulerClass() |
|
848 | 848 | |
|
849 | 849 | for id in self.controller.engines.keys(): |
|
850 | 850 | self.workers[id] = IWorker(self.controller.engines[id]) |
|
851 | 851 | self.workers[id].workerid = id |
|
852 | 852 | self.schedule.add_worker(self.workers[id]) |
|
853 | 853 | |
|
854 | 854 | def registerWorker(self, id): |
|
855 | 855 | """Called by controller.register_engine.""" |
|
856 | 856 | if self.workers.get(id): |
|
857 | 857 | raise ValueError("worker with id %s already exists. This should not happen." % id) |
|
858 | 858 | self.workers[id] = IWorker(self.controller.engines[id]) |
|
859 | 859 | self.workers[id].workerid = id |
|
860 | 860 | if not self.pendingTasks.has_key(id):# if not working |
|
861 | 861 | self.scheduler.add_worker(self.workers[id]) |
|
862 | 862 | self.distributeTasks() |
|
863 | 863 | |
|
864 | 864 | def unregisterWorker(self, id): |
|
865 | 865 | """Called by controller.unregister_engine""" |
|
866 | 866 | |
|
867 | 867 | if self.workers.has_key(id): |
|
868 | 868 | try: |
|
869 | 869 | self.scheduler.pop_worker(id) |
|
870 | 870 | except IndexError: |
|
871 | 871 | pass |
|
872 | 872 | self.workers.pop(id) |
|
873 | 873 | |
|
874 | 874 | def _pendingTaskIDs(self): |
|
875 | 875 | return [t.taskid for t in self.pendingTasks.values()] |
|
876 | 876 | |
|
877 | 877 | #--------------------------------------------------------------------------- |
|
878 | 878 | # Interface methods |
|
879 | 879 | #--------------------------------------------------------------------------- |
|
880 | 880 | |
|
881 | 881 | def run(self, task): |
|
882 | 882 | """ |
|
883 | 883 | Run a task and return `Deferred` to its taskid. |
|
884 | 884 | """ |
|
885 | 885 | task.taskid = self.taskid |
|
886 | 886 | task.start = time.localtime() |
|
887 | 887 | self.taskid += 1 |
|
888 | 888 | d = defer.Deferred() |
|
889 | 889 | self.scheduler.add_task(task) |
|
890 | 890 | log.msg('Queuing task: %i' % task.taskid) |
|
891 | 891 | |
|
892 | 892 | self.deferredResults[task.taskid] = [] |
|
893 | 893 | self.distributeTasks() |
|
894 | 894 | return defer.succeed(task.taskid) |
|
895 | 895 | |
|
896 | 896 | def get_task_result(self, taskid, block=False): |
|
897 | 897 | """ |
|
898 | 898 | Returns a `Deferred` to the task result, or None. |
|
899 | 899 | """ |
|
900 | 900 | log.msg("Getting task result: %i" % taskid) |
|
901 | 901 | if self.finishedResults.has_key(taskid): |
|
902 | 902 | tr = self.finishedResults[taskid] |
|
903 | 903 | return defer.succeed(tr) |
|
904 | 904 | elif self.deferredResults.has_key(taskid): |
|
905 | 905 | if block: |
|
906 | 906 | d = defer.Deferred() |
|
907 | 907 | self.deferredResults[taskid].append(d) |
|
908 | 908 | return d |
|
909 | 909 | else: |
|
910 | 910 | return defer.succeed(None) |
|
911 | 911 | else: |
|
912 | 912 | return defer.fail(IndexError("task ID not registered: %r" % taskid)) |
|
913 | 913 | |
|
914 | 914 | def abort(self, taskid): |
|
915 | 915 | """ |
|
916 | 916 | Remove a task from the queue if it has not been run already. |
|
917 | 917 | """ |
|
918 | 918 | if not isinstance(taskid, int): |
|
919 | 919 | return defer.fail(failure.Failure(TypeError("an integer task id expected: %r" % taskid))) |
|
920 | 920 | try: |
|
921 | 921 | self.scheduler.pop_task(taskid) |
|
922 | 922 | except IndexError, e: |
|
923 | 923 | if taskid in self.finishedResults.keys(): |
|
924 | 924 | d = defer.fail(IndexError("Task Already Completed")) |
|
925 | 925 | elif taskid in self.abortPending: |
|
926 | 926 | d = defer.fail(IndexError("Task Already Aborted")) |
|
927 | 927 | elif taskid in self._pendingTaskIDs():# task is pending |
|
928 | 928 | self.abortPending.append(taskid) |
|
929 | 929 | d = defer.succeed(None) |
|
930 | 930 | else: |
|
931 | 931 | d = defer.fail(e) |
|
932 | 932 | else: |
|
933 | 933 | d = defer.execute(self._doAbort, taskid) |
|
934 | 934 | |
|
935 | 935 | return d |
|
936 | 936 | |
|
937 | 937 | def barrier(self, taskids): |
|
938 | 938 | dList = [] |
|
939 | 939 | if isinstance(taskids, int): |
|
940 | 940 | taskids = [taskids] |
|
941 | 941 | for id in taskids: |
|
942 | 942 | d = self.get_task_result(id, block=True) |
|
943 | 943 | dList.append(d) |
|
944 | 944 | d = DeferredList(dList, consumeErrors=1) |
|
945 | 945 | d.addCallbacks(lambda r: None) |
|
946 | 946 | return d |
|
947 | 947 | |
|
948 | 948 | def spin(self): |
|
949 | 949 | return defer.succeed(self.distributeTasks()) |
|
950 | 950 | |
|
951 | 951 | def queue_status(self, verbose=False): |
|
952 | 952 | pending = self._pendingTaskIDs() |
|
953 | 953 | failed = [] |
|
954 | 954 | succeeded = [] |
|
955 | 955 | for k,v in self.finishedResults.iteritems(): |
|
956 | 956 | if not isinstance(v, failure.Failure): |
|
957 | 957 | if hasattr(v,'failure'): |
|
958 | 958 | if v.failure is None: |
|
959 | 959 | succeeded.append(k) |
|
960 | 960 | else: |
|
961 | 961 | failed.append(k) |
|
962 | 962 | scheduled = self.scheduler.taskids |
|
963 | 963 | if verbose: |
|
964 | 964 | result = dict(pending=pending, failed=failed, |
|
965 | 965 | succeeded=succeeded, scheduled=scheduled) |
|
966 | 966 | else: |
|
967 | 967 | result = dict(pending=len(pending),failed=len(failed), |
|
968 | 968 | succeeded=len(succeeded),scheduled=len(scheduled)) |
|
969 | 969 | return defer.succeed(result) |
|
970 | 970 | |
|
971 | 971 | #--------------------------------------------------------------------------- |
|
972 | 972 | # Queue methods |
|
973 | 973 | #--------------------------------------------------------------------------- |
|
974 | 974 | |
|
975 | 975 | def _doAbort(self, taskid): |
|
976 | 976 | """ |
|
977 | 977 | Helper function for aborting a pending task. |
|
978 | 978 | """ |
|
979 | 979 | log.msg("Task aborted: %i" % taskid) |
|
980 | 980 | result = failure.Failure(error.TaskAborted()) |
|
981 | 981 | self._finishTask(taskid, result) |
|
982 | 982 | if taskid in self.abortPending: |
|
983 | 983 | self.abortPending.remove(taskid) |
|
984 | 984 | |
|
985 | 985 | def _finishTask(self, taskid, result): |
|
986 | 986 | dlist = self.deferredResults.pop(taskid) |
|
987 | 987 | # result.taskid = taskid # The TaskResult should save the taskid |
|
988 | 988 | self.finishedResults[taskid] = result |
|
989 | 989 | for d in dlist: |
|
990 | 990 | d.callback(result) |
|
991 | 991 | |
|
992 | 992 | def distributeTasks(self): |
|
993 | 993 | """ |
|
994 | 994 | Distribute tasks while self.scheduler has things to do. |
|
995 | 995 | """ |
|
996 | 996 | log.msg("distributing Tasks") |
|
997 | 997 | worker, task = self.scheduler.schedule() |
|
998 | 998 | if not worker and not task: |
|
999 | 999 | if self.idleLater and self.idleLater.called:# we are inside failIdle |
|
1000 | 1000 | self.idleLater = None |
|
1001 | 1001 | else: |
|
1002 | 1002 | self.checkIdle() |
|
1003 | 1003 | return False |
|
1004 | 1004 | # else something to do: |
|
1005 | 1005 | while worker and task: |
|
1006 | 1006 | # get worker and task |
|
1007 | 1007 | # add to pending |
|
1008 | 1008 | self.pendingTasks[worker.workerid] = task |
|
1009 | 1009 | # run/link callbacks |
|
1010 | 1010 | d = worker.run(task) |
|
1011 | 1011 | log.msg("Running task %i on worker %i" %(task.taskid, worker.workerid)) |
|
1012 | 1012 | d.addBoth(self.taskCompleted, task.taskid, worker.workerid) |
|
1013 | 1013 | worker, task = self.scheduler.schedule() |
|
1014 | 1014 | # check for idle timeout: |
|
1015 | 1015 | self.checkIdle() |
|
1016 | 1016 | return True |
|
1017 | 1017 | |
|
1018 | 1018 | def checkIdle(self): |
|
1019 | 1019 | if self.idleLater and not self.idleLater.called: |
|
1020 | 1020 | self.idleLater.cancel() |
|
1021 | 1021 | if self.scheduler.ntasks and self.workers and \ |
|
1022 | 1022 | self.scheduler.nworkers == len(self.workers): |
|
1023 | 1023 | self.idleLater = reactor.callLater(self.timeout, self.failIdle) |
|
1024 | 1024 | else: |
|
1025 | 1025 | self.idleLater = None |
|
1026 | 1026 | |
|
1027 | 1027 | def failIdle(self): |
|
1028 | 1028 | if not self.distributeTasks(): |
|
1029 | 1029 | while self.scheduler.ntasks: |
|
1030 | 1030 | t = self.scheduler.pop_task() |
|
1031 | 1031 | msg = "task %i failed to execute due to unmet dependencies"%t.taskid |
|
1032 | 1032 | msg += " for %i seconds"%self.timeout |
|
1033 | 1033 | log.msg("Task aborted by timeout: %i" % t.taskid) |
|
1034 | 1034 | f = failure.Failure(error.TaskTimeout(msg)) |
|
1035 | 1035 | self._finishTask(t.taskid, f) |
|
1036 | 1036 | self.idleLater = None |
|
1037 | 1037 | |
|
1038 | 1038 | |
|
1039 | 1039 | def taskCompleted(self, success_and_result, taskid, workerid): |
|
1040 | 1040 | """This is the err/callback for a completed task.""" |
|
1041 | 1041 | success, result = success_and_result |
|
1042 | 1042 | try: |
|
1043 | 1043 | task = self.pendingTasks.pop(workerid) |
|
1044 | 1044 | except: |
|
1045 | 1045 | # this should not happen |
|
1046 | 1046 | log.msg("Tried to pop bad pending task %i from worker %i"%(taskid, workerid)) |
|
1047 | 1047 | log.msg("Result: %r"%result) |
|
1048 | 1048 | log.msg("Pending tasks: %s"%self.pendingTasks) |
|
1049 | 1049 | return |
|
1050 | 1050 | |
|
1051 | 1051 | # Check if aborted while pending |
|
1052 | 1052 | aborted = False |
|
1053 | 1053 | if taskid in self.abortPending: |
|
1054 | 1054 | self._doAbort(taskid) |
|
1055 | 1055 | aborted = True |
|
1056 | 1056 | |
|
1057 | 1057 | if not aborted: |
|
1058 | 1058 | if not success: |
|
1059 | 1059 | log.msg("Task %i failed on worker %i"% (taskid, workerid)) |
|
1060 | 1060 | if task.retries > 0: # resubmit |
|
1061 | 1061 | task.retries -= 1 |
|
1062 | 1062 | self.scheduler.add_task(task) |
|
1063 | 1063 | s = "Resubmitting task %i, %i retries remaining" %(taskid, task.retries) |
|
1064 | 1064 | log.msg(s) |
|
1065 | 1065 | self.distributeTasks() |
|
1066 | 1066 | elif isinstance(task.recovery_task, BaseTask) and \ |
|
1067 | 1067 | task.recovery_task.retries > -1: |
|
1068 | 1068 | # retries = -1 is to prevent infinite recovery_task loop |
|
1069 | 1069 | task.retries = -1 |
|
1070 | 1070 | task.recovery_task.taskid = taskid |
|
1071 | 1071 | task = task.recovery_task |
|
1072 | 1072 | self.scheduler.add_task(task) |
|
1073 | 1073 | s = "Recovering task %i, %i retries remaining" %(taskid, task.retries) |
|
1074 | 1074 | log.msg(s) |
|
1075 | 1075 | self.distributeTasks() |
|
1076 | 1076 | else: # done trying |
|
1077 | 1077 | self._finishTask(taskid, result) |
|
1078 | 1078 | # wait a second before readmitting a worker that failed |
|
1079 | 1079 | # it may have died, and not yet been unregistered |
|
1080 | 1080 | reactor.callLater(self.failurePenalty, self.readmitWorker, workerid) |
|
1081 | 1081 | else: # we succeeded |
|
1082 | 1082 | log.msg("Task completed: %i"% taskid) |
|
1083 | 1083 | self._finishTask(taskid, result) |
|
1084 | 1084 | self.readmitWorker(workerid) |
|
1085 | 1085 | else: # we aborted the task |
|
1086 | 1086 | if not success: |
|
1087 | 1087 | reactor.callLater(self.failurePenalty, self.readmitWorker, workerid) |
|
1088 | 1088 | else: |
|
1089 | 1089 | self.readmitWorker(workerid) |
|
1090 | 1090 | |
|
1091 | 1091 | def readmitWorker(self, workerid): |
|
1092 | 1092 | """ |
|
1093 | 1093 | Readmit a worker to the scheduler. |
|
1094 | 1094 | |
|
1095 | 1095 | This is outside `taskCompleted` because of the `failurePenalty` being |
|
1096 | 1096 | implemented through `reactor.callLater`. |
|
1097 | 1097 | """ |
|
1098 | 1098 | |
|
1099 | 1099 | if workerid in self.workers.keys() and workerid not in self.pendingTasks.keys(): |
|
1100 | 1100 | self.scheduler.add_worker(self.workers[workerid]) |
|
1101 | 1101 | self.distributeTasks() |
|
1102 | 1102 | |
|
1103 | 1103 | def clear(self): |
|
1104 | 1104 | """ |
|
1105 | 1105 | Clear all previously run tasks from the task controller. |
|
1106 | 1106 | |
|
1107 | 1107 | This is needed because the task controller keep all task results |
|
1108 | 1108 | in memory. This can be a problem is there are many completed |
|
1109 | 1109 | tasks. Users should call this periodically to clean out these |
|
1110 | 1110 | cached task results. |
|
1111 | 1111 | """ |
|
1112 | 1112 | self.finishedResults = {} |
|
1113 | 1113 | return defer.succeed(None) |
|
1114 | 1114 | |
|
1115 | 1115 | |
|
1116 | 1116 | components.registerAdapter(TaskController, cs.IControllerBase, ITaskController) |
@@ -1,18 +1,19 b'' | |||
|
1 | 1 | """Simple script to show reference holding behavior. |
|
2 | 2 | |
|
3 | 3 | This is used by a companion test case. |
|
4 | 4 | """ |
|
5 | 5 | |
|
6 | 6 | import gc |
|
7 | 7 | |
|
8 | 8 | class C(object): |
|
9 | 9 | def __del__(self): |
|
10 | 10 | pass |
|
11 | 11 | #print 'deleting object...' # dbg |
|
12 | 12 | |
|
13 | c = C() | |
|
13 | if __name__ == '__main__': | |
|
14 | c = C() | |
|
14 | 15 | |
|
15 | c_refs = gc.get_referrers(c) | |
|
16 | ref_ids = map(id,c_refs) | |
|
16 | c_refs = gc.get_referrers(c) | |
|
17 | ref_ids = map(id,c_refs) | |
|
17 | 18 | |
|
18 | print 'c referrers:',map(type,c_refs) | |
|
19 | print 'c referrers:',map(type,c_refs) |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: file was removed | |
This diff has been collapsed as it changes many lines, (800 lines changed) Show them Hide them |
|
1 | NO CONTENT: file was removed |
|
1 | NO CONTENT: file was removed |
|
1 | NO CONTENT: file was removed |
|
1 | NO CONTENT: file was removed |
|
1 | NO CONTENT: file was removed |
General Comments 0
You need to be logged in to leave comments.
Login now