##// END OF EJS Templates
BUG: Allow %magic argument filenames with spaces to be specified with quotes under win32.
Robert Kern -
Show More
@@ -1,3566 +1,3566 b''
1 1 # encoding: utf-8
2 2 """Magic functions for InteractiveShell.
3 3 """
4 4
5 5 #-----------------------------------------------------------------------------
6 6 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
7 7 # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu>
8 8 # Copyright (C) 2008-2009 The IPython Development Team
9 9
10 10 # Distributed under the terms of the BSD License. The full license is in
11 11 # the file COPYING, distributed as part of this software.
12 12 #-----------------------------------------------------------------------------
13 13
14 14 #-----------------------------------------------------------------------------
15 15 # Imports
16 16 #-----------------------------------------------------------------------------
17 17
18 18 import __builtin__
19 19 import __future__
20 20 import bdb
21 21 import inspect
22 22 import os
23 23 import sys
24 24 import shutil
25 25 import re
26 26 import time
27 27 import textwrap
28 28 from cStringIO import StringIO
29 29 from getopt import getopt,GetoptError
30 30 from pprint import pformat
31 31 from xmlrpclib import ServerProxy
32 32
33 33 # cProfile was added in Python2.5
34 34 try:
35 35 import cProfile as profile
36 36 import pstats
37 37 except ImportError:
38 38 # profile isn't bundled by default in Debian for license reasons
39 39 try:
40 40 import profile,pstats
41 41 except ImportError:
42 42 profile = pstats = None
43 43
44 44 import IPython
45 45 from IPython.core import debugger, oinspect
46 46 from IPython.core.error import TryNext
47 47 from IPython.core.error import UsageError
48 48 from IPython.core.fakemodule import FakeModule
49 49 from IPython.core.profiledir import ProfileDir
50 50 from IPython.core.macro import Macro
51 51 from IPython.core import magic_arguments, page
52 52 from IPython.core.prefilter import ESC_MAGIC
53 53 from IPython.lib.pylabtools import mpl_runner
54 54 from IPython.testing.skipdoctest import skip_doctest
55 55 from IPython.utils.io import file_read, nlprint
56 56 from IPython.utils.path import get_py_filename
57 57 from IPython.utils.process import arg_split, abbrev_cwd
58 58 from IPython.utils.terminal import set_term_title
59 59 from IPython.utils.text import LSString, SList, format_screen
60 60 from IPython.utils.timing import clock, clock2
61 61 from IPython.utils.warn import warn, error
62 62 from IPython.utils.ipstruct import Struct
63 63 import IPython.utils.generics
64 64
65 65 #-----------------------------------------------------------------------------
66 66 # Utility functions
67 67 #-----------------------------------------------------------------------------
68 68
69 69 def on_off(tag):
70 70 """Return an ON/OFF string for a 1/0 input. Simple utility function."""
71 71 return ['OFF','ON'][tag]
72 72
73 73 class Bunch: pass
74 74
75 75 def compress_dhist(dh):
76 76 head, tail = dh[:-10], dh[-10:]
77 77
78 78 newhead = []
79 79 done = set()
80 80 for h in head:
81 81 if h in done:
82 82 continue
83 83 newhead.append(h)
84 84 done.add(h)
85 85
86 86 return newhead + tail
87 87
88 88 def needs_local_scope(func):
89 89 """Decorator to mark magic functions which need to local scope to run."""
90 90 func.needs_local_scope = True
91 91 return func
92 92
93 93 # Used for exception handling in magic_edit
94 94 class MacroToEdit(ValueError): pass
95 95
96 96 #***************************************************************************
97 97 # Main class implementing Magic functionality
98 98
99 99 # XXX - for some odd reason, if Magic is made a new-style class, we get errors
100 100 # on construction of the main InteractiveShell object. Something odd is going
101 101 # on with super() calls, Configurable and the MRO... For now leave it as-is, but
102 102 # eventually this needs to be clarified.
103 103 # BG: This is because InteractiveShell inherits from this, but is itself a
104 104 # Configurable. This messes up the MRO in some way. The fix is that we need to
105 105 # make Magic a configurable that InteractiveShell does not subclass.
106 106
107 107 class Magic:
108 108 """Magic functions for InteractiveShell.
109 109
110 110 Shell functions which can be reached as %function_name. All magic
111 111 functions should accept a string, which they can parse for their own
112 112 needs. This can make some functions easier to type, eg `%cd ../`
113 113 vs. `%cd("../")`
114 114
115 115 ALL definitions MUST begin with the prefix magic_. The user won't need it
116 116 at the command line, but it is is needed in the definition. """
117 117
118 118 # class globals
119 119 auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.',
120 120 'Automagic is ON, % prefix NOT needed for magic functions.']
121 121
122 122 #......................................................................
123 123 # some utility functions
124 124
125 125 def __init__(self,shell):
126 126
127 127 self.options_table = {}
128 128 if profile is None:
129 129 self.magic_prun = self.profile_missing_notice
130 130 self.shell = shell
131 131
132 132 # namespace for holding state we may need
133 133 self._magic_state = Bunch()
134 134
135 135 def profile_missing_notice(self, *args, **kwargs):
136 136 error("""\
137 137 The profile module could not be found. It has been removed from the standard
138 138 python packages because of its non-free license. To use profiling, install the
139 139 python-profiler package from non-free.""")
140 140
141 141 def default_option(self,fn,optstr):
142 142 """Make an entry in the options_table for fn, with value optstr"""
143 143
144 144 if fn not in self.lsmagic():
145 145 error("%s is not a magic function" % fn)
146 146 self.options_table[fn] = optstr
147 147
148 148 def lsmagic(self):
149 149 """Return a list of currently available magic functions.
150 150
151 151 Gives a list of the bare names after mangling (['ls','cd', ...], not
152 152 ['magic_ls','magic_cd',...]"""
153 153
154 154 # FIXME. This needs a cleanup, in the way the magics list is built.
155 155
156 156 # magics in class definition
157 157 class_magic = lambda fn: fn.startswith('magic_') and \
158 158 callable(Magic.__dict__[fn])
159 159 # in instance namespace (run-time user additions)
160 160 inst_magic = lambda fn: fn.startswith('magic_') and \
161 161 callable(self.__dict__[fn])
162 162 # and bound magics by user (so they can access self):
163 163 inst_bound_magic = lambda fn: fn.startswith('magic_') and \
164 164 callable(self.__class__.__dict__[fn])
165 165 magics = filter(class_magic,Magic.__dict__.keys()) + \
166 166 filter(inst_magic,self.__dict__.keys()) + \
167 167 filter(inst_bound_magic,self.__class__.__dict__.keys())
168 168 out = []
169 169 for fn in set(magics):
170 170 out.append(fn.replace('magic_','',1))
171 171 out.sort()
172 172 return out
173 173
174 174 def extract_input_lines(self, range_str, raw=False):
175 175 """Return as a string a set of input history slices.
176 176
177 177 Inputs:
178 178
179 179 - range_str: the set of slices is given as a string, like
180 180 "~5/6-~4/2 4:8 9", since this function is for use by magic functions
181 181 which get their arguments as strings. The number before the / is the
182 182 session number: ~n goes n back from the current session.
183 183
184 184 Optional inputs:
185 185
186 186 - raw(False): by default, the processed input is used. If this is
187 187 true, the raw input history is used instead.
188 188
189 189 Note that slices can be called with two notations:
190 190
191 191 N:M -> standard python form, means including items N...(M-1).
192 192
193 193 N-M -> include items N..M (closed endpoint)."""
194 194 lines = self.shell.history_manager.\
195 195 get_range_by_str(range_str, raw=raw)
196 196 return "\n".join(x for _, _, x in lines)
197 197
198 198 def arg_err(self,func):
199 199 """Print docstring if incorrect arguments were passed"""
200 200 print 'Error in arguments:'
201 201 print oinspect.getdoc(func)
202 202
203 203 def format_latex(self,strng):
204 204 """Format a string for latex inclusion."""
205 205
206 206 # Characters that need to be escaped for latex:
207 207 escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE)
208 208 # Magic command names as headers:
209 209 cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC,
210 210 re.MULTILINE)
211 211 # Magic commands
212 212 cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC,
213 213 re.MULTILINE)
214 214 # Paragraph continue
215 215 par_re = re.compile(r'\\$',re.MULTILINE)
216 216
217 217 # The "\n" symbol
218 218 newline_re = re.compile(r'\\n')
219 219
220 220 # Now build the string for output:
221 221 #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng)
222 222 strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:',
223 223 strng)
224 224 strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng)
225 225 strng = par_re.sub(r'\\\\',strng)
226 226 strng = escape_re.sub(r'\\\1',strng)
227 227 strng = newline_re.sub(r'\\textbackslash{}n',strng)
228 228 return strng
229 229
230 230 def parse_options(self,arg_str,opt_str,*long_opts,**kw):
231 231 """Parse options passed to an argument string.
232 232
233 233 The interface is similar to that of getopt(), but it returns back a
234 234 Struct with the options as keys and the stripped argument string still
235 235 as a string.
236 236
237 237 arg_str is quoted as a true sys.argv vector by using shlex.split.
238 238 This allows us to easily expand variables, glob files, quote
239 239 arguments, etc.
240 240
241 241 Options:
242 242 -mode: default 'string'. If given as 'list', the argument string is
243 243 returned as a list (split on whitespace) instead of a string.
244 244
245 245 -list_all: put all option values in lists. Normally only options
246 246 appearing more than once are put in a list.
247 247
248 248 -posix (True): whether to split the input line in POSIX mode or not,
249 249 as per the conventions outlined in the shlex module from the
250 250 standard library."""
251 251
252 252 # inject default options at the beginning of the input line
253 253 caller = sys._getframe(1).f_code.co_name.replace('magic_','')
254 254 arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str)
255 255
256 256 mode = kw.get('mode','string')
257 257 if mode not in ['string','list']:
258 258 raise ValueError,'incorrect mode given: %s' % mode
259 259 # Get options
260 260 list_all = kw.get('list_all',0)
261 261 posix = kw.get('posix', os.name == 'posix')
262 262
263 263 # Check if we have more than one argument to warrant extra processing:
264 264 odict = {} # Dictionary with options
265 265 args = arg_str.split()
266 266 if len(args) >= 1:
267 267 # If the list of inputs only has 0 or 1 thing in it, there's no
268 268 # need to look for options
269 269 argv = arg_split(arg_str,posix)
270 270 # Do regular option processing
271 271 try:
272 272 opts,args = getopt(argv,opt_str,*long_opts)
273 273 except GetoptError,e:
274 274 raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str,
275 275 " ".join(long_opts)))
276 276 for o,a in opts:
277 277 if o.startswith('--'):
278 278 o = o[2:]
279 279 else:
280 280 o = o[1:]
281 281 try:
282 282 odict[o].append(a)
283 283 except AttributeError:
284 284 odict[o] = [odict[o],a]
285 285 except KeyError:
286 286 if list_all:
287 287 odict[o] = [a]
288 288 else:
289 289 odict[o] = a
290 290
291 291 # Prepare opts,args for return
292 292 opts = Struct(odict)
293 293 if mode == 'string':
294 294 args = ' '.join(args)
295 295
296 296 return opts,args
297 297
298 298 #......................................................................
299 299 # And now the actual magic functions
300 300
301 301 # Functions for IPython shell work (vars,funcs, config, etc)
302 302 def magic_lsmagic(self, parameter_s = ''):
303 303 """List currently available magic functions."""
304 304 mesc = ESC_MAGIC
305 305 print 'Available magic functions:\n'+mesc+\
306 306 (' '+mesc).join(self.lsmagic())
307 307 print '\n' + Magic.auto_status[self.shell.automagic]
308 308 return None
309 309
310 310 def magic_magic(self, parameter_s = ''):
311 311 """Print information about the magic function system.
312 312
313 313 Supported formats: -latex, -brief, -rest
314 314 """
315 315
316 316 mode = ''
317 317 try:
318 318 if parameter_s.split()[0] == '-latex':
319 319 mode = 'latex'
320 320 if parameter_s.split()[0] == '-brief':
321 321 mode = 'brief'
322 322 if parameter_s.split()[0] == '-rest':
323 323 mode = 'rest'
324 324 rest_docs = []
325 325 except:
326 326 pass
327 327
328 328 magic_docs = []
329 329 for fname in self.lsmagic():
330 330 mname = 'magic_' + fname
331 331 for space in (Magic,self,self.__class__):
332 332 try:
333 333 fn = space.__dict__[mname]
334 334 except KeyError:
335 335 pass
336 336 else:
337 337 break
338 338 if mode == 'brief':
339 339 # only first line
340 340 if fn.__doc__:
341 341 fndoc = fn.__doc__.split('\n',1)[0]
342 342 else:
343 343 fndoc = 'No documentation'
344 344 else:
345 345 if fn.__doc__:
346 346 fndoc = fn.__doc__.rstrip()
347 347 else:
348 348 fndoc = 'No documentation'
349 349
350 350
351 351 if mode == 'rest':
352 352 rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC,
353 353 fname,fndoc))
354 354
355 355 else:
356 356 magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC,
357 357 fname,fndoc))
358 358
359 359 magic_docs = ''.join(magic_docs)
360 360
361 361 if mode == 'rest':
362 362 return "".join(rest_docs)
363 363
364 364 if mode == 'latex':
365 365 print self.format_latex(magic_docs)
366 366 return
367 367 else:
368 368 magic_docs = format_screen(magic_docs)
369 369 if mode == 'brief':
370 370 return magic_docs
371 371
372 372 outmsg = """
373 373 IPython's 'magic' functions
374 374 ===========================
375 375
376 376 The magic function system provides a series of functions which allow you to
377 377 control the behavior of IPython itself, plus a lot of system-type
378 378 features. All these functions are prefixed with a % character, but parameters
379 379 are given without parentheses or quotes.
380 380
381 381 NOTE: If you have 'automagic' enabled (via the command line option or with the
382 382 %automagic function), you don't need to type in the % explicitly. By default,
383 383 IPython ships with automagic on, so you should only rarely need the % escape.
384 384
385 385 Example: typing '%cd mydir' (without the quotes) changes you working directory
386 386 to 'mydir', if it exists.
387 387
388 388 For a list of the available magic functions, use %lsmagic. For a description
389 389 of any of them, type %magic_name?, e.g. '%cd?'.
390 390
391 391 Currently the magic system has the following functions:\n"""
392 392
393 393 mesc = ESC_MAGIC
394 394 outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):"
395 395 "\n\n%s%s\n\n%s" % (outmsg,
396 396 magic_docs,mesc,mesc,
397 397 (' '+mesc).join(self.lsmagic()),
398 398 Magic.auto_status[self.shell.automagic] ) )
399 399 page.page(outmsg)
400 400
401 401 def magic_automagic(self, parameter_s = ''):
402 402 """Make magic functions callable without having to type the initial %.
403 403
404 404 Without argumentsl toggles on/off (when off, you must call it as
405 405 %automagic, of course). With arguments it sets the value, and you can
406 406 use any of (case insensitive):
407 407
408 408 - on,1,True: to activate
409 409
410 410 - off,0,False: to deactivate.
411 411
412 412 Note that magic functions have lowest priority, so if there's a
413 413 variable whose name collides with that of a magic fn, automagic won't
414 414 work for that function (you get the variable instead). However, if you
415 415 delete the variable (del var), the previously shadowed magic function
416 416 becomes visible to automagic again."""
417 417
418 418 arg = parameter_s.lower()
419 419 if parameter_s in ('on','1','true'):
420 420 self.shell.automagic = True
421 421 elif parameter_s in ('off','0','false'):
422 422 self.shell.automagic = False
423 423 else:
424 424 self.shell.automagic = not self.shell.automagic
425 425 print '\n' + Magic.auto_status[self.shell.automagic]
426 426
427 427 @skip_doctest
428 428 def magic_autocall(self, parameter_s = ''):
429 429 """Make functions callable without having to type parentheses.
430 430
431 431 Usage:
432 432
433 433 %autocall [mode]
434 434
435 435 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
436 436 value is toggled on and off (remembering the previous state).
437 437
438 438 In more detail, these values mean:
439 439
440 440 0 -> fully disabled
441 441
442 442 1 -> active, but do not apply if there are no arguments on the line.
443 443
444 444 In this mode, you get:
445 445
446 446 In [1]: callable
447 447 Out[1]: <built-in function callable>
448 448
449 449 In [2]: callable 'hello'
450 450 ------> callable('hello')
451 451 Out[2]: False
452 452
453 453 2 -> Active always. Even if no arguments are present, the callable
454 454 object is called:
455 455
456 456 In [2]: float
457 457 ------> float()
458 458 Out[2]: 0.0
459 459
460 460 Note that even with autocall off, you can still use '/' at the start of
461 461 a line to treat the first argument on the command line as a function
462 462 and add parentheses to it:
463 463
464 464 In [8]: /str 43
465 465 ------> str(43)
466 466 Out[8]: '43'
467 467
468 468 # all-random (note for auto-testing)
469 469 """
470 470
471 471 if parameter_s:
472 472 arg = int(parameter_s)
473 473 else:
474 474 arg = 'toggle'
475 475
476 476 if not arg in (0,1,2,'toggle'):
477 477 error('Valid modes: (0->Off, 1->Smart, 2->Full')
478 478 return
479 479
480 480 if arg in (0,1,2):
481 481 self.shell.autocall = arg
482 482 else: # toggle
483 483 if self.shell.autocall:
484 484 self._magic_state.autocall_save = self.shell.autocall
485 485 self.shell.autocall = 0
486 486 else:
487 487 try:
488 488 self.shell.autocall = self._magic_state.autocall_save
489 489 except AttributeError:
490 490 self.shell.autocall = self._magic_state.autocall_save = 1
491 491
492 492 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
493 493
494 494
495 495 def magic_page(self, parameter_s=''):
496 496 """Pretty print the object and display it through a pager.
497 497
498 498 %page [options] OBJECT
499 499
500 500 If no object is given, use _ (last output).
501 501
502 502 Options:
503 503
504 504 -r: page str(object), don't pretty-print it."""
505 505
506 506 # After a function contributed by Olivier Aubert, slightly modified.
507 507
508 508 # Process options/args
509 509 opts,args = self.parse_options(parameter_s,'r')
510 510 raw = 'r' in opts
511 511
512 512 oname = args and args or '_'
513 513 info = self._ofind(oname)
514 514 if info['found']:
515 515 txt = (raw and str or pformat)( info['obj'] )
516 516 page.page(txt)
517 517 else:
518 518 print 'Object `%s` not found' % oname
519 519
520 520 def magic_profile(self, parameter_s=''):
521 521 """Print your currently active IPython profile."""
522 522 print self.shell.profile
523 523
524 524 def magic_pinfo(self, parameter_s='', namespaces=None):
525 525 """Provide detailed information about an object.
526 526
527 527 '%pinfo object' is just a synonym for object? or ?object."""
528 528
529 529 #print 'pinfo par: <%s>' % parameter_s # dbg
530 530
531 531
532 532 # detail_level: 0 -> obj? , 1 -> obj??
533 533 detail_level = 0
534 534 # We need to detect if we got called as 'pinfo pinfo foo', which can
535 535 # happen if the user types 'pinfo foo?' at the cmd line.
536 536 pinfo,qmark1,oname,qmark2 = \
537 537 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
538 538 if pinfo or qmark1 or qmark2:
539 539 detail_level = 1
540 540 if "*" in oname:
541 541 self.magic_psearch(oname)
542 542 else:
543 543 self.shell._inspect('pinfo', oname, detail_level=detail_level,
544 544 namespaces=namespaces)
545 545
546 546 def magic_pinfo2(self, parameter_s='', namespaces=None):
547 547 """Provide extra detailed information about an object.
548 548
549 549 '%pinfo2 object' is just a synonym for object?? or ??object."""
550 550 self.shell._inspect('pinfo', parameter_s, detail_level=1,
551 551 namespaces=namespaces)
552 552
553 553 @skip_doctest
554 554 def magic_pdef(self, parameter_s='', namespaces=None):
555 555 """Print the definition header for any callable object.
556 556
557 557 If the object is a class, print the constructor information.
558 558
559 559 Examples
560 560 --------
561 561 ::
562 562
563 563 In [3]: %pdef urllib.urlopen
564 564 urllib.urlopen(url, data=None, proxies=None)
565 565 """
566 566 self._inspect('pdef',parameter_s, namespaces)
567 567
568 568 def magic_pdoc(self, parameter_s='', namespaces=None):
569 569 """Print the docstring for an object.
570 570
571 571 If the given object is a class, it will print both the class and the
572 572 constructor docstrings."""
573 573 self._inspect('pdoc',parameter_s, namespaces)
574 574
575 575 def magic_psource(self, parameter_s='', namespaces=None):
576 576 """Print (or run through pager) the source code for an object."""
577 577 self._inspect('psource',parameter_s, namespaces)
578 578
579 579 def magic_pfile(self, parameter_s=''):
580 580 """Print (or run through pager) the file where an object is defined.
581 581
582 582 The file opens at the line where the object definition begins. IPython
583 583 will honor the environment variable PAGER if set, and otherwise will
584 584 do its best to print the file in a convenient form.
585 585
586 586 If the given argument is not an object currently defined, IPython will
587 587 try to interpret it as a filename (automatically adding a .py extension
588 588 if needed). You can thus use %pfile as a syntax highlighting code
589 589 viewer."""
590 590
591 591 # first interpret argument as an object name
592 592 out = self._inspect('pfile',parameter_s)
593 593 # if not, try the input as a filename
594 594 if out == 'not found':
595 595 try:
596 filename = get_py_filename(parameter_s)
596 filename = get_py_filename(parameter_s, sys.platform == 'win32')
597 597 except IOError,msg:
598 598 print msg
599 599 return
600 600 page.page(self.shell.inspector.format(file(filename).read()))
601 601
602 602 def magic_psearch(self, parameter_s=''):
603 603 """Search for object in namespaces by wildcard.
604 604
605 605 %psearch [options] PATTERN [OBJECT TYPE]
606 606
607 607 Note: ? can be used as a synonym for %psearch, at the beginning or at
608 608 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
609 609 rest of the command line must be unchanged (options come first), so
610 610 for example the following forms are equivalent
611 611
612 612 %psearch -i a* function
613 613 -i a* function?
614 614 ?-i a* function
615 615
616 616 Arguments:
617 617
618 618 PATTERN
619 619
620 620 where PATTERN is a string containing * as a wildcard similar to its
621 621 use in a shell. The pattern is matched in all namespaces on the
622 622 search path. By default objects starting with a single _ are not
623 623 matched, many IPython generated objects have a single
624 624 underscore. The default is case insensitive matching. Matching is
625 625 also done on the attributes of objects and not only on the objects
626 626 in a module.
627 627
628 628 [OBJECT TYPE]
629 629
630 630 Is the name of a python type from the types module. The name is
631 631 given in lowercase without the ending type, ex. StringType is
632 632 written string. By adding a type here only objects matching the
633 633 given type are matched. Using all here makes the pattern match all
634 634 types (this is the default).
635 635
636 636 Options:
637 637
638 638 -a: makes the pattern match even objects whose names start with a
639 639 single underscore. These names are normally ommitted from the
640 640 search.
641 641
642 642 -i/-c: make the pattern case insensitive/sensitive. If neither of
643 643 these options is given, the default is read from your ipythonrc
644 644 file. The option name which sets this value is
645 645 'wildcards_case_sensitive'. If this option is not specified in your
646 646 ipythonrc file, IPython's internal default is to do a case sensitive
647 647 search.
648 648
649 649 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
650 650 specifiy can be searched in any of the following namespaces:
651 651 'builtin', 'user', 'user_global','internal', 'alias', where
652 652 'builtin' and 'user' are the search defaults. Note that you should
653 653 not use quotes when specifying namespaces.
654 654
655 655 'Builtin' contains the python module builtin, 'user' contains all
656 656 user data, 'alias' only contain the shell aliases and no python
657 657 objects, 'internal' contains objects used by IPython. The
658 658 'user_global' namespace is only used by embedded IPython instances,
659 659 and it contains module-level globals. You can add namespaces to the
660 660 search with -s or exclude them with -e (these options can be given
661 661 more than once).
662 662
663 663 Examples:
664 664
665 665 %psearch a* -> objects beginning with an a
666 666 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
667 667 %psearch a* function -> all functions beginning with an a
668 668 %psearch re.e* -> objects beginning with an e in module re
669 669 %psearch r*.e* -> objects that start with e in modules starting in r
670 670 %psearch r*.* string -> all strings in modules beginning with r
671 671
672 672 Case sensitve search:
673 673
674 674 %psearch -c a* list all object beginning with lower case a
675 675
676 676 Show objects beginning with a single _:
677 677
678 678 %psearch -a _* list objects beginning with a single underscore"""
679 679 try:
680 680 parameter_s = parameter_s.encode('ascii')
681 681 except UnicodeEncodeError:
682 682 print 'Python identifiers can only contain ascii characters.'
683 683 return
684 684
685 685 # default namespaces to be searched
686 686 def_search = ['user','builtin']
687 687
688 688 # Process options/args
689 689 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
690 690 opt = opts.get
691 691 shell = self.shell
692 692 psearch = shell.inspector.psearch
693 693
694 694 # select case options
695 695 if opts.has_key('i'):
696 696 ignore_case = True
697 697 elif opts.has_key('c'):
698 698 ignore_case = False
699 699 else:
700 700 ignore_case = not shell.wildcards_case_sensitive
701 701
702 702 # Build list of namespaces to search from user options
703 703 def_search.extend(opt('s',[]))
704 704 ns_exclude = ns_exclude=opt('e',[])
705 705 ns_search = [nm for nm in def_search if nm not in ns_exclude]
706 706
707 707 # Call the actual search
708 708 try:
709 709 psearch(args,shell.ns_table,ns_search,
710 710 show_all=opt('a'),ignore_case=ignore_case)
711 711 except:
712 712 shell.showtraceback()
713 713
714 714 @skip_doctest
715 715 def magic_who_ls(self, parameter_s=''):
716 716 """Return a sorted list of all interactive variables.
717 717
718 718 If arguments are given, only variables of types matching these
719 719 arguments are returned.
720 720
721 721 Examples
722 722 --------
723 723
724 724 Define two variables and list them with who_ls::
725 725
726 726 In [1]: alpha = 123
727 727
728 728 In [2]: beta = 'test'
729 729
730 730 In [3]: %who_ls
731 731 Out[3]: ['alpha', 'beta']
732 732
733 733 In [4]: %who_ls int
734 734 Out[4]: ['alpha']
735 735
736 736 In [5]: %who_ls str
737 737 Out[5]: ['beta']
738 738 """
739 739
740 740 user_ns = self.shell.user_ns
741 741 internal_ns = self.shell.internal_ns
742 742 user_ns_hidden = self.shell.user_ns_hidden
743 743 out = [ i for i in user_ns
744 744 if not i.startswith('_') \
745 745 and not (i in internal_ns or i in user_ns_hidden) ]
746 746
747 747 typelist = parameter_s.split()
748 748 if typelist:
749 749 typeset = set(typelist)
750 750 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
751 751
752 752 out.sort()
753 753 return out
754 754
755 755 @skip_doctest
756 756 def magic_who(self, parameter_s=''):
757 757 """Print all interactive variables, with some minimal formatting.
758 758
759 759 If any arguments are given, only variables whose type matches one of
760 760 these are printed. For example:
761 761
762 762 %who function str
763 763
764 764 will only list functions and strings, excluding all other types of
765 765 variables. To find the proper type names, simply use type(var) at a
766 766 command line to see how python prints type names. For example:
767 767
768 768 In [1]: type('hello')\\
769 769 Out[1]: <type 'str'>
770 770
771 771 indicates that the type name for strings is 'str'.
772 772
773 773 %who always excludes executed names loaded through your configuration
774 774 file and things which are internal to IPython.
775 775
776 776 This is deliberate, as typically you may load many modules and the
777 777 purpose of %who is to show you only what you've manually defined.
778 778
779 779 Examples
780 780 --------
781 781
782 782 Define two variables and list them with who::
783 783
784 784 In [1]: alpha = 123
785 785
786 786 In [2]: beta = 'test'
787 787
788 788 In [3]: %who
789 789 alpha beta
790 790
791 791 In [4]: %who int
792 792 alpha
793 793
794 794 In [5]: %who str
795 795 beta
796 796 """
797 797
798 798 varlist = self.magic_who_ls(parameter_s)
799 799 if not varlist:
800 800 if parameter_s:
801 801 print 'No variables match your requested type.'
802 802 else:
803 803 print 'Interactive namespace is empty.'
804 804 return
805 805
806 806 # if we have variables, move on...
807 807 count = 0
808 808 for i in varlist:
809 809 print i+'\t',
810 810 count += 1
811 811 if count > 8:
812 812 count = 0
813 813 print
814 814 print
815 815
816 816 @skip_doctest
817 817 def magic_whos(self, parameter_s=''):
818 818 """Like %who, but gives some extra information about each variable.
819 819
820 820 The same type filtering of %who can be applied here.
821 821
822 822 For all variables, the type is printed. Additionally it prints:
823 823
824 824 - For {},[],(): their length.
825 825
826 826 - For numpy arrays, a summary with shape, number of
827 827 elements, typecode and size in memory.
828 828
829 829 - Everything else: a string representation, snipping their middle if
830 830 too long.
831 831
832 832 Examples
833 833 --------
834 834
835 835 Define two variables and list them with whos::
836 836
837 837 In [1]: alpha = 123
838 838
839 839 In [2]: beta = 'test'
840 840
841 841 In [3]: %whos
842 842 Variable Type Data/Info
843 843 --------------------------------
844 844 alpha int 123
845 845 beta str test
846 846 """
847 847
848 848 varnames = self.magic_who_ls(parameter_s)
849 849 if not varnames:
850 850 if parameter_s:
851 851 print 'No variables match your requested type.'
852 852 else:
853 853 print 'Interactive namespace is empty.'
854 854 return
855 855
856 856 # if we have variables, move on...
857 857
858 858 # for these types, show len() instead of data:
859 859 seq_types = ['dict', 'list', 'tuple']
860 860
861 861 # for numpy/Numeric arrays, display summary info
862 862 try:
863 863 import numpy
864 864 except ImportError:
865 865 ndarray_type = None
866 866 else:
867 867 ndarray_type = numpy.ndarray.__name__
868 868 try:
869 869 import Numeric
870 870 except ImportError:
871 871 array_type = None
872 872 else:
873 873 array_type = Numeric.ArrayType.__name__
874 874
875 875 # Find all variable names and types so we can figure out column sizes
876 876 def get_vars(i):
877 877 return self.shell.user_ns[i]
878 878
879 879 # some types are well known and can be shorter
880 880 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
881 881 def type_name(v):
882 882 tn = type(v).__name__
883 883 return abbrevs.get(tn,tn)
884 884
885 885 varlist = map(get_vars,varnames)
886 886
887 887 typelist = []
888 888 for vv in varlist:
889 889 tt = type_name(vv)
890 890
891 891 if tt=='instance':
892 892 typelist.append( abbrevs.get(str(vv.__class__),
893 893 str(vv.__class__)))
894 894 else:
895 895 typelist.append(tt)
896 896
897 897 # column labels and # of spaces as separator
898 898 varlabel = 'Variable'
899 899 typelabel = 'Type'
900 900 datalabel = 'Data/Info'
901 901 colsep = 3
902 902 # variable format strings
903 903 vformat = "{0:<{varwidth}}{1:<{typewidth}}"
904 904 aformat = "%s: %s elems, type `%s`, %s bytes"
905 905 # find the size of the columns to format the output nicely
906 906 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
907 907 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
908 908 # table header
909 909 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
910 910 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
911 911 # and the table itself
912 912 kb = 1024
913 913 Mb = 1048576 # kb**2
914 914 for vname,var,vtype in zip(varnames,varlist,typelist):
915 915 print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth),
916 916 if vtype in seq_types:
917 917 print "n="+str(len(var))
918 918 elif vtype in [array_type,ndarray_type]:
919 919 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
920 920 if vtype==ndarray_type:
921 921 # numpy
922 922 vsize = var.size
923 923 vbytes = vsize*var.itemsize
924 924 vdtype = var.dtype
925 925 else:
926 926 # Numeric
927 927 vsize = Numeric.size(var)
928 928 vbytes = vsize*var.itemsize()
929 929 vdtype = var.typecode()
930 930
931 931 if vbytes < 100000:
932 932 print aformat % (vshape,vsize,vdtype,vbytes)
933 933 else:
934 934 print aformat % (vshape,vsize,vdtype,vbytes),
935 935 if vbytes < Mb:
936 936 print '(%s kb)' % (vbytes/kb,)
937 937 else:
938 938 print '(%s Mb)' % (vbytes/Mb,)
939 939 else:
940 940 try:
941 941 vstr = str(var)
942 942 except UnicodeEncodeError:
943 943 vstr = unicode(var).encode(sys.getdefaultencoding(),
944 944 'backslashreplace')
945 945 vstr = vstr.replace('\n','\\n')
946 946 if len(vstr) < 50:
947 947 print vstr
948 948 else:
949 949 print vstr[:25] + "<...>" + vstr[-25:]
950 950
951 951 def magic_reset(self, parameter_s=''):
952 952 """Resets the namespace by removing all names defined by the user.
953 953
954 954 Parameters
955 955 ----------
956 956 -f : force reset without asking for confirmation.
957 957
958 958 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
959 959 References to objects may be kept. By default (without this option),
960 960 we do a 'hard' reset, giving you a new session and removing all
961 961 references to objects from the current session.
962 962
963 963 Examples
964 964 --------
965 965 In [6]: a = 1
966 966
967 967 In [7]: a
968 968 Out[7]: 1
969 969
970 970 In [8]: 'a' in _ip.user_ns
971 971 Out[8]: True
972 972
973 973 In [9]: %reset -f
974 974
975 975 In [1]: 'a' in _ip.user_ns
976 976 Out[1]: False
977 977 """
978 978 opts, args = self.parse_options(parameter_s,'sf')
979 979 if 'f' in opts:
980 980 ans = True
981 981 else:
982 982 ans = self.shell.ask_yes_no(
983 983 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
984 984 if not ans:
985 985 print 'Nothing done.'
986 986 return
987 987
988 988 if 's' in opts: # Soft reset
989 989 user_ns = self.shell.user_ns
990 990 for i in self.magic_who_ls():
991 991 del(user_ns[i])
992 992
993 993 else: # Hard reset
994 994 self.shell.reset(new_session = False)
995 995
996 996
997 997
998 998 def magic_reset_selective(self, parameter_s=''):
999 999 """Resets the namespace by removing names defined by the user.
1000 1000
1001 1001 Input/Output history are left around in case you need them.
1002 1002
1003 1003 %reset_selective [-f] regex
1004 1004
1005 1005 No action is taken if regex is not included
1006 1006
1007 1007 Options
1008 1008 -f : force reset without asking for confirmation.
1009 1009
1010 1010 Examples
1011 1011 --------
1012 1012
1013 1013 We first fully reset the namespace so your output looks identical to
1014 1014 this example for pedagogical reasons; in practice you do not need a
1015 1015 full reset.
1016 1016
1017 1017 In [1]: %reset -f
1018 1018
1019 1019 Now, with a clean namespace we can make a few variables and use
1020 1020 %reset_selective to only delete names that match our regexp:
1021 1021
1022 1022 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1023 1023
1024 1024 In [3]: who_ls
1025 1025 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1026 1026
1027 1027 In [4]: %reset_selective -f b[2-3]m
1028 1028
1029 1029 In [5]: who_ls
1030 1030 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1031 1031
1032 1032 In [6]: %reset_selective -f d
1033 1033
1034 1034 In [7]: who_ls
1035 1035 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1036 1036
1037 1037 In [8]: %reset_selective -f c
1038 1038
1039 1039 In [9]: who_ls
1040 1040 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1041 1041
1042 1042 In [10]: %reset_selective -f b
1043 1043
1044 1044 In [11]: who_ls
1045 1045 Out[11]: ['a']
1046 1046 """
1047 1047
1048 1048 opts, regex = self.parse_options(parameter_s,'f')
1049 1049
1050 1050 if opts.has_key('f'):
1051 1051 ans = True
1052 1052 else:
1053 1053 ans = self.shell.ask_yes_no(
1054 1054 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
1055 1055 if not ans:
1056 1056 print 'Nothing done.'
1057 1057 return
1058 1058 user_ns = self.shell.user_ns
1059 1059 if not regex:
1060 1060 print 'No regex pattern specified. Nothing done.'
1061 1061 return
1062 1062 else:
1063 1063 try:
1064 1064 m = re.compile(regex)
1065 1065 except TypeError:
1066 1066 raise TypeError('regex must be a string or compiled pattern')
1067 1067 for i in self.magic_who_ls():
1068 1068 if m.search(i):
1069 1069 del(user_ns[i])
1070 1070
1071 1071 def magic_xdel(self, parameter_s=''):
1072 1072 """Delete a variable, trying to clear it from anywhere that
1073 1073 IPython's machinery has references to it. By default, this uses
1074 1074 the identity of the named object in the user namespace to remove
1075 1075 references held under other names. The object is also removed
1076 1076 from the output history.
1077 1077
1078 1078 Options
1079 1079 -n : Delete the specified name from all namespaces, without
1080 1080 checking their identity.
1081 1081 """
1082 1082 opts, varname = self.parse_options(parameter_s,'n')
1083 1083 try:
1084 1084 self.shell.del_var(varname, ('n' in opts))
1085 1085 except (NameError, ValueError) as e:
1086 1086 print type(e).__name__ +": "+ str(e)
1087 1087
1088 1088 def magic_logstart(self,parameter_s=''):
1089 1089 """Start logging anywhere in a session.
1090 1090
1091 1091 %logstart [-o|-r|-t] [log_name [log_mode]]
1092 1092
1093 1093 If no name is given, it defaults to a file named 'ipython_log.py' in your
1094 1094 current directory, in 'rotate' mode (see below).
1095 1095
1096 1096 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
1097 1097 history up to that point and then continues logging.
1098 1098
1099 1099 %logstart takes a second optional parameter: logging mode. This can be one
1100 1100 of (note that the modes are given unquoted):\\
1101 1101 append: well, that says it.\\
1102 1102 backup: rename (if exists) to name~ and start name.\\
1103 1103 global: single logfile in your home dir, appended to.\\
1104 1104 over : overwrite existing log.\\
1105 1105 rotate: create rotating logs name.1~, name.2~, etc.
1106 1106
1107 1107 Options:
1108 1108
1109 1109 -o: log also IPython's output. In this mode, all commands which
1110 1110 generate an Out[NN] prompt are recorded to the logfile, right after
1111 1111 their corresponding input line. The output lines are always
1112 1112 prepended with a '#[Out]# ' marker, so that the log remains valid
1113 1113 Python code.
1114 1114
1115 1115 Since this marker is always the same, filtering only the output from
1116 1116 a log is very easy, using for example a simple awk call:
1117 1117
1118 1118 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
1119 1119
1120 1120 -r: log 'raw' input. Normally, IPython's logs contain the processed
1121 1121 input, so that user lines are logged in their final form, converted
1122 1122 into valid Python. For example, %Exit is logged as
1123 1123 '_ip.magic("Exit"). If the -r flag is given, all input is logged
1124 1124 exactly as typed, with no transformations applied.
1125 1125
1126 1126 -t: put timestamps before each input line logged (these are put in
1127 1127 comments)."""
1128 1128
1129 1129 opts,par = self.parse_options(parameter_s,'ort')
1130 1130 log_output = 'o' in opts
1131 1131 log_raw_input = 'r' in opts
1132 1132 timestamp = 't' in opts
1133 1133
1134 1134 logger = self.shell.logger
1135 1135
1136 1136 # if no args are given, the defaults set in the logger constructor by
1137 1137 # ipytohn remain valid
1138 1138 if par:
1139 1139 try:
1140 1140 logfname,logmode = par.split()
1141 1141 except:
1142 1142 logfname = par
1143 1143 logmode = 'backup'
1144 1144 else:
1145 1145 logfname = logger.logfname
1146 1146 logmode = logger.logmode
1147 1147 # put logfname into rc struct as if it had been called on the command
1148 1148 # line, so it ends up saved in the log header Save it in case we need
1149 1149 # to restore it...
1150 1150 old_logfile = self.shell.logfile
1151 1151 if logfname:
1152 1152 logfname = os.path.expanduser(logfname)
1153 1153 self.shell.logfile = logfname
1154 1154
1155 1155 loghead = '# IPython log file\n\n'
1156 1156 try:
1157 1157 started = logger.logstart(logfname,loghead,logmode,
1158 1158 log_output,timestamp,log_raw_input)
1159 1159 except:
1160 1160 self.shell.logfile = old_logfile
1161 1161 warn("Couldn't start log: %s" % sys.exc_info()[1])
1162 1162 else:
1163 1163 # log input history up to this point, optionally interleaving
1164 1164 # output if requested
1165 1165
1166 1166 if timestamp:
1167 1167 # disable timestamping for the previous history, since we've
1168 1168 # lost those already (no time machine here).
1169 1169 logger.timestamp = False
1170 1170
1171 1171 if log_raw_input:
1172 1172 input_hist = self.shell.history_manager.input_hist_raw
1173 1173 else:
1174 1174 input_hist = self.shell.history_manager.input_hist_parsed
1175 1175
1176 1176 if log_output:
1177 1177 log_write = logger.log_write
1178 1178 output_hist = self.shell.history_manager.output_hist
1179 1179 for n in range(1,len(input_hist)-1):
1180 1180 log_write(input_hist[n].rstrip() + '\n')
1181 1181 if n in output_hist:
1182 1182 log_write(repr(output_hist[n]),'output')
1183 1183 else:
1184 1184 logger.log_write('\n'.join(input_hist[1:]))
1185 1185 logger.log_write('\n')
1186 1186 if timestamp:
1187 1187 # re-enable timestamping
1188 1188 logger.timestamp = True
1189 1189
1190 1190 print ('Activating auto-logging. '
1191 1191 'Current session state plus future input saved.')
1192 1192 logger.logstate()
1193 1193
1194 1194 def magic_logstop(self,parameter_s=''):
1195 1195 """Fully stop logging and close log file.
1196 1196
1197 1197 In order to start logging again, a new %logstart call needs to be made,
1198 1198 possibly (though not necessarily) with a new filename, mode and other
1199 1199 options."""
1200 1200 self.logger.logstop()
1201 1201
1202 1202 def magic_logoff(self,parameter_s=''):
1203 1203 """Temporarily stop logging.
1204 1204
1205 1205 You must have previously started logging."""
1206 1206 self.shell.logger.switch_log(0)
1207 1207
1208 1208 def magic_logon(self,parameter_s=''):
1209 1209 """Restart logging.
1210 1210
1211 1211 This function is for restarting logging which you've temporarily
1212 1212 stopped with %logoff. For starting logging for the first time, you
1213 1213 must use the %logstart function, which allows you to specify an
1214 1214 optional log filename."""
1215 1215
1216 1216 self.shell.logger.switch_log(1)
1217 1217
1218 1218 def magic_logstate(self,parameter_s=''):
1219 1219 """Print the status of the logging system."""
1220 1220
1221 1221 self.shell.logger.logstate()
1222 1222
1223 1223 def magic_pdb(self, parameter_s=''):
1224 1224 """Control the automatic calling of the pdb interactive debugger.
1225 1225
1226 1226 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1227 1227 argument it works as a toggle.
1228 1228
1229 1229 When an exception is triggered, IPython can optionally call the
1230 1230 interactive pdb debugger after the traceback printout. %pdb toggles
1231 1231 this feature on and off.
1232 1232
1233 1233 The initial state of this feature is set in your ipythonrc
1234 1234 configuration file (the variable is called 'pdb').
1235 1235
1236 1236 If you want to just activate the debugger AFTER an exception has fired,
1237 1237 without having to type '%pdb on' and rerunning your code, you can use
1238 1238 the %debug magic."""
1239 1239
1240 1240 par = parameter_s.strip().lower()
1241 1241
1242 1242 if par:
1243 1243 try:
1244 1244 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1245 1245 except KeyError:
1246 1246 print ('Incorrect argument. Use on/1, off/0, '
1247 1247 'or nothing for a toggle.')
1248 1248 return
1249 1249 else:
1250 1250 # toggle
1251 1251 new_pdb = not self.shell.call_pdb
1252 1252
1253 1253 # set on the shell
1254 1254 self.shell.call_pdb = new_pdb
1255 1255 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1256 1256
1257 1257 def magic_debug(self, parameter_s=''):
1258 1258 """Activate the interactive debugger in post-mortem mode.
1259 1259
1260 1260 If an exception has just occurred, this lets you inspect its stack
1261 1261 frames interactively. Note that this will always work only on the last
1262 1262 traceback that occurred, so you must call this quickly after an
1263 1263 exception that you wish to inspect has fired, because if another one
1264 1264 occurs, it clobbers the previous one.
1265 1265
1266 1266 If you want IPython to automatically do this on every exception, see
1267 1267 the %pdb magic for more details.
1268 1268 """
1269 1269 self.shell.debugger(force=True)
1270 1270
1271 1271 @skip_doctest
1272 1272 def magic_prun(self, parameter_s ='',user_mode=1,
1273 1273 opts=None,arg_lst=None,prog_ns=None):
1274 1274
1275 1275 """Run a statement through the python code profiler.
1276 1276
1277 1277 Usage:
1278 1278 %prun [options] statement
1279 1279
1280 1280 The given statement (which doesn't require quote marks) is run via the
1281 1281 python profiler in a manner similar to the profile.run() function.
1282 1282 Namespaces are internally managed to work correctly; profile.run
1283 1283 cannot be used in IPython because it makes certain assumptions about
1284 1284 namespaces which do not hold under IPython.
1285 1285
1286 1286 Options:
1287 1287
1288 1288 -l <limit>: you can place restrictions on what or how much of the
1289 1289 profile gets printed. The limit value can be:
1290 1290
1291 1291 * A string: only information for function names containing this string
1292 1292 is printed.
1293 1293
1294 1294 * An integer: only these many lines are printed.
1295 1295
1296 1296 * A float (between 0 and 1): this fraction of the report is printed
1297 1297 (for example, use a limit of 0.4 to see the topmost 40% only).
1298 1298
1299 1299 You can combine several limits with repeated use of the option. For
1300 1300 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1301 1301 information about class constructors.
1302 1302
1303 1303 -r: return the pstats.Stats object generated by the profiling. This
1304 1304 object has all the information about the profile in it, and you can
1305 1305 later use it for further analysis or in other functions.
1306 1306
1307 1307 -s <key>: sort profile by given key. You can provide more than one key
1308 1308 by using the option several times: '-s key1 -s key2 -s key3...'. The
1309 1309 default sorting key is 'time'.
1310 1310
1311 1311 The following is copied verbatim from the profile documentation
1312 1312 referenced below:
1313 1313
1314 1314 When more than one key is provided, additional keys are used as
1315 1315 secondary criteria when the there is equality in all keys selected
1316 1316 before them.
1317 1317
1318 1318 Abbreviations can be used for any key names, as long as the
1319 1319 abbreviation is unambiguous. The following are the keys currently
1320 1320 defined:
1321 1321
1322 1322 Valid Arg Meaning
1323 1323 "calls" call count
1324 1324 "cumulative" cumulative time
1325 1325 "file" file name
1326 1326 "module" file name
1327 1327 "pcalls" primitive call count
1328 1328 "line" line number
1329 1329 "name" function name
1330 1330 "nfl" name/file/line
1331 1331 "stdname" standard name
1332 1332 "time" internal time
1333 1333
1334 1334 Note that all sorts on statistics are in descending order (placing
1335 1335 most time consuming items first), where as name, file, and line number
1336 1336 searches are in ascending order (i.e., alphabetical). The subtle
1337 1337 distinction between "nfl" and "stdname" is that the standard name is a
1338 1338 sort of the name as printed, which means that the embedded line
1339 1339 numbers get compared in an odd way. For example, lines 3, 20, and 40
1340 1340 would (if the file names were the same) appear in the string order
1341 1341 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1342 1342 line numbers. In fact, sort_stats("nfl") is the same as
1343 1343 sort_stats("name", "file", "line").
1344 1344
1345 1345 -T <filename>: save profile results as shown on screen to a text
1346 1346 file. The profile is still shown on screen.
1347 1347
1348 1348 -D <filename>: save (via dump_stats) profile statistics to given
1349 1349 filename. This data is in a format understod by the pstats module, and
1350 1350 is generated by a call to the dump_stats() method of profile
1351 1351 objects. The profile is still shown on screen.
1352 1352
1353 1353 If you want to run complete programs under the profiler's control, use
1354 1354 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1355 1355 contains profiler specific options as described here.
1356 1356
1357 1357 You can read the complete documentation for the profile module with::
1358 1358
1359 1359 In [1]: import profile; profile.help()
1360 1360 """
1361 1361
1362 1362 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1363 1363 # protect user quote marks
1364 1364 parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'")
1365 1365
1366 1366 if user_mode: # regular user call
1367 1367 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:',
1368 1368 list_all=1)
1369 1369 namespace = self.shell.user_ns
1370 1370 else: # called to run a program by %run -p
1371 1371 try:
1372 filename = get_py_filename(arg_lst[0])
1372 filename = get_py_filename(arg_lst[0], sys.platform == 'win32')
1373 1373 except IOError,msg:
1374 1374 error(msg)
1375 1375 return
1376 1376
1377 1377 arg_str = 'execfile(filename,prog_ns)'
1378 1378 namespace = locals()
1379 1379
1380 1380 opts.merge(opts_def)
1381 1381
1382 1382 prof = profile.Profile()
1383 1383 try:
1384 1384 prof = prof.runctx(arg_str,namespace,namespace)
1385 1385 sys_exit = ''
1386 1386 except SystemExit:
1387 1387 sys_exit = """*** SystemExit exception caught in code being profiled."""
1388 1388
1389 1389 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1390 1390
1391 1391 lims = opts.l
1392 1392 if lims:
1393 1393 lims = [] # rebuild lims with ints/floats/strings
1394 1394 for lim in opts.l:
1395 1395 try:
1396 1396 lims.append(int(lim))
1397 1397 except ValueError:
1398 1398 try:
1399 1399 lims.append(float(lim))
1400 1400 except ValueError:
1401 1401 lims.append(lim)
1402 1402
1403 1403 # Trap output.
1404 1404 stdout_trap = StringIO()
1405 1405
1406 1406 if hasattr(stats,'stream'):
1407 1407 # In newer versions of python, the stats object has a 'stream'
1408 1408 # attribute to write into.
1409 1409 stats.stream = stdout_trap
1410 1410 stats.print_stats(*lims)
1411 1411 else:
1412 1412 # For older versions, we manually redirect stdout during printing
1413 1413 sys_stdout = sys.stdout
1414 1414 try:
1415 1415 sys.stdout = stdout_trap
1416 1416 stats.print_stats(*lims)
1417 1417 finally:
1418 1418 sys.stdout = sys_stdout
1419 1419
1420 1420 output = stdout_trap.getvalue()
1421 1421 output = output.rstrip()
1422 1422
1423 1423 page.page(output)
1424 1424 print sys_exit,
1425 1425
1426 1426 dump_file = opts.D[0]
1427 1427 text_file = opts.T[0]
1428 1428 if dump_file:
1429 1429 prof.dump_stats(dump_file)
1430 1430 print '\n*** Profile stats marshalled to file',\
1431 1431 `dump_file`+'.',sys_exit
1432 1432 if text_file:
1433 1433 pfile = file(text_file,'w')
1434 1434 pfile.write(output)
1435 1435 pfile.close()
1436 1436 print '\n*** Profile printout saved to text file',\
1437 1437 `text_file`+'.',sys_exit
1438 1438
1439 1439 if opts.has_key('r'):
1440 1440 return stats
1441 1441 else:
1442 1442 return None
1443 1443
1444 1444 @skip_doctest
1445 1445 def magic_run(self, parameter_s ='',runner=None,
1446 1446 file_finder=get_py_filename):
1447 1447 """Run the named file inside IPython as a program.
1448 1448
1449 1449 Usage:\\
1450 1450 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1451 1451
1452 1452 Parameters after the filename are passed as command-line arguments to
1453 1453 the program (put in sys.argv). Then, control returns to IPython's
1454 1454 prompt.
1455 1455
1456 1456 This is similar to running at a system prompt:\\
1457 1457 $ python file args\\
1458 1458 but with the advantage of giving you IPython's tracebacks, and of
1459 1459 loading all variables into your interactive namespace for further use
1460 1460 (unless -p is used, see below).
1461 1461
1462 1462 The file is executed in a namespace initially consisting only of
1463 1463 __name__=='__main__' and sys.argv constructed as indicated. It thus
1464 1464 sees its environment as if it were being run as a stand-alone program
1465 1465 (except for sharing global objects such as previously imported
1466 1466 modules). But after execution, the IPython interactive namespace gets
1467 1467 updated with all variables defined in the program (except for __name__
1468 1468 and sys.argv). This allows for very convenient loading of code for
1469 1469 interactive work, while giving each program a 'clean sheet' to run in.
1470 1470
1471 1471 Options:
1472 1472
1473 1473 -n: __name__ is NOT set to '__main__', but to the running file's name
1474 1474 without extension (as python does under import). This allows running
1475 1475 scripts and reloading the definitions in them without calling code
1476 1476 protected by an ' if __name__ == "__main__" ' clause.
1477 1477
1478 1478 -i: run the file in IPython's namespace instead of an empty one. This
1479 1479 is useful if you are experimenting with code written in a text editor
1480 1480 which depends on variables defined interactively.
1481 1481
1482 1482 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1483 1483 being run. This is particularly useful if IPython is being used to
1484 1484 run unittests, which always exit with a sys.exit() call. In such
1485 1485 cases you are interested in the output of the test results, not in
1486 1486 seeing a traceback of the unittest module.
1487 1487
1488 1488 -t: print timing information at the end of the run. IPython will give
1489 1489 you an estimated CPU time consumption for your script, which under
1490 1490 Unix uses the resource module to avoid the wraparound problems of
1491 1491 time.clock(). Under Unix, an estimate of time spent on system tasks
1492 1492 is also given (for Windows platforms this is reported as 0.0).
1493 1493
1494 1494 If -t is given, an additional -N<N> option can be given, where <N>
1495 1495 must be an integer indicating how many times you want the script to
1496 1496 run. The final timing report will include total and per run results.
1497 1497
1498 1498 For example (testing the script uniq_stable.py):
1499 1499
1500 1500 In [1]: run -t uniq_stable
1501 1501
1502 1502 IPython CPU timings (estimated):\\
1503 1503 User : 0.19597 s.\\
1504 1504 System: 0.0 s.\\
1505 1505
1506 1506 In [2]: run -t -N5 uniq_stable
1507 1507
1508 1508 IPython CPU timings (estimated):\\
1509 1509 Total runs performed: 5\\
1510 1510 Times : Total Per run\\
1511 1511 User : 0.910862 s, 0.1821724 s.\\
1512 1512 System: 0.0 s, 0.0 s.
1513 1513
1514 1514 -d: run your program under the control of pdb, the Python debugger.
1515 1515 This allows you to execute your program step by step, watch variables,
1516 1516 etc. Internally, what IPython does is similar to calling:
1517 1517
1518 1518 pdb.run('execfile("YOURFILENAME")')
1519 1519
1520 1520 with a breakpoint set on line 1 of your file. You can change the line
1521 1521 number for this automatic breakpoint to be <N> by using the -bN option
1522 1522 (where N must be an integer). For example:
1523 1523
1524 1524 %run -d -b40 myscript
1525 1525
1526 1526 will set the first breakpoint at line 40 in myscript.py. Note that
1527 1527 the first breakpoint must be set on a line which actually does
1528 1528 something (not a comment or docstring) for it to stop execution.
1529 1529
1530 1530 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1531 1531 first enter 'c' (without qoutes) to start execution up to the first
1532 1532 breakpoint.
1533 1533
1534 1534 Entering 'help' gives information about the use of the debugger. You
1535 1535 can easily see pdb's full documentation with "import pdb;pdb.help()"
1536 1536 at a prompt.
1537 1537
1538 1538 -p: run program under the control of the Python profiler module (which
1539 1539 prints a detailed report of execution times, function calls, etc).
1540 1540
1541 1541 You can pass other options after -p which affect the behavior of the
1542 1542 profiler itself. See the docs for %prun for details.
1543 1543
1544 1544 In this mode, the program's variables do NOT propagate back to the
1545 1545 IPython interactive namespace (because they remain in the namespace
1546 1546 where the profiler executes them).
1547 1547
1548 1548 Internally this triggers a call to %prun, see its documentation for
1549 1549 details on the options available specifically for profiling.
1550 1550
1551 1551 There is one special usage for which the text above doesn't apply:
1552 1552 if the filename ends with .ipy, the file is run as ipython script,
1553 1553 just as if the commands were written on IPython prompt.
1554 1554 """
1555 1555
1556 1556 # get arguments and set sys.argv for program to be run.
1557 1557 opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e',
1558 1558 mode='list',list_all=1)
1559 1559
1560 1560 try:
1561 filename = file_finder(arg_lst[0])
1561 filename = file_finder(arg_lst[0], sys.platform == 'win32')
1562 1562 except IndexError:
1563 1563 warn('you must provide at least a filename.')
1564 1564 print '\n%run:\n',oinspect.getdoc(self.magic_run)
1565 1565 return
1566 1566 except IOError,msg:
1567 1567 error(msg)
1568 1568 return
1569 1569
1570 1570 if filename.lower().endswith('.ipy'):
1571 1571 self.shell.safe_execfile_ipy(filename)
1572 1572 return
1573 1573
1574 1574 # Control the response to exit() calls made by the script being run
1575 1575 exit_ignore = opts.has_key('e')
1576 1576
1577 1577 # Make sure that the running script gets a proper sys.argv as if it
1578 1578 # were run from a system shell.
1579 1579 save_argv = sys.argv # save it for later restoring
1580 1580
1581 1581 # simulate shell expansion on arguments, at least tilde expansion
1582 1582 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
1583 1583
1584 1584 sys.argv = [filename]+ args # put in the proper filename
1585 1585
1586 1586 if opts.has_key('i'):
1587 1587 # Run in user's interactive namespace
1588 1588 prog_ns = self.shell.user_ns
1589 1589 __name__save = self.shell.user_ns['__name__']
1590 1590 prog_ns['__name__'] = '__main__'
1591 1591 main_mod = self.shell.new_main_mod(prog_ns)
1592 1592 else:
1593 1593 # Run in a fresh, empty namespace
1594 1594 if opts.has_key('n'):
1595 1595 name = os.path.splitext(os.path.basename(filename))[0]
1596 1596 else:
1597 1597 name = '__main__'
1598 1598
1599 1599 main_mod = self.shell.new_main_mod()
1600 1600 prog_ns = main_mod.__dict__
1601 1601 prog_ns['__name__'] = name
1602 1602
1603 1603 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1604 1604 # set the __file__ global in the script's namespace
1605 1605 prog_ns['__file__'] = filename
1606 1606
1607 1607 # pickle fix. See interactiveshell for an explanation. But we need to make sure
1608 1608 # that, if we overwrite __main__, we replace it at the end
1609 1609 main_mod_name = prog_ns['__name__']
1610 1610
1611 1611 if main_mod_name == '__main__':
1612 1612 restore_main = sys.modules['__main__']
1613 1613 else:
1614 1614 restore_main = False
1615 1615
1616 1616 # This needs to be undone at the end to prevent holding references to
1617 1617 # every single object ever created.
1618 1618 sys.modules[main_mod_name] = main_mod
1619 1619
1620 1620 try:
1621 1621 stats = None
1622 1622 with self.readline_no_record:
1623 1623 if opts.has_key('p'):
1624 1624 stats = self.magic_prun('',0,opts,arg_lst,prog_ns)
1625 1625 else:
1626 1626 if opts.has_key('d'):
1627 1627 deb = debugger.Pdb(self.shell.colors)
1628 1628 # reset Breakpoint state, which is moronically kept
1629 1629 # in a class
1630 1630 bdb.Breakpoint.next = 1
1631 1631 bdb.Breakpoint.bplist = {}
1632 1632 bdb.Breakpoint.bpbynumber = [None]
1633 1633 # Set an initial breakpoint to stop execution
1634 1634 maxtries = 10
1635 1635 bp = int(opts.get('b',[1])[0])
1636 1636 checkline = deb.checkline(filename,bp)
1637 1637 if not checkline:
1638 1638 for bp in range(bp+1,bp+maxtries+1):
1639 1639 if deb.checkline(filename,bp):
1640 1640 break
1641 1641 else:
1642 1642 msg = ("\nI failed to find a valid line to set "
1643 1643 "a breakpoint\n"
1644 1644 "after trying up to line: %s.\n"
1645 1645 "Please set a valid breakpoint manually "
1646 1646 "with the -b option." % bp)
1647 1647 error(msg)
1648 1648 return
1649 1649 # if we find a good linenumber, set the breakpoint
1650 1650 deb.do_break('%s:%s' % (filename,bp))
1651 1651 # Start file run
1652 1652 print "NOTE: Enter 'c' at the",
1653 1653 print "%s prompt to start your script." % deb.prompt
1654 1654 try:
1655 1655 deb.run('execfile("%s")' % filename,prog_ns)
1656 1656
1657 1657 except:
1658 1658 etype, value, tb = sys.exc_info()
1659 1659 # Skip three frames in the traceback: the %run one,
1660 1660 # one inside bdb.py, and the command-line typed by the
1661 1661 # user (run by exec in pdb itself).
1662 1662 self.shell.InteractiveTB(etype,value,tb,tb_offset=3)
1663 1663 else:
1664 1664 if runner is None:
1665 1665 runner = self.shell.safe_execfile
1666 1666 if opts.has_key('t'):
1667 1667 # timed execution
1668 1668 try:
1669 1669 nruns = int(opts['N'][0])
1670 1670 if nruns < 1:
1671 1671 error('Number of runs must be >=1')
1672 1672 return
1673 1673 except (KeyError):
1674 1674 nruns = 1
1675 1675 twall0 = time.time()
1676 1676 if nruns == 1:
1677 1677 t0 = clock2()
1678 1678 runner(filename,prog_ns,prog_ns,
1679 1679 exit_ignore=exit_ignore)
1680 1680 t1 = clock2()
1681 1681 t_usr = t1[0]-t0[0]
1682 1682 t_sys = t1[1]-t0[1]
1683 1683 print "\nIPython CPU timings (estimated):"
1684 1684 print " User : %10.2f s." % t_usr
1685 1685 print " System : %10.2f s." % t_sys
1686 1686 else:
1687 1687 runs = range(nruns)
1688 1688 t0 = clock2()
1689 1689 for nr in runs:
1690 1690 runner(filename,prog_ns,prog_ns,
1691 1691 exit_ignore=exit_ignore)
1692 1692 t1 = clock2()
1693 1693 t_usr = t1[0]-t0[0]
1694 1694 t_sys = t1[1]-t0[1]
1695 1695 print "\nIPython CPU timings (estimated):"
1696 1696 print "Total runs performed:",nruns
1697 1697 print " Times : %10.2f %10.2f" % ('Total','Per run')
1698 1698 print " User : %10.2f s, %10.2f s." % (t_usr,t_usr/nruns)
1699 1699 print " System : %10.2f s, %10.2f s." % (t_sys,t_sys/nruns)
1700 1700 twall1 = time.time()
1701 1701 print "Wall time: %10.2f s." % (twall1-twall0)
1702 1702
1703 1703 else:
1704 1704 # regular execution
1705 1705 runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore)
1706 1706
1707 1707 if opts.has_key('i'):
1708 1708 self.shell.user_ns['__name__'] = __name__save
1709 1709 else:
1710 1710 # The shell MUST hold a reference to prog_ns so after %run
1711 1711 # exits, the python deletion mechanism doesn't zero it out
1712 1712 # (leaving dangling references).
1713 1713 self.shell.cache_main_mod(prog_ns,filename)
1714 1714 # update IPython interactive namespace
1715 1715
1716 1716 # Some forms of read errors on the file may mean the
1717 1717 # __name__ key was never set; using pop we don't have to
1718 1718 # worry about a possible KeyError.
1719 1719 prog_ns.pop('__name__', None)
1720 1720
1721 1721 self.shell.user_ns.update(prog_ns)
1722 1722 finally:
1723 1723 # It's a bit of a mystery why, but __builtins__ can change from
1724 1724 # being a module to becoming a dict missing some key data after
1725 1725 # %run. As best I can see, this is NOT something IPython is doing
1726 1726 # at all, and similar problems have been reported before:
1727 1727 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1728 1728 # Since this seems to be done by the interpreter itself, the best
1729 1729 # we can do is to at least restore __builtins__ for the user on
1730 1730 # exit.
1731 1731 self.shell.user_ns['__builtins__'] = __builtin__
1732 1732
1733 1733 # Ensure key global structures are restored
1734 1734 sys.argv = save_argv
1735 1735 if restore_main:
1736 1736 sys.modules['__main__'] = restore_main
1737 1737 else:
1738 1738 # Remove from sys.modules the reference to main_mod we'd
1739 1739 # added. Otherwise it will trap references to objects
1740 1740 # contained therein.
1741 1741 del sys.modules[main_mod_name]
1742 1742
1743 1743 return stats
1744 1744
1745 1745 @skip_doctest
1746 1746 def magic_timeit(self, parameter_s =''):
1747 1747 """Time execution of a Python statement or expression
1748 1748
1749 1749 Usage:\\
1750 1750 %timeit [-n<N> -r<R> [-t|-c]] statement
1751 1751
1752 1752 Time execution of a Python statement or expression using the timeit
1753 1753 module.
1754 1754
1755 1755 Options:
1756 1756 -n<N>: execute the given statement <N> times in a loop. If this value
1757 1757 is not given, a fitting value is chosen.
1758 1758
1759 1759 -r<R>: repeat the loop iteration <R> times and take the best result.
1760 1760 Default: 3
1761 1761
1762 1762 -t: use time.time to measure the time, which is the default on Unix.
1763 1763 This function measures wall time.
1764 1764
1765 1765 -c: use time.clock to measure the time, which is the default on
1766 1766 Windows and measures wall time. On Unix, resource.getrusage is used
1767 1767 instead and returns the CPU user time.
1768 1768
1769 1769 -p<P>: use a precision of <P> digits to display the timing result.
1770 1770 Default: 3
1771 1771
1772 1772
1773 1773 Examples:
1774 1774
1775 1775 In [1]: %timeit pass
1776 1776 10000000 loops, best of 3: 53.3 ns per loop
1777 1777
1778 1778 In [2]: u = None
1779 1779
1780 1780 In [3]: %timeit u is None
1781 1781 10000000 loops, best of 3: 184 ns per loop
1782 1782
1783 1783 In [4]: %timeit -r 4 u == None
1784 1784 1000000 loops, best of 4: 242 ns per loop
1785 1785
1786 1786 In [5]: import time
1787 1787
1788 1788 In [6]: %timeit -n1 time.sleep(2)
1789 1789 1 loops, best of 3: 2 s per loop
1790 1790
1791 1791
1792 1792 The times reported by %timeit will be slightly higher than those
1793 1793 reported by the timeit.py script when variables are accessed. This is
1794 1794 due to the fact that %timeit executes the statement in the namespace
1795 1795 of the shell, compared with timeit.py, which uses a single setup
1796 1796 statement to import function or create variables. Generally, the bias
1797 1797 does not matter as long as results from timeit.py are not mixed with
1798 1798 those from %timeit."""
1799 1799
1800 1800 import timeit
1801 1801 import math
1802 1802
1803 1803 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1804 1804 # certain terminals. Until we figure out a robust way of
1805 1805 # auto-detecting if the terminal can deal with it, use plain 'us' for
1806 1806 # microseconds. I am really NOT happy about disabling the proper
1807 1807 # 'micro' prefix, but crashing is worse... If anyone knows what the
1808 1808 # right solution for this is, I'm all ears...
1809 1809 #
1810 1810 # Note: using
1811 1811 #
1812 1812 # s = u'\xb5'
1813 1813 # s.encode(sys.getdefaultencoding())
1814 1814 #
1815 1815 # is not sufficient, as I've seen terminals where that fails but
1816 1816 # print s
1817 1817 #
1818 1818 # succeeds
1819 1819 #
1820 1820 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1821 1821
1822 1822 #units = [u"s", u"ms",u'\xb5',"ns"]
1823 1823 units = [u"s", u"ms",u'us',"ns"]
1824 1824
1825 1825 scaling = [1, 1e3, 1e6, 1e9]
1826 1826
1827 1827 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1828 1828 posix=False)
1829 1829 if stmt == "":
1830 1830 return
1831 1831 timefunc = timeit.default_timer
1832 1832 number = int(getattr(opts, "n", 0))
1833 1833 repeat = int(getattr(opts, "r", timeit.default_repeat))
1834 1834 precision = int(getattr(opts, "p", 3))
1835 1835 if hasattr(opts, "t"):
1836 1836 timefunc = time.time
1837 1837 if hasattr(opts, "c"):
1838 1838 timefunc = clock
1839 1839
1840 1840 timer = timeit.Timer(timer=timefunc)
1841 1841 # this code has tight coupling to the inner workings of timeit.Timer,
1842 1842 # but is there a better way to achieve that the code stmt has access
1843 1843 # to the shell namespace?
1844 1844
1845 1845 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1846 1846 'setup': "pass"}
1847 1847 # Track compilation time so it can be reported if too long
1848 1848 # Minimum time above which compilation time will be reported
1849 1849 tc_min = 0.1
1850 1850
1851 1851 t0 = clock()
1852 1852 code = compile(src, "<magic-timeit>", "exec")
1853 1853 tc = clock()-t0
1854 1854
1855 1855 ns = {}
1856 1856 exec code in self.shell.user_ns, ns
1857 1857 timer.inner = ns["inner"]
1858 1858
1859 1859 if number == 0:
1860 1860 # determine number so that 0.2 <= total time < 2.0
1861 1861 number = 1
1862 1862 for i in range(1, 10):
1863 1863 if timer.timeit(number) >= 0.2:
1864 1864 break
1865 1865 number *= 10
1866 1866
1867 1867 best = min(timer.repeat(repeat, number)) / number
1868 1868
1869 1869 if best > 0.0 and best < 1000.0:
1870 1870 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1871 1871 elif best >= 1000.0:
1872 1872 order = 0
1873 1873 else:
1874 1874 order = 3
1875 1875 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1876 1876 precision,
1877 1877 best * scaling[order],
1878 1878 units[order])
1879 1879 if tc > tc_min:
1880 1880 print "Compiler time: %.2f s" % tc
1881 1881
1882 1882 @skip_doctest
1883 1883 @needs_local_scope
1884 1884 def magic_time(self,parameter_s = ''):
1885 1885 """Time execution of a Python statement or expression.
1886 1886
1887 1887 The CPU and wall clock times are printed, and the value of the
1888 1888 expression (if any) is returned. Note that under Win32, system time
1889 1889 is always reported as 0, since it can not be measured.
1890 1890
1891 1891 This function provides very basic timing functionality. In Python
1892 1892 2.3, the timeit module offers more control and sophistication, so this
1893 1893 could be rewritten to use it (patches welcome).
1894 1894
1895 1895 Some examples:
1896 1896
1897 1897 In [1]: time 2**128
1898 1898 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1899 1899 Wall time: 0.00
1900 1900 Out[1]: 340282366920938463463374607431768211456L
1901 1901
1902 1902 In [2]: n = 1000000
1903 1903
1904 1904 In [3]: time sum(range(n))
1905 1905 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
1906 1906 Wall time: 1.37
1907 1907 Out[3]: 499999500000L
1908 1908
1909 1909 In [4]: time print 'hello world'
1910 1910 hello world
1911 1911 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1912 1912 Wall time: 0.00
1913 1913
1914 1914 Note that the time needed by Python to compile the given expression
1915 1915 will be reported if it is more than 0.1s. In this example, the
1916 1916 actual exponentiation is done by Python at compilation time, so while
1917 1917 the expression can take a noticeable amount of time to compute, that
1918 1918 time is purely due to the compilation:
1919 1919
1920 1920 In [5]: time 3**9999;
1921 1921 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1922 1922 Wall time: 0.00 s
1923 1923
1924 1924 In [6]: time 3**999999;
1925 1925 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1926 1926 Wall time: 0.00 s
1927 1927 Compiler : 0.78 s
1928 1928 """
1929 1929
1930 1930 # fail immediately if the given expression can't be compiled
1931 1931
1932 1932 expr = self.shell.prefilter(parameter_s,False)
1933 1933
1934 1934 # Minimum time above which compilation time will be reported
1935 1935 tc_min = 0.1
1936 1936
1937 1937 try:
1938 1938 mode = 'eval'
1939 1939 t0 = clock()
1940 1940 code = compile(expr,'<timed eval>',mode)
1941 1941 tc = clock()-t0
1942 1942 except SyntaxError:
1943 1943 mode = 'exec'
1944 1944 t0 = clock()
1945 1945 code = compile(expr,'<timed exec>',mode)
1946 1946 tc = clock()-t0
1947 1947 # skew measurement as little as possible
1948 1948 glob = self.shell.user_ns
1949 1949 locs = self._magic_locals
1950 1950 clk = clock2
1951 1951 wtime = time.time
1952 1952 # time execution
1953 1953 wall_st = wtime()
1954 1954 if mode=='eval':
1955 1955 st = clk()
1956 1956 out = eval(code, glob, locs)
1957 1957 end = clk()
1958 1958 else:
1959 1959 st = clk()
1960 1960 exec code in glob, locs
1961 1961 end = clk()
1962 1962 out = None
1963 1963 wall_end = wtime()
1964 1964 # Compute actual times and report
1965 1965 wall_time = wall_end-wall_st
1966 1966 cpu_user = end[0]-st[0]
1967 1967 cpu_sys = end[1]-st[1]
1968 1968 cpu_tot = cpu_user+cpu_sys
1969 1969 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
1970 1970 (cpu_user,cpu_sys,cpu_tot)
1971 1971 print "Wall time: %.2f s" % wall_time
1972 1972 if tc > tc_min:
1973 1973 print "Compiler : %.2f s" % tc
1974 1974 return out
1975 1975
1976 1976 @skip_doctest
1977 1977 def magic_macro(self,parameter_s = ''):
1978 1978 """Define a macro for future re-execution. It accepts ranges of history,
1979 1979 filenames or string objects.
1980 1980
1981 1981 Usage:\\
1982 1982 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
1983 1983
1984 1984 Options:
1985 1985
1986 1986 -r: use 'raw' input. By default, the 'processed' history is used,
1987 1987 so that magics are loaded in their transformed version to valid
1988 1988 Python. If this option is given, the raw input as typed as the
1989 1989 command line is used instead.
1990 1990
1991 1991 This will define a global variable called `name` which is a string
1992 1992 made of joining the slices and lines you specify (n1,n2,... numbers
1993 1993 above) from your input history into a single string. This variable
1994 1994 acts like an automatic function which re-executes those lines as if
1995 1995 you had typed them. You just type 'name' at the prompt and the code
1996 1996 executes.
1997 1997
1998 1998 The syntax for indicating input ranges is described in %history.
1999 1999
2000 2000 Note: as a 'hidden' feature, you can also use traditional python slice
2001 2001 notation, where N:M means numbers N through M-1.
2002 2002
2003 2003 For example, if your history contains (%hist prints it):
2004 2004
2005 2005 44: x=1
2006 2006 45: y=3
2007 2007 46: z=x+y
2008 2008 47: print x
2009 2009 48: a=5
2010 2010 49: print 'x',x,'y',y
2011 2011
2012 2012 you can create a macro with lines 44 through 47 (included) and line 49
2013 2013 called my_macro with:
2014 2014
2015 2015 In [55]: %macro my_macro 44-47 49
2016 2016
2017 2017 Now, typing `my_macro` (without quotes) will re-execute all this code
2018 2018 in one pass.
2019 2019
2020 2020 You don't need to give the line-numbers in order, and any given line
2021 2021 number can appear multiple times. You can assemble macros with any
2022 2022 lines from your input history in any order.
2023 2023
2024 2024 The macro is a simple object which holds its value in an attribute,
2025 2025 but IPython's display system checks for macros and executes them as
2026 2026 code instead of printing them when you type their name.
2027 2027
2028 2028 You can view a macro's contents by explicitly printing it with:
2029 2029
2030 2030 'print macro_name'.
2031 2031
2032 2032 """
2033 2033 opts,args = self.parse_options(parameter_s,'r',mode='list')
2034 2034 if not args: # List existing macros
2035 2035 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2036 2036 isinstance(v, Macro))
2037 2037 if len(args) == 1:
2038 2038 raise UsageError(
2039 2039 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2040 2040 name, codefrom = args[0], " ".join(args[1:])
2041 2041
2042 2042 #print 'rng',ranges # dbg
2043 2043 try:
2044 2044 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2045 2045 except (ValueError, TypeError) as e:
2046 2046 print e.args[0]
2047 2047 return
2048 2048 macro = Macro(lines)
2049 2049 self.shell.define_macro(name, macro)
2050 2050 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2051 2051 print '=== Macro contents: ==='
2052 2052 print macro,
2053 2053
2054 2054 def magic_save(self,parameter_s = ''):
2055 2055 """Save a set of lines or a macro to a given filename.
2056 2056
2057 2057 Usage:\\
2058 2058 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
2059 2059
2060 2060 Options:
2061 2061
2062 2062 -r: use 'raw' input. By default, the 'processed' history is used,
2063 2063 so that magics are loaded in their transformed version to valid
2064 2064 Python. If this option is given, the raw input as typed as the
2065 2065 command line is used instead.
2066 2066
2067 2067 This function uses the same syntax as %history for input ranges,
2068 2068 then saves the lines to the filename you specify.
2069 2069
2070 2070 It adds a '.py' extension to the file if you don't do so yourself, and
2071 2071 it asks for confirmation before overwriting existing files."""
2072 2072
2073 2073 opts,args = self.parse_options(parameter_s,'r',mode='list')
2074 2074 fname, codefrom = args[0], " ".join(args[1:])
2075 2075 if not fname.endswith('.py'):
2076 2076 fname += '.py'
2077 2077 if os.path.isfile(fname):
2078 2078 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
2079 2079 if ans.lower() not in ['y','yes']:
2080 2080 print 'Operation cancelled.'
2081 2081 return
2082 2082 try:
2083 2083 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
2084 2084 except (TypeError, ValueError) as e:
2085 2085 print e.args[0]
2086 2086 return
2087 2087 if isinstance(cmds, unicode):
2088 2088 cmds = cmds.encode("utf-8")
2089 2089 with open(fname,'w') as f:
2090 2090 f.write("# coding: utf-8\n")
2091 2091 f.write(cmds)
2092 2092 print 'The following commands were written to file `%s`:' % fname
2093 2093 print cmds
2094 2094
2095 2095 def magic_pastebin(self, parameter_s = ''):
2096 2096 """Upload code to the 'Lodge it' paste bin, returning the URL."""
2097 2097 try:
2098 2098 code = self.shell.find_user_code(parameter_s)
2099 2099 except (ValueError, TypeError) as e:
2100 2100 print e.args[0]
2101 2101 return
2102 2102 pbserver = ServerProxy('http://paste.pocoo.org/xmlrpc/')
2103 2103 id = pbserver.pastes.newPaste("python", code)
2104 2104 return "http://paste.pocoo.org/show/" + id
2105 2105
2106 2106 def magic_loadpy(self, arg_s):
2107 2107 """Load a .py python script into the GUI console.
2108 2108
2109 2109 This magic command can either take a local filename or a url::
2110 2110
2111 2111 %loadpy myscript.py
2112 2112 %loadpy http://www.example.com/myscript.py
2113 2113 """
2114 2114 if not arg_s.endswith('.py'):
2115 2115 raise ValueError('%%load only works with .py files: %s' % arg_s)
2116 2116 if arg_s.startswith('http'):
2117 2117 import urllib2
2118 2118 response = urllib2.urlopen(arg_s)
2119 2119 content = response.read()
2120 2120 else:
2121 2121 with open(arg_s) as f:
2122 2122 content = f.read()
2123 2123 self.set_next_input(content)
2124 2124
2125 2125 def _find_edit_target(self, args, opts, last_call):
2126 2126 """Utility method used by magic_edit to find what to edit."""
2127 2127
2128 2128 def make_filename(arg):
2129 2129 "Make a filename from the given args"
2130 2130 try:
2131 filename = get_py_filename(arg)
2131 filename = get_py_filename(arg, win32=sys.platform == 'win32')
2132 2132 except IOError:
2133 2133 # If it ends with .py but doesn't already exist, assume we want
2134 2134 # a new file.
2135 2135 if args.endswith('.py'):
2136 2136 filename = arg
2137 2137 else:
2138 2138 filename = None
2139 2139 return filename
2140 2140
2141 2141 # Set a few locals from the options for convenience:
2142 2142 opts_prev = 'p' in opts
2143 2143 opts_raw = 'r' in opts
2144 2144
2145 2145 # custom exceptions
2146 2146 class DataIsObject(Exception): pass
2147 2147
2148 2148 # Default line number value
2149 2149 lineno = opts.get('n',None)
2150 2150
2151 2151 if opts_prev:
2152 2152 args = '_%s' % last_call[0]
2153 2153 if not self.shell.user_ns.has_key(args):
2154 2154 args = last_call[1]
2155 2155
2156 2156 # use last_call to remember the state of the previous call, but don't
2157 2157 # let it be clobbered by successive '-p' calls.
2158 2158 try:
2159 2159 last_call[0] = self.shell.displayhook.prompt_count
2160 2160 if not opts_prev:
2161 2161 last_call[1] = parameter_s
2162 2162 except:
2163 2163 pass
2164 2164
2165 2165 # by default this is done with temp files, except when the given
2166 2166 # arg is a filename
2167 2167 use_temp = True
2168 2168
2169 2169 data = ''
2170 2170
2171 2171 # First, see if the arguments should be a filename.
2172 2172 filename = make_filename(args)
2173 2173 if filename:
2174 2174 use_temp = False
2175 2175 elif args:
2176 2176 # Mode where user specifies ranges of lines, like in %macro.
2177 2177 data = self.extract_input_lines(args, opts_raw)
2178 2178 if not data:
2179 2179 try:
2180 2180 # Load the parameter given as a variable. If not a string,
2181 2181 # process it as an object instead (below)
2182 2182
2183 2183 #print '*** args',args,'type',type(args) # dbg
2184 2184 data = eval(args, self.shell.user_ns)
2185 2185 if not isinstance(data, basestring):
2186 2186 raise DataIsObject
2187 2187
2188 2188 except (NameError,SyntaxError):
2189 2189 # given argument is not a variable, try as a filename
2190 2190 filename = make_filename(args)
2191 2191 if filename is None:
2192 2192 warn("Argument given (%s) can't be found as a variable "
2193 2193 "or as a filename." % args)
2194 2194 return
2195 2195 use_temp = False
2196 2196
2197 2197 except DataIsObject:
2198 2198 # macros have a special edit function
2199 2199 if isinstance(data, Macro):
2200 2200 raise MacroToEdit(data)
2201 2201
2202 2202 # For objects, try to edit the file where they are defined
2203 2203 try:
2204 2204 filename = inspect.getabsfile(data)
2205 2205 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2206 2206 # class created by %edit? Try to find source
2207 2207 # by looking for method definitions instead, the
2208 2208 # __module__ in those classes is FakeModule.
2209 2209 attrs = [getattr(data, aname) for aname in dir(data)]
2210 2210 for attr in attrs:
2211 2211 if not inspect.ismethod(attr):
2212 2212 continue
2213 2213 filename = inspect.getabsfile(attr)
2214 2214 if filename and 'fakemodule' not in filename.lower():
2215 2215 # change the attribute to be the edit target instead
2216 2216 data = attr
2217 2217 break
2218 2218
2219 2219 datafile = 1
2220 2220 except TypeError:
2221 2221 filename = make_filename(args)
2222 2222 datafile = 1
2223 2223 warn('Could not find file where `%s` is defined.\n'
2224 2224 'Opening a file named `%s`' % (args,filename))
2225 2225 # Now, make sure we can actually read the source (if it was in
2226 2226 # a temp file it's gone by now).
2227 2227 if datafile:
2228 2228 try:
2229 2229 if lineno is None:
2230 2230 lineno = inspect.getsourcelines(data)[1]
2231 2231 except IOError:
2232 2232 filename = make_filename(args)
2233 2233 if filename is None:
2234 2234 warn('The file `%s` where `%s` was defined cannot '
2235 2235 'be read.' % (filename,data))
2236 2236 return
2237 2237 use_temp = False
2238 2238
2239 2239 if use_temp:
2240 2240 filename = self.shell.mktempfile(data)
2241 2241 print 'IPython will make a temporary file named:',filename
2242 2242
2243 2243 return filename, lineno, use_temp
2244 2244
2245 2245 def _edit_macro(self,mname,macro):
2246 2246 """open an editor with the macro data in a file"""
2247 2247 filename = self.shell.mktempfile(macro.value)
2248 2248 self.shell.hooks.editor(filename)
2249 2249
2250 2250 # and make a new macro object, to replace the old one
2251 2251 mfile = open(filename)
2252 2252 mvalue = mfile.read()
2253 2253 mfile.close()
2254 2254 self.shell.user_ns[mname] = Macro(mvalue)
2255 2255
2256 2256 def magic_ed(self,parameter_s=''):
2257 2257 """Alias to %edit."""
2258 2258 return self.magic_edit(parameter_s)
2259 2259
2260 2260 @skip_doctest
2261 2261 def magic_edit(self,parameter_s='',last_call=['','']):
2262 2262 """Bring up an editor and execute the resulting code.
2263 2263
2264 2264 Usage:
2265 2265 %edit [options] [args]
2266 2266
2267 2267 %edit runs IPython's editor hook. The default version of this hook is
2268 2268 set to call the __IPYTHON__.rc.editor command. This is read from your
2269 2269 environment variable $EDITOR. If this isn't found, it will default to
2270 2270 vi under Linux/Unix and to notepad under Windows. See the end of this
2271 2271 docstring for how to change the editor hook.
2272 2272
2273 2273 You can also set the value of this editor via the command line option
2274 2274 '-editor' or in your ipythonrc file. This is useful if you wish to use
2275 2275 specifically for IPython an editor different from your typical default
2276 2276 (and for Windows users who typically don't set environment variables).
2277 2277
2278 2278 This command allows you to conveniently edit multi-line code right in
2279 2279 your IPython session.
2280 2280
2281 2281 If called without arguments, %edit opens up an empty editor with a
2282 2282 temporary file and will execute the contents of this file when you
2283 2283 close it (don't forget to save it!).
2284 2284
2285 2285
2286 2286 Options:
2287 2287
2288 2288 -n <number>: open the editor at a specified line number. By default,
2289 2289 the IPython editor hook uses the unix syntax 'editor +N filename', but
2290 2290 you can configure this by providing your own modified hook if your
2291 2291 favorite editor supports line-number specifications with a different
2292 2292 syntax.
2293 2293
2294 2294 -p: this will call the editor with the same data as the previous time
2295 2295 it was used, regardless of how long ago (in your current session) it
2296 2296 was.
2297 2297
2298 2298 -r: use 'raw' input. This option only applies to input taken from the
2299 2299 user's history. By default, the 'processed' history is used, so that
2300 2300 magics are loaded in their transformed version to valid Python. If
2301 2301 this option is given, the raw input as typed as the command line is
2302 2302 used instead. When you exit the editor, it will be executed by
2303 2303 IPython's own processor.
2304 2304
2305 2305 -x: do not execute the edited code immediately upon exit. This is
2306 2306 mainly useful if you are editing programs which need to be called with
2307 2307 command line arguments, which you can then do using %run.
2308 2308
2309 2309
2310 2310 Arguments:
2311 2311
2312 2312 If arguments are given, the following possibilites exist:
2313 2313
2314 2314 - If the argument is a filename, IPython will load that into the
2315 2315 editor. It will execute its contents with execfile() when you exit,
2316 2316 loading any code in the file into your interactive namespace.
2317 2317
2318 2318 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
2319 2319 The syntax is the same as in the %history magic.
2320 2320
2321 2321 - If the argument is a string variable, its contents are loaded
2322 2322 into the editor. You can thus edit any string which contains
2323 2323 python code (including the result of previous edits).
2324 2324
2325 2325 - If the argument is the name of an object (other than a string),
2326 2326 IPython will try to locate the file where it was defined and open the
2327 2327 editor at the point where it is defined. You can use `%edit function`
2328 2328 to load an editor exactly at the point where 'function' is defined,
2329 2329 edit it and have the file be executed automatically.
2330 2330
2331 2331 If the object is a macro (see %macro for details), this opens up your
2332 2332 specified editor with a temporary file containing the macro's data.
2333 2333 Upon exit, the macro is reloaded with the contents of the file.
2334 2334
2335 2335 Note: opening at an exact line is only supported under Unix, and some
2336 2336 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2337 2337 '+NUMBER' parameter necessary for this feature. Good editors like
2338 2338 (X)Emacs, vi, jed, pico and joe all do.
2339 2339
2340 2340 After executing your code, %edit will return as output the code you
2341 2341 typed in the editor (except when it was an existing file). This way
2342 2342 you can reload the code in further invocations of %edit as a variable,
2343 2343 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2344 2344 the output.
2345 2345
2346 2346 Note that %edit is also available through the alias %ed.
2347 2347
2348 2348 This is an example of creating a simple function inside the editor and
2349 2349 then modifying it. First, start up the editor:
2350 2350
2351 2351 In [1]: ed
2352 2352 Editing... done. Executing edited code...
2353 2353 Out[1]: 'def foo():n print "foo() was defined in an editing session"n'
2354 2354
2355 2355 We can then call the function foo():
2356 2356
2357 2357 In [2]: foo()
2358 2358 foo() was defined in an editing session
2359 2359
2360 2360 Now we edit foo. IPython automatically loads the editor with the
2361 2361 (temporary) file where foo() was previously defined:
2362 2362
2363 2363 In [3]: ed foo
2364 2364 Editing... done. Executing edited code...
2365 2365
2366 2366 And if we call foo() again we get the modified version:
2367 2367
2368 2368 In [4]: foo()
2369 2369 foo() has now been changed!
2370 2370
2371 2371 Here is an example of how to edit a code snippet successive
2372 2372 times. First we call the editor:
2373 2373
2374 2374 In [5]: ed
2375 2375 Editing... done. Executing edited code...
2376 2376 hello
2377 2377 Out[5]: "print 'hello'n"
2378 2378
2379 2379 Now we call it again with the previous output (stored in _):
2380 2380
2381 2381 In [6]: ed _
2382 2382 Editing... done. Executing edited code...
2383 2383 hello world
2384 2384 Out[6]: "print 'hello world'n"
2385 2385
2386 2386 Now we call it with the output #8 (stored in _8, also as Out[8]):
2387 2387
2388 2388 In [7]: ed _8
2389 2389 Editing... done. Executing edited code...
2390 2390 hello again
2391 2391 Out[7]: "print 'hello again'n"
2392 2392
2393 2393
2394 2394 Changing the default editor hook:
2395 2395
2396 2396 If you wish to write your own editor hook, you can put it in a
2397 2397 configuration file which you load at startup time. The default hook
2398 2398 is defined in the IPython.core.hooks module, and you can use that as a
2399 2399 starting example for further modifications. That file also has
2400 2400 general instructions on how to set a new hook for use once you've
2401 2401 defined it."""
2402 2402 opts,args = self.parse_options(parameter_s,'prxn:')
2403 2403
2404 2404 try:
2405 2405 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
2406 2406 except MacroToEdit as e:
2407 2407 self._edit_macro(args, e.args[0])
2408 2408 return
2409 2409
2410 2410 # do actual editing here
2411 2411 print 'Editing...',
2412 2412 sys.stdout.flush()
2413 2413 try:
2414 2414 # Quote filenames that may have spaces in them
2415 2415 if ' ' in filename:
2416 2416 filename = "'%s'" % filename
2417 2417 self.shell.hooks.editor(filename,lineno)
2418 2418 except TryNext:
2419 2419 warn('Could not open editor')
2420 2420 return
2421 2421
2422 2422 # XXX TODO: should this be generalized for all string vars?
2423 2423 # For now, this is special-cased to blocks created by cpaste
2424 2424 if args.strip() == 'pasted_block':
2425 2425 self.shell.user_ns['pasted_block'] = file_read(filename)
2426 2426
2427 2427 if 'x' in opts: # -x prevents actual execution
2428 2428 print
2429 2429 else:
2430 2430 print 'done. Executing edited code...'
2431 2431 if 'r' in opts: # Untranslated IPython code
2432 2432 self.shell.run_cell(file_read(filename),
2433 2433 store_history=False)
2434 2434 else:
2435 2435 self.shell.safe_execfile(filename,self.shell.user_ns,
2436 2436 self.shell.user_ns)
2437 2437
2438 2438 if is_temp:
2439 2439 try:
2440 2440 return open(filename).read()
2441 2441 except IOError,msg:
2442 2442 if msg.filename == filename:
2443 2443 warn('File not found. Did you forget to save?')
2444 2444 return
2445 2445 else:
2446 2446 self.shell.showtraceback()
2447 2447
2448 2448 def magic_xmode(self,parameter_s = ''):
2449 2449 """Switch modes for the exception handlers.
2450 2450
2451 2451 Valid modes: Plain, Context and Verbose.
2452 2452
2453 2453 If called without arguments, acts as a toggle."""
2454 2454
2455 2455 def xmode_switch_err(name):
2456 2456 warn('Error changing %s exception modes.\n%s' %
2457 2457 (name,sys.exc_info()[1]))
2458 2458
2459 2459 shell = self.shell
2460 2460 new_mode = parameter_s.strip().capitalize()
2461 2461 try:
2462 2462 shell.InteractiveTB.set_mode(mode=new_mode)
2463 2463 print 'Exception reporting mode:',shell.InteractiveTB.mode
2464 2464 except:
2465 2465 xmode_switch_err('user')
2466 2466
2467 2467 def magic_colors(self,parameter_s = ''):
2468 2468 """Switch color scheme for prompts, info system and exception handlers.
2469 2469
2470 2470 Currently implemented schemes: NoColor, Linux, LightBG.
2471 2471
2472 2472 Color scheme names are not case-sensitive.
2473 2473
2474 2474 Examples
2475 2475 --------
2476 2476 To get a plain black and white terminal::
2477 2477
2478 2478 %colors nocolor
2479 2479 """
2480 2480
2481 2481 def color_switch_err(name):
2482 2482 warn('Error changing %s color schemes.\n%s' %
2483 2483 (name,sys.exc_info()[1]))
2484 2484
2485 2485
2486 2486 new_scheme = parameter_s.strip()
2487 2487 if not new_scheme:
2488 2488 raise UsageError(
2489 2489 "%colors: you must specify a color scheme. See '%colors?'")
2490 2490 return
2491 2491 # local shortcut
2492 2492 shell = self.shell
2493 2493
2494 2494 import IPython.utils.rlineimpl as readline
2495 2495
2496 2496 if not readline.have_readline and sys.platform == "win32":
2497 2497 msg = """\
2498 2498 Proper color support under MS Windows requires the pyreadline library.
2499 2499 You can find it at:
2500 2500 http://ipython.scipy.org/moin/PyReadline/Intro
2501 2501 Gary's readline needs the ctypes module, from:
2502 2502 http://starship.python.net/crew/theller/ctypes
2503 2503 (Note that ctypes is already part of Python versions 2.5 and newer).
2504 2504
2505 2505 Defaulting color scheme to 'NoColor'"""
2506 2506 new_scheme = 'NoColor'
2507 2507 warn(msg)
2508 2508
2509 2509 # readline option is 0
2510 2510 if not shell.has_readline:
2511 2511 new_scheme = 'NoColor'
2512 2512
2513 2513 # Set prompt colors
2514 2514 try:
2515 2515 shell.displayhook.set_colors(new_scheme)
2516 2516 except:
2517 2517 color_switch_err('prompt')
2518 2518 else:
2519 2519 shell.colors = \
2520 2520 shell.displayhook.color_table.active_scheme_name
2521 2521 # Set exception colors
2522 2522 try:
2523 2523 shell.InteractiveTB.set_colors(scheme = new_scheme)
2524 2524 shell.SyntaxTB.set_colors(scheme = new_scheme)
2525 2525 except:
2526 2526 color_switch_err('exception')
2527 2527
2528 2528 # Set info (for 'object?') colors
2529 2529 if shell.color_info:
2530 2530 try:
2531 2531 shell.inspector.set_active_scheme(new_scheme)
2532 2532 except:
2533 2533 color_switch_err('object inspector')
2534 2534 else:
2535 2535 shell.inspector.set_active_scheme('NoColor')
2536 2536
2537 2537 def magic_pprint(self, parameter_s=''):
2538 2538 """Toggle pretty printing on/off."""
2539 2539 ptformatter = self.shell.display_formatter.formatters['text/plain']
2540 2540 ptformatter.pprint = bool(1 - ptformatter.pprint)
2541 2541 print 'Pretty printing has been turned', \
2542 2542 ['OFF','ON'][ptformatter.pprint]
2543 2543
2544 2544 #......................................................................
2545 2545 # Functions to implement unix shell-type things
2546 2546
2547 2547 @skip_doctest
2548 2548 def magic_alias(self, parameter_s = ''):
2549 2549 """Define an alias for a system command.
2550 2550
2551 2551 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2552 2552
2553 2553 Then, typing 'alias_name params' will execute the system command 'cmd
2554 2554 params' (from your underlying operating system).
2555 2555
2556 2556 Aliases have lower precedence than magic functions and Python normal
2557 2557 variables, so if 'foo' is both a Python variable and an alias, the
2558 2558 alias can not be executed until 'del foo' removes the Python variable.
2559 2559
2560 2560 You can use the %l specifier in an alias definition to represent the
2561 2561 whole line when the alias is called. For example:
2562 2562
2563 2563 In [2]: alias bracket echo "Input in brackets: <%l>"
2564 2564 In [3]: bracket hello world
2565 2565 Input in brackets: <hello world>
2566 2566
2567 2567 You can also define aliases with parameters using %s specifiers (one
2568 2568 per parameter):
2569 2569
2570 2570 In [1]: alias parts echo first %s second %s
2571 2571 In [2]: %parts A B
2572 2572 first A second B
2573 2573 In [3]: %parts A
2574 2574 Incorrect number of arguments: 2 expected.
2575 2575 parts is an alias to: 'echo first %s second %s'
2576 2576
2577 2577 Note that %l and %s are mutually exclusive. You can only use one or
2578 2578 the other in your aliases.
2579 2579
2580 2580 Aliases expand Python variables just like system calls using ! or !!
2581 2581 do: all expressions prefixed with '$' get expanded. For details of
2582 2582 the semantic rules, see PEP-215:
2583 2583 http://www.python.org/peps/pep-0215.html. This is the library used by
2584 2584 IPython for variable expansion. If you want to access a true shell
2585 2585 variable, an extra $ is necessary to prevent its expansion by IPython:
2586 2586
2587 2587 In [6]: alias show echo
2588 2588 In [7]: PATH='A Python string'
2589 2589 In [8]: show $PATH
2590 2590 A Python string
2591 2591 In [9]: show $$PATH
2592 2592 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2593 2593
2594 2594 You can use the alias facility to acess all of $PATH. See the %rehash
2595 2595 and %rehashx functions, which automatically create aliases for the
2596 2596 contents of your $PATH.
2597 2597
2598 2598 If called with no parameters, %alias prints the current alias table."""
2599 2599
2600 2600 par = parameter_s.strip()
2601 2601 if not par:
2602 2602 stored = self.db.get('stored_aliases', {} )
2603 2603 aliases = sorted(self.shell.alias_manager.aliases)
2604 2604 # for k, v in stored:
2605 2605 # atab.append(k, v[0])
2606 2606
2607 2607 print "Total number of aliases:", len(aliases)
2608 2608 sys.stdout.flush()
2609 2609 return aliases
2610 2610
2611 2611 # Now try to define a new one
2612 2612 try:
2613 2613 alias,cmd = par.split(None, 1)
2614 2614 except:
2615 2615 print oinspect.getdoc(self.magic_alias)
2616 2616 else:
2617 2617 self.shell.alias_manager.soft_define_alias(alias, cmd)
2618 2618 # end magic_alias
2619 2619
2620 2620 def magic_unalias(self, parameter_s = ''):
2621 2621 """Remove an alias"""
2622 2622
2623 2623 aname = parameter_s.strip()
2624 2624 self.shell.alias_manager.undefine_alias(aname)
2625 2625 stored = self.db.get('stored_aliases', {} )
2626 2626 if aname in stored:
2627 2627 print "Removing %stored alias",aname
2628 2628 del stored[aname]
2629 2629 self.db['stored_aliases'] = stored
2630 2630
2631 2631 def magic_rehashx(self, parameter_s = ''):
2632 2632 """Update the alias table with all executable files in $PATH.
2633 2633
2634 2634 This version explicitly checks that every entry in $PATH is a file
2635 2635 with execute access (os.X_OK), so it is much slower than %rehash.
2636 2636
2637 2637 Under Windows, it checks executability as a match agains a
2638 2638 '|'-separated string of extensions, stored in the IPython config
2639 2639 variable win_exec_ext. This defaults to 'exe|com|bat'.
2640 2640
2641 2641 This function also resets the root module cache of module completer,
2642 2642 used on slow filesystems.
2643 2643 """
2644 2644 from IPython.core.alias import InvalidAliasError
2645 2645
2646 2646 # for the benefit of module completer in ipy_completers.py
2647 2647 del self.db['rootmodules']
2648 2648
2649 2649 path = [os.path.abspath(os.path.expanduser(p)) for p in
2650 2650 os.environ.get('PATH','').split(os.pathsep)]
2651 2651 path = filter(os.path.isdir,path)
2652 2652
2653 2653 syscmdlist = []
2654 2654 # Now define isexec in a cross platform manner.
2655 2655 if os.name == 'posix':
2656 2656 isexec = lambda fname:os.path.isfile(fname) and \
2657 2657 os.access(fname,os.X_OK)
2658 2658 else:
2659 2659 try:
2660 2660 winext = os.environ['pathext'].replace(';','|').replace('.','')
2661 2661 except KeyError:
2662 2662 winext = 'exe|com|bat|py'
2663 2663 if 'py' not in winext:
2664 2664 winext += '|py'
2665 2665 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2666 2666 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2667 2667 savedir = os.getcwdu()
2668 2668
2669 2669 # Now walk the paths looking for executables to alias.
2670 2670 try:
2671 2671 # write the whole loop for posix/Windows so we don't have an if in
2672 2672 # the innermost part
2673 2673 if os.name == 'posix':
2674 2674 for pdir in path:
2675 2675 os.chdir(pdir)
2676 2676 for ff in os.listdir(pdir):
2677 2677 if isexec(ff):
2678 2678 try:
2679 2679 # Removes dots from the name since ipython
2680 2680 # will assume names with dots to be python.
2681 2681 self.shell.alias_manager.define_alias(
2682 2682 ff.replace('.',''), ff)
2683 2683 except InvalidAliasError:
2684 2684 pass
2685 2685 else:
2686 2686 syscmdlist.append(ff)
2687 2687 else:
2688 2688 no_alias = self.shell.alias_manager.no_alias
2689 2689 for pdir in path:
2690 2690 os.chdir(pdir)
2691 2691 for ff in os.listdir(pdir):
2692 2692 base, ext = os.path.splitext(ff)
2693 2693 if isexec(ff) and base.lower() not in no_alias:
2694 2694 if ext.lower() == '.exe':
2695 2695 ff = base
2696 2696 try:
2697 2697 # Removes dots from the name since ipython
2698 2698 # will assume names with dots to be python.
2699 2699 self.shell.alias_manager.define_alias(
2700 2700 base.lower().replace('.',''), ff)
2701 2701 except InvalidAliasError:
2702 2702 pass
2703 2703 syscmdlist.append(ff)
2704 2704 db = self.db
2705 2705 db['syscmdlist'] = syscmdlist
2706 2706 finally:
2707 2707 os.chdir(savedir)
2708 2708
2709 2709 @skip_doctest
2710 2710 def magic_pwd(self, parameter_s = ''):
2711 2711 """Return the current working directory path.
2712 2712
2713 2713 Examples
2714 2714 --------
2715 2715 ::
2716 2716
2717 2717 In [9]: pwd
2718 2718 Out[9]: '/home/tsuser/sprint/ipython'
2719 2719 """
2720 2720 return os.getcwdu()
2721 2721
2722 2722 @skip_doctest
2723 2723 def magic_cd(self, parameter_s=''):
2724 2724 """Change the current working directory.
2725 2725
2726 2726 This command automatically maintains an internal list of directories
2727 2727 you visit during your IPython session, in the variable _dh. The
2728 2728 command %dhist shows this history nicely formatted. You can also
2729 2729 do 'cd -<tab>' to see directory history conveniently.
2730 2730
2731 2731 Usage:
2732 2732
2733 2733 cd 'dir': changes to directory 'dir'.
2734 2734
2735 2735 cd -: changes to the last visited directory.
2736 2736
2737 2737 cd -<n>: changes to the n-th directory in the directory history.
2738 2738
2739 2739 cd --foo: change to directory that matches 'foo' in history
2740 2740
2741 2741 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2742 2742 (note: cd <bookmark_name> is enough if there is no
2743 2743 directory <bookmark_name>, but a bookmark with the name exists.)
2744 2744 'cd -b <tab>' allows you to tab-complete bookmark names.
2745 2745
2746 2746 Options:
2747 2747
2748 2748 -q: quiet. Do not print the working directory after the cd command is
2749 2749 executed. By default IPython's cd command does print this directory,
2750 2750 since the default prompts do not display path information.
2751 2751
2752 2752 Note that !cd doesn't work for this purpose because the shell where
2753 2753 !command runs is immediately discarded after executing 'command'.
2754 2754
2755 2755 Examples
2756 2756 --------
2757 2757 ::
2758 2758
2759 2759 In [10]: cd parent/child
2760 2760 /home/tsuser/parent/child
2761 2761 """
2762 2762
2763 2763 parameter_s = parameter_s.strip()
2764 2764 #bkms = self.shell.persist.get("bookmarks",{})
2765 2765
2766 2766 oldcwd = os.getcwdu()
2767 2767 numcd = re.match(r'(-)(\d+)$',parameter_s)
2768 2768 # jump in directory history by number
2769 2769 if numcd:
2770 2770 nn = int(numcd.group(2))
2771 2771 try:
2772 2772 ps = self.shell.user_ns['_dh'][nn]
2773 2773 except IndexError:
2774 2774 print 'The requested directory does not exist in history.'
2775 2775 return
2776 2776 else:
2777 2777 opts = {}
2778 2778 elif parameter_s.startswith('--'):
2779 2779 ps = None
2780 2780 fallback = None
2781 2781 pat = parameter_s[2:]
2782 2782 dh = self.shell.user_ns['_dh']
2783 2783 # first search only by basename (last component)
2784 2784 for ent in reversed(dh):
2785 2785 if pat in os.path.basename(ent) and os.path.isdir(ent):
2786 2786 ps = ent
2787 2787 break
2788 2788
2789 2789 if fallback is None and pat in ent and os.path.isdir(ent):
2790 2790 fallback = ent
2791 2791
2792 2792 # if we have no last part match, pick the first full path match
2793 2793 if ps is None:
2794 2794 ps = fallback
2795 2795
2796 2796 if ps is None:
2797 2797 print "No matching entry in directory history"
2798 2798 return
2799 2799 else:
2800 2800 opts = {}
2801 2801
2802 2802
2803 2803 else:
2804 2804 #turn all non-space-escaping backslashes to slashes,
2805 2805 # for c:\windows\directory\names\
2806 2806 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2807 2807 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2808 2808 # jump to previous
2809 2809 if ps == '-':
2810 2810 try:
2811 2811 ps = self.shell.user_ns['_dh'][-2]
2812 2812 except IndexError:
2813 2813 raise UsageError('%cd -: No previous directory to change to.')
2814 2814 # jump to bookmark if needed
2815 2815 else:
2816 2816 if not os.path.isdir(ps) or opts.has_key('b'):
2817 2817 bkms = self.db.get('bookmarks', {})
2818 2818
2819 2819 if bkms.has_key(ps):
2820 2820 target = bkms[ps]
2821 2821 print '(bookmark:%s) -> %s' % (ps,target)
2822 2822 ps = target
2823 2823 else:
2824 2824 if opts.has_key('b'):
2825 2825 raise UsageError("Bookmark '%s' not found. "
2826 2826 "Use '%%bookmark -l' to see your bookmarks." % ps)
2827 2827
2828 2828 # strip extra quotes on Windows, because os.chdir doesn't like them
2829 2829 if sys.platform == 'win32':
2830 2830 ps = ps.strip('\'"')
2831 2831 # at this point ps should point to the target dir
2832 2832 if ps:
2833 2833 try:
2834 2834 os.chdir(os.path.expanduser(ps))
2835 2835 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2836 2836 set_term_title('IPython: ' + abbrev_cwd())
2837 2837 except OSError:
2838 2838 print sys.exc_info()[1]
2839 2839 else:
2840 2840 cwd = os.getcwdu()
2841 2841 dhist = self.shell.user_ns['_dh']
2842 2842 if oldcwd != cwd:
2843 2843 dhist.append(cwd)
2844 2844 self.db['dhist'] = compress_dhist(dhist)[-100:]
2845 2845
2846 2846 else:
2847 2847 os.chdir(self.shell.home_dir)
2848 2848 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2849 2849 set_term_title('IPython: ' + '~')
2850 2850 cwd = os.getcwdu()
2851 2851 dhist = self.shell.user_ns['_dh']
2852 2852
2853 2853 if oldcwd != cwd:
2854 2854 dhist.append(cwd)
2855 2855 self.db['dhist'] = compress_dhist(dhist)[-100:]
2856 2856 if not 'q' in opts and self.shell.user_ns['_dh']:
2857 2857 print self.shell.user_ns['_dh'][-1]
2858 2858
2859 2859
2860 2860 def magic_env(self, parameter_s=''):
2861 2861 """List environment variables."""
2862 2862
2863 2863 return os.environ.data
2864 2864
2865 2865 def magic_pushd(self, parameter_s=''):
2866 2866 """Place the current dir on stack and change directory.
2867 2867
2868 2868 Usage:\\
2869 2869 %pushd ['dirname']
2870 2870 """
2871 2871
2872 2872 dir_s = self.shell.dir_stack
2873 2873 tgt = os.path.expanduser(parameter_s)
2874 2874 cwd = os.getcwdu().replace(self.home_dir,'~')
2875 2875 if tgt:
2876 2876 self.magic_cd(parameter_s)
2877 2877 dir_s.insert(0,cwd)
2878 2878 return self.magic_dirs()
2879 2879
2880 2880 def magic_popd(self, parameter_s=''):
2881 2881 """Change to directory popped off the top of the stack.
2882 2882 """
2883 2883 if not self.shell.dir_stack:
2884 2884 raise UsageError("%popd on empty stack")
2885 2885 top = self.shell.dir_stack.pop(0)
2886 2886 self.magic_cd(top)
2887 2887 print "popd ->",top
2888 2888
2889 2889 def magic_dirs(self, parameter_s=''):
2890 2890 """Return the current directory stack."""
2891 2891
2892 2892 return self.shell.dir_stack
2893 2893
2894 2894 def magic_dhist(self, parameter_s=''):
2895 2895 """Print your history of visited directories.
2896 2896
2897 2897 %dhist -> print full history\\
2898 2898 %dhist n -> print last n entries only\\
2899 2899 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
2900 2900
2901 2901 This history is automatically maintained by the %cd command, and
2902 2902 always available as the global list variable _dh. You can use %cd -<n>
2903 2903 to go to directory number <n>.
2904 2904
2905 2905 Note that most of time, you should view directory history by entering
2906 2906 cd -<TAB>.
2907 2907
2908 2908 """
2909 2909
2910 2910 dh = self.shell.user_ns['_dh']
2911 2911 if parameter_s:
2912 2912 try:
2913 2913 args = map(int,parameter_s.split())
2914 2914 except:
2915 2915 self.arg_err(Magic.magic_dhist)
2916 2916 return
2917 2917 if len(args) == 1:
2918 2918 ini,fin = max(len(dh)-(args[0]),0),len(dh)
2919 2919 elif len(args) == 2:
2920 2920 ini,fin = args
2921 2921 else:
2922 2922 self.arg_err(Magic.magic_dhist)
2923 2923 return
2924 2924 else:
2925 2925 ini,fin = 0,len(dh)
2926 2926 nlprint(dh,
2927 2927 header = 'Directory history (kept in _dh)',
2928 2928 start=ini,stop=fin)
2929 2929
2930 2930 @skip_doctest
2931 2931 def magic_sc(self, parameter_s=''):
2932 2932 """Shell capture - execute a shell command and capture its output.
2933 2933
2934 2934 DEPRECATED. Suboptimal, retained for backwards compatibility.
2935 2935
2936 2936 You should use the form 'var = !command' instead. Example:
2937 2937
2938 2938 "%sc -l myfiles = ls ~" should now be written as
2939 2939
2940 2940 "myfiles = !ls ~"
2941 2941
2942 2942 myfiles.s, myfiles.l and myfiles.n still apply as documented
2943 2943 below.
2944 2944
2945 2945 --
2946 2946 %sc [options] varname=command
2947 2947
2948 2948 IPython will run the given command using commands.getoutput(), and
2949 2949 will then update the user's interactive namespace with a variable
2950 2950 called varname, containing the value of the call. Your command can
2951 2951 contain shell wildcards, pipes, etc.
2952 2952
2953 2953 The '=' sign in the syntax is mandatory, and the variable name you
2954 2954 supply must follow Python's standard conventions for valid names.
2955 2955
2956 2956 (A special format without variable name exists for internal use)
2957 2957
2958 2958 Options:
2959 2959
2960 2960 -l: list output. Split the output on newlines into a list before
2961 2961 assigning it to the given variable. By default the output is stored
2962 2962 as a single string.
2963 2963
2964 2964 -v: verbose. Print the contents of the variable.
2965 2965
2966 2966 In most cases you should not need to split as a list, because the
2967 2967 returned value is a special type of string which can automatically
2968 2968 provide its contents either as a list (split on newlines) or as a
2969 2969 space-separated string. These are convenient, respectively, either
2970 2970 for sequential processing or to be passed to a shell command.
2971 2971
2972 2972 For example:
2973 2973
2974 2974 # all-random
2975 2975
2976 2976 # Capture into variable a
2977 2977 In [1]: sc a=ls *py
2978 2978
2979 2979 # a is a string with embedded newlines
2980 2980 In [2]: a
2981 2981 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
2982 2982
2983 2983 # which can be seen as a list:
2984 2984 In [3]: a.l
2985 2985 Out[3]: ['setup.py', 'win32_manual_post_install.py']
2986 2986
2987 2987 # or as a whitespace-separated string:
2988 2988 In [4]: a.s
2989 2989 Out[4]: 'setup.py win32_manual_post_install.py'
2990 2990
2991 2991 # a.s is useful to pass as a single command line:
2992 2992 In [5]: !wc -l $a.s
2993 2993 146 setup.py
2994 2994 130 win32_manual_post_install.py
2995 2995 276 total
2996 2996
2997 2997 # while the list form is useful to loop over:
2998 2998 In [6]: for f in a.l:
2999 2999 ...: !wc -l $f
3000 3000 ...:
3001 3001 146 setup.py
3002 3002 130 win32_manual_post_install.py
3003 3003
3004 3004 Similiarly, the lists returned by the -l option are also special, in
3005 3005 the sense that you can equally invoke the .s attribute on them to
3006 3006 automatically get a whitespace-separated string from their contents:
3007 3007
3008 3008 In [7]: sc -l b=ls *py
3009 3009
3010 3010 In [8]: b
3011 3011 Out[8]: ['setup.py', 'win32_manual_post_install.py']
3012 3012
3013 3013 In [9]: b.s
3014 3014 Out[9]: 'setup.py win32_manual_post_install.py'
3015 3015
3016 3016 In summary, both the lists and strings used for ouptut capture have
3017 3017 the following special attributes:
3018 3018
3019 3019 .l (or .list) : value as list.
3020 3020 .n (or .nlstr): value as newline-separated string.
3021 3021 .s (or .spstr): value as space-separated string.
3022 3022 """
3023 3023
3024 3024 opts,args = self.parse_options(parameter_s,'lv')
3025 3025 # Try to get a variable name and command to run
3026 3026 try:
3027 3027 # the variable name must be obtained from the parse_options
3028 3028 # output, which uses shlex.split to strip options out.
3029 3029 var,_ = args.split('=',1)
3030 3030 var = var.strip()
3031 3031 # But the the command has to be extracted from the original input
3032 3032 # parameter_s, not on what parse_options returns, to avoid the
3033 3033 # quote stripping which shlex.split performs on it.
3034 3034 _,cmd = parameter_s.split('=',1)
3035 3035 except ValueError:
3036 3036 var,cmd = '',''
3037 3037 # If all looks ok, proceed
3038 3038 split = 'l' in opts
3039 3039 out = self.shell.getoutput(cmd, split=split)
3040 3040 if opts.has_key('v'):
3041 3041 print '%s ==\n%s' % (var,pformat(out))
3042 3042 if var:
3043 3043 self.shell.user_ns.update({var:out})
3044 3044 else:
3045 3045 return out
3046 3046
3047 3047 def magic_sx(self, parameter_s=''):
3048 3048 """Shell execute - run a shell command and capture its output.
3049 3049
3050 3050 %sx command
3051 3051
3052 3052 IPython will run the given command using commands.getoutput(), and
3053 3053 return the result formatted as a list (split on '\\n'). Since the
3054 3054 output is _returned_, it will be stored in ipython's regular output
3055 3055 cache Out[N] and in the '_N' automatic variables.
3056 3056
3057 3057 Notes:
3058 3058
3059 3059 1) If an input line begins with '!!', then %sx is automatically
3060 3060 invoked. That is, while:
3061 3061 !ls
3062 3062 causes ipython to simply issue system('ls'), typing
3063 3063 !!ls
3064 3064 is a shorthand equivalent to:
3065 3065 %sx ls
3066 3066
3067 3067 2) %sx differs from %sc in that %sx automatically splits into a list,
3068 3068 like '%sc -l'. The reason for this is to make it as easy as possible
3069 3069 to process line-oriented shell output via further python commands.
3070 3070 %sc is meant to provide much finer control, but requires more
3071 3071 typing.
3072 3072
3073 3073 3) Just like %sc -l, this is a list with special attributes:
3074 3074
3075 3075 .l (or .list) : value as list.
3076 3076 .n (or .nlstr): value as newline-separated string.
3077 3077 .s (or .spstr): value as whitespace-separated string.
3078 3078
3079 3079 This is very useful when trying to use such lists as arguments to
3080 3080 system commands."""
3081 3081
3082 3082 if parameter_s:
3083 3083 return self.shell.getoutput(parameter_s)
3084 3084
3085 3085
3086 3086 def magic_bookmark(self, parameter_s=''):
3087 3087 """Manage IPython's bookmark system.
3088 3088
3089 3089 %bookmark <name> - set bookmark to current dir
3090 3090 %bookmark <name> <dir> - set bookmark to <dir>
3091 3091 %bookmark -l - list all bookmarks
3092 3092 %bookmark -d <name> - remove bookmark
3093 3093 %bookmark -r - remove all bookmarks
3094 3094
3095 3095 You can later on access a bookmarked folder with:
3096 3096 %cd -b <name>
3097 3097 or simply '%cd <name>' if there is no directory called <name> AND
3098 3098 there is such a bookmark defined.
3099 3099
3100 3100 Your bookmarks persist through IPython sessions, but they are
3101 3101 associated with each profile."""
3102 3102
3103 3103 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3104 3104 if len(args) > 2:
3105 3105 raise UsageError("%bookmark: too many arguments")
3106 3106
3107 3107 bkms = self.db.get('bookmarks',{})
3108 3108
3109 3109 if opts.has_key('d'):
3110 3110 try:
3111 3111 todel = args[0]
3112 3112 except IndexError:
3113 3113 raise UsageError(
3114 3114 "%bookmark -d: must provide a bookmark to delete")
3115 3115 else:
3116 3116 try:
3117 3117 del bkms[todel]
3118 3118 except KeyError:
3119 3119 raise UsageError(
3120 3120 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3121 3121
3122 3122 elif opts.has_key('r'):
3123 3123 bkms = {}
3124 3124 elif opts.has_key('l'):
3125 3125 bks = bkms.keys()
3126 3126 bks.sort()
3127 3127 if bks:
3128 3128 size = max(map(len,bks))
3129 3129 else:
3130 3130 size = 0
3131 3131 fmt = '%-'+str(size)+'s -> %s'
3132 3132 print 'Current bookmarks:'
3133 3133 for bk in bks:
3134 3134 print fmt % (bk,bkms[bk])
3135 3135 else:
3136 3136 if not args:
3137 3137 raise UsageError("%bookmark: You must specify the bookmark name")
3138 3138 elif len(args)==1:
3139 3139 bkms[args[0]] = os.getcwdu()
3140 3140 elif len(args)==2:
3141 3141 bkms[args[0]] = args[1]
3142 3142 self.db['bookmarks'] = bkms
3143 3143
3144 3144 def magic_pycat(self, parameter_s=''):
3145 3145 """Show a syntax-highlighted file through a pager.
3146 3146
3147 3147 This magic is similar to the cat utility, but it will assume the file
3148 3148 to be Python source and will show it with syntax highlighting. """
3149 3149
3150 3150 try:
3151 filename = get_py_filename(parameter_s)
3151 filename = get_py_filename(parameter_s, sys.platform == 'win32')
3152 3152 cont = file_read(filename)
3153 3153 except IOError:
3154 3154 try:
3155 3155 cont = eval(parameter_s,self.user_ns)
3156 3156 except NameError:
3157 3157 cont = None
3158 3158 if cont is None:
3159 3159 print "Error: no such file or variable"
3160 3160 return
3161 3161
3162 3162 page.page(self.shell.pycolorize(cont))
3163 3163
3164 3164 def _rerun_pasted(self):
3165 3165 """ Rerun a previously pasted command.
3166 3166 """
3167 3167 b = self.user_ns.get('pasted_block', None)
3168 3168 if b is None:
3169 3169 raise UsageError('No previous pasted block available')
3170 3170 print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b))
3171 3171 exec b in self.user_ns
3172 3172
3173 3173 def _get_pasted_lines(self, sentinel):
3174 3174 """ Yield pasted lines until the user enters the given sentinel value.
3175 3175 """
3176 3176 from IPython.core import interactiveshell
3177 3177 print "Pasting code; enter '%s' alone on the line to stop." % sentinel
3178 3178 while True:
3179 3179 l = interactiveshell.raw_input_original(':')
3180 3180 if l == sentinel:
3181 3181 return
3182 3182 else:
3183 3183 yield l
3184 3184
3185 3185 def _strip_pasted_lines_for_code(self, raw_lines):
3186 3186 """ Strip non-code parts of a sequence of lines to return a block of
3187 3187 code.
3188 3188 """
3189 3189 # Regular expressions that declare text we strip from the input:
3190 3190 strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt
3191 3191 r'^\s*(\s?>)+', # Python input prompt
3192 3192 r'^\s*\.{3,}', # Continuation prompts
3193 3193 r'^\++',
3194 3194 ]
3195 3195
3196 3196 strip_from_start = map(re.compile,strip_re)
3197 3197
3198 3198 lines = []
3199 3199 for l in raw_lines:
3200 3200 for pat in strip_from_start:
3201 3201 l = pat.sub('',l)
3202 3202 lines.append(l)
3203 3203
3204 3204 block = "\n".join(lines) + '\n'
3205 3205 #print "block:\n",block
3206 3206 return block
3207 3207
3208 3208 def _execute_block(self, block, par):
3209 3209 """ Execute a block, or store it in a variable, per the user's request.
3210 3210 """
3211 3211 if not par:
3212 3212 b = textwrap.dedent(block)
3213 3213 self.user_ns['pasted_block'] = b
3214 3214 exec b in self.user_ns
3215 3215 else:
3216 3216 self.user_ns[par] = SList(block.splitlines())
3217 3217 print "Block assigned to '%s'" % par
3218 3218
3219 3219 def magic_quickref(self,arg):
3220 3220 """ Show a quick reference sheet """
3221 3221 import IPython.core.usage
3222 3222 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
3223 3223
3224 3224 page.page(qr)
3225 3225
3226 3226 def magic_doctest_mode(self,parameter_s=''):
3227 3227 """Toggle doctest mode on and off.
3228 3228
3229 3229 This mode is intended to make IPython behave as much as possible like a
3230 3230 plain Python shell, from the perspective of how its prompts, exceptions
3231 3231 and output look. This makes it easy to copy and paste parts of a
3232 3232 session into doctests. It does so by:
3233 3233
3234 3234 - Changing the prompts to the classic ``>>>`` ones.
3235 3235 - Changing the exception reporting mode to 'Plain'.
3236 3236 - Disabling pretty-printing of output.
3237 3237
3238 3238 Note that IPython also supports the pasting of code snippets that have
3239 3239 leading '>>>' and '...' prompts in them. This means that you can paste
3240 3240 doctests from files or docstrings (even if they have leading
3241 3241 whitespace), and the code will execute correctly. You can then use
3242 3242 '%history -t' to see the translated history; this will give you the
3243 3243 input after removal of all the leading prompts and whitespace, which
3244 3244 can be pasted back into an editor.
3245 3245
3246 3246 With these features, you can switch into this mode easily whenever you
3247 3247 need to do testing and changes to doctests, without having to leave
3248 3248 your existing IPython session.
3249 3249 """
3250 3250
3251 3251 from IPython.utils.ipstruct import Struct
3252 3252
3253 3253 # Shorthands
3254 3254 shell = self.shell
3255 3255 oc = shell.displayhook
3256 3256 meta = shell.meta
3257 3257 disp_formatter = self.shell.display_formatter
3258 3258 ptformatter = disp_formatter.formatters['text/plain']
3259 3259 # dstore is a data store kept in the instance metadata bag to track any
3260 3260 # changes we make, so we can undo them later.
3261 3261 dstore = meta.setdefault('doctest_mode',Struct())
3262 3262 save_dstore = dstore.setdefault
3263 3263
3264 3264 # save a few values we'll need to recover later
3265 3265 mode = save_dstore('mode',False)
3266 3266 save_dstore('rc_pprint',ptformatter.pprint)
3267 3267 save_dstore('xmode',shell.InteractiveTB.mode)
3268 3268 save_dstore('rc_separate_out',shell.separate_out)
3269 3269 save_dstore('rc_separate_out2',shell.separate_out2)
3270 3270 save_dstore('rc_prompts_pad_left',shell.prompts_pad_left)
3271 3271 save_dstore('rc_separate_in',shell.separate_in)
3272 3272 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
3273 3273
3274 3274 if mode == False:
3275 3275 # turn on
3276 3276 oc.prompt1.p_template = '>>> '
3277 3277 oc.prompt2.p_template = '... '
3278 3278 oc.prompt_out.p_template = ''
3279 3279
3280 3280 # Prompt separators like plain python
3281 3281 oc.input_sep = oc.prompt1.sep = ''
3282 3282 oc.output_sep = ''
3283 3283 oc.output_sep2 = ''
3284 3284
3285 3285 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3286 3286 oc.prompt_out.pad_left = False
3287 3287
3288 3288 ptformatter.pprint = False
3289 3289 disp_formatter.plain_text_only = True
3290 3290
3291 3291 shell.magic_xmode('Plain')
3292 3292 else:
3293 3293 # turn off
3294 3294 oc.prompt1.p_template = shell.prompt_in1
3295 3295 oc.prompt2.p_template = shell.prompt_in2
3296 3296 oc.prompt_out.p_template = shell.prompt_out
3297 3297
3298 3298 oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in
3299 3299
3300 3300 oc.output_sep = dstore.rc_separate_out
3301 3301 oc.output_sep2 = dstore.rc_separate_out2
3302 3302
3303 3303 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3304 3304 oc.prompt_out.pad_left = dstore.rc_prompts_pad_left
3305 3305
3306 3306 ptformatter.pprint = dstore.rc_pprint
3307 3307 disp_formatter.plain_text_only = dstore.rc_plain_text_only
3308 3308
3309 3309 shell.magic_xmode(dstore.xmode)
3310 3310
3311 3311 # Store new mode and inform
3312 3312 dstore.mode = bool(1-int(mode))
3313 3313 mode_label = ['OFF','ON'][dstore.mode]
3314 3314 print 'Doctest mode is:', mode_label
3315 3315
3316 3316 def magic_gui(self, parameter_s=''):
3317 3317 """Enable or disable IPython GUI event loop integration.
3318 3318
3319 3319 %gui [GUINAME]
3320 3320
3321 3321 This magic replaces IPython's threaded shells that were activated
3322 3322 using the (pylab/wthread/etc.) command line flags. GUI toolkits
3323 3323 can now be enabled, disabled and changed at runtime and keyboard
3324 3324 interrupts should work without any problems. The following toolkits
3325 3325 are supported: wxPython, PyQt4, PyGTK, and Tk::
3326 3326
3327 3327 %gui wx # enable wxPython event loop integration
3328 3328 %gui qt4|qt # enable PyQt4 event loop integration
3329 3329 %gui gtk # enable PyGTK event loop integration
3330 3330 %gui tk # enable Tk event loop integration
3331 3331 %gui # disable all event loop integration
3332 3332
3333 3333 WARNING: after any of these has been called you can simply create
3334 3334 an application object, but DO NOT start the event loop yourself, as
3335 3335 we have already handled that.
3336 3336 """
3337 3337 from IPython.lib.inputhook import enable_gui
3338 3338 opts, arg = self.parse_options(parameter_s, '')
3339 3339 if arg=='': arg = None
3340 3340 return enable_gui(arg)
3341 3341
3342 3342 def magic_load_ext(self, module_str):
3343 3343 """Load an IPython extension by its module name."""
3344 3344 return self.extension_manager.load_extension(module_str)
3345 3345
3346 3346 def magic_unload_ext(self, module_str):
3347 3347 """Unload an IPython extension by its module name."""
3348 3348 self.extension_manager.unload_extension(module_str)
3349 3349
3350 3350 def magic_reload_ext(self, module_str):
3351 3351 """Reload an IPython extension by its module name."""
3352 3352 self.extension_manager.reload_extension(module_str)
3353 3353
3354 3354 @skip_doctest
3355 3355 def magic_install_profiles(self, s):
3356 3356 """Install the default IPython profiles into the .ipython dir.
3357 3357
3358 3358 If the default profiles have already been installed, they will not
3359 3359 be overwritten. You can force overwriting them by using the ``-o``
3360 3360 option::
3361 3361
3362 3362 In [1]: %install_profiles -o
3363 3363 """
3364 3364 if '-o' in s:
3365 3365 overwrite = True
3366 3366 else:
3367 3367 overwrite = False
3368 3368 from IPython.config import profile
3369 3369 profile_dir = os.path.dirname(profile.__file__)
3370 3370 ipython_dir = self.ipython_dir
3371 3371 print "Installing profiles to: %s [overwrite=%s]"%(ipython_dir,overwrite)
3372 3372 for src in os.listdir(profile_dir):
3373 3373 if src.startswith('profile_'):
3374 3374 name = src.replace('profile_', '')
3375 3375 print " %s"%name
3376 3376 pd = ProfileDir.create_profile_dir_by_name(ipython_dir, name)
3377 3377 pd.copy_config_file('ipython_config.py', path=src,
3378 3378 overwrite=overwrite)
3379 3379
3380 3380 @skip_doctest
3381 3381 def magic_install_default_config(self, s):
3382 3382 """Install IPython's default config file into the .ipython dir.
3383 3383
3384 3384 If the default config file (:file:`ipython_config.py`) is already
3385 3385 installed, it will not be overwritten. You can force overwriting
3386 3386 by using the ``-o`` option::
3387 3387
3388 3388 In [1]: %install_default_config
3389 3389 """
3390 3390 if '-o' in s:
3391 3391 overwrite = True
3392 3392 else:
3393 3393 overwrite = False
3394 3394 pd = self.shell.profile_dir
3395 3395 print "Installing default config file in: %s" % pd.location
3396 3396 pd.copy_config_file('ipython_config.py', overwrite=overwrite)
3397 3397
3398 3398 # Pylab support: simple wrappers that activate pylab, load gui input
3399 3399 # handling and modify slightly %run
3400 3400
3401 3401 @skip_doctest
3402 3402 def _pylab_magic_run(self, parameter_s=''):
3403 3403 Magic.magic_run(self, parameter_s,
3404 3404 runner=mpl_runner(self.shell.safe_execfile))
3405 3405
3406 3406 _pylab_magic_run.__doc__ = magic_run.__doc__
3407 3407
3408 3408 @skip_doctest
3409 3409 def magic_pylab(self, s):
3410 3410 """Load numpy and matplotlib to work interactively.
3411 3411
3412 3412 %pylab [GUINAME]
3413 3413
3414 3414 This function lets you activate pylab (matplotlib, numpy and
3415 3415 interactive support) at any point during an IPython session.
3416 3416
3417 3417 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3418 3418 pylab and mlab, as well as all names from numpy and pylab.
3419 3419
3420 3420 Parameters
3421 3421 ----------
3422 3422 guiname : optional
3423 3423 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk', 'osx' or
3424 3424 'tk'). If given, the corresponding Matplotlib backend is used,
3425 3425 otherwise matplotlib's default (which you can override in your
3426 3426 matplotlib config file) is used.
3427 3427
3428 3428 Examples
3429 3429 --------
3430 3430 In this case, where the MPL default is TkAgg:
3431 3431 In [2]: %pylab
3432 3432
3433 3433 Welcome to pylab, a matplotlib-based Python environment.
3434 3434 Backend in use: TkAgg
3435 3435 For more information, type 'help(pylab)'.
3436 3436
3437 3437 But you can explicitly request a different backend:
3438 3438 In [3]: %pylab qt
3439 3439
3440 3440 Welcome to pylab, a matplotlib-based Python environment.
3441 3441 Backend in use: Qt4Agg
3442 3442 For more information, type 'help(pylab)'.
3443 3443 """
3444 3444 self.shell.enable_pylab(s)
3445 3445
3446 3446 def magic_tb(self, s):
3447 3447 """Print the last traceback with the currently active exception mode.
3448 3448
3449 3449 See %xmode for changing exception reporting modes."""
3450 3450 self.shell.showtraceback()
3451 3451
3452 3452 @skip_doctest
3453 3453 def magic_precision(self, s=''):
3454 3454 """Set floating point precision for pretty printing.
3455 3455
3456 3456 Can set either integer precision or a format string.
3457 3457
3458 3458 If numpy has been imported and precision is an int,
3459 3459 numpy display precision will also be set, via ``numpy.set_printoptions``.
3460 3460
3461 3461 If no argument is given, defaults will be restored.
3462 3462
3463 3463 Examples
3464 3464 --------
3465 3465 ::
3466 3466
3467 3467 In [1]: from math import pi
3468 3468
3469 3469 In [2]: %precision 3
3470 3470 Out[2]: u'%.3f'
3471 3471
3472 3472 In [3]: pi
3473 3473 Out[3]: 3.142
3474 3474
3475 3475 In [4]: %precision %i
3476 3476 Out[4]: u'%i'
3477 3477
3478 3478 In [5]: pi
3479 3479 Out[5]: 3
3480 3480
3481 3481 In [6]: %precision %e
3482 3482 Out[6]: u'%e'
3483 3483
3484 3484 In [7]: pi**10
3485 3485 Out[7]: 9.364805e+04
3486 3486
3487 3487 In [8]: %precision
3488 3488 Out[8]: u'%r'
3489 3489
3490 3490 In [9]: pi**10
3491 3491 Out[9]: 93648.047476082982
3492 3492
3493 3493 """
3494 3494
3495 3495 ptformatter = self.shell.display_formatter.formatters['text/plain']
3496 3496 ptformatter.float_precision = s
3497 3497 return ptformatter.float_format
3498 3498
3499 3499
3500 3500 @magic_arguments.magic_arguments()
3501 3501 @magic_arguments.argument(
3502 3502 '-e', '--export', action='store_true', default=False,
3503 3503 help='Export IPython history as a notebook. The filename argument '
3504 3504 'is used to specify the notebook name and format. For example '
3505 3505 'a filename of notebook.ipynb will result in a notebook name '
3506 3506 'of "notebook" and a format of "xml". Likewise using a ".json" '
3507 3507 'or ".py" file extension will write the notebook in the json '
3508 3508 'or py formats.'
3509 3509 )
3510 3510 @magic_arguments.argument(
3511 3511 '-f', '--format',
3512 3512 help='Convert an existing IPython notebook to a new format. This option '
3513 3513 'specifies the new format and can have the values: xml, json, py. '
3514 3514 'The target filename is choosen automatically based on the new '
3515 3515 'format. The filename argument gives the name of the source file.'
3516 3516 )
3517 3517 @magic_arguments.argument(
3518 3518 'filename', type=unicode,
3519 3519 help='Notebook name or filename'
3520 3520 )
3521 3521 def magic_notebook(self, s):
3522 3522 """Export and convert IPython notebooks.
3523 3523
3524 3524 This function can export the current IPython history to a notebook file
3525 3525 or can convert an existing notebook file into a different format. For
3526 3526 example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb".
3527 3527 To export the history to "foo.py" do "%notebook -e foo.py". To convert
3528 3528 "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible
3529 3529 formats include (json/ipynb, py).
3530 3530 """
3531 3531 args = magic_arguments.parse_argstring(self.magic_notebook, s)
3532 3532
3533 3533 from IPython.nbformat import current
3534 3534 if args.export:
3535 3535 fname, name, format = current.parse_filename(args.filename)
3536 3536 cells = []
3537 3537 hist = list(self.history_manager.get_range())
3538 3538 for session, prompt_number, input in hist[:-1]:
3539 3539 cells.append(current.new_code_cell(prompt_number=prompt_number, input=input))
3540 3540 worksheet = current.new_worksheet(cells=cells)
3541 3541 nb = current.new_notebook(name=name,worksheets=[worksheet])
3542 3542 with open(fname, 'w') as f:
3543 3543 current.write(nb, f, format);
3544 3544 elif args.format is not None:
3545 3545 old_fname, old_name, old_format = current.parse_filename(args.filename)
3546 3546 new_format = args.format
3547 3547 if new_format == u'xml':
3548 3548 raise ValueError('Notebooks cannot be written as xml.')
3549 3549 elif new_format == u'ipynb' or new_format == u'json':
3550 3550 new_fname = old_name + u'.ipynb'
3551 3551 new_format = u'json'
3552 3552 elif new_format == u'py':
3553 3553 new_fname = old_name + u'.py'
3554 3554 else:
3555 3555 raise ValueError('Invalid notebook format: %s' % new_format)
3556 3556 with open(old_fname, 'r') as f:
3557 3557 s = f.read()
3558 3558 try:
3559 3559 nb = current.reads(s, old_format)
3560 3560 except:
3561 3561 nb = current.reads(s, u'xml')
3562 3562 with open(new_fname, 'w') as f:
3563 3563 current.write(nb, f, new_format)
3564 3564
3565 3565
3566 3566 # end Magic
@@ -1,233 +1,233 b''
1 1 """Global IPython app to support test running.
2 2
3 3 We must start our own ipython object and heavily muck with it so that all the
4 4 modifications IPython makes to system behavior don't send the doctest machinery
5 5 into a fit. This code should be considered a gross hack, but it gets the job
6 6 done.
7 7 """
8 8 from __future__ import absolute_import
9 9 from __future__ import print_function
10 10
11 11 #-----------------------------------------------------------------------------
12 12 # Copyright (C) 2009-2010 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 # stdlib
23 23 import __builtin__
24 24 import os
25 25 import sys
26 26 from types import MethodType
27 27
28 28 # our own
29 29 from . import tools
30 30
31 31 from IPython.utils import io
32 32 from IPython.frontend.terminal.interactiveshell import TerminalInteractiveShell
33 33
34 34 #-----------------------------------------------------------------------------
35 35 # Functions
36 36 #-----------------------------------------------------------------------------
37 37
38 38 class StreamProxy(io.IOStream):
39 39 """Proxy for sys.stdout/err. This will request the stream *at call time*
40 40 allowing for nose's Capture plugin's redirection of sys.stdout/err.
41 41
42 42 Parameters
43 43 ----------
44 44 name : str
45 45 The name of the stream. This will be requested anew at every call
46 46 """
47 47
48 48 def __init__(self, name):
49 49 self.name=name
50 50
51 51 @property
52 52 def stream(self):
53 53 return getattr(sys, self.name)
54 54
55 55 def flush(self):
56 56 self.stream.flush()
57 57
58 58 # Hack to modify the %run command so we can sync the user's namespace with the
59 59 # test globals. Once we move over to a clean magic system, this will be done
60 60 # with much less ugliness.
61 61
62 62 class py_file_finder(object):
63 63 def __init__(self,test_filename):
64 64 self.test_filename = test_filename
65 65
66 def __call__(self,name):
66 def __call__(self,name,win32=False):
67 67 from IPython.utils.path import get_py_filename
68 68 try:
69 return get_py_filename(name)
69 return get_py_filename(name,win32=win32)
70 70 except IOError:
71 71 test_dir = os.path.dirname(self.test_filename)
72 72 new_path = os.path.join(test_dir,name)
73 return get_py_filename(new_path)
73 return get_py_filename(new_path,win32=win32)
74 74
75 75
76 76 def _run_ns_sync(self,arg_s,runner=None):
77 77 """Modified version of %run that syncs testing namespaces.
78 78
79 79 This is strictly needed for running doctests that call %run.
80 80 """
81 81 #print('in run_ns_sync', arg_s, file=sys.stderr) # dbg
82 82 finder = py_file_finder(arg_s)
83 83 return get_ipython().magic_run_ori(arg_s, runner, finder)
84 84
85 85
86 86 class ipnsdict(dict):
87 87 """A special subclass of dict for use as an IPython namespace in doctests.
88 88
89 89 This subclass adds a simple checkpointing capability so that when testing
90 90 machinery clears it (we use it as the test execution context), it doesn't
91 91 get completely destroyed.
92 92
93 93 In addition, it can handle the presence of the '_' key in a special manner,
94 94 which is needed because of how Python's doctest machinery operates with
95 95 '_'. See constructor and :meth:`update` for details.
96 96 """
97 97
98 98 def __init__(self,*a):
99 99 dict.__init__(self,*a)
100 100 self._savedict = {}
101 101 # If this flag is True, the .update() method will unconditionally
102 102 # remove a key named '_'. This is so that such a dict can be used as a
103 103 # namespace in doctests that call '_'.
104 104 self.protect_underscore = False
105 105
106 106 def clear(self):
107 107 dict.clear(self)
108 108 self.update(self._savedict)
109 109
110 110 def _checkpoint(self):
111 111 self._savedict.clear()
112 112 self._savedict.update(self)
113 113
114 114 def update(self,other):
115 115 self._checkpoint()
116 116 dict.update(self,other)
117 117
118 118 if self.protect_underscore:
119 119 # If '_' is in the namespace, python won't set it when executing
120 120 # code *in doctests*, and we have multiple doctests that use '_'.
121 121 # So we ensure that the namespace is always 'clean' of it before
122 122 # it's used for test code execution.
123 123 # This flag is only turned on by the doctest machinery, so that
124 124 # normal test code can assume the _ key is updated like any other
125 125 # key and can test for its presence after cell executions.
126 126 self.pop('_', None)
127 127
128 128 # The builtins namespace must *always* be the real __builtin__ module,
129 129 # else weird stuff happens. The main ipython code does have provisions
130 130 # to ensure this after %run, but since in this class we do some
131 131 # aggressive low-level cleaning of the execution namespace, we need to
132 132 # correct for that ourselves, to ensure consitency with the 'real'
133 133 # ipython.
134 134 self['__builtins__'] = __builtin__
135 135
136 136 def __delitem__(self, key):
137 137 """Part of the test suite checks that we can release all
138 138 references to an object. So we need to make sure that we're not
139 139 keeping a reference in _savedict."""
140 140 dict.__delitem__(self, key)
141 141 try:
142 142 del self._savedict[key]
143 143 except KeyError:
144 144 pass
145 145
146 146
147 147 def get_ipython():
148 148 # This will get replaced by the real thing once we start IPython below
149 149 return start_ipython()
150 150
151 151
152 152 # A couple of methods to override those in the running IPython to interact
153 153 # better with doctest (doctest captures on raw stdout, so we need to direct
154 154 # various types of output there otherwise it will miss them).
155 155
156 156 def xsys(self, cmd):
157 157 """Replace the default system call with a capturing one for doctest.
158 158 """
159 159 # We use getoutput, but we need to strip it because pexpect captures
160 160 # the trailing newline differently from commands.getoutput
161 161 print(self.getoutput(cmd, split=False).rstrip(), end='', file=sys.stdout)
162 162 sys.stdout.flush()
163 163
164 164
165 165 def _showtraceback(self, etype, evalue, stb):
166 166 """Print the traceback purely on stdout for doctest to capture it.
167 167 """
168 168 print(self.InteractiveTB.stb2text(stb), file=sys.stdout)
169 169
170 170
171 171 def start_ipython():
172 172 """Start a global IPython shell, which we need for IPython-specific syntax.
173 173 """
174 174 global get_ipython
175 175
176 176 # This function should only ever run once!
177 177 if hasattr(start_ipython, 'already_called'):
178 178 return
179 179 start_ipython.already_called = True
180 180
181 181 # Store certain global objects that IPython modifies
182 182 _displayhook = sys.displayhook
183 183 _excepthook = sys.excepthook
184 184 _main = sys.modules.get('__main__')
185 185
186 186 # Create custom argv and namespaces for our IPython to be test-friendly
187 187 config = tools.default_config()
188 188
189 189 # Create and initialize our test-friendly IPython instance.
190 190 shell = TerminalInteractiveShell.instance(config=config,
191 191 user_ns=ipnsdict(),
192 192 user_global_ns={}
193 193 )
194 194
195 195 # A few more tweaks needed for playing nicely with doctests...
196 196
197 197 # remove history file
198 198 shell.tempfiles.append(config.HistoryManager.hist_file)
199 199
200 200 # These traps are normally only active for interactive use, set them
201 201 # permanently since we'll be mocking interactive sessions.
202 202 shell.builtin_trap.activate()
203 203
204 204 # Modify the IPython system call with one that uses getoutput, so that we
205 205 # can capture subcommands and print them to Python's stdout, otherwise the
206 206 # doctest machinery would miss them.
207 207 shell.system = MethodType(xsys, shell, TerminalInteractiveShell)
208 208
209 209
210 210 shell._showtraceback = MethodType(_showtraceback, shell,
211 211 TerminalInteractiveShell)
212 212
213 213 # IPython is ready, now clean up some global state...
214 214
215 215 # Deactivate the various python system hooks added by ipython for
216 216 # interactive convenience so we don't confuse the doctest system
217 217 sys.modules['__main__'] = _main
218 218 sys.displayhook = _displayhook
219 219 sys.excepthook = _excepthook
220 220
221 221 # So that ipython magics and aliases can be doctested (they work by making
222 222 # a call into a global _ip object). Also make the top-level get_ipython
223 223 # now return this without recursively calling here again.
224 224 _ip = shell
225 225 get_ipython = _ip.get_ipython
226 226 __builtin__._ip = _ip
227 227 __builtin__.get_ipython = get_ipython
228 228
229 229 # To avoid extra IPython messages during testing, suppress io.stdout/stderr
230 230 io.stdout = StreamProxy('stdout')
231 231 io.stderr = StreamProxy('stderr')
232 232
233 233 return _ip
@@ -1,333 +1,345 b''
1 1 """Generic testing tools that do NOT depend on Twisted.
2 2
3 3 In particular, this module exposes a set of top-level assert* functions that
4 4 can be used in place of nose.tools.assert* in method generators (the ones in
5 5 nose can not, at least as of nose 0.10.4).
6 6
7 7 Note: our testing package contains testing.util, which does depend on Twisted
8 8 and provides utilities for tests that manage Deferreds. All testing support
9 9 tools that only depend on nose, IPython or the standard library should go here
10 10 instead.
11 11
12 12
13 13 Authors
14 14 -------
15 15 - Fernando Perez <Fernando.Perez@berkeley.edu>
16 16 """
17 17
18 18 from __future__ import absolute_import
19 19
20 20 #-----------------------------------------------------------------------------
21 21 # Copyright (C) 2009 The IPython Development Team
22 22 #
23 23 # Distributed under the terms of the BSD License. The full license is in
24 24 # the file COPYING, distributed as part of this software.
25 25 #-----------------------------------------------------------------------------
26 26
27 27 #-----------------------------------------------------------------------------
28 28 # Imports
29 29 #-----------------------------------------------------------------------------
30 30
31 31 import os
32 32 import re
33 33 import sys
34 34 import tempfile
35 35
36 36 from contextlib import contextmanager
37 37
38 38 try:
39 39 # These tools are used by parts of the runtime, so we make the nose
40 40 # dependency optional at this point. Nose is a hard dependency to run the
41 41 # test suite, but NOT to use ipython itself.
42 42 import nose.tools as nt
43 43 has_nose = True
44 44 except ImportError:
45 45 has_nose = False
46 46
47 47 from IPython.config.loader import Config
48 48 from IPython.utils.process import find_cmd, getoutputerror
49 49 from IPython.utils.text import list_strings
50 50 from IPython.utils.io import temp_pyfile
51 51
52 52 from . import decorators as dec
53 53 from . import skipdoctest
54 54
55 55 #-----------------------------------------------------------------------------
56 56 # Globals
57 57 #-----------------------------------------------------------------------------
58 58
59 59 # Make a bunch of nose.tools assert wrappers that can be used in test
60 60 # generators. This will expose an assert* function for each one in nose.tools.
61 61
62 62 _tpl = """
63 63 def %(name)s(*a,**kw):
64 64 return nt.%(name)s(*a,**kw)
65 65 """
66 66
67 67 if has_nose:
68 68 for _x in [a for a in dir(nt) if a.startswith('assert')]:
69 69 exec _tpl % dict(name=_x)
70 70
71 71 #-----------------------------------------------------------------------------
72 72 # Functions and classes
73 73 #-----------------------------------------------------------------------------
74 74
75 75 # The docstring for full_path doctests differently on win32 (different path
76 76 # separator) so just skip the doctest there. The example remains informative.
77 77 doctest_deco = skipdoctest.skip_doctest if sys.platform == 'win32' else dec.null_deco
78 78
79 79 @doctest_deco
80 80 def full_path(startPath,files):
81 81 """Make full paths for all the listed files, based on startPath.
82 82
83 83 Only the base part of startPath is kept, since this routine is typically
84 84 used with a script's __file__ variable as startPath. The base of startPath
85 85 is then prepended to all the listed files, forming the output list.
86 86
87 87 Parameters
88 88 ----------
89 89 startPath : string
90 90 Initial path to use as the base for the results. This path is split
91 91 using os.path.split() and only its first component is kept.
92 92
93 93 files : string or list
94 94 One or more files.
95 95
96 96 Examples
97 97 --------
98 98
99 99 >>> full_path('/foo/bar.py',['a.txt','b.txt'])
100 100 ['/foo/a.txt', '/foo/b.txt']
101 101
102 102 >>> full_path('/foo',['a.txt','b.txt'])
103 103 ['/a.txt', '/b.txt']
104 104
105 105 If a single file is given, the output is still a list:
106 106 >>> full_path('/foo','a.txt')
107 107 ['/a.txt']
108 108 """
109 109
110 110 files = list_strings(files)
111 111 base = os.path.split(startPath)[0]
112 112 return [ os.path.join(base,f) for f in files ]
113 113
114 114
115 115 def parse_test_output(txt):
116 116 """Parse the output of a test run and return errors, failures.
117 117
118 118 Parameters
119 119 ----------
120 120 txt : str
121 121 Text output of a test run, assumed to contain a line of one of the
122 122 following forms::
123 123 'FAILED (errors=1)'
124 124 'FAILED (failures=1)'
125 125 'FAILED (errors=1, failures=1)'
126 126
127 127 Returns
128 128 -------
129 129 nerr, nfail: number of errors and failures.
130 130 """
131 131
132 132 err_m = re.search(r'^FAILED \(errors=(\d+)\)', txt, re.MULTILINE)
133 133 if err_m:
134 134 nerr = int(err_m.group(1))
135 135 nfail = 0
136 136 return nerr, nfail
137 137
138 138 fail_m = re.search(r'^FAILED \(failures=(\d+)\)', txt, re.MULTILINE)
139 139 if fail_m:
140 140 nerr = 0
141 141 nfail = int(fail_m.group(1))
142 142 return nerr, nfail
143 143
144 144 both_m = re.search(r'^FAILED \(errors=(\d+), failures=(\d+)\)', txt,
145 145 re.MULTILINE)
146 146 if both_m:
147 147 nerr = int(both_m.group(1))
148 148 nfail = int(both_m.group(2))
149 149 return nerr, nfail
150 150
151 151 # If the input didn't match any of these forms, assume no error/failures
152 152 return 0, 0
153 153
154 154
155 155 # So nose doesn't think this is a test
156 156 parse_test_output.__test__ = False
157 157
158 158
159 159 def default_argv():
160 160 """Return a valid default argv for creating testing instances of ipython"""
161 161
162 162 return ['--quick', # so no config file is loaded
163 163 # Other defaults to minimize side effects on stdout
164 164 '--colors=NoColor', '--no-term-title','--no-banner',
165 165 '--autocall=0']
166 166
167 167
168 168 def default_config():
169 169 """Return a config object with good defaults for testing."""
170 170 config = Config()
171 171 config.TerminalInteractiveShell.colors = 'NoColor'
172 172 config.TerminalTerminalInteractiveShell.term_title = False,
173 173 config.TerminalInteractiveShell.autocall = 0
174 174 config.HistoryManager.hist_file = tempfile.mktemp(u'test_hist.sqlite')
175 175 config.HistoryManager.db_cache_size = 10000
176 176 return config
177 177
178 178
179 179 def ipexec(fname, options=None):
180 180 """Utility to call 'ipython filename'.
181 181
182 182 Starts IPython witha minimal and safe configuration to make startup as fast
183 183 as possible.
184 184
185 185 Note that this starts IPython in a subprocess!
186 186
187 187 Parameters
188 188 ----------
189 189 fname : str
190 190 Name of file to be executed (should have .py or .ipy extension).
191 191
192 192 options : optional, list
193 193 Extra command-line flags to be passed to IPython.
194 194
195 195 Returns
196 196 -------
197 197 (stdout, stderr) of ipython subprocess.
198 198 """
199 199 if options is None: options = []
200 200
201 201 # For these subprocess calls, eliminate all prompt printing so we only see
202 202 # output from script execution
203 203 prompt_opts = [ '--InteractiveShell.prompt_in1=""',
204 204 '--InteractiveShell.prompt_in2=""',
205 205 '--InteractiveShell.prompt_out=""'
206 206 ]
207 207 cmdargs = ' '.join(default_argv() + prompt_opts + options)
208 208
209 209 _ip = get_ipython()
210 210 test_dir = os.path.dirname(__file__)
211 211
212 212 ipython_cmd = find_cmd('ipython')
213 213 # Absolute path for filename
214 214 full_fname = os.path.join(test_dir, fname)
215 215 full_cmd = '%s %s %s' % (ipython_cmd, cmdargs, full_fname)
216 216 #print >> sys.stderr, 'FULL CMD:', full_cmd # dbg
217 217 out = getoutputerror(full_cmd)
218 218 # `import readline` causes 'ESC[?1034h' to be the first output sometimes,
219 219 # so strip that off the front of the first line if it is found
220 220 if out:
221 221 first = out[0]
222 222 m = re.match(r'\x1b\[[^h]+h', first)
223 223 if m:
224 224 # strip initial readline escape
225 225 out = list(out)
226 226 out[0] = first[len(m.group()):]
227 227 out = tuple(out)
228 228 return out
229 229
230 230
231 231 def ipexec_validate(fname, expected_out, expected_err='',
232 232 options=None):
233 233 """Utility to call 'ipython filename' and validate output/error.
234 234
235 235 This function raises an AssertionError if the validation fails.
236 236
237 237 Note that this starts IPython in a subprocess!
238 238
239 239 Parameters
240 240 ----------
241 241 fname : str
242 242 Name of the file to be executed (should have .py or .ipy extension).
243 243
244 244 expected_out : str
245 245 Expected stdout of the process.
246 246
247 247 expected_err : optional, str
248 248 Expected stderr of the process.
249 249
250 250 options : optional, list
251 251 Extra command-line flags to be passed to IPython.
252 252
253 253 Returns
254 254 -------
255 255 None
256 256 """
257 257
258 258 import nose.tools as nt
259 259
260 260 out, err = ipexec(fname)
261 261 #print 'OUT', out # dbg
262 262 #print 'ERR', err # dbg
263 263 # If there are any errors, we must check those befor stdout, as they may be
264 264 # more informative than simply having an empty stdout.
265 265 if err:
266 266 if expected_err:
267 267 nt.assert_equals(err.strip(), expected_err.strip())
268 268 else:
269 269 raise ValueError('Running file %r produced error: %r' %
270 270 (fname, err))
271 271 # If no errors or output on stderr was expected, match stdout
272 272 nt.assert_equals(out.strip(), expected_out.strip())
273 273
274 274
275 275 class TempFileMixin(object):
276 276 """Utility class to create temporary Python/IPython files.
277 277
278 278 Meant as a mixin class for test cases."""
279 279
280 280 def mktmp(self, src, ext='.py'):
281 281 """Make a valid python temp file."""
282 282 fname, f = temp_pyfile(src, ext)
283 283 self.tmpfile = f
284 284 self.fname = fname
285 285
286 286 def tearDown(self):
287 287 if hasattr(self, 'tmpfile'):
288 288 # If the tmpfile wasn't made because of skipped tests, like in
289 289 # win32, there's nothing to cleanup.
290 290 self.tmpfile.close()
291 291 try:
292 292 os.unlink(self.fname)
293 293 except:
294 294 # On Windows, even though we close the file, we still can't
295 295 # delete it. I have no clue why
296 296 pass
297 297
298 298 pair_fail_msg = ("Testing function {0}\n\n"
299 299 "In:\n"
300 300 " {1!r}\n"
301 301 "Expected:\n"
302 302 " {2!r}\n"
303 303 "Got:\n"
304 304 " {3!r}\n")
305 305 def check_pairs(func, pairs):
306 306 """Utility function for the common case of checking a function with a
307 307 sequence of input/output pairs.
308 308
309 309 Parameters
310 310 ----------
311 311 func : callable
312 312 The function to be tested. Should accept a single argument.
313 313 pairs : iterable
314 314 A list of (input, expected_output) tuples.
315 315
316 316 Returns
317 317 -------
318 318 None. Raises an AssertionError if any output does not match the expected
319 319 value.
320 320 """
321 321 for inp, expected in pairs:
322 322 out = func(inp)
323 323 assert out == expected, pair_fail_msg.format(func.func_name, inp, expected, out)
324 324
325 325 @contextmanager
326 326 def mute_warn():
327 327 from IPython.utils import warn
328 328 save_warn = warn.warn
329 329 warn.warn = lambda *a, **kw: None
330 330 try:
331 331 yield
332 332 finally:
333 warn.warn = save_warn No newline at end of file
333 warn.warn = save_warn
334
335 @contextmanager
336 def make_tempfile(name):
337 """ Create an empty, named, temporary file for the duration of the context.
338 """
339 f = open(name, 'w')
340 f.close()
341 try:
342 yield
343 finally:
344 os.unlink(name)
345
@@ -1,466 +1,473 b''
1 1 # encoding: utf-8
2 2 """
3 3 Utilities for path handling.
4 4 """
5 5
6 6 #-----------------------------------------------------------------------------
7 7 # Copyright (C) 2008-2009 The IPython Development Team
8 8 #
9 9 # Distributed under the terms of the BSD License. The full license is in
10 10 # the file COPYING, distributed as part of this software.
11 11 #-----------------------------------------------------------------------------
12 12
13 13 #-----------------------------------------------------------------------------
14 14 # Imports
15 15 #-----------------------------------------------------------------------------
16 16
17 17 import os
18 18 import sys
19 19 import tempfile
20 20 from hashlib import md5
21 21
22 22 import IPython
23 23 from IPython.utils import warn
24 24 from IPython.utils.process import system
25 25 from IPython.utils.importstring import import_item
26 26
27 27 #-----------------------------------------------------------------------------
28 28 # Code
29 29 #-----------------------------------------------------------------------------
30 30
31 31 fs_encoding = sys.getfilesystemencoding()
32 32
33 33 def _cast_unicode(s, enc=None):
34 34 """Turn 8-bit strings into unicode."""
35 35 if isinstance(s, bytes):
36 36 enc = enc or sys.getdefaultencoding()
37 37 return s.decode(enc)
38 38 return s
39 39
40 40
41 41 def _get_long_path_name(path):
42 42 """Dummy no-op."""
43 43 return path
44 44
45 45 def _writable_dir(path):
46 46 """Whether `path` is a directory, to which the user has write access."""
47 47 return os.path.isdir(path) and os.access(path, os.W_OK)
48 48
49 49 if sys.platform == 'win32':
50 50 def _get_long_path_name(path):
51 51 """Get a long path name (expand ~) on Windows using ctypes.
52 52
53 53 Examples
54 54 --------
55 55
56 56 >>> get_long_path_name('c:\\docume~1')
57 57 u'c:\\\\Documents and Settings'
58 58
59 59 """
60 60 try:
61 61 import ctypes
62 62 except ImportError:
63 63 raise ImportError('you need to have ctypes installed for this to work')
64 64 _GetLongPathName = ctypes.windll.kernel32.GetLongPathNameW
65 65 _GetLongPathName.argtypes = [ctypes.c_wchar_p, ctypes.c_wchar_p,
66 66 ctypes.c_uint ]
67 67
68 68 buf = ctypes.create_unicode_buffer(260)
69 69 rv = _GetLongPathName(path, buf, 260)
70 70 if rv == 0 or rv > 260:
71 71 return path
72 72 else:
73 73 return buf.value
74 74
75 75
76 76 def get_long_path_name(path):
77 77 """Expand a path into its long form.
78 78
79 79 On Windows this expands any ~ in the paths. On other platforms, it is
80 80 a null operation.
81 81 """
82 82 return _get_long_path_name(path)
83 83
84 84
85 def get_py_filename(name):
85 def get_py_filename(name, win32=False):
86 86 """Return a valid python filename in the current directory.
87 87
88 88 If the given name is not a file, it adds '.py' and searches again.
89 Raises IOError with an informative message if the file isn't found."""
89 Raises IOError with an informative message if the file isn't found.
90
91 If the win32 argument is True, then apply Windows semantics to the filename.
92 In particular, remove any quoting that has been applied to it.
93 """
90 94
91 95 name = os.path.expanduser(name)
96 if win32:
97 if name.startswith(("'", '"')) and name.endswith(("'", '"')):
98 name = name[1:-1]
92 99 if not os.path.isfile(name) and not name.endswith('.py'):
93 100 name += '.py'
94 101 if os.path.isfile(name):
95 102 return name
96 103 else:
97 104 raise IOError,'File `%s` not found.' % name
98 105
99 106
100 107 def filefind(filename, path_dirs=None):
101 108 """Find a file by looking through a sequence of paths.
102 109
103 110 This iterates through a sequence of paths looking for a file and returns
104 111 the full, absolute path of the first occurence of the file. If no set of
105 112 path dirs is given, the filename is tested as is, after running through
106 113 :func:`expandvars` and :func:`expanduser`. Thus a simple call::
107 114
108 115 filefind('myfile.txt')
109 116
110 117 will find the file in the current working dir, but::
111 118
112 119 filefind('~/myfile.txt')
113 120
114 121 Will find the file in the users home directory. This function does not
115 122 automatically try any paths, such as the cwd or the user's home directory.
116 123
117 124 Parameters
118 125 ----------
119 126 filename : str
120 127 The filename to look for.
121 128 path_dirs : str, None or sequence of str
122 129 The sequence of paths to look for the file in. If None, the filename
123 130 need to be absolute or be in the cwd. If a string, the string is
124 131 put into a sequence and the searched. If a sequence, walk through
125 132 each element and join with ``filename``, calling :func:`expandvars`
126 133 and :func:`expanduser` before testing for existence.
127 134
128 135 Returns
129 136 -------
130 137 Raises :exc:`IOError` or returns absolute path to file.
131 138 """
132 139
133 140 # If paths are quoted, abspath gets confused, strip them...
134 141 filename = filename.strip('"').strip("'")
135 142 # If the input is an absolute path, just check it exists
136 143 if os.path.isabs(filename) and os.path.isfile(filename):
137 144 return filename
138 145
139 146 if path_dirs is None:
140 147 path_dirs = ("",)
141 148 elif isinstance(path_dirs, basestring):
142 149 path_dirs = (path_dirs,)
143 150
144 151 for path in path_dirs:
145 152 if path == '.': path = os.getcwdu()
146 153 testname = expand_path(os.path.join(path, filename))
147 154 if os.path.isfile(testname):
148 155 return os.path.abspath(testname)
149 156
150 157 raise IOError("File %r does not exist in any of the search paths: %r" %
151 158 (filename, path_dirs) )
152 159
153 160
154 161 class HomeDirError(Exception):
155 162 pass
156 163
157 164
158 165 def get_home_dir():
159 166 """Return the closest possible equivalent to a 'home' directory.
160 167
161 168 * On POSIX, we try $HOME.
162 169 * On Windows we try:
163 170 - %HOMESHARE%
164 171 - %HOMEDRIVE\%HOMEPATH%
165 172 - %USERPROFILE%
166 173 - Registry hack for My Documents
167 174 - %HOME%: rare, but some people with unix-like setups may have defined it
168 175 * On Dos C:\
169 176
170 177 Currently only Posix and NT are implemented, a HomeDirError exception is
171 178 raised for all other OSes.
172 179 """
173 180
174 181 env = os.environ
175 182
176 183 # first, check py2exe distribution root directory for _ipython.
177 184 # This overrides all. Normally does not exist.
178 185
179 186 if hasattr(sys, "frozen"): #Is frozen by py2exe
180 187 if '\\library.zip\\' in IPython.__file__.lower():#libraries compressed to zip-file
181 188 root, rest = IPython.__file__.lower().split('library.zip')
182 189 else:
183 190 root=os.path.join(os.path.split(IPython.__file__)[0],"../../")
184 191 root=os.path.abspath(root).rstrip('\\')
185 192 if _writable_dir(os.path.join(root, '_ipython')):
186 193 os.environ["IPYKITROOT"] = root
187 194 return _cast_unicode(root, fs_encoding)
188 195
189 196 if os.name == 'posix':
190 197 # Linux, Unix, AIX, OS X
191 198 try:
192 199 homedir = env['HOME']
193 200 except KeyError:
194 201 # Last-ditch attempt at finding a suitable $HOME, on systems where
195 202 # it may not be defined in the environment but the system shell
196 203 # still knows it - reported once as:
197 204 # https://github.com/ipython/ipython/issues/154
198 205 from subprocess import Popen, PIPE
199 206 homedir = Popen('echo $HOME', shell=True,
200 207 stdout=PIPE).communicate()[0].strip()
201 208 if homedir:
202 209 return _cast_unicode(homedir, fs_encoding)
203 210 else:
204 211 raise HomeDirError('Undefined $HOME, IPython cannot proceed.')
205 212 else:
206 213 return _cast_unicode(homedir, fs_encoding)
207 214 elif os.name == 'nt':
208 215 # Now for win9x, XP, Vista, 7?
209 216 # For some strange reason all of these return 'nt' for os.name.
210 217 # First look for a network home directory. This will return the UNC
211 218 # path (\\server\\Users\%username%) not the mapped path (Z:\). This
212 219 # is needed when running IPython on cluster where all paths have to
213 220 # be UNC.
214 221 try:
215 222 homedir = env['HOMESHARE']
216 223 except KeyError:
217 224 pass
218 225 else:
219 226 if _writable_dir(homedir):
220 227 return _cast_unicode(homedir, fs_encoding)
221 228
222 229 # Now look for a local home directory
223 230 try:
224 231 homedir = os.path.join(env['HOMEDRIVE'],env['HOMEPATH'])
225 232 except KeyError:
226 233 pass
227 234 else:
228 235 if _writable_dir(homedir):
229 236 return _cast_unicode(homedir, fs_encoding)
230 237
231 238 # Now the users profile directory
232 239 try:
233 240 homedir = os.path.join(env['USERPROFILE'])
234 241 except KeyError:
235 242 pass
236 243 else:
237 244 if _writable_dir(homedir):
238 245 return _cast_unicode(homedir, fs_encoding)
239 246
240 247 # Use the registry to get the 'My Documents' folder.
241 248 try:
242 249 import _winreg as wreg
243 250 key = wreg.OpenKey(
244 251 wreg.HKEY_CURRENT_USER,
245 252 "Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders"
246 253 )
247 254 homedir = wreg.QueryValueEx(key,'Personal')[0]
248 255 key.Close()
249 256 except:
250 257 pass
251 258 else:
252 259 if _writable_dir(homedir):
253 260 return _cast_unicode(homedir, fs_encoding)
254 261
255 262 # A user with a lot of unix tools in win32 may have defined $HOME.
256 263 # Try this as a last ditch option.
257 264 try:
258 265 homedir = env['HOME']
259 266 except KeyError:
260 267 pass
261 268 else:
262 269 if _writable_dir(homedir):
263 270 return _cast_unicode(homedir, fs_encoding)
264 271
265 272 # If all else fails, raise HomeDirError
266 273 raise HomeDirError('No valid home directory could be found')
267 274 elif os.name == 'dos':
268 275 # Desperate, may do absurd things in classic MacOS. May work under DOS.
269 276 return u'C:\\'
270 277 else:
271 278 raise HomeDirError('No valid home directory could be found for your OS')
272 279
273 280 def get_xdg_dir():
274 281 """Return the XDG_CONFIG_HOME, if it is defined and exists, else None.
275 282
276 283 This is only for posix (Linux,Unix,OS X, etc) systems.
277 284 """
278 285
279 286 env = os.environ
280 287
281 288 if os.name == 'posix':
282 289 # Linux, Unix, AIX, OS X
283 290 # use ~/.config if not set OR empty
284 291 xdg = env.get("XDG_CONFIG_HOME", None) or os.path.join(get_home_dir(), '.config')
285 292 if xdg and _writable_dir(xdg):
286 293 return _cast_unicode(xdg, fs_encoding)
287 294
288 295 return None
289 296
290 297
291 298 def get_ipython_dir():
292 299 """Get the IPython directory for this platform and user.
293 300
294 301 This uses the logic in `get_home_dir` to find the home directory
295 302 and the adds .ipython to the end of the path.
296 303 """
297 304
298 305 env = os.environ
299 306 pjoin = os.path.join
300 307
301 308
302 309 ipdir_def = '.ipython'
303 310 xdg_def = 'ipython'
304 311
305 312 home_dir = get_home_dir()
306 313 xdg_dir = get_xdg_dir()
307 314 # import pdb; pdb.set_trace() # dbg
308 315 ipdir = env.get('IPYTHON_DIR', env.get('IPYTHONDIR', None))
309 316 if ipdir is None:
310 317 # not set explicitly, use XDG_CONFIG_HOME or HOME
311 318 home_ipdir = pjoin(home_dir, ipdir_def)
312 319 if xdg_dir:
313 320 # use XDG, as long as the user isn't already
314 321 # using $HOME/.ipython and *not* XDG/ipython
315 322
316 323 xdg_ipdir = pjoin(xdg_dir, xdg_def)
317 324
318 325 if _writable_dir(xdg_ipdir) or not _writable_dir(home_ipdir):
319 326 ipdir = xdg_ipdir
320 327
321 328 if ipdir is None:
322 329 # not using XDG
323 330 ipdir = home_ipdir
324 331
325 332 ipdir = os.path.normpath(os.path.expanduser(ipdir))
326 333
327 334 if os.path.exists(ipdir) and not _writable_dir(ipdir):
328 335 # ipdir exists, but is not writable
329 336 warn.warn("IPython dir '%s' is not a writable location,"
330 337 " using a temp directory."%ipdir)
331 338 ipdir = tempfile.mkdtemp()
332 339 elif not os.path.exists(ipdir):
333 340 parent = ipdir.rsplit(os.path.sep, 1)[0]
334 341 if not _writable_dir(parent):
335 342 # ipdir does not exist and parent isn't writable
336 343 warn.warn("IPython parent '%s' is not a writable location,"
337 344 " using a temp directory."%parent)
338 345 ipdir = tempfile.mkdtemp()
339 346
340 347 return _cast_unicode(ipdir, fs_encoding)
341 348
342 349
343 350 def get_ipython_package_dir():
344 351 """Get the base directory where IPython itself is installed."""
345 352 ipdir = os.path.dirname(IPython.__file__)
346 353 return _cast_unicode(ipdir, fs_encoding)
347 354
348 355
349 356 def get_ipython_module_path(module_str):
350 357 """Find the path to an IPython module in this version of IPython.
351 358
352 359 This will always find the version of the module that is in this importable
353 360 IPython package. This will always return the path to the ``.py``
354 361 version of the module.
355 362 """
356 363 if module_str == 'IPython':
357 364 return os.path.join(get_ipython_package_dir(), '__init__.py')
358 365 mod = import_item(module_str)
359 366 the_path = mod.__file__.replace('.pyc', '.py')
360 367 the_path = the_path.replace('.pyo', '.py')
361 368 return _cast_unicode(the_path, fs_encoding)
362 369
363 370
364 371 def expand_path(s):
365 372 """Expand $VARS and ~names in a string, like a shell
366 373
367 374 :Examples:
368 375
369 376 In [2]: os.environ['FOO']='test'
370 377
371 378 In [3]: expand_path('variable FOO is $FOO')
372 379 Out[3]: 'variable FOO is test'
373 380 """
374 381 # This is a pretty subtle hack. When expand user is given a UNC path
375 382 # on Windows (\\server\share$\%username%), os.path.expandvars, removes
376 383 # the $ to get (\\server\share\%username%). I think it considered $
377 384 # alone an empty var. But, we need the $ to remains there (it indicates
378 385 # a hidden share).
379 386 if os.name=='nt':
380 387 s = s.replace('$\\', 'IPYTHON_TEMP')
381 388 s = os.path.expandvars(os.path.expanduser(s))
382 389 if os.name=='nt':
383 390 s = s.replace('IPYTHON_TEMP', '$\\')
384 391 return s
385 392
386 393
387 394 def target_outdated(target,deps):
388 395 """Determine whether a target is out of date.
389 396
390 397 target_outdated(target,deps) -> 1/0
391 398
392 399 deps: list of filenames which MUST exist.
393 400 target: single filename which may or may not exist.
394 401
395 402 If target doesn't exist or is older than any file listed in deps, return
396 403 true, otherwise return false.
397 404 """
398 405 try:
399 406 target_time = os.path.getmtime(target)
400 407 except os.error:
401 408 return 1
402 409 for dep in deps:
403 410 dep_time = os.path.getmtime(dep)
404 411 if dep_time > target_time:
405 412 #print "For target",target,"Dep failed:",dep # dbg
406 413 #print "times (dep,tar):",dep_time,target_time # dbg
407 414 return 1
408 415 return 0
409 416
410 417
411 418 def target_update(target,deps,cmd):
412 419 """Update a target with a given command given a list of dependencies.
413 420
414 421 target_update(target,deps,cmd) -> runs cmd if target is outdated.
415 422
416 423 This is just a wrapper around target_outdated() which calls the given
417 424 command if target is outdated."""
418 425
419 426 if target_outdated(target,deps):
420 427 system(cmd)
421 428
422 429 def filehash(path):
423 430 """Make an MD5 hash of a file, ignoring any differences in line
424 431 ending characters."""
425 432 with open(path, "rU") as f:
426 433 return md5(f.read()).hexdigest()
427 434
428 435 # If the config is unmodified from the default, we'll just delete it.
429 436 # These are consistent for 0.10.x, thankfully. We're not going to worry about
430 437 # older versions.
431 438 old_config_md5 = {'ipy_user_conf.py': 'fc108bedff4b9a00f91fa0a5999140d3',
432 439 'ipythonrc': '12a68954f3403eea2eec09dc8fe5a9b5'}
433 440
434 441 def check_for_old_config(ipython_dir=None):
435 442 """Check for old config files, and present a warning if they exist.
436 443
437 444 A link to the docs of the new config is included in the message.
438 445
439 446 This should mitigate confusion with the transition to the new
440 447 config system in 0.11.
441 448 """
442 449 if ipython_dir is None:
443 450 ipython_dir = get_ipython_dir()
444 451
445 452 old_configs = ['ipy_user_conf.py', 'ipythonrc', 'ipython_config.py']
446 453 warned = False
447 454 for cfg in old_configs:
448 455 f = os.path.join(ipython_dir, cfg)
449 456 if os.path.exists(f):
450 457 if filehash(f) == old_config_md5.get(cfg, ''):
451 458 os.unlink(f)
452 459 else:
453 460 warn.warn("Found old IPython config file %r (modified by user)"%f)
454 461 warned = True
455 462
456 463 if warned:
457 464 warn.info("""
458 465 The IPython configuration system has changed as of 0.11, and these files will
459 466 be ignored. See http://ipython.github.com/ipython-doc/dev/config for details
460 467 of the new config system.
461 468 To start configuring IPython, do `ipython profile create`, and edit
462 469 `ipython_config.py` in <ipython_dir>/profile_default.
463 470 If you need to leave the old config files in place for an older version of
464 471 IPython and want to suppress this warning message, set
465 472 `c.InteractiveShellApp.ignore_old_config=True` in the new config.""")
466 473
@@ -1,404 +1,430 b''
1 1 # encoding: utf-8
2 2 """Tests for IPython.utils.path.py"""
3 3
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (C) 2008 The IPython Development Team
6 6 #
7 7 # Distributed under the terms of the BSD License. The full license is in
8 8 # the file COPYING, distributed as part of this software.
9 9 #-----------------------------------------------------------------------------
10 10
11 11 #-----------------------------------------------------------------------------
12 12 # Imports
13 13 #-----------------------------------------------------------------------------
14 14
15 from __future__ import with_statement
16
15 17 import os
16 18 import shutil
17 19 import sys
18 20 import tempfile
19 21 import StringIO
20 22
21 23 from os.path import join, abspath, split
22 24
23 25 import nose.tools as nt
24 26
25 27 from nose import with_setup
26 28
27 29 import IPython
28 30 from IPython.testing import decorators as dec
29 31 from IPython.testing.decorators import skip_if_not_win32, skip_win32
32 from IPython.testing.tools import make_tempfile
30 33 from IPython.utils import path, io
31 34
32 35 # Platform-dependent imports
33 36 try:
34 37 import _winreg as wreg
35 38 except ImportError:
36 39 #Fake _winreg module on none windows platforms
37 40 import new
38 41 sys.modules["_winreg"] = new.module("_winreg")
39 42 import _winreg as wreg
40 43 #Add entries that needs to be stubbed by the testing code
41 44 (wreg.OpenKey, wreg.QueryValueEx,) = (None, None)
42 45
43 46 #-----------------------------------------------------------------------------
44 47 # Globals
45 48 #-----------------------------------------------------------------------------
46 49 env = os.environ
47 50 TEST_FILE_PATH = split(abspath(__file__))[0]
48 51 TMP_TEST_DIR = tempfile.mkdtemp()
49 52 HOME_TEST_DIR = join(TMP_TEST_DIR, "home_test_dir")
50 53 XDG_TEST_DIR = join(HOME_TEST_DIR, "xdg_test_dir")
51 54 IP_TEST_DIR = join(HOME_TEST_DIR,'.ipython')
52 55 #
53 56 # Setup/teardown functions/decorators
54 57 #
55 58
56 59 def setup():
57 60 """Setup testenvironment for the module:
58 61
59 62 - Adds dummy home dir tree
60 63 """
61 64 # Do not mask exceptions here. In particular, catching WindowsError is a
62 65 # problem because that exception is only defined on Windows...
63 66 os.makedirs(IP_TEST_DIR)
64 67 os.makedirs(os.path.join(XDG_TEST_DIR, 'ipython'))
65 68
66 69
67 70 def teardown():
68 71 """Teardown testenvironment for the module:
69 72
70 73 - Remove dummy home dir tree
71 74 """
72 75 # Note: we remove the parent test dir, which is the root of all test
73 76 # subdirs we may have created. Use shutil instead of os.removedirs, so
74 77 # that non-empty directories are all recursively removed.
75 78 shutil.rmtree(TMP_TEST_DIR)
76 79
77 80
78 81 def setup_environment():
79 82 """Setup testenvironment for some functions that are tested
80 83 in this module. In particular this functions stores attributes
81 84 and other things that we need to stub in some test functions.
82 85 This needs to be done on a function level and not module level because
83 86 each testfunction needs a pristine environment.
84 87 """
85 88 global oldstuff, platformstuff
86 oldstuff = (env.copy(), os.name, path.get_home_dir, IPython.__file__)
89 oldstuff = (env.copy(), os.name, path.get_home_dir, IPython.__file__, os.getcwd())
87 90
88 91 if os.name == 'nt':
89 92 platformstuff = (wreg.OpenKey, wreg.QueryValueEx,)
90 93
91 94
92 95 def teardown_environment():
93 96 """Restore things that were remebered by the setup_environment function
94 97 """
95 (oldenv, os.name, path.get_home_dir, IPython.__file__,) = oldstuff
98 (oldenv, os.name, path.get_home_dir, IPython.__file__, old_wd) = oldstuff
99 os.chdir(old_wd)
96 100 reload(path)
97 101
98 102 for key in env.keys():
99 103 if key not in oldenv:
100 104 del env[key]
101 105 env.update(oldenv)
102 106 if hasattr(sys, 'frozen'):
103 107 del sys.frozen
104 108 if os.name == 'nt':
105 109 (wreg.OpenKey, wreg.QueryValueEx,) = platformstuff
106 110
107 111 # Build decorator that uses the setup_environment/setup_environment
108 112 with_environment = with_setup(setup_environment, teardown_environment)
109 113
110 114
111 115 @skip_if_not_win32
112 116 @with_environment
113 117 def test_get_home_dir_1():
114 118 """Testcase for py2exe logic, un-compressed lib
115 119 """
116 120 sys.frozen = True
117 121
118 122 #fake filename for IPython.__init__
119 123 IPython.__file__ = abspath(join(HOME_TEST_DIR, "Lib/IPython/__init__.py"))
120 124
121 125 home_dir = path.get_home_dir()
122 126 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
123 127
124 128
125 129 @skip_if_not_win32
126 130 @with_environment
127 131 def test_get_home_dir_2():
128 132 """Testcase for py2exe logic, compressed lib
129 133 """
130 134 sys.frozen = True
131 135 #fake filename for IPython.__init__
132 136 IPython.__file__ = abspath(join(HOME_TEST_DIR, "Library.zip/IPython/__init__.py")).lower()
133 137
134 138 home_dir = path.get_home_dir()
135 139 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR).lower())
136 140
137 141
138 142 @with_environment
139 143 @skip_win32
140 144 def test_get_home_dir_3():
141 145 """Testcase $HOME is set, then use its value as home directory."""
142 146 env["HOME"] = HOME_TEST_DIR
143 147 home_dir = path.get_home_dir()
144 148 nt.assert_equal(home_dir, env["HOME"])
145 149
146 150
147 151 @with_environment
148 152 @skip_win32
149 153 def test_get_home_dir_4():
150 154 """Testcase $HOME is not set, os=='posix'.
151 155 This should fail with HomeDirError"""
152 156
153 157 os.name = 'posix'
154 158 if 'HOME' in env: del env['HOME']
155 159 nt.assert_raises(path.HomeDirError, path.get_home_dir)
156 160
157 161
158 162 @skip_if_not_win32
159 163 @with_environment
160 164 def test_get_home_dir_5():
161 165 """Using HOMEDRIVE + HOMEPATH, os=='nt'.
162 166
163 167 HOMESHARE is missing.
164 168 """
165 169
166 170 os.name = 'nt'
167 171 env.pop('HOMESHARE', None)
168 172 env['HOMEDRIVE'], env['HOMEPATH'] = os.path.splitdrive(HOME_TEST_DIR)
169 173 home_dir = path.get_home_dir()
170 174 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
171 175
172 176
173 177 @skip_if_not_win32
174 178 @with_environment
175 179 def test_get_home_dir_6():
176 180 """Using USERPROFILE, os=='nt'.
177 181
178 182 HOMESHARE, HOMEDRIVE, HOMEPATH are missing.
179 183 """
180 184
181 185 os.name = 'nt'
182 186 env.pop('HOMESHARE', None)
183 187 env.pop('HOMEDRIVE', None)
184 188 env.pop('HOMEPATH', None)
185 189 env["USERPROFILE"] = abspath(HOME_TEST_DIR)
186 190 home_dir = path.get_home_dir()
187 191 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
188 192
189 193
190 194 @skip_if_not_win32
191 195 @with_environment
192 196 def test_get_home_dir_7():
193 197 """Using HOMESHARE, os=='nt'."""
194 198
195 199 os.name = 'nt'
196 200 env["HOMESHARE"] = abspath(HOME_TEST_DIR)
197 201 home_dir = path.get_home_dir()
198 202 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
199 203
200 204
201 205 # Should we stub wreg fully so we can run the test on all platforms?
202 206 @skip_if_not_win32
203 207 @with_environment
204 208 def test_get_home_dir_8():
205 209 """Using registry hack for 'My Documents', os=='nt'
206 210
207 211 HOMESHARE, HOMEDRIVE, HOMEPATH, USERPROFILE and others are missing.
208 212 """
209 213 os.name = 'nt'
210 214 # Remove from stub environment all keys that may be set
211 215 for key in ['HOME', 'HOMESHARE', 'HOMEDRIVE', 'HOMEPATH', 'USERPROFILE']:
212 216 env.pop(key, None)
213 217
214 218 #Stub windows registry functions
215 219 def OpenKey(x, y):
216 220 class key:
217 221 def Close(self):
218 222 pass
219 223 return key()
220 224 def QueryValueEx(x, y):
221 225 return [abspath(HOME_TEST_DIR)]
222 226
223 227 wreg.OpenKey = OpenKey
224 228 wreg.QueryValueEx = QueryValueEx
225 229
226 230 home_dir = path.get_home_dir()
227 231 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
228 232
229 233
230 234 @with_environment
231 235 def test_get_ipython_dir_1():
232 236 """test_get_ipython_dir_1, Testcase to see if we can call get_ipython_dir without Exceptions."""
233 237 env_ipdir = os.path.join("someplace", ".ipython")
234 238 path._writable_dir = lambda path: True
235 239 env['IPYTHON_DIR'] = env_ipdir
236 240 ipdir = path.get_ipython_dir()
237 241 nt.assert_equal(ipdir, env_ipdir)
238 242
239 243
240 244 @with_environment
241 245 def test_get_ipython_dir_2():
242 246 """test_get_ipython_dir_2, Testcase to see if we can call get_ipython_dir without Exceptions."""
243 247 path.get_home_dir = lambda : "someplace"
244 248 path.get_xdg_dir = lambda : None
245 249 path._writable_dir = lambda path: True
246 250 os.name = "posix"
247 251 env.pop('IPYTHON_DIR', None)
248 252 env.pop('IPYTHONDIR', None)
249 253 env.pop('XDG_CONFIG_HOME', None)
250 254 ipdir = path.get_ipython_dir()
251 255 nt.assert_equal(ipdir, os.path.join("someplace", ".ipython"))
252 256
253 257 @with_environment
254 258 def test_get_ipython_dir_3():
255 259 """test_get_ipython_dir_3, use XDG if defined, and .ipython doesn't exist."""
256 260 path.get_home_dir = lambda : "someplace"
257 261 path._writable_dir = lambda path: True
258 262 os.name = "posix"
259 263 env.pop('IPYTHON_DIR', None)
260 264 env.pop('IPYTHONDIR', None)
261 265 env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
262 266 ipdir = path.get_ipython_dir()
263 267 nt.assert_equal(ipdir, os.path.join(XDG_TEST_DIR, "ipython"))
264 268
265 269 @with_environment
266 270 def test_get_ipython_dir_4():
267 271 """test_get_ipython_dir_4, use XDG if both exist."""
268 272 path.get_home_dir = lambda : HOME_TEST_DIR
269 273 os.name = "posix"
270 274 env.pop('IPYTHON_DIR', None)
271 275 env.pop('IPYTHONDIR', None)
272 276 env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
273 277 xdg_ipdir = os.path.join(XDG_TEST_DIR, "ipython")
274 278 ipdir = path.get_ipython_dir()
275 279 nt.assert_equal(ipdir, xdg_ipdir)
276 280
277 281 @with_environment
278 282 def test_get_ipython_dir_5():
279 283 """test_get_ipython_dir_5, use .ipython if exists and XDG defined, but doesn't exist."""
280 284 path.get_home_dir = lambda : HOME_TEST_DIR
281 285 os.name = "posix"
282 286 env.pop('IPYTHON_DIR', None)
283 287 env.pop('IPYTHONDIR', None)
284 288 env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
285 289 os.rmdir(os.path.join(XDG_TEST_DIR, 'ipython'))
286 290 ipdir = path.get_ipython_dir()
287 291 nt.assert_equal(ipdir, IP_TEST_DIR)
288 292
289 293 @with_environment
290 294 def test_get_ipython_dir_6():
291 295 """test_get_ipython_dir_6, use XDG if defined and neither exist."""
292 296 xdg = os.path.join(HOME_TEST_DIR, 'somexdg')
293 297 os.mkdir(xdg)
294 298 shutil.rmtree(os.path.join(HOME_TEST_DIR, '.ipython'))
295 299 path.get_home_dir = lambda : HOME_TEST_DIR
296 300 path.get_xdg_dir = lambda : xdg
297 301 os.name = "posix"
298 302 env.pop('IPYTHON_DIR', None)
299 303 env.pop('IPYTHONDIR', None)
300 304 env.pop('XDG_CONFIG_HOME', None)
301 305 xdg_ipdir = os.path.join(xdg, "ipython")
302 306 ipdir = path.get_ipython_dir()
303 307 nt.assert_equal(ipdir, xdg_ipdir)
304 308
305 309 @with_environment
306 310 def test_get_ipython_dir_7():
307 311 """test_get_ipython_dir_7, test home directory expansion on IPYTHON_DIR"""
308 312 path._writable_dir = lambda path: True
309 313 home_dir = os.path.expanduser('~')
310 314 env['IPYTHON_DIR'] = os.path.join('~', 'somewhere')
311 315 ipdir = path.get_ipython_dir()
312 316 nt.assert_equal(ipdir, os.path.join(home_dir, 'somewhere'))
313 317
314 318
315 319 @with_environment
316 320 def test_get_xdg_dir_1():
317 321 """test_get_xdg_dir_1, check xdg_dir"""
318 322 reload(path)
319 323 path._writable_dir = lambda path: True
320 324 path.get_home_dir = lambda : 'somewhere'
321 325 os.name = "posix"
322 326 env.pop('IPYTHON_DIR', None)
323 327 env.pop('IPYTHONDIR', None)
324 328 env.pop('XDG_CONFIG_HOME', None)
325 329
326 330 nt.assert_equal(path.get_xdg_dir(), os.path.join('somewhere', '.config'))
327 331
328 332
329 333 @with_environment
330 334 def test_get_xdg_dir_1():
331 335 """test_get_xdg_dir_1, check nonexistant xdg_dir"""
332 336 reload(path)
333 337 path.get_home_dir = lambda : HOME_TEST_DIR
334 338 os.name = "posix"
335 339 env.pop('IPYTHON_DIR', None)
336 340 env.pop('IPYTHONDIR', None)
337 341 env.pop('XDG_CONFIG_HOME', None)
338 342 nt.assert_equal(path.get_xdg_dir(), None)
339 343
340 344 @with_environment
341 345 def test_get_xdg_dir_2():
342 346 """test_get_xdg_dir_2, check xdg_dir default to ~/.config"""
343 347 reload(path)
344 348 path.get_home_dir = lambda : HOME_TEST_DIR
345 349 os.name = "posix"
346 350 env.pop('IPYTHON_DIR', None)
347 351 env.pop('IPYTHONDIR', None)
348 352 env.pop('XDG_CONFIG_HOME', None)
349 353 cfgdir=os.path.join(path.get_home_dir(), '.config')
350 354 os.makedirs(cfgdir)
351 355
352 356 nt.assert_equal(path.get_xdg_dir(), cfgdir)
353 357
354 358 def test_filefind():
355 359 """Various tests for filefind"""
356 360 f = tempfile.NamedTemporaryFile()
357 361 # print 'fname:',f.name
358 362 alt_dirs = path.get_ipython_dir()
359 363 t = path.filefind(f.name, alt_dirs)
360 364 # print 'found:',t
361 365
362 366
363 367 def test_get_ipython_package_dir():
364 368 ipdir = path.get_ipython_package_dir()
365 369 nt.assert_true(os.path.isdir(ipdir))
366 370
367 371
368 372 def test_get_ipython_module_path():
369 373 ipapp_path = path.get_ipython_module_path('IPython.frontend.terminal.ipapp')
370 374 nt.assert_true(os.path.isfile(ipapp_path))
371 375
372 376
373 377 @dec.skip_if_not_win32
374 378 def test_get_long_path_name_win32():
375 379 p = path.get_long_path_name('c:\\docume~1')
376 380 nt.assert_equals(p,u'c:\\Documents and Settings')
377 381
378 382
379 383 @dec.skip_win32
380 384 def test_get_long_path_name():
381 385 p = path.get_long_path_name('/usr/local')
382 386 nt.assert_equals(p,'/usr/local')
383 387
384 388 @dec.skip_win32 # can't create not-user-writable dir on win
385 389 @with_environment
386 390 def test_not_writable_ipdir():
387 391 tmpdir = tempfile.mkdtemp()
388 392 os.name = "posix"
389 393 env.pop('IPYTHON_DIR', None)
390 394 env.pop('IPYTHONDIR', None)
391 395 env.pop('XDG_CONFIG_HOME', None)
392 396 env['HOME'] = tmpdir
393 397 ipdir = os.path.join(tmpdir, '.ipython')
394 398 os.mkdir(ipdir)
395 399 os.chmod(ipdir, 600)
396 400 stderr = io.stderr
397 401 pipe = StringIO.StringIO()
398 402 io.stderr = pipe
399 403 ipdir = path.get_ipython_dir()
400 404 io.stderr.flush()
401 405 io.stderr = stderr
402 406 nt.assert_true('WARNING' in pipe.getvalue())
403 407 env.pop('IPYTHON_DIR', None)
404 No newline at end of file
408
409 @with_environment
410 def test_get_py_filename():
411 os.chdir(TMP_TEST_DIR)
412 for win32 in (True, False):
413 with make_tempfile('foo.py'):
414 nt.assert_equals(path.get_py_filename('foo.py', win32=win32), 'foo.py')
415 nt.assert_equals(path.get_py_filename('foo', win32=win32), 'foo.py')
416 with make_tempfile('foo'):
417 nt.assert_equals(path.get_py_filename('foo', win32=win32), 'foo')
418 nt.assert_raises(IOError, path.get_py_filename, 'foo.py', win32=win32)
419 nt.assert_raises(IOError, path.get_py_filename, 'foo', win32=win32)
420 nt.assert_raises(IOError, path.get_py_filename, 'foo.py', win32=win32)
421 true_fn = 'foo with spaces.py'
422 with make_tempfile(true_fn):
423 nt.assert_equals(path.get_py_filename('foo with spaces', win32=win32), true_fn)
424 nt.assert_equals(path.get_py_filename('foo with spaces.py', win32=win32), true_fn)
425 if win32:
426 nt.assert_equals(path.get_py_filename('"foo with spaces.py"', win32=True), true_fn)
427 nt.assert_equals(path.get_py_filename("'foo with spaces.py'", win32=True), true_fn)
428 else:
429 nt.assert_raises(IOError, path.get_py_filename, '"foo with spaces.py"', win32=False)
430 nt.assert_raises(IOError, path.get_py_filename, "'foo with spaces.py'", win32=False)
General Comments 0
You need to be logged in to leave comments. Login now