##// END OF EJS Templates
BUG: break out the filename-unquoting from get_py_filename to be used in other contexts. Fix %save, in this respect.
Robert Kern -
Show More
@@ -1,3566 +1,3570 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 from IPython.utils.path import get_py_filename
56 from IPython.utils.path import get_py_filename, unquote_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, sys.platform == 'win32')
596 filename = get_py_filename(parameter_s)
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], sys.platform == 'win32')
1372 filename = get_py_filename(arg_lst[0])
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 dump_file = unquote_filename(dump_file)
1429 1430 prof.dump_stats(dump_file)
1430 1431 print '\n*** Profile stats marshalled to file',\
1431 1432 `dump_file`+'.',sys_exit
1432 1433 if text_file:
1434 text_file = unquote_filename(text_file)
1433 1435 pfile = file(text_file,'w')
1434 1436 pfile.write(output)
1435 1437 pfile.close()
1436 1438 print '\n*** Profile printout saved to text file',\
1437 1439 `text_file`+'.',sys_exit
1438 1440
1439 1441 if opts.has_key('r'):
1440 1442 return stats
1441 1443 else:
1442 1444 return None
1443 1445
1444 1446 @skip_doctest
1445 1447 def magic_run(self, parameter_s ='',runner=None,
1446 1448 file_finder=get_py_filename):
1447 1449 """Run the named file inside IPython as a program.
1448 1450
1449 1451 Usage:\\
1450 1452 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1451 1453
1452 1454 Parameters after the filename are passed as command-line arguments to
1453 1455 the program (put in sys.argv). Then, control returns to IPython's
1454 1456 prompt.
1455 1457
1456 1458 This is similar to running at a system prompt:\\
1457 1459 $ python file args\\
1458 1460 but with the advantage of giving you IPython's tracebacks, and of
1459 1461 loading all variables into your interactive namespace for further use
1460 1462 (unless -p is used, see below).
1461 1463
1462 1464 The file is executed in a namespace initially consisting only of
1463 1465 __name__=='__main__' and sys.argv constructed as indicated. It thus
1464 1466 sees its environment as if it were being run as a stand-alone program
1465 1467 (except for sharing global objects such as previously imported
1466 1468 modules). But after execution, the IPython interactive namespace gets
1467 1469 updated with all variables defined in the program (except for __name__
1468 1470 and sys.argv). This allows for very convenient loading of code for
1469 1471 interactive work, while giving each program a 'clean sheet' to run in.
1470 1472
1471 1473 Options:
1472 1474
1473 1475 -n: __name__ is NOT set to '__main__', but to the running file's name
1474 1476 without extension (as python does under import). This allows running
1475 1477 scripts and reloading the definitions in them without calling code
1476 1478 protected by an ' if __name__ == "__main__" ' clause.
1477 1479
1478 1480 -i: run the file in IPython's namespace instead of an empty one. This
1479 1481 is useful if you are experimenting with code written in a text editor
1480 1482 which depends on variables defined interactively.
1481 1483
1482 1484 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1483 1485 being run. This is particularly useful if IPython is being used to
1484 1486 run unittests, which always exit with a sys.exit() call. In such
1485 1487 cases you are interested in the output of the test results, not in
1486 1488 seeing a traceback of the unittest module.
1487 1489
1488 1490 -t: print timing information at the end of the run. IPython will give
1489 1491 you an estimated CPU time consumption for your script, which under
1490 1492 Unix uses the resource module to avoid the wraparound problems of
1491 1493 time.clock(). Under Unix, an estimate of time spent on system tasks
1492 1494 is also given (for Windows platforms this is reported as 0.0).
1493 1495
1494 1496 If -t is given, an additional -N<N> option can be given, where <N>
1495 1497 must be an integer indicating how many times you want the script to
1496 1498 run. The final timing report will include total and per run results.
1497 1499
1498 1500 For example (testing the script uniq_stable.py):
1499 1501
1500 1502 In [1]: run -t uniq_stable
1501 1503
1502 1504 IPython CPU timings (estimated):\\
1503 1505 User : 0.19597 s.\\
1504 1506 System: 0.0 s.\\
1505 1507
1506 1508 In [2]: run -t -N5 uniq_stable
1507 1509
1508 1510 IPython CPU timings (estimated):\\
1509 1511 Total runs performed: 5\\
1510 1512 Times : Total Per run\\
1511 1513 User : 0.910862 s, 0.1821724 s.\\
1512 1514 System: 0.0 s, 0.0 s.
1513 1515
1514 1516 -d: run your program under the control of pdb, the Python debugger.
1515 1517 This allows you to execute your program step by step, watch variables,
1516 1518 etc. Internally, what IPython does is similar to calling:
1517 1519
1518 1520 pdb.run('execfile("YOURFILENAME")')
1519 1521
1520 1522 with a breakpoint set on line 1 of your file. You can change the line
1521 1523 number for this automatic breakpoint to be <N> by using the -bN option
1522 1524 (where N must be an integer). For example:
1523 1525
1524 1526 %run -d -b40 myscript
1525 1527
1526 1528 will set the first breakpoint at line 40 in myscript.py. Note that
1527 1529 the first breakpoint must be set on a line which actually does
1528 1530 something (not a comment or docstring) for it to stop execution.
1529 1531
1530 1532 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1531 1533 first enter 'c' (without qoutes) to start execution up to the first
1532 1534 breakpoint.
1533 1535
1534 1536 Entering 'help' gives information about the use of the debugger. You
1535 1537 can easily see pdb's full documentation with "import pdb;pdb.help()"
1536 1538 at a prompt.
1537 1539
1538 1540 -p: run program under the control of the Python profiler module (which
1539 1541 prints a detailed report of execution times, function calls, etc).
1540 1542
1541 1543 You can pass other options after -p which affect the behavior of the
1542 1544 profiler itself. See the docs for %prun for details.
1543 1545
1544 1546 In this mode, the program's variables do NOT propagate back to the
1545 1547 IPython interactive namespace (because they remain in the namespace
1546 1548 where the profiler executes them).
1547 1549
1548 1550 Internally this triggers a call to %prun, see its documentation for
1549 1551 details on the options available specifically for profiling.
1550 1552
1551 1553 There is one special usage for which the text above doesn't apply:
1552 1554 if the filename ends with .ipy, the file is run as ipython script,
1553 1555 just as if the commands were written on IPython prompt.
1554 1556 """
1555 1557
1556 1558 # get arguments and set sys.argv for program to be run.
1557 1559 opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e',
1558 1560 mode='list',list_all=1)
1559 1561
1560 1562 try:
1561 filename = file_finder(arg_lst[0], sys.platform == 'win32')
1563 filename = file_finder(arg_lst[0])
1562 1564 except IndexError:
1563 1565 warn('you must provide at least a filename.')
1564 1566 print '\n%run:\n',oinspect.getdoc(self.magic_run)
1565 1567 return
1566 1568 except IOError,msg:
1567 1569 error(msg)
1568 1570 return
1569 1571
1570 1572 if filename.lower().endswith('.ipy'):
1571 1573 self.shell.safe_execfile_ipy(filename)
1572 1574 return
1573 1575
1574 1576 # Control the response to exit() calls made by the script being run
1575 1577 exit_ignore = opts.has_key('e')
1576 1578
1577 1579 # Make sure that the running script gets a proper sys.argv as if it
1578 1580 # were run from a system shell.
1579 1581 save_argv = sys.argv # save it for later restoring
1580 1582
1581 1583 # simulate shell expansion on arguments, at least tilde expansion
1582 1584 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
1583 1585
1584 1586 sys.argv = [filename]+ args # put in the proper filename
1585 1587
1586 1588 if opts.has_key('i'):
1587 1589 # Run in user's interactive namespace
1588 1590 prog_ns = self.shell.user_ns
1589 1591 __name__save = self.shell.user_ns['__name__']
1590 1592 prog_ns['__name__'] = '__main__'
1591 1593 main_mod = self.shell.new_main_mod(prog_ns)
1592 1594 else:
1593 1595 # Run in a fresh, empty namespace
1594 1596 if opts.has_key('n'):
1595 1597 name = os.path.splitext(os.path.basename(filename))[0]
1596 1598 else:
1597 1599 name = '__main__'
1598 1600
1599 1601 main_mod = self.shell.new_main_mod()
1600 1602 prog_ns = main_mod.__dict__
1601 1603 prog_ns['__name__'] = name
1602 1604
1603 1605 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1604 1606 # set the __file__ global in the script's namespace
1605 1607 prog_ns['__file__'] = filename
1606 1608
1607 1609 # pickle fix. See interactiveshell for an explanation. But we need to make sure
1608 1610 # that, if we overwrite __main__, we replace it at the end
1609 1611 main_mod_name = prog_ns['__name__']
1610 1612
1611 1613 if main_mod_name == '__main__':
1612 1614 restore_main = sys.modules['__main__']
1613 1615 else:
1614 1616 restore_main = False
1615 1617
1616 1618 # This needs to be undone at the end to prevent holding references to
1617 1619 # every single object ever created.
1618 1620 sys.modules[main_mod_name] = main_mod
1619 1621
1620 1622 try:
1621 1623 stats = None
1622 1624 with self.readline_no_record:
1623 1625 if opts.has_key('p'):
1624 1626 stats = self.magic_prun('',0,opts,arg_lst,prog_ns)
1625 1627 else:
1626 1628 if opts.has_key('d'):
1627 1629 deb = debugger.Pdb(self.shell.colors)
1628 1630 # reset Breakpoint state, which is moronically kept
1629 1631 # in a class
1630 1632 bdb.Breakpoint.next = 1
1631 1633 bdb.Breakpoint.bplist = {}
1632 1634 bdb.Breakpoint.bpbynumber = [None]
1633 1635 # Set an initial breakpoint to stop execution
1634 1636 maxtries = 10
1635 1637 bp = int(opts.get('b',[1])[0])
1636 1638 checkline = deb.checkline(filename,bp)
1637 1639 if not checkline:
1638 1640 for bp in range(bp+1,bp+maxtries+1):
1639 1641 if deb.checkline(filename,bp):
1640 1642 break
1641 1643 else:
1642 1644 msg = ("\nI failed to find a valid line to set "
1643 1645 "a breakpoint\n"
1644 1646 "after trying up to line: %s.\n"
1645 1647 "Please set a valid breakpoint manually "
1646 1648 "with the -b option." % bp)
1647 1649 error(msg)
1648 1650 return
1649 1651 # if we find a good linenumber, set the breakpoint
1650 1652 deb.do_break('%s:%s' % (filename,bp))
1651 1653 # Start file run
1652 1654 print "NOTE: Enter 'c' at the",
1653 1655 print "%s prompt to start your script." % deb.prompt
1654 1656 try:
1655 1657 deb.run('execfile("%s")' % filename,prog_ns)
1656 1658
1657 1659 except:
1658 1660 etype, value, tb = sys.exc_info()
1659 1661 # Skip three frames in the traceback: the %run one,
1660 1662 # one inside bdb.py, and the command-line typed by the
1661 1663 # user (run by exec in pdb itself).
1662 1664 self.shell.InteractiveTB(etype,value,tb,tb_offset=3)
1663 1665 else:
1664 1666 if runner is None:
1665 1667 runner = self.shell.safe_execfile
1666 1668 if opts.has_key('t'):
1667 1669 # timed execution
1668 1670 try:
1669 1671 nruns = int(opts['N'][0])
1670 1672 if nruns < 1:
1671 1673 error('Number of runs must be >=1')
1672 1674 return
1673 1675 except (KeyError):
1674 1676 nruns = 1
1675 1677 twall0 = time.time()
1676 1678 if nruns == 1:
1677 1679 t0 = clock2()
1678 1680 runner(filename,prog_ns,prog_ns,
1679 1681 exit_ignore=exit_ignore)
1680 1682 t1 = clock2()
1681 1683 t_usr = t1[0]-t0[0]
1682 1684 t_sys = t1[1]-t0[1]
1683 1685 print "\nIPython CPU timings (estimated):"
1684 1686 print " User : %10.2f s." % t_usr
1685 1687 print " System : %10.2f s." % t_sys
1686 1688 else:
1687 1689 runs = range(nruns)
1688 1690 t0 = clock2()
1689 1691 for nr in runs:
1690 1692 runner(filename,prog_ns,prog_ns,
1691 1693 exit_ignore=exit_ignore)
1692 1694 t1 = clock2()
1693 1695 t_usr = t1[0]-t0[0]
1694 1696 t_sys = t1[1]-t0[1]
1695 1697 print "\nIPython CPU timings (estimated):"
1696 1698 print "Total runs performed:",nruns
1697 1699 print " Times : %10.2f %10.2f" % ('Total','Per run')
1698 1700 print " User : %10.2f s, %10.2f s." % (t_usr,t_usr/nruns)
1699 1701 print " System : %10.2f s, %10.2f s." % (t_sys,t_sys/nruns)
1700 1702 twall1 = time.time()
1701 1703 print "Wall time: %10.2f s." % (twall1-twall0)
1702 1704
1703 1705 else:
1704 1706 # regular execution
1705 1707 runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore)
1706 1708
1707 1709 if opts.has_key('i'):
1708 1710 self.shell.user_ns['__name__'] = __name__save
1709 1711 else:
1710 1712 # The shell MUST hold a reference to prog_ns so after %run
1711 1713 # exits, the python deletion mechanism doesn't zero it out
1712 1714 # (leaving dangling references).
1713 1715 self.shell.cache_main_mod(prog_ns,filename)
1714 1716 # update IPython interactive namespace
1715 1717
1716 1718 # Some forms of read errors on the file may mean the
1717 1719 # __name__ key was never set; using pop we don't have to
1718 1720 # worry about a possible KeyError.
1719 1721 prog_ns.pop('__name__', None)
1720 1722
1721 1723 self.shell.user_ns.update(prog_ns)
1722 1724 finally:
1723 1725 # It's a bit of a mystery why, but __builtins__ can change from
1724 1726 # being a module to becoming a dict missing some key data after
1725 1727 # %run. As best I can see, this is NOT something IPython is doing
1726 1728 # at all, and similar problems have been reported before:
1727 1729 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1728 1730 # Since this seems to be done by the interpreter itself, the best
1729 1731 # we can do is to at least restore __builtins__ for the user on
1730 1732 # exit.
1731 1733 self.shell.user_ns['__builtins__'] = __builtin__
1732 1734
1733 1735 # Ensure key global structures are restored
1734 1736 sys.argv = save_argv
1735 1737 if restore_main:
1736 1738 sys.modules['__main__'] = restore_main
1737 1739 else:
1738 1740 # Remove from sys.modules the reference to main_mod we'd
1739 1741 # added. Otherwise it will trap references to objects
1740 1742 # contained therein.
1741 1743 del sys.modules[main_mod_name]
1742 1744
1743 1745 return stats
1744 1746
1745 1747 @skip_doctest
1746 1748 def magic_timeit(self, parameter_s =''):
1747 1749 """Time execution of a Python statement or expression
1748 1750
1749 1751 Usage:\\
1750 1752 %timeit [-n<N> -r<R> [-t|-c]] statement
1751 1753
1752 1754 Time execution of a Python statement or expression using the timeit
1753 1755 module.
1754 1756
1755 1757 Options:
1756 1758 -n<N>: execute the given statement <N> times in a loop. If this value
1757 1759 is not given, a fitting value is chosen.
1758 1760
1759 1761 -r<R>: repeat the loop iteration <R> times and take the best result.
1760 1762 Default: 3
1761 1763
1762 1764 -t: use time.time to measure the time, which is the default on Unix.
1763 1765 This function measures wall time.
1764 1766
1765 1767 -c: use time.clock to measure the time, which is the default on
1766 1768 Windows and measures wall time. On Unix, resource.getrusage is used
1767 1769 instead and returns the CPU user time.
1768 1770
1769 1771 -p<P>: use a precision of <P> digits to display the timing result.
1770 1772 Default: 3
1771 1773
1772 1774
1773 1775 Examples:
1774 1776
1775 1777 In [1]: %timeit pass
1776 1778 10000000 loops, best of 3: 53.3 ns per loop
1777 1779
1778 1780 In [2]: u = None
1779 1781
1780 1782 In [3]: %timeit u is None
1781 1783 10000000 loops, best of 3: 184 ns per loop
1782 1784
1783 1785 In [4]: %timeit -r 4 u == None
1784 1786 1000000 loops, best of 4: 242 ns per loop
1785 1787
1786 1788 In [5]: import time
1787 1789
1788 1790 In [6]: %timeit -n1 time.sleep(2)
1789 1791 1 loops, best of 3: 2 s per loop
1790 1792
1791 1793
1792 1794 The times reported by %timeit will be slightly higher than those
1793 1795 reported by the timeit.py script when variables are accessed. This is
1794 1796 due to the fact that %timeit executes the statement in the namespace
1795 1797 of the shell, compared with timeit.py, which uses a single setup
1796 1798 statement to import function or create variables. Generally, the bias
1797 1799 does not matter as long as results from timeit.py are not mixed with
1798 1800 those from %timeit."""
1799 1801
1800 1802 import timeit
1801 1803 import math
1802 1804
1803 1805 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1804 1806 # certain terminals. Until we figure out a robust way of
1805 1807 # auto-detecting if the terminal can deal with it, use plain 'us' for
1806 1808 # microseconds. I am really NOT happy about disabling the proper
1807 1809 # 'micro' prefix, but crashing is worse... If anyone knows what the
1808 1810 # right solution for this is, I'm all ears...
1809 1811 #
1810 1812 # Note: using
1811 1813 #
1812 1814 # s = u'\xb5'
1813 1815 # s.encode(sys.getdefaultencoding())
1814 1816 #
1815 1817 # is not sufficient, as I've seen terminals where that fails but
1816 1818 # print s
1817 1819 #
1818 1820 # succeeds
1819 1821 #
1820 1822 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1821 1823
1822 1824 #units = [u"s", u"ms",u'\xb5',"ns"]
1823 1825 units = [u"s", u"ms",u'us',"ns"]
1824 1826
1825 1827 scaling = [1, 1e3, 1e6, 1e9]
1826 1828
1827 1829 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1828 1830 posix=False)
1829 1831 if stmt == "":
1830 1832 return
1831 1833 timefunc = timeit.default_timer
1832 1834 number = int(getattr(opts, "n", 0))
1833 1835 repeat = int(getattr(opts, "r", timeit.default_repeat))
1834 1836 precision = int(getattr(opts, "p", 3))
1835 1837 if hasattr(opts, "t"):
1836 1838 timefunc = time.time
1837 1839 if hasattr(opts, "c"):
1838 1840 timefunc = clock
1839 1841
1840 1842 timer = timeit.Timer(timer=timefunc)
1841 1843 # this code has tight coupling to the inner workings of timeit.Timer,
1842 1844 # but is there a better way to achieve that the code stmt has access
1843 1845 # to the shell namespace?
1844 1846
1845 1847 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1846 1848 'setup': "pass"}
1847 1849 # Track compilation time so it can be reported if too long
1848 1850 # Minimum time above which compilation time will be reported
1849 1851 tc_min = 0.1
1850 1852
1851 1853 t0 = clock()
1852 1854 code = compile(src, "<magic-timeit>", "exec")
1853 1855 tc = clock()-t0
1854 1856
1855 1857 ns = {}
1856 1858 exec code in self.shell.user_ns, ns
1857 1859 timer.inner = ns["inner"]
1858 1860
1859 1861 if number == 0:
1860 1862 # determine number so that 0.2 <= total time < 2.0
1861 1863 number = 1
1862 1864 for i in range(1, 10):
1863 1865 if timer.timeit(number) >= 0.2:
1864 1866 break
1865 1867 number *= 10
1866 1868
1867 1869 best = min(timer.repeat(repeat, number)) / number
1868 1870
1869 1871 if best > 0.0 and best < 1000.0:
1870 1872 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1871 1873 elif best >= 1000.0:
1872 1874 order = 0
1873 1875 else:
1874 1876 order = 3
1875 1877 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1876 1878 precision,
1877 1879 best * scaling[order],
1878 1880 units[order])
1879 1881 if tc > tc_min:
1880 1882 print "Compiler time: %.2f s" % tc
1881 1883
1882 1884 @skip_doctest
1883 1885 @needs_local_scope
1884 1886 def magic_time(self,parameter_s = ''):
1885 1887 """Time execution of a Python statement or expression.
1886 1888
1887 1889 The CPU and wall clock times are printed, and the value of the
1888 1890 expression (if any) is returned. Note that under Win32, system time
1889 1891 is always reported as 0, since it can not be measured.
1890 1892
1891 1893 This function provides very basic timing functionality. In Python
1892 1894 2.3, the timeit module offers more control and sophistication, so this
1893 1895 could be rewritten to use it (patches welcome).
1894 1896
1895 1897 Some examples:
1896 1898
1897 1899 In [1]: time 2**128
1898 1900 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1899 1901 Wall time: 0.00
1900 1902 Out[1]: 340282366920938463463374607431768211456L
1901 1903
1902 1904 In [2]: n = 1000000
1903 1905
1904 1906 In [3]: time sum(range(n))
1905 1907 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
1906 1908 Wall time: 1.37
1907 1909 Out[3]: 499999500000L
1908 1910
1909 1911 In [4]: time print 'hello world'
1910 1912 hello world
1911 1913 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1912 1914 Wall time: 0.00
1913 1915
1914 1916 Note that the time needed by Python to compile the given expression
1915 1917 will be reported if it is more than 0.1s. In this example, the
1916 1918 actual exponentiation is done by Python at compilation time, so while
1917 1919 the expression can take a noticeable amount of time to compute, that
1918 1920 time is purely due to the compilation:
1919 1921
1920 1922 In [5]: time 3**9999;
1921 1923 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1922 1924 Wall time: 0.00 s
1923 1925
1924 1926 In [6]: time 3**999999;
1925 1927 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1926 1928 Wall time: 0.00 s
1927 1929 Compiler : 0.78 s
1928 1930 """
1929 1931
1930 1932 # fail immediately if the given expression can't be compiled
1931 1933
1932 1934 expr = self.shell.prefilter(parameter_s,False)
1933 1935
1934 1936 # Minimum time above which compilation time will be reported
1935 1937 tc_min = 0.1
1936 1938
1937 1939 try:
1938 1940 mode = 'eval'
1939 1941 t0 = clock()
1940 1942 code = compile(expr,'<timed eval>',mode)
1941 1943 tc = clock()-t0
1942 1944 except SyntaxError:
1943 1945 mode = 'exec'
1944 1946 t0 = clock()
1945 1947 code = compile(expr,'<timed exec>',mode)
1946 1948 tc = clock()-t0
1947 1949 # skew measurement as little as possible
1948 1950 glob = self.shell.user_ns
1949 1951 locs = self._magic_locals
1950 1952 clk = clock2
1951 1953 wtime = time.time
1952 1954 # time execution
1953 1955 wall_st = wtime()
1954 1956 if mode=='eval':
1955 1957 st = clk()
1956 1958 out = eval(code, glob, locs)
1957 1959 end = clk()
1958 1960 else:
1959 1961 st = clk()
1960 1962 exec code in glob, locs
1961 1963 end = clk()
1962 1964 out = None
1963 1965 wall_end = wtime()
1964 1966 # Compute actual times and report
1965 1967 wall_time = wall_end-wall_st
1966 1968 cpu_user = end[0]-st[0]
1967 1969 cpu_sys = end[1]-st[1]
1968 1970 cpu_tot = cpu_user+cpu_sys
1969 1971 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
1970 1972 (cpu_user,cpu_sys,cpu_tot)
1971 1973 print "Wall time: %.2f s" % wall_time
1972 1974 if tc > tc_min:
1973 1975 print "Compiler : %.2f s" % tc
1974 1976 return out
1975 1977
1976 1978 @skip_doctest
1977 1979 def magic_macro(self,parameter_s = ''):
1978 1980 """Define a macro for future re-execution. It accepts ranges of history,
1979 1981 filenames or string objects.
1980 1982
1981 1983 Usage:\\
1982 1984 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
1983 1985
1984 1986 Options:
1985 1987
1986 1988 -r: use 'raw' input. By default, the 'processed' history is used,
1987 1989 so that magics are loaded in their transformed version to valid
1988 1990 Python. If this option is given, the raw input as typed as the
1989 1991 command line is used instead.
1990 1992
1991 1993 This will define a global variable called `name` which is a string
1992 1994 made of joining the slices and lines you specify (n1,n2,... numbers
1993 1995 above) from your input history into a single string. This variable
1994 1996 acts like an automatic function which re-executes those lines as if
1995 1997 you had typed them. You just type 'name' at the prompt and the code
1996 1998 executes.
1997 1999
1998 2000 The syntax for indicating input ranges is described in %history.
1999 2001
2000 2002 Note: as a 'hidden' feature, you can also use traditional python slice
2001 2003 notation, where N:M means numbers N through M-1.
2002 2004
2003 2005 For example, if your history contains (%hist prints it):
2004 2006
2005 2007 44: x=1
2006 2008 45: y=3
2007 2009 46: z=x+y
2008 2010 47: print x
2009 2011 48: a=5
2010 2012 49: print 'x',x,'y',y
2011 2013
2012 2014 you can create a macro with lines 44 through 47 (included) and line 49
2013 2015 called my_macro with:
2014 2016
2015 2017 In [55]: %macro my_macro 44-47 49
2016 2018
2017 2019 Now, typing `my_macro` (without quotes) will re-execute all this code
2018 2020 in one pass.
2019 2021
2020 2022 You don't need to give the line-numbers in order, and any given line
2021 2023 number can appear multiple times. You can assemble macros with any
2022 2024 lines from your input history in any order.
2023 2025
2024 2026 The macro is a simple object which holds its value in an attribute,
2025 2027 but IPython's display system checks for macros and executes them as
2026 2028 code instead of printing them when you type their name.
2027 2029
2028 2030 You can view a macro's contents by explicitly printing it with:
2029 2031
2030 2032 'print macro_name'.
2031 2033
2032 2034 """
2033 2035 opts,args = self.parse_options(parameter_s,'r',mode='list')
2034 2036 if not args: # List existing macros
2035 2037 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2036 2038 isinstance(v, Macro))
2037 2039 if len(args) == 1:
2038 2040 raise UsageError(
2039 2041 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2040 2042 name, codefrom = args[0], " ".join(args[1:])
2041 2043
2042 2044 #print 'rng',ranges # dbg
2043 2045 try:
2044 2046 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2045 2047 except (ValueError, TypeError) as e:
2046 2048 print e.args[0]
2047 2049 return
2048 2050 macro = Macro(lines)
2049 2051 self.shell.define_macro(name, macro)
2050 2052 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2051 2053 print '=== Macro contents: ==='
2052 2054 print macro,
2053 2055
2054 2056 def magic_save(self,parameter_s = ''):
2055 2057 """Save a set of lines or a macro to a given filename.
2056 2058
2057 2059 Usage:\\
2058 2060 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
2059 2061
2060 2062 Options:
2061 2063
2062 2064 -r: use 'raw' input. By default, the 'processed' history is used,
2063 2065 so that magics are loaded in their transformed version to valid
2064 2066 Python. If this option is given, the raw input as typed as the
2065 2067 command line is used instead.
2066 2068
2067 2069 This function uses the same syntax as %history for input ranges,
2068 2070 then saves the lines to the filename you specify.
2069 2071
2070 2072 It adds a '.py' extension to the file if you don't do so yourself, and
2071 2073 it asks for confirmation before overwriting existing files."""
2072 2074
2073 2075 opts,args = self.parse_options(parameter_s,'r',mode='list')
2074 fname, codefrom = args[0], " ".join(args[1:])
2076 fname, codefrom = unquote_filename(args[0]), " ".join(args[1:])
2075 2077 if not fname.endswith('.py'):
2076 2078 fname += '.py'
2077 2079 if os.path.isfile(fname):
2078 2080 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
2079 2081 if ans.lower() not in ['y','yes']:
2080 2082 print 'Operation cancelled.'
2081 2083 return
2082 2084 try:
2083 2085 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
2084 2086 except (TypeError, ValueError) as e:
2085 2087 print e.args[0]
2086 2088 return
2087 2089 if isinstance(cmds, unicode):
2088 2090 cmds = cmds.encode("utf-8")
2089 2091 with open(fname,'w') as f:
2090 2092 f.write("# coding: utf-8\n")
2091 2093 f.write(cmds)
2092 2094 print 'The following commands were written to file `%s`:' % fname
2093 2095 print cmds
2094 2096
2095 2097 def magic_pastebin(self, parameter_s = ''):
2096 2098 """Upload code to the 'Lodge it' paste bin, returning the URL."""
2097 2099 try:
2098 2100 code = self.shell.find_user_code(parameter_s)
2099 2101 except (ValueError, TypeError) as e:
2100 2102 print e.args[0]
2101 2103 return
2102 2104 pbserver = ServerProxy('http://paste.pocoo.org/xmlrpc/')
2103 2105 id = pbserver.pastes.newPaste("python", code)
2104 2106 return "http://paste.pocoo.org/show/" + id
2105 2107
2106 2108 def magic_loadpy(self, arg_s):
2107 2109 """Load a .py python script into the GUI console.
2108 2110
2109 2111 This magic command can either take a local filename or a url::
2110 2112
2111 2113 %loadpy myscript.py
2112 2114 %loadpy http://www.example.com/myscript.py
2113 2115 """
2116 arg_s = unquote_filename(arg_s)
2114 2117 if not arg_s.endswith('.py'):
2115 2118 raise ValueError('%%load only works with .py files: %s' % arg_s)
2116 2119 if arg_s.startswith('http'):
2117 2120 import urllib2
2118 2121 response = urllib2.urlopen(arg_s)
2119 2122 content = response.read()
2120 2123 else:
2121 2124 with open(arg_s) as f:
2122 2125 content = f.read()
2123 2126 self.set_next_input(content)
2124 2127
2125 2128 def _find_edit_target(self, args, opts, last_call):
2126 2129 """Utility method used by magic_edit to find what to edit."""
2127 2130
2128 2131 def make_filename(arg):
2129 2132 "Make a filename from the given args"
2133 arg = unquote_filename(arg)
2130 2134 try:
2131 filename = get_py_filename(arg, win32=sys.platform == 'win32')
2135 filename = get_py_filename(arg)
2132 2136 except IOError:
2133 2137 # If it ends with .py but doesn't already exist, assume we want
2134 2138 # a new file.
2135 if args.endswith('.py'):
2139 if arg.endswith('.py'):
2136 2140 filename = arg
2137 2141 else:
2138 2142 filename = None
2139 2143 return filename
2140 2144
2141 2145 # Set a few locals from the options for convenience:
2142 2146 opts_prev = 'p' in opts
2143 2147 opts_raw = 'r' in opts
2144 2148
2145 2149 # custom exceptions
2146 2150 class DataIsObject(Exception): pass
2147 2151
2148 2152 # Default line number value
2149 2153 lineno = opts.get('n',None)
2150 2154
2151 2155 if opts_prev:
2152 2156 args = '_%s' % last_call[0]
2153 2157 if not self.shell.user_ns.has_key(args):
2154 2158 args = last_call[1]
2155 2159
2156 2160 # use last_call to remember the state of the previous call, but don't
2157 2161 # let it be clobbered by successive '-p' calls.
2158 2162 try:
2159 2163 last_call[0] = self.shell.displayhook.prompt_count
2160 2164 if not opts_prev:
2161 2165 last_call[1] = parameter_s
2162 2166 except:
2163 2167 pass
2164 2168
2165 2169 # by default this is done with temp files, except when the given
2166 2170 # arg is a filename
2167 2171 use_temp = True
2168 2172
2169 2173 data = ''
2170 2174
2171 2175 # First, see if the arguments should be a filename.
2172 2176 filename = make_filename(args)
2173 2177 if filename:
2174 2178 use_temp = False
2175 2179 elif args:
2176 2180 # Mode where user specifies ranges of lines, like in %macro.
2177 2181 data = self.extract_input_lines(args, opts_raw)
2178 2182 if not data:
2179 2183 try:
2180 2184 # Load the parameter given as a variable. If not a string,
2181 2185 # process it as an object instead (below)
2182 2186
2183 2187 #print '*** args',args,'type',type(args) # dbg
2184 2188 data = eval(args, self.shell.user_ns)
2185 2189 if not isinstance(data, basestring):
2186 2190 raise DataIsObject
2187 2191
2188 2192 except (NameError,SyntaxError):
2189 2193 # given argument is not a variable, try as a filename
2190 2194 filename = make_filename(args)
2191 2195 if filename is None:
2192 2196 warn("Argument given (%s) can't be found as a variable "
2193 2197 "or as a filename." % args)
2194 2198 return
2195 2199 use_temp = False
2196 2200
2197 2201 except DataIsObject:
2198 2202 # macros have a special edit function
2199 2203 if isinstance(data, Macro):
2200 2204 raise MacroToEdit(data)
2201 2205
2202 2206 # For objects, try to edit the file where they are defined
2203 2207 try:
2204 2208 filename = inspect.getabsfile(data)
2205 2209 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2206 2210 # class created by %edit? Try to find source
2207 2211 # by looking for method definitions instead, the
2208 2212 # __module__ in those classes is FakeModule.
2209 2213 attrs = [getattr(data, aname) for aname in dir(data)]
2210 2214 for attr in attrs:
2211 2215 if not inspect.ismethod(attr):
2212 2216 continue
2213 2217 filename = inspect.getabsfile(attr)
2214 2218 if filename and 'fakemodule' not in filename.lower():
2215 2219 # change the attribute to be the edit target instead
2216 2220 data = attr
2217 2221 break
2218 2222
2219 2223 datafile = 1
2220 2224 except TypeError:
2221 2225 filename = make_filename(args)
2222 2226 datafile = 1
2223 2227 warn('Could not find file where `%s` is defined.\n'
2224 2228 'Opening a file named `%s`' % (args,filename))
2225 2229 # Now, make sure we can actually read the source (if it was in
2226 2230 # a temp file it's gone by now).
2227 2231 if datafile:
2228 2232 try:
2229 2233 if lineno is None:
2230 2234 lineno = inspect.getsourcelines(data)[1]
2231 2235 except IOError:
2232 2236 filename = make_filename(args)
2233 2237 if filename is None:
2234 2238 warn('The file `%s` where `%s` was defined cannot '
2235 2239 'be read.' % (filename,data))
2236 2240 return
2237 2241 use_temp = False
2238 2242
2239 2243 if use_temp:
2240 2244 filename = self.shell.mktempfile(data)
2241 2245 print 'IPython will make a temporary file named:',filename
2242 2246
2243 2247 return filename, lineno, use_temp
2244 2248
2245 2249 def _edit_macro(self,mname,macro):
2246 2250 """open an editor with the macro data in a file"""
2247 2251 filename = self.shell.mktempfile(macro.value)
2248 2252 self.shell.hooks.editor(filename)
2249 2253
2250 2254 # and make a new macro object, to replace the old one
2251 2255 mfile = open(filename)
2252 2256 mvalue = mfile.read()
2253 2257 mfile.close()
2254 2258 self.shell.user_ns[mname] = Macro(mvalue)
2255 2259
2256 2260 def magic_ed(self,parameter_s=''):
2257 2261 """Alias to %edit."""
2258 2262 return self.magic_edit(parameter_s)
2259 2263
2260 2264 @skip_doctest
2261 2265 def magic_edit(self,parameter_s='',last_call=['','']):
2262 2266 """Bring up an editor and execute the resulting code.
2263 2267
2264 2268 Usage:
2265 2269 %edit [options] [args]
2266 2270
2267 2271 %edit runs IPython's editor hook. The default version of this hook is
2268 2272 set to call the __IPYTHON__.rc.editor command. This is read from your
2269 2273 environment variable $EDITOR. If this isn't found, it will default to
2270 2274 vi under Linux/Unix and to notepad under Windows. See the end of this
2271 2275 docstring for how to change the editor hook.
2272 2276
2273 2277 You can also set the value of this editor via the command line option
2274 2278 '-editor' or in your ipythonrc file. This is useful if you wish to use
2275 2279 specifically for IPython an editor different from your typical default
2276 2280 (and for Windows users who typically don't set environment variables).
2277 2281
2278 2282 This command allows you to conveniently edit multi-line code right in
2279 2283 your IPython session.
2280 2284
2281 2285 If called without arguments, %edit opens up an empty editor with a
2282 2286 temporary file and will execute the contents of this file when you
2283 2287 close it (don't forget to save it!).
2284 2288
2285 2289
2286 2290 Options:
2287 2291
2288 2292 -n <number>: open the editor at a specified line number. By default,
2289 2293 the IPython editor hook uses the unix syntax 'editor +N filename', but
2290 2294 you can configure this by providing your own modified hook if your
2291 2295 favorite editor supports line-number specifications with a different
2292 2296 syntax.
2293 2297
2294 2298 -p: this will call the editor with the same data as the previous time
2295 2299 it was used, regardless of how long ago (in your current session) it
2296 2300 was.
2297 2301
2298 2302 -r: use 'raw' input. This option only applies to input taken from the
2299 2303 user's history. By default, the 'processed' history is used, so that
2300 2304 magics are loaded in their transformed version to valid Python. If
2301 2305 this option is given, the raw input as typed as the command line is
2302 2306 used instead. When you exit the editor, it will be executed by
2303 2307 IPython's own processor.
2304 2308
2305 2309 -x: do not execute the edited code immediately upon exit. This is
2306 2310 mainly useful if you are editing programs which need to be called with
2307 2311 command line arguments, which you can then do using %run.
2308 2312
2309 2313
2310 2314 Arguments:
2311 2315
2312 2316 If arguments are given, the following possibilites exist:
2313 2317
2314 2318 - If the argument is a filename, IPython will load that into the
2315 2319 editor. It will execute its contents with execfile() when you exit,
2316 2320 loading any code in the file into your interactive namespace.
2317 2321
2318 2322 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
2319 2323 The syntax is the same as in the %history magic.
2320 2324
2321 2325 - If the argument is a string variable, its contents are loaded
2322 2326 into the editor. You can thus edit any string which contains
2323 2327 python code (including the result of previous edits).
2324 2328
2325 2329 - If the argument is the name of an object (other than a string),
2326 2330 IPython will try to locate the file where it was defined and open the
2327 2331 editor at the point where it is defined. You can use `%edit function`
2328 2332 to load an editor exactly at the point where 'function' is defined,
2329 2333 edit it and have the file be executed automatically.
2330 2334
2331 2335 If the object is a macro (see %macro for details), this opens up your
2332 2336 specified editor with a temporary file containing the macro's data.
2333 2337 Upon exit, the macro is reloaded with the contents of the file.
2334 2338
2335 2339 Note: opening at an exact line is only supported under Unix, and some
2336 2340 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2337 2341 '+NUMBER' parameter necessary for this feature. Good editors like
2338 2342 (X)Emacs, vi, jed, pico and joe all do.
2339 2343
2340 2344 After executing your code, %edit will return as output the code you
2341 2345 typed in the editor (except when it was an existing file). This way
2342 2346 you can reload the code in further invocations of %edit as a variable,
2343 2347 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2344 2348 the output.
2345 2349
2346 2350 Note that %edit is also available through the alias %ed.
2347 2351
2348 2352 This is an example of creating a simple function inside the editor and
2349 2353 then modifying it. First, start up the editor:
2350 2354
2351 2355 In [1]: ed
2352 2356 Editing... done. Executing edited code...
2353 2357 Out[1]: 'def foo():n print "foo() was defined in an editing session"n'
2354 2358
2355 2359 We can then call the function foo():
2356 2360
2357 2361 In [2]: foo()
2358 2362 foo() was defined in an editing session
2359 2363
2360 2364 Now we edit foo. IPython automatically loads the editor with the
2361 2365 (temporary) file where foo() was previously defined:
2362 2366
2363 2367 In [3]: ed foo
2364 2368 Editing... done. Executing edited code...
2365 2369
2366 2370 And if we call foo() again we get the modified version:
2367 2371
2368 2372 In [4]: foo()
2369 2373 foo() has now been changed!
2370 2374
2371 2375 Here is an example of how to edit a code snippet successive
2372 2376 times. First we call the editor:
2373 2377
2374 2378 In [5]: ed
2375 2379 Editing... done. Executing edited code...
2376 2380 hello
2377 2381 Out[5]: "print 'hello'n"
2378 2382
2379 2383 Now we call it again with the previous output (stored in _):
2380 2384
2381 2385 In [6]: ed _
2382 2386 Editing... done. Executing edited code...
2383 2387 hello world
2384 2388 Out[6]: "print 'hello world'n"
2385 2389
2386 2390 Now we call it with the output #8 (stored in _8, also as Out[8]):
2387 2391
2388 2392 In [7]: ed _8
2389 2393 Editing... done. Executing edited code...
2390 2394 hello again
2391 2395 Out[7]: "print 'hello again'n"
2392 2396
2393 2397
2394 2398 Changing the default editor hook:
2395 2399
2396 2400 If you wish to write your own editor hook, you can put it in a
2397 2401 configuration file which you load at startup time. The default hook
2398 2402 is defined in the IPython.core.hooks module, and you can use that as a
2399 2403 starting example for further modifications. That file also has
2400 2404 general instructions on how to set a new hook for use once you've
2401 2405 defined it."""
2402 2406 opts,args = self.parse_options(parameter_s,'prxn:')
2403 2407
2404 2408 try:
2405 2409 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
2406 2410 except MacroToEdit as e:
2407 2411 self._edit_macro(args, e.args[0])
2408 2412 return
2409 2413
2410 2414 # do actual editing here
2411 2415 print 'Editing...',
2412 2416 sys.stdout.flush()
2413 2417 try:
2414 2418 # Quote filenames that may have spaces in them
2415 2419 if ' ' in filename:
2416 2420 filename = "'%s'" % filename
2417 2421 self.shell.hooks.editor(filename,lineno)
2418 2422 except TryNext:
2419 2423 warn('Could not open editor')
2420 2424 return
2421 2425
2422 2426 # XXX TODO: should this be generalized for all string vars?
2423 2427 # For now, this is special-cased to blocks created by cpaste
2424 2428 if args.strip() == 'pasted_block':
2425 2429 self.shell.user_ns['pasted_block'] = file_read(filename)
2426 2430
2427 2431 if 'x' in opts: # -x prevents actual execution
2428 2432 print
2429 2433 else:
2430 2434 print 'done. Executing edited code...'
2431 2435 if 'r' in opts: # Untranslated IPython code
2432 2436 self.shell.run_cell(file_read(filename),
2433 2437 store_history=False)
2434 2438 else:
2435 2439 self.shell.safe_execfile(filename,self.shell.user_ns,
2436 2440 self.shell.user_ns)
2437 2441
2438 2442 if is_temp:
2439 2443 try:
2440 2444 return open(filename).read()
2441 2445 except IOError,msg:
2442 2446 if msg.filename == filename:
2443 2447 warn('File not found. Did you forget to save?')
2444 2448 return
2445 2449 else:
2446 2450 self.shell.showtraceback()
2447 2451
2448 2452 def magic_xmode(self,parameter_s = ''):
2449 2453 """Switch modes for the exception handlers.
2450 2454
2451 2455 Valid modes: Plain, Context and Verbose.
2452 2456
2453 2457 If called without arguments, acts as a toggle."""
2454 2458
2455 2459 def xmode_switch_err(name):
2456 2460 warn('Error changing %s exception modes.\n%s' %
2457 2461 (name,sys.exc_info()[1]))
2458 2462
2459 2463 shell = self.shell
2460 2464 new_mode = parameter_s.strip().capitalize()
2461 2465 try:
2462 2466 shell.InteractiveTB.set_mode(mode=new_mode)
2463 2467 print 'Exception reporting mode:',shell.InteractiveTB.mode
2464 2468 except:
2465 2469 xmode_switch_err('user')
2466 2470
2467 2471 def magic_colors(self,parameter_s = ''):
2468 2472 """Switch color scheme for prompts, info system and exception handlers.
2469 2473
2470 2474 Currently implemented schemes: NoColor, Linux, LightBG.
2471 2475
2472 2476 Color scheme names are not case-sensitive.
2473 2477
2474 2478 Examples
2475 2479 --------
2476 2480 To get a plain black and white terminal::
2477 2481
2478 2482 %colors nocolor
2479 2483 """
2480 2484
2481 2485 def color_switch_err(name):
2482 2486 warn('Error changing %s color schemes.\n%s' %
2483 2487 (name,sys.exc_info()[1]))
2484 2488
2485 2489
2486 2490 new_scheme = parameter_s.strip()
2487 2491 if not new_scheme:
2488 2492 raise UsageError(
2489 2493 "%colors: you must specify a color scheme. See '%colors?'")
2490 2494 return
2491 2495 # local shortcut
2492 2496 shell = self.shell
2493 2497
2494 2498 import IPython.utils.rlineimpl as readline
2495 2499
2496 2500 if not readline.have_readline and sys.platform == "win32":
2497 2501 msg = """\
2498 2502 Proper color support under MS Windows requires the pyreadline library.
2499 2503 You can find it at:
2500 2504 http://ipython.scipy.org/moin/PyReadline/Intro
2501 2505 Gary's readline needs the ctypes module, from:
2502 2506 http://starship.python.net/crew/theller/ctypes
2503 2507 (Note that ctypes is already part of Python versions 2.5 and newer).
2504 2508
2505 2509 Defaulting color scheme to 'NoColor'"""
2506 2510 new_scheme = 'NoColor'
2507 2511 warn(msg)
2508 2512
2509 2513 # readline option is 0
2510 2514 if not shell.has_readline:
2511 2515 new_scheme = 'NoColor'
2512 2516
2513 2517 # Set prompt colors
2514 2518 try:
2515 2519 shell.displayhook.set_colors(new_scheme)
2516 2520 except:
2517 2521 color_switch_err('prompt')
2518 2522 else:
2519 2523 shell.colors = \
2520 2524 shell.displayhook.color_table.active_scheme_name
2521 2525 # Set exception colors
2522 2526 try:
2523 2527 shell.InteractiveTB.set_colors(scheme = new_scheme)
2524 2528 shell.SyntaxTB.set_colors(scheme = new_scheme)
2525 2529 except:
2526 2530 color_switch_err('exception')
2527 2531
2528 2532 # Set info (for 'object?') colors
2529 2533 if shell.color_info:
2530 2534 try:
2531 2535 shell.inspector.set_active_scheme(new_scheme)
2532 2536 except:
2533 2537 color_switch_err('object inspector')
2534 2538 else:
2535 2539 shell.inspector.set_active_scheme('NoColor')
2536 2540
2537 2541 def magic_pprint(self, parameter_s=''):
2538 2542 """Toggle pretty printing on/off."""
2539 2543 ptformatter = self.shell.display_formatter.formatters['text/plain']
2540 2544 ptformatter.pprint = bool(1 - ptformatter.pprint)
2541 2545 print 'Pretty printing has been turned', \
2542 2546 ['OFF','ON'][ptformatter.pprint]
2543 2547
2544 2548 #......................................................................
2545 2549 # Functions to implement unix shell-type things
2546 2550
2547 2551 @skip_doctest
2548 2552 def magic_alias(self, parameter_s = ''):
2549 2553 """Define an alias for a system command.
2550 2554
2551 2555 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2552 2556
2553 2557 Then, typing 'alias_name params' will execute the system command 'cmd
2554 2558 params' (from your underlying operating system).
2555 2559
2556 2560 Aliases have lower precedence than magic functions and Python normal
2557 2561 variables, so if 'foo' is both a Python variable and an alias, the
2558 2562 alias can not be executed until 'del foo' removes the Python variable.
2559 2563
2560 2564 You can use the %l specifier in an alias definition to represent the
2561 2565 whole line when the alias is called. For example:
2562 2566
2563 2567 In [2]: alias bracket echo "Input in brackets: <%l>"
2564 2568 In [3]: bracket hello world
2565 2569 Input in brackets: <hello world>
2566 2570
2567 2571 You can also define aliases with parameters using %s specifiers (one
2568 2572 per parameter):
2569 2573
2570 2574 In [1]: alias parts echo first %s second %s
2571 2575 In [2]: %parts A B
2572 2576 first A second B
2573 2577 In [3]: %parts A
2574 2578 Incorrect number of arguments: 2 expected.
2575 2579 parts is an alias to: 'echo first %s second %s'
2576 2580
2577 2581 Note that %l and %s are mutually exclusive. You can only use one or
2578 2582 the other in your aliases.
2579 2583
2580 2584 Aliases expand Python variables just like system calls using ! or !!
2581 2585 do: all expressions prefixed with '$' get expanded. For details of
2582 2586 the semantic rules, see PEP-215:
2583 2587 http://www.python.org/peps/pep-0215.html. This is the library used by
2584 2588 IPython for variable expansion. If you want to access a true shell
2585 2589 variable, an extra $ is necessary to prevent its expansion by IPython:
2586 2590
2587 2591 In [6]: alias show echo
2588 2592 In [7]: PATH='A Python string'
2589 2593 In [8]: show $PATH
2590 2594 A Python string
2591 2595 In [9]: show $$PATH
2592 2596 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2593 2597
2594 2598 You can use the alias facility to acess all of $PATH. See the %rehash
2595 2599 and %rehashx functions, which automatically create aliases for the
2596 2600 contents of your $PATH.
2597 2601
2598 2602 If called with no parameters, %alias prints the current alias table."""
2599 2603
2600 2604 par = parameter_s.strip()
2601 2605 if not par:
2602 2606 stored = self.db.get('stored_aliases', {} )
2603 2607 aliases = sorted(self.shell.alias_manager.aliases)
2604 2608 # for k, v in stored:
2605 2609 # atab.append(k, v[0])
2606 2610
2607 2611 print "Total number of aliases:", len(aliases)
2608 2612 sys.stdout.flush()
2609 2613 return aliases
2610 2614
2611 2615 # Now try to define a new one
2612 2616 try:
2613 2617 alias,cmd = par.split(None, 1)
2614 2618 except:
2615 2619 print oinspect.getdoc(self.magic_alias)
2616 2620 else:
2617 2621 self.shell.alias_manager.soft_define_alias(alias, cmd)
2618 2622 # end magic_alias
2619 2623
2620 2624 def magic_unalias(self, parameter_s = ''):
2621 2625 """Remove an alias"""
2622 2626
2623 2627 aname = parameter_s.strip()
2624 2628 self.shell.alias_manager.undefine_alias(aname)
2625 2629 stored = self.db.get('stored_aliases', {} )
2626 2630 if aname in stored:
2627 2631 print "Removing %stored alias",aname
2628 2632 del stored[aname]
2629 2633 self.db['stored_aliases'] = stored
2630 2634
2631 2635 def magic_rehashx(self, parameter_s = ''):
2632 2636 """Update the alias table with all executable files in $PATH.
2633 2637
2634 2638 This version explicitly checks that every entry in $PATH is a file
2635 2639 with execute access (os.X_OK), so it is much slower than %rehash.
2636 2640
2637 2641 Under Windows, it checks executability as a match agains a
2638 2642 '|'-separated string of extensions, stored in the IPython config
2639 2643 variable win_exec_ext. This defaults to 'exe|com|bat'.
2640 2644
2641 2645 This function also resets the root module cache of module completer,
2642 2646 used on slow filesystems.
2643 2647 """
2644 2648 from IPython.core.alias import InvalidAliasError
2645 2649
2646 2650 # for the benefit of module completer in ipy_completers.py
2647 2651 del self.db['rootmodules']
2648 2652
2649 2653 path = [os.path.abspath(os.path.expanduser(p)) for p in
2650 2654 os.environ.get('PATH','').split(os.pathsep)]
2651 2655 path = filter(os.path.isdir,path)
2652 2656
2653 2657 syscmdlist = []
2654 2658 # Now define isexec in a cross platform manner.
2655 2659 if os.name == 'posix':
2656 2660 isexec = lambda fname:os.path.isfile(fname) and \
2657 2661 os.access(fname,os.X_OK)
2658 2662 else:
2659 2663 try:
2660 2664 winext = os.environ['pathext'].replace(';','|').replace('.','')
2661 2665 except KeyError:
2662 2666 winext = 'exe|com|bat|py'
2663 2667 if 'py' not in winext:
2664 2668 winext += '|py'
2665 2669 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2666 2670 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2667 2671 savedir = os.getcwdu()
2668 2672
2669 2673 # Now walk the paths looking for executables to alias.
2670 2674 try:
2671 2675 # write the whole loop for posix/Windows so we don't have an if in
2672 2676 # the innermost part
2673 2677 if os.name == 'posix':
2674 2678 for pdir in path:
2675 2679 os.chdir(pdir)
2676 2680 for ff in os.listdir(pdir):
2677 2681 if isexec(ff):
2678 2682 try:
2679 2683 # Removes dots from the name since ipython
2680 2684 # will assume names with dots to be python.
2681 2685 self.shell.alias_manager.define_alias(
2682 2686 ff.replace('.',''), ff)
2683 2687 except InvalidAliasError:
2684 2688 pass
2685 2689 else:
2686 2690 syscmdlist.append(ff)
2687 2691 else:
2688 2692 no_alias = self.shell.alias_manager.no_alias
2689 2693 for pdir in path:
2690 2694 os.chdir(pdir)
2691 2695 for ff in os.listdir(pdir):
2692 2696 base, ext = os.path.splitext(ff)
2693 2697 if isexec(ff) and base.lower() not in no_alias:
2694 2698 if ext.lower() == '.exe':
2695 2699 ff = base
2696 2700 try:
2697 2701 # Removes dots from the name since ipython
2698 2702 # will assume names with dots to be python.
2699 2703 self.shell.alias_manager.define_alias(
2700 2704 base.lower().replace('.',''), ff)
2701 2705 except InvalidAliasError:
2702 2706 pass
2703 2707 syscmdlist.append(ff)
2704 2708 db = self.db
2705 2709 db['syscmdlist'] = syscmdlist
2706 2710 finally:
2707 2711 os.chdir(savedir)
2708 2712
2709 2713 @skip_doctest
2710 2714 def magic_pwd(self, parameter_s = ''):
2711 2715 """Return the current working directory path.
2712 2716
2713 2717 Examples
2714 2718 --------
2715 2719 ::
2716 2720
2717 2721 In [9]: pwd
2718 2722 Out[9]: '/home/tsuser/sprint/ipython'
2719 2723 """
2720 2724 return os.getcwdu()
2721 2725
2722 2726 @skip_doctest
2723 2727 def magic_cd(self, parameter_s=''):
2724 2728 """Change the current working directory.
2725 2729
2726 2730 This command automatically maintains an internal list of directories
2727 2731 you visit during your IPython session, in the variable _dh. The
2728 2732 command %dhist shows this history nicely formatted. You can also
2729 2733 do 'cd -<tab>' to see directory history conveniently.
2730 2734
2731 2735 Usage:
2732 2736
2733 2737 cd 'dir': changes to directory 'dir'.
2734 2738
2735 2739 cd -: changes to the last visited directory.
2736 2740
2737 2741 cd -<n>: changes to the n-th directory in the directory history.
2738 2742
2739 2743 cd --foo: change to directory that matches 'foo' in history
2740 2744
2741 2745 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2742 2746 (note: cd <bookmark_name> is enough if there is no
2743 2747 directory <bookmark_name>, but a bookmark with the name exists.)
2744 2748 'cd -b <tab>' allows you to tab-complete bookmark names.
2745 2749
2746 2750 Options:
2747 2751
2748 2752 -q: quiet. Do not print the working directory after the cd command is
2749 2753 executed. By default IPython's cd command does print this directory,
2750 2754 since the default prompts do not display path information.
2751 2755
2752 2756 Note that !cd doesn't work for this purpose because the shell where
2753 2757 !command runs is immediately discarded after executing 'command'.
2754 2758
2755 2759 Examples
2756 2760 --------
2757 2761 ::
2758 2762
2759 2763 In [10]: cd parent/child
2760 2764 /home/tsuser/parent/child
2761 2765 """
2762 2766
2763 2767 parameter_s = parameter_s.strip()
2764 2768 #bkms = self.shell.persist.get("bookmarks",{})
2765 2769
2766 2770 oldcwd = os.getcwdu()
2767 2771 numcd = re.match(r'(-)(\d+)$',parameter_s)
2768 2772 # jump in directory history by number
2769 2773 if numcd:
2770 2774 nn = int(numcd.group(2))
2771 2775 try:
2772 2776 ps = self.shell.user_ns['_dh'][nn]
2773 2777 except IndexError:
2774 2778 print 'The requested directory does not exist in history.'
2775 2779 return
2776 2780 else:
2777 2781 opts = {}
2778 2782 elif parameter_s.startswith('--'):
2779 2783 ps = None
2780 2784 fallback = None
2781 2785 pat = parameter_s[2:]
2782 2786 dh = self.shell.user_ns['_dh']
2783 2787 # first search only by basename (last component)
2784 2788 for ent in reversed(dh):
2785 2789 if pat in os.path.basename(ent) and os.path.isdir(ent):
2786 2790 ps = ent
2787 2791 break
2788 2792
2789 2793 if fallback is None and pat in ent and os.path.isdir(ent):
2790 2794 fallback = ent
2791 2795
2792 2796 # if we have no last part match, pick the first full path match
2793 2797 if ps is None:
2794 2798 ps = fallback
2795 2799
2796 2800 if ps is None:
2797 2801 print "No matching entry in directory history"
2798 2802 return
2799 2803 else:
2800 2804 opts = {}
2801 2805
2802 2806
2803 2807 else:
2804 2808 #turn all non-space-escaping backslashes to slashes,
2805 2809 # for c:\windows\directory\names\
2806 2810 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2807 2811 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2808 2812 # jump to previous
2809 2813 if ps == '-':
2810 2814 try:
2811 2815 ps = self.shell.user_ns['_dh'][-2]
2812 2816 except IndexError:
2813 2817 raise UsageError('%cd -: No previous directory to change to.')
2814 2818 # jump to bookmark if needed
2815 2819 else:
2816 2820 if not os.path.isdir(ps) or opts.has_key('b'):
2817 2821 bkms = self.db.get('bookmarks', {})
2818 2822
2819 2823 if bkms.has_key(ps):
2820 2824 target = bkms[ps]
2821 2825 print '(bookmark:%s) -> %s' % (ps,target)
2822 2826 ps = target
2823 2827 else:
2824 2828 if opts.has_key('b'):
2825 2829 raise UsageError("Bookmark '%s' not found. "
2826 2830 "Use '%%bookmark -l' to see your bookmarks." % ps)
2827 2831
2828 2832 # strip extra quotes on Windows, because os.chdir doesn't like them
2829 if sys.platform == 'win32':
2830 ps = ps.strip('\'"')
2833 ps = unquote_filename(ps)
2831 2834 # at this point ps should point to the target dir
2832 2835 if ps:
2833 2836 try:
2834 2837 os.chdir(os.path.expanduser(ps))
2835 2838 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2836 2839 set_term_title('IPython: ' + abbrev_cwd())
2837 2840 except OSError:
2838 2841 print sys.exc_info()[1]
2839 2842 else:
2840 2843 cwd = os.getcwdu()
2841 2844 dhist = self.shell.user_ns['_dh']
2842 2845 if oldcwd != cwd:
2843 2846 dhist.append(cwd)
2844 2847 self.db['dhist'] = compress_dhist(dhist)[-100:]
2845 2848
2846 2849 else:
2847 2850 os.chdir(self.shell.home_dir)
2848 2851 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2849 2852 set_term_title('IPython: ' + '~')
2850 2853 cwd = os.getcwdu()
2851 2854 dhist = self.shell.user_ns['_dh']
2852 2855
2853 2856 if oldcwd != cwd:
2854 2857 dhist.append(cwd)
2855 2858 self.db['dhist'] = compress_dhist(dhist)[-100:]
2856 2859 if not 'q' in opts and self.shell.user_ns['_dh']:
2857 2860 print self.shell.user_ns['_dh'][-1]
2858 2861
2859 2862
2860 2863 def magic_env(self, parameter_s=''):
2861 2864 """List environment variables."""
2862 2865
2863 2866 return os.environ.data
2864 2867
2865 2868 def magic_pushd(self, parameter_s=''):
2866 2869 """Place the current dir on stack and change directory.
2867 2870
2868 2871 Usage:\\
2869 2872 %pushd ['dirname']
2870 2873 """
2871 2874
2872 2875 dir_s = self.shell.dir_stack
2873 tgt = os.path.expanduser(parameter_s)
2876 tgt = os.path.expanduser(unquote_filename(parameter_s))
2874 2877 cwd = os.getcwdu().replace(self.home_dir,'~')
2875 2878 if tgt:
2876 2879 self.magic_cd(parameter_s)
2877 2880 dir_s.insert(0,cwd)
2878 2881 return self.magic_dirs()
2879 2882
2880 2883 def magic_popd(self, parameter_s=''):
2881 2884 """Change to directory popped off the top of the stack.
2882 2885 """
2883 2886 if not self.shell.dir_stack:
2884 2887 raise UsageError("%popd on empty stack")
2885 2888 top = self.shell.dir_stack.pop(0)
2886 2889 self.magic_cd(top)
2887 2890 print "popd ->",top
2888 2891
2889 2892 def magic_dirs(self, parameter_s=''):
2890 2893 """Return the current directory stack."""
2891 2894
2892 2895 return self.shell.dir_stack
2893 2896
2894 2897 def magic_dhist(self, parameter_s=''):
2895 2898 """Print your history of visited directories.
2896 2899
2897 2900 %dhist -> print full history\\
2898 2901 %dhist n -> print last n entries only\\
2899 2902 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
2900 2903
2901 2904 This history is automatically maintained by the %cd command, and
2902 2905 always available as the global list variable _dh. You can use %cd -<n>
2903 2906 to go to directory number <n>.
2904 2907
2905 2908 Note that most of time, you should view directory history by entering
2906 2909 cd -<TAB>.
2907 2910
2908 2911 """
2909 2912
2910 2913 dh = self.shell.user_ns['_dh']
2911 2914 if parameter_s:
2912 2915 try:
2913 2916 args = map(int,parameter_s.split())
2914 2917 except:
2915 2918 self.arg_err(Magic.magic_dhist)
2916 2919 return
2917 2920 if len(args) == 1:
2918 2921 ini,fin = max(len(dh)-(args[0]),0),len(dh)
2919 2922 elif len(args) == 2:
2920 2923 ini,fin = args
2921 2924 else:
2922 2925 self.arg_err(Magic.magic_dhist)
2923 2926 return
2924 2927 else:
2925 2928 ini,fin = 0,len(dh)
2926 2929 nlprint(dh,
2927 2930 header = 'Directory history (kept in _dh)',
2928 2931 start=ini,stop=fin)
2929 2932
2930 2933 @skip_doctest
2931 2934 def magic_sc(self, parameter_s=''):
2932 2935 """Shell capture - execute a shell command and capture its output.
2933 2936
2934 2937 DEPRECATED. Suboptimal, retained for backwards compatibility.
2935 2938
2936 2939 You should use the form 'var = !command' instead. Example:
2937 2940
2938 2941 "%sc -l myfiles = ls ~" should now be written as
2939 2942
2940 2943 "myfiles = !ls ~"
2941 2944
2942 2945 myfiles.s, myfiles.l and myfiles.n still apply as documented
2943 2946 below.
2944 2947
2945 2948 --
2946 2949 %sc [options] varname=command
2947 2950
2948 2951 IPython will run the given command using commands.getoutput(), and
2949 2952 will then update the user's interactive namespace with a variable
2950 2953 called varname, containing the value of the call. Your command can
2951 2954 contain shell wildcards, pipes, etc.
2952 2955
2953 2956 The '=' sign in the syntax is mandatory, and the variable name you
2954 2957 supply must follow Python's standard conventions for valid names.
2955 2958
2956 2959 (A special format without variable name exists for internal use)
2957 2960
2958 2961 Options:
2959 2962
2960 2963 -l: list output. Split the output on newlines into a list before
2961 2964 assigning it to the given variable. By default the output is stored
2962 2965 as a single string.
2963 2966
2964 2967 -v: verbose. Print the contents of the variable.
2965 2968
2966 2969 In most cases you should not need to split as a list, because the
2967 2970 returned value is a special type of string which can automatically
2968 2971 provide its contents either as a list (split on newlines) or as a
2969 2972 space-separated string. These are convenient, respectively, either
2970 2973 for sequential processing or to be passed to a shell command.
2971 2974
2972 2975 For example:
2973 2976
2974 2977 # all-random
2975 2978
2976 2979 # Capture into variable a
2977 2980 In [1]: sc a=ls *py
2978 2981
2979 2982 # a is a string with embedded newlines
2980 2983 In [2]: a
2981 2984 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
2982 2985
2983 2986 # which can be seen as a list:
2984 2987 In [3]: a.l
2985 2988 Out[3]: ['setup.py', 'win32_manual_post_install.py']
2986 2989
2987 2990 # or as a whitespace-separated string:
2988 2991 In [4]: a.s
2989 2992 Out[4]: 'setup.py win32_manual_post_install.py'
2990 2993
2991 2994 # a.s is useful to pass as a single command line:
2992 2995 In [5]: !wc -l $a.s
2993 2996 146 setup.py
2994 2997 130 win32_manual_post_install.py
2995 2998 276 total
2996 2999
2997 3000 # while the list form is useful to loop over:
2998 3001 In [6]: for f in a.l:
2999 3002 ...: !wc -l $f
3000 3003 ...:
3001 3004 146 setup.py
3002 3005 130 win32_manual_post_install.py
3003 3006
3004 3007 Similiarly, the lists returned by the -l option are also special, in
3005 3008 the sense that you can equally invoke the .s attribute on them to
3006 3009 automatically get a whitespace-separated string from their contents:
3007 3010
3008 3011 In [7]: sc -l b=ls *py
3009 3012
3010 3013 In [8]: b
3011 3014 Out[8]: ['setup.py', 'win32_manual_post_install.py']
3012 3015
3013 3016 In [9]: b.s
3014 3017 Out[9]: 'setup.py win32_manual_post_install.py'
3015 3018
3016 3019 In summary, both the lists and strings used for ouptut capture have
3017 3020 the following special attributes:
3018 3021
3019 3022 .l (or .list) : value as list.
3020 3023 .n (or .nlstr): value as newline-separated string.
3021 3024 .s (or .spstr): value as space-separated string.
3022 3025 """
3023 3026
3024 3027 opts,args = self.parse_options(parameter_s,'lv')
3025 3028 # Try to get a variable name and command to run
3026 3029 try:
3027 3030 # the variable name must be obtained from the parse_options
3028 3031 # output, which uses shlex.split to strip options out.
3029 3032 var,_ = args.split('=',1)
3030 3033 var = var.strip()
3031 3034 # But the the command has to be extracted from the original input
3032 3035 # parameter_s, not on what parse_options returns, to avoid the
3033 3036 # quote stripping which shlex.split performs on it.
3034 3037 _,cmd = parameter_s.split('=',1)
3035 3038 except ValueError:
3036 3039 var,cmd = '',''
3037 3040 # If all looks ok, proceed
3038 3041 split = 'l' in opts
3039 3042 out = self.shell.getoutput(cmd, split=split)
3040 3043 if opts.has_key('v'):
3041 3044 print '%s ==\n%s' % (var,pformat(out))
3042 3045 if var:
3043 3046 self.shell.user_ns.update({var:out})
3044 3047 else:
3045 3048 return out
3046 3049
3047 3050 def magic_sx(self, parameter_s=''):
3048 3051 """Shell execute - run a shell command and capture its output.
3049 3052
3050 3053 %sx command
3051 3054
3052 3055 IPython will run the given command using commands.getoutput(), and
3053 3056 return the result formatted as a list (split on '\\n'). Since the
3054 3057 output is _returned_, it will be stored in ipython's regular output
3055 3058 cache Out[N] and in the '_N' automatic variables.
3056 3059
3057 3060 Notes:
3058 3061
3059 3062 1) If an input line begins with '!!', then %sx is automatically
3060 3063 invoked. That is, while:
3061 3064 !ls
3062 3065 causes ipython to simply issue system('ls'), typing
3063 3066 !!ls
3064 3067 is a shorthand equivalent to:
3065 3068 %sx ls
3066 3069
3067 3070 2) %sx differs from %sc in that %sx automatically splits into a list,
3068 3071 like '%sc -l'. The reason for this is to make it as easy as possible
3069 3072 to process line-oriented shell output via further python commands.
3070 3073 %sc is meant to provide much finer control, but requires more
3071 3074 typing.
3072 3075
3073 3076 3) Just like %sc -l, this is a list with special attributes:
3074 3077
3075 3078 .l (or .list) : value as list.
3076 3079 .n (or .nlstr): value as newline-separated string.
3077 3080 .s (or .spstr): value as whitespace-separated string.
3078 3081
3079 3082 This is very useful when trying to use such lists as arguments to
3080 3083 system commands."""
3081 3084
3082 3085 if parameter_s:
3083 3086 return self.shell.getoutput(parameter_s)
3084 3087
3085 3088
3086 3089 def magic_bookmark(self, parameter_s=''):
3087 3090 """Manage IPython's bookmark system.
3088 3091
3089 3092 %bookmark <name> - set bookmark to current dir
3090 3093 %bookmark <name> <dir> - set bookmark to <dir>
3091 3094 %bookmark -l - list all bookmarks
3092 3095 %bookmark -d <name> - remove bookmark
3093 3096 %bookmark -r - remove all bookmarks
3094 3097
3095 3098 You can later on access a bookmarked folder with:
3096 3099 %cd -b <name>
3097 3100 or simply '%cd <name>' if there is no directory called <name> AND
3098 3101 there is such a bookmark defined.
3099 3102
3100 3103 Your bookmarks persist through IPython sessions, but they are
3101 3104 associated with each profile."""
3102 3105
3103 3106 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3104 3107 if len(args) > 2:
3105 3108 raise UsageError("%bookmark: too many arguments")
3106 3109
3107 3110 bkms = self.db.get('bookmarks',{})
3108 3111
3109 3112 if opts.has_key('d'):
3110 3113 try:
3111 3114 todel = args[0]
3112 3115 except IndexError:
3113 3116 raise UsageError(
3114 3117 "%bookmark -d: must provide a bookmark to delete")
3115 3118 else:
3116 3119 try:
3117 3120 del bkms[todel]
3118 3121 except KeyError:
3119 3122 raise UsageError(
3120 3123 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3121 3124
3122 3125 elif opts.has_key('r'):
3123 3126 bkms = {}
3124 3127 elif opts.has_key('l'):
3125 3128 bks = bkms.keys()
3126 3129 bks.sort()
3127 3130 if bks:
3128 3131 size = max(map(len,bks))
3129 3132 else:
3130 3133 size = 0
3131 3134 fmt = '%-'+str(size)+'s -> %s'
3132 3135 print 'Current bookmarks:'
3133 3136 for bk in bks:
3134 3137 print fmt % (bk,bkms[bk])
3135 3138 else:
3136 3139 if not args:
3137 3140 raise UsageError("%bookmark: You must specify the bookmark name")
3138 3141 elif len(args)==1:
3139 3142 bkms[args[0]] = os.getcwdu()
3140 3143 elif len(args)==2:
3141 3144 bkms[args[0]] = args[1]
3142 3145 self.db['bookmarks'] = bkms
3143 3146
3144 3147 def magic_pycat(self, parameter_s=''):
3145 3148 """Show a syntax-highlighted file through a pager.
3146 3149
3147 3150 This magic is similar to the cat utility, but it will assume the file
3148 3151 to be Python source and will show it with syntax highlighting. """
3149 3152
3150 3153 try:
3151 filename = get_py_filename(parameter_s, sys.platform == 'win32')
3154 filename = get_py_filename(parameter_s)
3152 3155 cont = file_read(filename)
3153 3156 except IOError:
3154 3157 try:
3155 3158 cont = eval(parameter_s,self.user_ns)
3156 3159 except NameError:
3157 3160 cont = None
3158 3161 if cont is None:
3159 3162 print "Error: no such file or variable"
3160 3163 return
3161 3164
3162 3165 page.page(self.shell.pycolorize(cont))
3163 3166
3164 3167 def _rerun_pasted(self):
3165 3168 """ Rerun a previously pasted command.
3166 3169 """
3167 3170 b = self.user_ns.get('pasted_block', None)
3168 3171 if b is None:
3169 3172 raise UsageError('No previous pasted block available')
3170 3173 print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b))
3171 3174 exec b in self.user_ns
3172 3175
3173 3176 def _get_pasted_lines(self, sentinel):
3174 3177 """ Yield pasted lines until the user enters the given sentinel value.
3175 3178 """
3176 3179 from IPython.core import interactiveshell
3177 3180 print "Pasting code; enter '%s' alone on the line to stop." % sentinel
3178 3181 while True:
3179 3182 l = interactiveshell.raw_input_original(':')
3180 3183 if l == sentinel:
3181 3184 return
3182 3185 else:
3183 3186 yield l
3184 3187
3185 3188 def _strip_pasted_lines_for_code(self, raw_lines):
3186 3189 """ Strip non-code parts of a sequence of lines to return a block of
3187 3190 code.
3188 3191 """
3189 3192 # Regular expressions that declare text we strip from the input:
3190 3193 strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt
3191 3194 r'^\s*(\s?>)+', # Python input prompt
3192 3195 r'^\s*\.{3,}', # Continuation prompts
3193 3196 r'^\++',
3194 3197 ]
3195 3198
3196 3199 strip_from_start = map(re.compile,strip_re)
3197 3200
3198 3201 lines = []
3199 3202 for l in raw_lines:
3200 3203 for pat in strip_from_start:
3201 3204 l = pat.sub('',l)
3202 3205 lines.append(l)
3203 3206
3204 3207 block = "\n".join(lines) + '\n'
3205 3208 #print "block:\n",block
3206 3209 return block
3207 3210
3208 3211 def _execute_block(self, block, par):
3209 3212 """ Execute a block, or store it in a variable, per the user's request.
3210 3213 """
3211 3214 if not par:
3212 3215 b = textwrap.dedent(block)
3213 3216 self.user_ns['pasted_block'] = b
3214 3217 exec b in self.user_ns
3215 3218 else:
3216 3219 self.user_ns[par] = SList(block.splitlines())
3217 3220 print "Block assigned to '%s'" % par
3218 3221
3219 3222 def magic_quickref(self,arg):
3220 3223 """ Show a quick reference sheet """
3221 3224 import IPython.core.usage
3222 3225 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
3223 3226
3224 3227 page.page(qr)
3225 3228
3226 3229 def magic_doctest_mode(self,parameter_s=''):
3227 3230 """Toggle doctest mode on and off.
3228 3231
3229 3232 This mode is intended to make IPython behave as much as possible like a
3230 3233 plain Python shell, from the perspective of how its prompts, exceptions
3231 3234 and output look. This makes it easy to copy and paste parts of a
3232 3235 session into doctests. It does so by:
3233 3236
3234 3237 - Changing the prompts to the classic ``>>>`` ones.
3235 3238 - Changing the exception reporting mode to 'Plain'.
3236 3239 - Disabling pretty-printing of output.
3237 3240
3238 3241 Note that IPython also supports the pasting of code snippets that have
3239 3242 leading '>>>' and '...' prompts in them. This means that you can paste
3240 3243 doctests from files or docstrings (even if they have leading
3241 3244 whitespace), and the code will execute correctly. You can then use
3242 3245 '%history -t' to see the translated history; this will give you the
3243 3246 input after removal of all the leading prompts and whitespace, which
3244 3247 can be pasted back into an editor.
3245 3248
3246 3249 With these features, you can switch into this mode easily whenever you
3247 3250 need to do testing and changes to doctests, without having to leave
3248 3251 your existing IPython session.
3249 3252 """
3250 3253
3251 3254 from IPython.utils.ipstruct import Struct
3252 3255
3253 3256 # Shorthands
3254 3257 shell = self.shell
3255 3258 oc = shell.displayhook
3256 3259 meta = shell.meta
3257 3260 disp_formatter = self.shell.display_formatter
3258 3261 ptformatter = disp_formatter.formatters['text/plain']
3259 3262 # dstore is a data store kept in the instance metadata bag to track any
3260 3263 # changes we make, so we can undo them later.
3261 3264 dstore = meta.setdefault('doctest_mode',Struct())
3262 3265 save_dstore = dstore.setdefault
3263 3266
3264 3267 # save a few values we'll need to recover later
3265 3268 mode = save_dstore('mode',False)
3266 3269 save_dstore('rc_pprint',ptformatter.pprint)
3267 3270 save_dstore('xmode',shell.InteractiveTB.mode)
3268 3271 save_dstore('rc_separate_out',shell.separate_out)
3269 3272 save_dstore('rc_separate_out2',shell.separate_out2)
3270 3273 save_dstore('rc_prompts_pad_left',shell.prompts_pad_left)
3271 3274 save_dstore('rc_separate_in',shell.separate_in)
3272 3275 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
3273 3276
3274 3277 if mode == False:
3275 3278 # turn on
3276 3279 oc.prompt1.p_template = '>>> '
3277 3280 oc.prompt2.p_template = '... '
3278 3281 oc.prompt_out.p_template = ''
3279 3282
3280 3283 # Prompt separators like plain python
3281 3284 oc.input_sep = oc.prompt1.sep = ''
3282 3285 oc.output_sep = ''
3283 3286 oc.output_sep2 = ''
3284 3287
3285 3288 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3286 3289 oc.prompt_out.pad_left = False
3287 3290
3288 3291 ptformatter.pprint = False
3289 3292 disp_formatter.plain_text_only = True
3290 3293
3291 3294 shell.magic_xmode('Plain')
3292 3295 else:
3293 3296 # turn off
3294 3297 oc.prompt1.p_template = shell.prompt_in1
3295 3298 oc.prompt2.p_template = shell.prompt_in2
3296 3299 oc.prompt_out.p_template = shell.prompt_out
3297 3300
3298 3301 oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in
3299 3302
3300 3303 oc.output_sep = dstore.rc_separate_out
3301 3304 oc.output_sep2 = dstore.rc_separate_out2
3302 3305
3303 3306 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3304 3307 oc.prompt_out.pad_left = dstore.rc_prompts_pad_left
3305 3308
3306 3309 ptformatter.pprint = dstore.rc_pprint
3307 3310 disp_formatter.plain_text_only = dstore.rc_plain_text_only
3308 3311
3309 3312 shell.magic_xmode(dstore.xmode)
3310 3313
3311 3314 # Store new mode and inform
3312 3315 dstore.mode = bool(1-int(mode))
3313 3316 mode_label = ['OFF','ON'][dstore.mode]
3314 3317 print 'Doctest mode is:', mode_label
3315 3318
3316 3319 def magic_gui(self, parameter_s=''):
3317 3320 """Enable or disable IPython GUI event loop integration.
3318 3321
3319 3322 %gui [GUINAME]
3320 3323
3321 3324 This magic replaces IPython's threaded shells that were activated
3322 3325 using the (pylab/wthread/etc.) command line flags. GUI toolkits
3323 3326 can now be enabled, disabled and changed at runtime and keyboard
3324 3327 interrupts should work without any problems. The following toolkits
3325 3328 are supported: wxPython, PyQt4, PyGTK, and Tk::
3326 3329
3327 3330 %gui wx # enable wxPython event loop integration
3328 3331 %gui qt4|qt # enable PyQt4 event loop integration
3329 3332 %gui gtk # enable PyGTK event loop integration
3330 3333 %gui tk # enable Tk event loop integration
3331 3334 %gui # disable all event loop integration
3332 3335
3333 3336 WARNING: after any of these has been called you can simply create
3334 3337 an application object, but DO NOT start the event loop yourself, as
3335 3338 we have already handled that.
3336 3339 """
3337 3340 from IPython.lib.inputhook import enable_gui
3338 3341 opts, arg = self.parse_options(parameter_s, '')
3339 3342 if arg=='': arg = None
3340 3343 return enable_gui(arg)
3341 3344
3342 3345 def magic_load_ext(self, module_str):
3343 3346 """Load an IPython extension by its module name."""
3344 3347 return self.extension_manager.load_extension(module_str)
3345 3348
3346 3349 def magic_unload_ext(self, module_str):
3347 3350 """Unload an IPython extension by its module name."""
3348 3351 self.extension_manager.unload_extension(module_str)
3349 3352
3350 3353 def magic_reload_ext(self, module_str):
3351 3354 """Reload an IPython extension by its module name."""
3352 3355 self.extension_manager.reload_extension(module_str)
3353 3356
3354 3357 @skip_doctest
3355 3358 def magic_install_profiles(self, s):
3356 3359 """Install the default IPython profiles into the .ipython dir.
3357 3360
3358 3361 If the default profiles have already been installed, they will not
3359 3362 be overwritten. You can force overwriting them by using the ``-o``
3360 3363 option::
3361 3364
3362 3365 In [1]: %install_profiles -o
3363 3366 """
3364 3367 if '-o' in s:
3365 3368 overwrite = True
3366 3369 else:
3367 3370 overwrite = False
3368 3371 from IPython.config import profile
3369 3372 profile_dir = os.path.dirname(profile.__file__)
3370 3373 ipython_dir = self.ipython_dir
3371 3374 print "Installing profiles to: %s [overwrite=%s]"%(ipython_dir,overwrite)
3372 3375 for src in os.listdir(profile_dir):
3373 3376 if src.startswith('profile_'):
3374 3377 name = src.replace('profile_', '')
3375 3378 print " %s"%name
3376 3379 pd = ProfileDir.create_profile_dir_by_name(ipython_dir, name)
3377 3380 pd.copy_config_file('ipython_config.py', path=src,
3378 3381 overwrite=overwrite)
3379 3382
3380 3383 @skip_doctest
3381 3384 def magic_install_default_config(self, s):
3382 3385 """Install IPython's default config file into the .ipython dir.
3383 3386
3384 3387 If the default config file (:file:`ipython_config.py`) is already
3385 3388 installed, it will not be overwritten. You can force overwriting
3386 3389 by using the ``-o`` option::
3387 3390
3388 3391 In [1]: %install_default_config
3389 3392 """
3390 3393 if '-o' in s:
3391 3394 overwrite = True
3392 3395 else:
3393 3396 overwrite = False
3394 3397 pd = self.shell.profile_dir
3395 3398 print "Installing default config file in: %s" % pd.location
3396 3399 pd.copy_config_file('ipython_config.py', overwrite=overwrite)
3397 3400
3398 3401 # Pylab support: simple wrappers that activate pylab, load gui input
3399 3402 # handling and modify slightly %run
3400 3403
3401 3404 @skip_doctest
3402 3405 def _pylab_magic_run(self, parameter_s=''):
3403 3406 Magic.magic_run(self, parameter_s,
3404 3407 runner=mpl_runner(self.shell.safe_execfile))
3405 3408
3406 3409 _pylab_magic_run.__doc__ = magic_run.__doc__
3407 3410
3408 3411 @skip_doctest
3409 3412 def magic_pylab(self, s):
3410 3413 """Load numpy and matplotlib to work interactively.
3411 3414
3412 3415 %pylab [GUINAME]
3413 3416
3414 3417 This function lets you activate pylab (matplotlib, numpy and
3415 3418 interactive support) at any point during an IPython session.
3416 3419
3417 3420 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3418 3421 pylab and mlab, as well as all names from numpy and pylab.
3419 3422
3420 3423 Parameters
3421 3424 ----------
3422 3425 guiname : optional
3423 3426 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk', 'osx' or
3424 3427 'tk'). If given, the corresponding Matplotlib backend is used,
3425 3428 otherwise matplotlib's default (which you can override in your
3426 3429 matplotlib config file) is used.
3427 3430
3428 3431 Examples
3429 3432 --------
3430 3433 In this case, where the MPL default is TkAgg:
3431 3434 In [2]: %pylab
3432 3435
3433 3436 Welcome to pylab, a matplotlib-based Python environment.
3434 3437 Backend in use: TkAgg
3435 3438 For more information, type 'help(pylab)'.
3436 3439
3437 3440 But you can explicitly request a different backend:
3438 3441 In [3]: %pylab qt
3439 3442
3440 3443 Welcome to pylab, a matplotlib-based Python environment.
3441 3444 Backend in use: Qt4Agg
3442 3445 For more information, type 'help(pylab)'.
3443 3446 """
3444 3447 self.shell.enable_pylab(s)
3445 3448
3446 3449 def magic_tb(self, s):
3447 3450 """Print the last traceback with the currently active exception mode.
3448 3451
3449 3452 See %xmode for changing exception reporting modes."""
3450 3453 self.shell.showtraceback()
3451 3454
3452 3455 @skip_doctest
3453 3456 def magic_precision(self, s=''):
3454 3457 """Set floating point precision for pretty printing.
3455 3458
3456 3459 Can set either integer precision or a format string.
3457 3460
3458 3461 If numpy has been imported and precision is an int,
3459 3462 numpy display precision will also be set, via ``numpy.set_printoptions``.
3460 3463
3461 3464 If no argument is given, defaults will be restored.
3462 3465
3463 3466 Examples
3464 3467 --------
3465 3468 ::
3466 3469
3467 3470 In [1]: from math import pi
3468 3471
3469 3472 In [2]: %precision 3
3470 3473 Out[2]: u'%.3f'
3471 3474
3472 3475 In [3]: pi
3473 3476 Out[3]: 3.142
3474 3477
3475 3478 In [4]: %precision %i
3476 3479 Out[4]: u'%i'
3477 3480
3478 3481 In [5]: pi
3479 3482 Out[5]: 3
3480 3483
3481 3484 In [6]: %precision %e
3482 3485 Out[6]: u'%e'
3483 3486
3484 3487 In [7]: pi**10
3485 3488 Out[7]: 9.364805e+04
3486 3489
3487 3490 In [8]: %precision
3488 3491 Out[8]: u'%r'
3489 3492
3490 3493 In [9]: pi**10
3491 3494 Out[9]: 93648.047476082982
3492 3495
3493 3496 """
3494 3497
3495 3498 ptformatter = self.shell.display_formatter.formatters['text/plain']
3496 3499 ptformatter.float_precision = s
3497 3500 return ptformatter.float_format
3498 3501
3499 3502
3500 3503 @magic_arguments.magic_arguments()
3501 3504 @magic_arguments.argument(
3502 3505 '-e', '--export', action='store_true', default=False,
3503 3506 help='Export IPython history as a notebook. The filename argument '
3504 3507 'is used to specify the notebook name and format. For example '
3505 3508 'a filename of notebook.ipynb will result in a notebook name '
3506 3509 'of "notebook" and a format of "xml". Likewise using a ".json" '
3507 3510 'or ".py" file extension will write the notebook in the json '
3508 3511 'or py formats.'
3509 3512 )
3510 3513 @magic_arguments.argument(
3511 3514 '-f', '--format',
3512 3515 help='Convert an existing IPython notebook to a new format. This option '
3513 3516 'specifies the new format and can have the values: xml, json, py. '
3514 3517 'The target filename is choosen automatically based on the new '
3515 3518 'format. The filename argument gives the name of the source file.'
3516 3519 )
3517 3520 @magic_arguments.argument(
3518 3521 'filename', type=unicode,
3519 3522 help='Notebook name or filename'
3520 3523 )
3521 3524 def magic_notebook(self, s):
3522 3525 """Export and convert IPython notebooks.
3523 3526
3524 3527 This function can export the current IPython history to a notebook file
3525 3528 or can convert an existing notebook file into a different format. For
3526 3529 example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb".
3527 3530 To export the history to "foo.py" do "%notebook -e foo.py". To convert
3528 3531 "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible
3529 3532 formats include (json/ipynb, py).
3530 3533 """
3531 3534 args = magic_arguments.parse_argstring(self.magic_notebook, s)
3532 3535
3533 3536 from IPython.nbformat import current
3537 args.filename = unquote_filename(args.filename)
3534 3538 if args.export:
3535 3539 fname, name, format = current.parse_filename(args.filename)
3536 3540 cells = []
3537 3541 hist = list(self.history_manager.get_range())
3538 3542 for session, prompt_number, input in hist[:-1]:
3539 3543 cells.append(current.new_code_cell(prompt_number=prompt_number, input=input))
3540 3544 worksheet = current.new_worksheet(cells=cells)
3541 3545 nb = current.new_notebook(name=name,worksheets=[worksheet])
3542 3546 with open(fname, 'w') as f:
3543 3547 current.write(nb, f, format);
3544 3548 elif args.format is not None:
3545 3549 old_fname, old_name, old_format = current.parse_filename(args.filename)
3546 3550 new_format = args.format
3547 3551 if new_format == u'xml':
3548 3552 raise ValueError('Notebooks cannot be written as xml.')
3549 3553 elif new_format == u'ipynb' or new_format == u'json':
3550 3554 new_fname = old_name + u'.ipynb'
3551 3555 new_format = u'json'
3552 3556 elif new_format == u'py':
3553 3557 new_fname = old_name + u'.py'
3554 3558 else:
3555 3559 raise ValueError('Invalid notebook format: %s' % new_format)
3556 3560 with open(old_fname, 'r') as f:
3557 3561 s = f.read()
3558 3562 try:
3559 3563 nb = current.reads(s, old_format)
3560 3564 except:
3561 3565 nb = current.reads(s, u'xml')
3562 3566 with open(new_fname, 'w') as f:
3563 3567 current.write(nb, f, new_format)
3564 3568
3565 3569
3566 3570 # end Magic
@@ -1,473 +1,485 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, win32=False):
85 def unquote_filename(name, win32=(sys.platform=='win32')):
86 """ On Windows, remove leading and trailing quotes from filenames.
87 """
88 if win32:
89 if name.startswith(("'", '"')) and name.endswith(("'", '"')):
90 name = name[1:-1]
91 return name
92
93
94 def get_py_filename(name, force_win32=None):
86 95 """Return a valid python filename in the current directory.
87 96
88 97 If the given name is not a file, it adds '.py' and searches again.
89 98 Raises IOError with an informative message if the file isn't found.
90 99
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.
100 On Windows, apply Windows semantics to the filename. In particular, remove
101 any quoting that has been applied to it. This option can be forced for
102 testing purposes.
93 103 """
94 104
95 105 name = os.path.expanduser(name)
96 if win32:
97 if name.startswith(("'", '"')) and name.endswith(("'", '"')):
98 name = name[1:-1]
106 if force_win32 is None:
107 win32 = (sys.platform == 'win32')
108 else:
109 win32 = force_win32
110 name = unquote_filename(name, win32=win32)
99 111 if not os.path.isfile(name) and not name.endswith('.py'):
100 112 name += '.py'
101 113 if os.path.isfile(name):
102 114 return name
103 115 else:
104 116 raise IOError,'File `%s` not found.' % name
105 117
106 118
107 119 def filefind(filename, path_dirs=None):
108 120 """Find a file by looking through a sequence of paths.
109 121
110 122 This iterates through a sequence of paths looking for a file and returns
111 123 the full, absolute path of the first occurence of the file. If no set of
112 124 path dirs is given, the filename is tested as is, after running through
113 125 :func:`expandvars` and :func:`expanduser`. Thus a simple call::
114 126
115 127 filefind('myfile.txt')
116 128
117 129 will find the file in the current working dir, but::
118 130
119 131 filefind('~/myfile.txt')
120 132
121 133 Will find the file in the users home directory. This function does not
122 134 automatically try any paths, such as the cwd or the user's home directory.
123 135
124 136 Parameters
125 137 ----------
126 138 filename : str
127 139 The filename to look for.
128 140 path_dirs : str, None or sequence of str
129 141 The sequence of paths to look for the file in. If None, the filename
130 142 need to be absolute or be in the cwd. If a string, the string is
131 143 put into a sequence and the searched. If a sequence, walk through
132 144 each element and join with ``filename``, calling :func:`expandvars`
133 145 and :func:`expanduser` before testing for existence.
134 146
135 147 Returns
136 148 -------
137 149 Raises :exc:`IOError` or returns absolute path to file.
138 150 """
139 151
140 152 # If paths are quoted, abspath gets confused, strip them...
141 153 filename = filename.strip('"').strip("'")
142 154 # If the input is an absolute path, just check it exists
143 155 if os.path.isabs(filename) and os.path.isfile(filename):
144 156 return filename
145 157
146 158 if path_dirs is None:
147 159 path_dirs = ("",)
148 160 elif isinstance(path_dirs, basestring):
149 161 path_dirs = (path_dirs,)
150 162
151 163 for path in path_dirs:
152 164 if path == '.': path = os.getcwdu()
153 165 testname = expand_path(os.path.join(path, filename))
154 166 if os.path.isfile(testname):
155 167 return os.path.abspath(testname)
156 168
157 169 raise IOError("File %r does not exist in any of the search paths: %r" %
158 170 (filename, path_dirs) )
159 171
160 172
161 173 class HomeDirError(Exception):
162 174 pass
163 175
164 176
165 177 def get_home_dir():
166 178 """Return the closest possible equivalent to a 'home' directory.
167 179
168 180 * On POSIX, we try $HOME.
169 181 * On Windows we try:
170 182 - %HOMESHARE%
171 183 - %HOMEDRIVE\%HOMEPATH%
172 184 - %USERPROFILE%
173 185 - Registry hack for My Documents
174 186 - %HOME%: rare, but some people with unix-like setups may have defined it
175 187 * On Dos C:\
176 188
177 189 Currently only Posix and NT are implemented, a HomeDirError exception is
178 190 raised for all other OSes.
179 191 """
180 192
181 193 env = os.environ
182 194
183 195 # first, check py2exe distribution root directory for _ipython.
184 196 # This overrides all. Normally does not exist.
185 197
186 198 if hasattr(sys, "frozen"): #Is frozen by py2exe
187 199 if '\\library.zip\\' in IPython.__file__.lower():#libraries compressed to zip-file
188 200 root, rest = IPython.__file__.lower().split('library.zip')
189 201 else:
190 202 root=os.path.join(os.path.split(IPython.__file__)[0],"../../")
191 203 root=os.path.abspath(root).rstrip('\\')
192 204 if _writable_dir(os.path.join(root, '_ipython')):
193 205 os.environ["IPYKITROOT"] = root
194 206 return _cast_unicode(root, fs_encoding)
195 207
196 208 if os.name == 'posix':
197 209 # Linux, Unix, AIX, OS X
198 210 try:
199 211 homedir = env['HOME']
200 212 except KeyError:
201 213 # Last-ditch attempt at finding a suitable $HOME, on systems where
202 214 # it may not be defined in the environment but the system shell
203 215 # still knows it - reported once as:
204 216 # https://github.com/ipython/ipython/issues/154
205 217 from subprocess import Popen, PIPE
206 218 homedir = Popen('echo $HOME', shell=True,
207 219 stdout=PIPE).communicate()[0].strip()
208 220 if homedir:
209 221 return _cast_unicode(homedir, fs_encoding)
210 222 else:
211 223 raise HomeDirError('Undefined $HOME, IPython cannot proceed.')
212 224 else:
213 225 return _cast_unicode(homedir, fs_encoding)
214 226 elif os.name == 'nt':
215 227 # Now for win9x, XP, Vista, 7?
216 228 # For some strange reason all of these return 'nt' for os.name.
217 229 # First look for a network home directory. This will return the UNC
218 230 # path (\\server\\Users\%username%) not the mapped path (Z:\). This
219 231 # is needed when running IPython on cluster where all paths have to
220 232 # be UNC.
221 233 try:
222 234 homedir = env['HOMESHARE']
223 235 except KeyError:
224 236 pass
225 237 else:
226 238 if _writable_dir(homedir):
227 239 return _cast_unicode(homedir, fs_encoding)
228 240
229 241 # Now look for a local home directory
230 242 try:
231 243 homedir = os.path.join(env['HOMEDRIVE'],env['HOMEPATH'])
232 244 except KeyError:
233 245 pass
234 246 else:
235 247 if _writable_dir(homedir):
236 248 return _cast_unicode(homedir, fs_encoding)
237 249
238 250 # Now the users profile directory
239 251 try:
240 252 homedir = os.path.join(env['USERPROFILE'])
241 253 except KeyError:
242 254 pass
243 255 else:
244 256 if _writable_dir(homedir):
245 257 return _cast_unicode(homedir, fs_encoding)
246 258
247 259 # Use the registry to get the 'My Documents' folder.
248 260 try:
249 261 import _winreg as wreg
250 262 key = wreg.OpenKey(
251 263 wreg.HKEY_CURRENT_USER,
252 264 "Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders"
253 265 )
254 266 homedir = wreg.QueryValueEx(key,'Personal')[0]
255 267 key.Close()
256 268 except:
257 269 pass
258 270 else:
259 271 if _writable_dir(homedir):
260 272 return _cast_unicode(homedir, fs_encoding)
261 273
262 274 # A user with a lot of unix tools in win32 may have defined $HOME.
263 275 # Try this as a last ditch option.
264 276 try:
265 277 homedir = env['HOME']
266 278 except KeyError:
267 279 pass
268 280 else:
269 281 if _writable_dir(homedir):
270 282 return _cast_unicode(homedir, fs_encoding)
271 283
272 284 # If all else fails, raise HomeDirError
273 285 raise HomeDirError('No valid home directory could be found')
274 286 elif os.name == 'dos':
275 287 # Desperate, may do absurd things in classic MacOS. May work under DOS.
276 288 return u'C:\\'
277 289 else:
278 290 raise HomeDirError('No valid home directory could be found for your OS')
279 291
280 292 def get_xdg_dir():
281 293 """Return the XDG_CONFIG_HOME, if it is defined and exists, else None.
282 294
283 295 This is only for posix (Linux,Unix,OS X, etc) systems.
284 296 """
285 297
286 298 env = os.environ
287 299
288 300 if os.name == 'posix':
289 301 # Linux, Unix, AIX, OS X
290 302 # use ~/.config if not set OR empty
291 303 xdg = env.get("XDG_CONFIG_HOME", None) or os.path.join(get_home_dir(), '.config')
292 304 if xdg and _writable_dir(xdg):
293 305 return _cast_unicode(xdg, fs_encoding)
294 306
295 307 return None
296 308
297 309
298 310 def get_ipython_dir():
299 311 """Get the IPython directory for this platform and user.
300 312
301 313 This uses the logic in `get_home_dir` to find the home directory
302 314 and the adds .ipython to the end of the path.
303 315 """
304 316
305 317 env = os.environ
306 318 pjoin = os.path.join
307 319
308 320
309 321 ipdir_def = '.ipython'
310 322 xdg_def = 'ipython'
311 323
312 324 home_dir = get_home_dir()
313 325 xdg_dir = get_xdg_dir()
314 326 # import pdb; pdb.set_trace() # dbg
315 327 ipdir = env.get('IPYTHON_DIR', env.get('IPYTHONDIR', None))
316 328 if ipdir is None:
317 329 # not set explicitly, use XDG_CONFIG_HOME or HOME
318 330 home_ipdir = pjoin(home_dir, ipdir_def)
319 331 if xdg_dir:
320 332 # use XDG, as long as the user isn't already
321 333 # using $HOME/.ipython and *not* XDG/ipython
322 334
323 335 xdg_ipdir = pjoin(xdg_dir, xdg_def)
324 336
325 337 if _writable_dir(xdg_ipdir) or not _writable_dir(home_ipdir):
326 338 ipdir = xdg_ipdir
327 339
328 340 if ipdir is None:
329 341 # not using XDG
330 342 ipdir = home_ipdir
331 343
332 344 ipdir = os.path.normpath(os.path.expanduser(ipdir))
333 345
334 346 if os.path.exists(ipdir) and not _writable_dir(ipdir):
335 347 # ipdir exists, but is not writable
336 348 warn.warn("IPython dir '%s' is not a writable location,"
337 349 " using a temp directory."%ipdir)
338 350 ipdir = tempfile.mkdtemp()
339 351 elif not os.path.exists(ipdir):
340 352 parent = ipdir.rsplit(os.path.sep, 1)[0]
341 353 if not _writable_dir(parent):
342 354 # ipdir does not exist and parent isn't writable
343 355 warn.warn("IPython parent '%s' is not a writable location,"
344 356 " using a temp directory."%parent)
345 357 ipdir = tempfile.mkdtemp()
346 358
347 359 return _cast_unicode(ipdir, fs_encoding)
348 360
349 361
350 362 def get_ipython_package_dir():
351 363 """Get the base directory where IPython itself is installed."""
352 364 ipdir = os.path.dirname(IPython.__file__)
353 365 return _cast_unicode(ipdir, fs_encoding)
354 366
355 367
356 368 def get_ipython_module_path(module_str):
357 369 """Find the path to an IPython module in this version of IPython.
358 370
359 371 This will always find the version of the module that is in this importable
360 372 IPython package. This will always return the path to the ``.py``
361 373 version of the module.
362 374 """
363 375 if module_str == 'IPython':
364 376 return os.path.join(get_ipython_package_dir(), '__init__.py')
365 377 mod = import_item(module_str)
366 378 the_path = mod.__file__.replace('.pyc', '.py')
367 379 the_path = the_path.replace('.pyo', '.py')
368 380 return _cast_unicode(the_path, fs_encoding)
369 381
370 382
371 383 def expand_path(s):
372 384 """Expand $VARS and ~names in a string, like a shell
373 385
374 386 :Examples:
375 387
376 388 In [2]: os.environ['FOO']='test'
377 389
378 390 In [3]: expand_path('variable FOO is $FOO')
379 391 Out[3]: 'variable FOO is test'
380 392 """
381 393 # This is a pretty subtle hack. When expand user is given a UNC path
382 394 # on Windows (\\server\share$\%username%), os.path.expandvars, removes
383 395 # the $ to get (\\server\share\%username%). I think it considered $
384 396 # alone an empty var. But, we need the $ to remains there (it indicates
385 397 # a hidden share).
386 398 if os.name=='nt':
387 399 s = s.replace('$\\', 'IPYTHON_TEMP')
388 400 s = os.path.expandvars(os.path.expanduser(s))
389 401 if os.name=='nt':
390 402 s = s.replace('IPYTHON_TEMP', '$\\')
391 403 return s
392 404
393 405
394 406 def target_outdated(target,deps):
395 407 """Determine whether a target is out of date.
396 408
397 409 target_outdated(target,deps) -> 1/0
398 410
399 411 deps: list of filenames which MUST exist.
400 412 target: single filename which may or may not exist.
401 413
402 414 If target doesn't exist or is older than any file listed in deps, return
403 415 true, otherwise return false.
404 416 """
405 417 try:
406 418 target_time = os.path.getmtime(target)
407 419 except os.error:
408 420 return 1
409 421 for dep in deps:
410 422 dep_time = os.path.getmtime(dep)
411 423 if dep_time > target_time:
412 424 #print "For target",target,"Dep failed:",dep # dbg
413 425 #print "times (dep,tar):",dep_time,target_time # dbg
414 426 return 1
415 427 return 0
416 428
417 429
418 430 def target_update(target,deps,cmd):
419 431 """Update a target with a given command given a list of dependencies.
420 432
421 433 target_update(target,deps,cmd) -> runs cmd if target is outdated.
422 434
423 435 This is just a wrapper around target_outdated() which calls the given
424 436 command if target is outdated."""
425 437
426 438 if target_outdated(target,deps):
427 439 system(cmd)
428 440
429 441 def filehash(path):
430 442 """Make an MD5 hash of a file, ignoring any differences in line
431 443 ending characters."""
432 444 with open(path, "rU") as f:
433 445 return md5(f.read()).hexdigest()
434 446
435 447 # If the config is unmodified from the default, we'll just delete it.
436 448 # These are consistent for 0.10.x, thankfully. We're not going to worry about
437 449 # older versions.
438 450 old_config_md5 = {'ipy_user_conf.py': 'fc108bedff4b9a00f91fa0a5999140d3',
439 451 'ipythonrc': '12a68954f3403eea2eec09dc8fe5a9b5'}
440 452
441 453 def check_for_old_config(ipython_dir=None):
442 454 """Check for old config files, and present a warning if they exist.
443 455
444 456 A link to the docs of the new config is included in the message.
445 457
446 458 This should mitigate confusion with the transition to the new
447 459 config system in 0.11.
448 460 """
449 461 if ipython_dir is None:
450 462 ipython_dir = get_ipython_dir()
451 463
452 464 old_configs = ['ipy_user_conf.py', 'ipythonrc', 'ipython_config.py']
453 465 warned = False
454 466 for cfg in old_configs:
455 467 f = os.path.join(ipython_dir, cfg)
456 468 if os.path.exists(f):
457 469 if filehash(f) == old_config_md5.get(cfg, ''):
458 470 os.unlink(f)
459 471 else:
460 472 warn.warn("Found old IPython config file %r (modified by user)"%f)
461 473 warned = True
462 474
463 475 if warned:
464 476 warn.info("""
465 477 The IPython configuration system has changed as of 0.11, and these files will
466 478 be ignored. See http://ipython.github.com/ipython-doc/dev/config for details
467 479 of the new config system.
468 480 To start configuring IPython, do `ipython profile create`, and edit
469 481 `ipython_config.py` in <ipython_dir>/profile_default.
470 482 If you need to leave the old config files in place for an older version of
471 483 IPython and want to suppress this warning message, set
472 484 `c.InteractiveShellApp.ignore_old_config=True` in the new config.""")
473 485
@@ -1,430 +1,443 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 15 from __future__ import with_statement
16 16
17 17 import os
18 18 import shutil
19 19 import sys
20 20 import tempfile
21 21 import StringIO
22 22
23 23 from os.path import join, abspath, split
24 24
25 25 import nose.tools as nt
26 26
27 27 from nose import with_setup
28 28
29 29 import IPython
30 30 from IPython.testing import decorators as dec
31 31 from IPython.testing.decorators import skip_if_not_win32, skip_win32
32 32 from IPython.testing.tools import make_tempfile
33 33 from IPython.utils import path, io
34 34
35 35 # Platform-dependent imports
36 36 try:
37 37 import _winreg as wreg
38 38 except ImportError:
39 39 #Fake _winreg module on none windows platforms
40 40 import new
41 41 sys.modules["_winreg"] = new.module("_winreg")
42 42 import _winreg as wreg
43 43 #Add entries that needs to be stubbed by the testing code
44 44 (wreg.OpenKey, wreg.QueryValueEx,) = (None, None)
45 45
46 46 #-----------------------------------------------------------------------------
47 47 # Globals
48 48 #-----------------------------------------------------------------------------
49 49 env = os.environ
50 50 TEST_FILE_PATH = split(abspath(__file__))[0]
51 51 TMP_TEST_DIR = tempfile.mkdtemp()
52 52 HOME_TEST_DIR = join(TMP_TEST_DIR, "home_test_dir")
53 53 XDG_TEST_DIR = join(HOME_TEST_DIR, "xdg_test_dir")
54 54 IP_TEST_DIR = join(HOME_TEST_DIR,'.ipython')
55 55 #
56 56 # Setup/teardown functions/decorators
57 57 #
58 58
59 59 def setup():
60 60 """Setup testenvironment for the module:
61 61
62 62 - Adds dummy home dir tree
63 63 """
64 64 # Do not mask exceptions here. In particular, catching WindowsError is a
65 65 # problem because that exception is only defined on Windows...
66 66 os.makedirs(IP_TEST_DIR)
67 67 os.makedirs(os.path.join(XDG_TEST_DIR, 'ipython'))
68 68
69 69
70 70 def teardown():
71 71 """Teardown testenvironment for the module:
72 72
73 73 - Remove dummy home dir tree
74 74 """
75 75 # Note: we remove the parent test dir, which is the root of all test
76 76 # subdirs we may have created. Use shutil instead of os.removedirs, so
77 77 # that non-empty directories are all recursively removed.
78 78 shutil.rmtree(TMP_TEST_DIR)
79 79
80 80
81 81 def setup_environment():
82 82 """Setup testenvironment for some functions that are tested
83 83 in this module. In particular this functions stores attributes
84 84 and other things that we need to stub in some test functions.
85 85 This needs to be done on a function level and not module level because
86 86 each testfunction needs a pristine environment.
87 87 """
88 88 global oldstuff, platformstuff
89 89 oldstuff = (env.copy(), os.name, path.get_home_dir, IPython.__file__, os.getcwd())
90 90
91 91 if os.name == 'nt':
92 92 platformstuff = (wreg.OpenKey, wreg.QueryValueEx,)
93 93
94 94
95 95 def teardown_environment():
96 96 """Restore things that were remebered by the setup_environment function
97 97 """
98 98 (oldenv, os.name, path.get_home_dir, IPython.__file__, old_wd) = oldstuff
99 99 os.chdir(old_wd)
100 100 reload(path)
101 101
102 102 for key in env.keys():
103 103 if key not in oldenv:
104 104 del env[key]
105 105 env.update(oldenv)
106 106 if hasattr(sys, 'frozen'):
107 107 del sys.frozen
108 108 if os.name == 'nt':
109 109 (wreg.OpenKey, wreg.QueryValueEx,) = platformstuff
110 110
111 111 # Build decorator that uses the setup_environment/setup_environment
112 112 with_environment = with_setup(setup_environment, teardown_environment)
113 113
114 114
115 115 @skip_if_not_win32
116 116 @with_environment
117 117 def test_get_home_dir_1():
118 118 """Testcase for py2exe logic, un-compressed lib
119 119 """
120 120 sys.frozen = True
121 121
122 122 #fake filename for IPython.__init__
123 123 IPython.__file__ = abspath(join(HOME_TEST_DIR, "Lib/IPython/__init__.py"))
124 124
125 125 home_dir = path.get_home_dir()
126 126 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
127 127
128 128
129 129 @skip_if_not_win32
130 130 @with_environment
131 131 def test_get_home_dir_2():
132 132 """Testcase for py2exe logic, compressed lib
133 133 """
134 134 sys.frozen = True
135 135 #fake filename for IPython.__init__
136 136 IPython.__file__ = abspath(join(HOME_TEST_DIR, "Library.zip/IPython/__init__.py")).lower()
137 137
138 138 home_dir = path.get_home_dir()
139 139 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR).lower())
140 140
141 141
142 142 @with_environment
143 143 @skip_win32
144 144 def test_get_home_dir_3():
145 145 """Testcase $HOME is set, then use its value as home directory."""
146 146 env["HOME"] = HOME_TEST_DIR
147 147 home_dir = path.get_home_dir()
148 148 nt.assert_equal(home_dir, env["HOME"])
149 149
150 150
151 151 @with_environment
152 152 @skip_win32
153 153 def test_get_home_dir_4():
154 154 """Testcase $HOME is not set, os=='posix'.
155 155 This should fail with HomeDirError"""
156 156
157 157 os.name = 'posix'
158 158 if 'HOME' in env: del env['HOME']
159 159 nt.assert_raises(path.HomeDirError, path.get_home_dir)
160 160
161 161
162 162 @skip_if_not_win32
163 163 @with_environment
164 164 def test_get_home_dir_5():
165 165 """Using HOMEDRIVE + HOMEPATH, os=='nt'.
166 166
167 167 HOMESHARE is missing.
168 168 """
169 169
170 170 os.name = 'nt'
171 171 env.pop('HOMESHARE', None)
172 172 env['HOMEDRIVE'], env['HOMEPATH'] = os.path.splitdrive(HOME_TEST_DIR)
173 173 home_dir = path.get_home_dir()
174 174 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
175 175
176 176
177 177 @skip_if_not_win32
178 178 @with_environment
179 179 def test_get_home_dir_6():
180 180 """Using USERPROFILE, os=='nt'.
181 181
182 182 HOMESHARE, HOMEDRIVE, HOMEPATH are missing.
183 183 """
184 184
185 185 os.name = 'nt'
186 186 env.pop('HOMESHARE', None)
187 187 env.pop('HOMEDRIVE', None)
188 188 env.pop('HOMEPATH', None)
189 189 env["USERPROFILE"] = abspath(HOME_TEST_DIR)
190 190 home_dir = path.get_home_dir()
191 191 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
192 192
193 193
194 194 @skip_if_not_win32
195 195 @with_environment
196 196 def test_get_home_dir_7():
197 197 """Using HOMESHARE, os=='nt'."""
198 198
199 199 os.name = 'nt'
200 200 env["HOMESHARE"] = abspath(HOME_TEST_DIR)
201 201 home_dir = path.get_home_dir()
202 202 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
203 203
204 204
205 205 # Should we stub wreg fully so we can run the test on all platforms?
206 206 @skip_if_not_win32
207 207 @with_environment
208 208 def test_get_home_dir_8():
209 209 """Using registry hack for 'My Documents', os=='nt'
210 210
211 211 HOMESHARE, HOMEDRIVE, HOMEPATH, USERPROFILE and others are missing.
212 212 """
213 213 os.name = 'nt'
214 214 # Remove from stub environment all keys that may be set
215 215 for key in ['HOME', 'HOMESHARE', 'HOMEDRIVE', 'HOMEPATH', 'USERPROFILE']:
216 216 env.pop(key, None)
217 217
218 218 #Stub windows registry functions
219 219 def OpenKey(x, y):
220 220 class key:
221 221 def Close(self):
222 222 pass
223 223 return key()
224 224 def QueryValueEx(x, y):
225 225 return [abspath(HOME_TEST_DIR)]
226 226
227 227 wreg.OpenKey = OpenKey
228 228 wreg.QueryValueEx = QueryValueEx
229 229
230 230 home_dir = path.get_home_dir()
231 231 nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
232 232
233 233
234 234 @with_environment
235 235 def test_get_ipython_dir_1():
236 236 """test_get_ipython_dir_1, Testcase to see if we can call get_ipython_dir without Exceptions."""
237 237 env_ipdir = os.path.join("someplace", ".ipython")
238 238 path._writable_dir = lambda path: True
239 239 env['IPYTHON_DIR'] = env_ipdir
240 240 ipdir = path.get_ipython_dir()
241 241 nt.assert_equal(ipdir, env_ipdir)
242 242
243 243
244 244 @with_environment
245 245 def test_get_ipython_dir_2():
246 246 """test_get_ipython_dir_2, Testcase to see if we can call get_ipython_dir without Exceptions."""
247 247 path.get_home_dir = lambda : "someplace"
248 248 path.get_xdg_dir = lambda : None
249 249 path._writable_dir = lambda path: True
250 250 os.name = "posix"
251 251 env.pop('IPYTHON_DIR', None)
252 252 env.pop('IPYTHONDIR', None)
253 253 env.pop('XDG_CONFIG_HOME', None)
254 254 ipdir = path.get_ipython_dir()
255 255 nt.assert_equal(ipdir, os.path.join("someplace", ".ipython"))
256 256
257 257 @with_environment
258 258 def test_get_ipython_dir_3():
259 259 """test_get_ipython_dir_3, use XDG if defined, and .ipython doesn't exist."""
260 260 path.get_home_dir = lambda : "someplace"
261 261 path._writable_dir = lambda path: True
262 262 os.name = "posix"
263 263 env.pop('IPYTHON_DIR', None)
264 264 env.pop('IPYTHONDIR', None)
265 265 env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
266 266 ipdir = path.get_ipython_dir()
267 267 nt.assert_equal(ipdir, os.path.join(XDG_TEST_DIR, "ipython"))
268 268
269 269 @with_environment
270 270 def test_get_ipython_dir_4():
271 271 """test_get_ipython_dir_4, use XDG if both exist."""
272 272 path.get_home_dir = lambda : HOME_TEST_DIR
273 273 os.name = "posix"
274 274 env.pop('IPYTHON_DIR', None)
275 275 env.pop('IPYTHONDIR', None)
276 276 env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
277 277 xdg_ipdir = os.path.join(XDG_TEST_DIR, "ipython")
278 278 ipdir = path.get_ipython_dir()
279 279 nt.assert_equal(ipdir, xdg_ipdir)
280 280
281 281 @with_environment
282 282 def test_get_ipython_dir_5():
283 283 """test_get_ipython_dir_5, use .ipython if exists and XDG defined, but doesn't exist."""
284 284 path.get_home_dir = lambda : HOME_TEST_DIR
285 285 os.name = "posix"
286 286 env.pop('IPYTHON_DIR', None)
287 287 env.pop('IPYTHONDIR', None)
288 288 env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
289 289 os.rmdir(os.path.join(XDG_TEST_DIR, 'ipython'))
290 290 ipdir = path.get_ipython_dir()
291 291 nt.assert_equal(ipdir, IP_TEST_DIR)
292 292
293 293 @with_environment
294 294 def test_get_ipython_dir_6():
295 295 """test_get_ipython_dir_6, use XDG if defined and neither exist."""
296 296 xdg = os.path.join(HOME_TEST_DIR, 'somexdg')
297 297 os.mkdir(xdg)
298 298 shutil.rmtree(os.path.join(HOME_TEST_DIR, '.ipython'))
299 299 path.get_home_dir = lambda : HOME_TEST_DIR
300 300 path.get_xdg_dir = lambda : xdg
301 301 os.name = "posix"
302 302 env.pop('IPYTHON_DIR', None)
303 303 env.pop('IPYTHONDIR', None)
304 304 env.pop('XDG_CONFIG_HOME', None)
305 305 xdg_ipdir = os.path.join(xdg, "ipython")
306 306 ipdir = path.get_ipython_dir()
307 307 nt.assert_equal(ipdir, xdg_ipdir)
308 308
309 309 @with_environment
310 310 def test_get_ipython_dir_7():
311 311 """test_get_ipython_dir_7, test home directory expansion on IPYTHON_DIR"""
312 312 path._writable_dir = lambda path: True
313 313 home_dir = os.path.expanduser('~')
314 314 env['IPYTHON_DIR'] = os.path.join('~', 'somewhere')
315 315 ipdir = path.get_ipython_dir()
316 316 nt.assert_equal(ipdir, os.path.join(home_dir, 'somewhere'))
317 317
318 318
319 319 @with_environment
320 320 def test_get_xdg_dir_1():
321 321 """test_get_xdg_dir_1, check xdg_dir"""
322 322 reload(path)
323 323 path._writable_dir = lambda path: True
324 324 path.get_home_dir = lambda : 'somewhere'
325 325 os.name = "posix"
326 326 env.pop('IPYTHON_DIR', None)
327 327 env.pop('IPYTHONDIR', None)
328 328 env.pop('XDG_CONFIG_HOME', None)
329 329
330 330 nt.assert_equal(path.get_xdg_dir(), os.path.join('somewhere', '.config'))
331 331
332 332
333 333 @with_environment
334 334 def test_get_xdg_dir_1():
335 335 """test_get_xdg_dir_1, check nonexistant xdg_dir"""
336 336 reload(path)
337 337 path.get_home_dir = lambda : HOME_TEST_DIR
338 338 os.name = "posix"
339 339 env.pop('IPYTHON_DIR', None)
340 340 env.pop('IPYTHONDIR', None)
341 341 env.pop('XDG_CONFIG_HOME', None)
342 342 nt.assert_equal(path.get_xdg_dir(), None)
343 343
344 344 @with_environment
345 345 def test_get_xdg_dir_2():
346 346 """test_get_xdg_dir_2, check xdg_dir default to ~/.config"""
347 347 reload(path)
348 348 path.get_home_dir = lambda : HOME_TEST_DIR
349 349 os.name = "posix"
350 350 env.pop('IPYTHON_DIR', None)
351 351 env.pop('IPYTHONDIR', None)
352 352 env.pop('XDG_CONFIG_HOME', None)
353 353 cfgdir=os.path.join(path.get_home_dir(), '.config')
354 354 os.makedirs(cfgdir)
355 355
356 356 nt.assert_equal(path.get_xdg_dir(), cfgdir)
357 357
358 358 def test_filefind():
359 359 """Various tests for filefind"""
360 360 f = tempfile.NamedTemporaryFile()
361 361 # print 'fname:',f.name
362 362 alt_dirs = path.get_ipython_dir()
363 363 t = path.filefind(f.name, alt_dirs)
364 364 # print 'found:',t
365 365
366 366
367 367 def test_get_ipython_package_dir():
368 368 ipdir = path.get_ipython_package_dir()
369 369 nt.assert_true(os.path.isdir(ipdir))
370 370
371 371
372 372 def test_get_ipython_module_path():
373 373 ipapp_path = path.get_ipython_module_path('IPython.frontend.terminal.ipapp')
374 374 nt.assert_true(os.path.isfile(ipapp_path))
375 375
376 376
377 377 @dec.skip_if_not_win32
378 378 def test_get_long_path_name_win32():
379 379 p = path.get_long_path_name('c:\\docume~1')
380 380 nt.assert_equals(p,u'c:\\Documents and Settings')
381 381
382 382
383 383 @dec.skip_win32
384 384 def test_get_long_path_name():
385 385 p = path.get_long_path_name('/usr/local')
386 386 nt.assert_equals(p,'/usr/local')
387 387
388 388 @dec.skip_win32 # can't create not-user-writable dir on win
389 389 @with_environment
390 390 def test_not_writable_ipdir():
391 391 tmpdir = tempfile.mkdtemp()
392 392 os.name = "posix"
393 393 env.pop('IPYTHON_DIR', None)
394 394 env.pop('IPYTHONDIR', None)
395 395 env.pop('XDG_CONFIG_HOME', None)
396 396 env['HOME'] = tmpdir
397 397 ipdir = os.path.join(tmpdir, '.ipython')
398 398 os.mkdir(ipdir)
399 399 os.chmod(ipdir, 600)
400 400 stderr = io.stderr
401 401 pipe = StringIO.StringIO()
402 402 io.stderr = pipe
403 403 ipdir = path.get_ipython_dir()
404 404 io.stderr.flush()
405 405 io.stderr = stderr
406 406 nt.assert_true('WARNING' in pipe.getvalue())
407 407 env.pop('IPYTHON_DIR', None)
408 408
409 def test_unquote_filename():
410 for win32 in (True, False):
411 nt.assert_equals(path.unquote_filename('foo.py', win32=win32), 'foo.py')
412 nt.assert_equals(path.unquote_filename('foo bar.py', win32=win32), 'foo bar.py')
413 nt.assert_equals(path.unquote_filename('"foo.py"', win32=True), 'foo.py')
414 nt.assert_equals(path.unquote_filename('"foo bar.py"', win32=True), 'foo bar.py')
415 nt.assert_equals(path.unquote_filename("'foo.py'", win32=True), 'foo.py')
416 nt.assert_equals(path.unquote_filename("'foo bar.py'", win32=True), 'foo bar.py')
417 nt.assert_equals(path.unquote_filename('"foo.py"', win32=False), '"foo.py"')
418 nt.assert_equals(path.unquote_filename('"foo bar.py"', win32=False), '"foo bar.py"')
419 nt.assert_equals(path.unquote_filename("'foo.py'", win32=False), "'foo.py'")
420 nt.assert_equals(path.unquote_filename("'foo bar.py'", win32=False), "'foo bar.py'")
421
409 422 @with_environment
410 423 def test_get_py_filename():
411 424 os.chdir(TMP_TEST_DIR)
412 425 for win32 in (True, False):
413 426 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')
427 nt.assert_equals(path.get_py_filename('foo.py', force_win32=win32), 'foo.py')
428 nt.assert_equals(path.get_py_filename('foo', force_win32=win32), 'foo.py')
416 429 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)
430 nt.assert_equals(path.get_py_filename('foo', force_win32=win32), 'foo')
431 nt.assert_raises(IOError, path.get_py_filename, 'foo.py', force_win32=win32)
432 nt.assert_raises(IOError, path.get_py_filename, 'foo', force_win32=win32)
433 nt.assert_raises(IOError, path.get_py_filename, 'foo.py', force_win32=win32)
421 434 true_fn = 'foo with spaces.py'
422 435 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)
436 nt.assert_equals(path.get_py_filename('foo with spaces', force_win32=win32), true_fn)
437 nt.assert_equals(path.get_py_filename('foo with spaces.py', force_win32=win32), true_fn)
425 438 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)
439 nt.assert_equals(path.get_py_filename('"foo with spaces.py"', force_win32=True), true_fn)
440 nt.assert_equals(path.get_py_filename("'foo with spaces.py'", force_win32=True), true_fn)
428 441 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)
442 nt.assert_raises(IOError, path.get_py_filename, '"foo with spaces.py"', force_win32=False)
443 nt.assert_raises(IOError, path.get_py_filename, "'foo with spaces.py'", force_win32=False)
General Comments 0
You need to be logged in to leave comments. Login now